Returns the number of previous mask is possible, TRUE otherwise, FALSE in case of an error.
No value is returned.
") (prototype . "void xslt_set_scheme_handlers(resource $xh, array $handlers)") (purpose . "Set the scheme handlers for the XSLT processor") (id . "function.xslt-set-scheme-handlers")) "xslt_set_scheme_handler" ((documentation . "Set Scheme handlers for a XSLT processor void xslt_set_scheme_handler(resource $xh, array $handlers) No value is returned. (PHP 4 >= 4.0.5)") (versions . "PHP 4 >= 4.0.5") (return . "No value is returned.
") (prototype . "void xslt_set_scheme_handler(resource $xh, array $handlers)") (purpose . "Set Scheme handlers for a XSLT processor") (id . "function.xslt-set-scheme-handler")) "xslt_set_sax_handlers" ((documentation . "Set the SAX handlers to be called when the XML document gets processed void xslt_set_sax_handlers(resource $processor, array $handlers) No value is returned. (PHP 4 >= 4.0.6)") (versions . "PHP 4 >= 4.0.6") (return . "No value is returned.
") (prototype . "void xslt_set_sax_handlers(resource $processor, array $handlers)") (purpose . "Set the SAX handlers to be called when the XML document gets processed") (id . "function.xslt-set-sax-handlers")) "xslt_set_sax_handler" ((documentation . "Set SAX handlers for a XSLT processor void xslt_set_sax_handler(resource $xh, array $handlers) No value is returned. (PHP 4 >= 4.0.3)") (versions . "PHP 4 >= 4.0.3") (return . "No value is returned.
") (prototype . "void xslt_set_sax_handler(resource $xh, array $handlers)") (purpose . "Set SAX handlers for a XSLT processor") (id . "function.xslt-set-sax-handler")) "xslt_set_object" ((documentation . "Sets the object in which to resolve callback functions bool xslt_set_object(resource $processor, object $obj) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.3.0)") (versions . "PHP 4 >= 4.3.0") (return . " Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void xslt_set_log(resource $xh [, mixed $log = ''])") (purpose . "Set the log file to write log messages to") (id . "function.xslt-set-log")) "xslt_set_error_handler" ((documentation . "Set an error handler for a XSLT processor void xslt_set_error_handler(resource $xh, mixed $handler) No value is returned. (PHP 4 >= 4.0.4)") (versions . "PHP 4 >= 4.0.4") (return . "No value is returned.
") (prototype . "void xslt_set_error_handler(resource $xh, mixed $handler)") (purpose . "Set an error handler for a XSLT processor") (id . "function.xslt-set-error-handler")) "xslt_set_encoding" ((documentation . "Set the encoding for the parsing of XML documents void xslt_set_encoding(resource $xh, string $encoding) No value is returned. (PHP 4 >= 4.0.5)") (versions . "PHP 4 >= 4.0.5") (return . "No value is returned.
") (prototype . "void xslt_set_encoding(resource $xh, string $encoding)") (purpose . "Set the encoding for the parsing of XML documents") (id . "function.xslt-set-encoding")) "xslt_set_base" ((documentation . "Set the base URI for all XSLT transformations void xslt_set_base(resource $xh, string $uri) No value is returned. (PHP 4 >= 4.0.5)") (versions . "PHP 4 >= 4.0.5") (return . "No value is returned.
") (prototype . "void xslt_set_base(resource $xh, string $uri)") (purpose . "Set the base URI for all XSLT transformations") (id . "function.xslt-set-base")) "xslt_process" ((documentation . "Perform an XSLT transformation mixed xslt_process(resource $xh, string $xmlcontainer, string $xslcontainer [, string $resultcontainer = '' [, array $arguments = '' [, array $parameters = '']]]) Returns TRUE on success or FALSE on failure. If the result container is not specified - i.e. NULL - than the result is returned. (PHP 4 >= 4.0.3)") (versions . "PHP 4 >= 4.0.3") (return . " Returns TRUE on success or FALSE on failure. If the result container is not specified - i.e. NULL - than the result is returned.
Returns the options, a bitmask constructed with the XSLT_SABOPT_XXX constants.
") (prototype . "int xslt_getopt(resource $processor)") (purpose . "Get options on a given xsl processor") (id . "function.xslt-getopt")) "xslt_free" ((documentation . "Free XSLT processor void xslt_free(resource $xh) No value is returned. (PHP 4 >= 4.0.3)") (versions . "PHP 4 >= 4.0.3") (return . "No value is returned.
") (prototype . "void xslt_free(resource $xh)") (purpose . "Free XSLT processor") (id . "function.xslt-free")) "xslt_error" ((documentation . "Returns an error string string xslt_error(resource $xh) Returns the error message, as a string. (PHP 4 >= 4.0.3)") (versions . "PHP 4 >= 4.0.3") (return . "Returns the error message, as a string.
") (prototype . "string xslt_error(resource $xh)") (purpose . "Returns an error string") (id . "function.xslt-error")) "xslt_errno" ((documentation . "Returns an error number int xslt_errno(resource $xh) Returns the error code, as an integer. (PHP 4 >= 4.0.3)") (versions . "PHP 4 >= 4.0.3") (return . "Returns the error code, as an integer.
") (prototype . "int xslt_errno(resource $xh)") (purpose . "Returns an error number") (id . "function.xslt-errno")) "xslt_create" ((documentation . "Create a new XSLT processor resource xslt_create() Returns an XSLT processor link identifier on success, or FALSE on error. (PHP 4 >= 4.0.3)") (versions . "PHP 4 >= 4.0.3") (return . " Returns an XSLT processor link identifier on success, or FALSE on error.
Returns the version number, or FALSE if not available.
Returns Sablotron.
") (prototype . "string xslt_backend_name()") (purpose . "Returns the name of the backend") (id . "function.xslt-backend-name")) "xslt_backend_info" ((documentation . "Returns the information on the compilation settings of the backend string xslt_backend_info() Returns a string with information about the compilation setting of the backend or an error string when no information available. (PHP 4 >= 4.3.0)") (versions . "PHP 4 >= 4.3.0") (return . "Returns a string with information about the compilation setting of the backend or an error string when no information available.
") (prototype . "string xslt_backend_info()") (purpose . "Returns the information on the compilation settings of the backend") (id . "function.xslt-backend-info")) "xmlwriter_write_raw" ((documentation . "Write a raw XML text bool xmlwriter_write_raw(string $content, resource $xmlwriter) Returns TRUE on success or FALSE on failure. (PHP 5 >= 5.2.0, PECL xmlwriter >= 2.0.4)") (versions . "PHP 5 >= 5.2.0, PECL xmlwriter >= 2.0.4") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the current buffer as a string.
") (prototype . "string xmlwriter_output_memory([bool $flush = true, resource $xmlwriter])") (purpose . "Returns current buffer") (id . "function.xmlwriter-output-memory")) "xmlwriter_open_uri" ((documentation . #("Create new xmlwriter using source uri for output resource xmlwriter_open_uri(string $uri) Object oriented style: Returns TRUE on success or FALSE on failure. Procedural style: Returns a new xmlwriter resource for later use with the xmlwriter functions on success, FALSE on error. (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)" 203 211 (shr-url "language.types.resource.html"))) (versions . "PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0") (return . " Object oriented style: Returns TRUE on success or FALSE on failure.
Procedural style: Returns a new xmlwriter resource for later use with the xmlwriter functions on success, FALSE on error.
Object oriented style: Returns TRUE on success or FALSE on failure.
Procedural style: Returns a new xmlwriter resource for later use with the xmlwriter functions on success, FALSE on error.
Returns TRUE on success or FALSE on failure.
If you opened the writer in memory, this function returns the generated XML buffer, Else, if using URI, this function will write the buffer and return the number of written bytes.
") (prototype . "mixed xmlwriter_flush([bool $empty = true, resource $xmlwriter])") (purpose . "Flush current buffer") (id . "function.xmlwriter-flush")) "xmlwriter_end_pi" ((documentation . "End current PI bool xmlwriter_end_pi(resource $xmlwriter) Returns TRUE on success or FALSE on failure. (PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0)") (versions . "PHP 5 >= 5.1.2, PECL xmlwriter >= 0.1.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
This function returns FALSE if parser does not refer to a valid parser, or if the option could not be set. Else the option is set and TRUE is returned.
This function returns FALSE if parser does not refer to a valid parser or if option isn't valid (generates also a E_WARNING). Else the option's value is returned.
This function returns FALSE if parser does not refer to a valid parser, or else it frees the parser and returns TRUE.
Returns a resource handle for the new XML parser.
") (prototype . "resource xml_parser_create([string $encoding = ''])") (purpose . "Create an XML parser") (id . "function.xml-parser-create")) "xml_parser_create_ns" ((documentation . "Create an XML parser with namespace support resource xml_parser_create_ns([string $encoding = '' [, string $separator = ':']]) Returns a resource handle for the new XML parser. (PHP 4 >= 4.0.5, PHP 5)") (versions . "PHP 4 >= 4.0.5, PHP 5") (return . "Returns a resource handle for the new XML parser.
") (prototype . "resource xml_parser_create_ns([string $encoding = '' [, string $separator = ':']])") (purpose . "Create an XML parser with namespace support") (id . "function.xml-parser-create-ns")) "xml_parse" ((documentation . "Start parsing an XML document int xml_parse(resource $parser, string $data [, bool $is_final = false]) Returns 1 on success or 0 on failure. For unsuccessful parses, error information can be retrieved with xml_get_error_code, xml_error_string, xml_get_current_line_number, xml_get_current_column_number and xml_get_current_byte_index. Note: Entity errors are reported at the end of the data thus only if is_final is set and TRUE. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns 1 on success or 0 on failure.
For unsuccessful parses, error information can be retrieved with xml_get_error_code, xml_error_string, xml_get_current_line_number, xml_get_current_column_number and xml_get_current_byte_index.
") (prototype . "int xml_parse(resource $parser, string $data [, bool $is_final = false])") (purpose . "Start parsing an XML document") (id . "function.xml-parse")) "xml_parse_into_struct" ((documentation . "Parse XML data into an array structure int xml_parse_into_struct(resource $parser, string $data, array $values [, array $index = '']) xml_parse_into_struct returns 0 for failure and 1 for success. This is not the same as FALSE and TRUE, be careful with operators such as ===. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Note:
Entity errors are reported at the end of the data thus only if
is_finalis set andTRUE.
xml_parse_into_struct returns 0 for failure and 1 for success. This is not the same as FALSE and TRUE, be careful with operators such as ===.
This function returns FALSE if parser does not refer to a valid parser, or else it returns one of the error codes listed in the error codes section.
This function returns FALSE if parser does not refer to a valid parser, or else it returns which line the parser is currently at in its data buffer.
This function returns FALSE if parser does not refer to a valid parser, or else it returns which column on the current line (as given by xml_get_current_line_number) the parser is currently at.
This function returns FALSE if parser does not refer to a valid parser, or else it returns which byte index the parser is currently at in its data buffer (starting at 0).
Returns a string with a textual description of the error code, or FALSE if no description was found.
Returns the UTF-8 translation of data.
Returns the ISO-8859-1 translation of data.
Returns the WDDX packet, or FALSE on error.
Returns the WDDX packet, or FALSE on error.
Returns a packet ID for use in later functions, or FALSE on error.
Returns the string containing the WDDX packet.
") (prototype . "string wddx_packet_end(resource $packet_id)") (purpose . "Ends a WDDX packet with the specified ID") (id . "function.wddx-packet-end")) "wddx_deserialize" ((documentation . "Unserializes a WDDX packet mixed wddx_deserialize(string $packet) Returns the deserialized value which can be a string, a number or an array. Note that structures are deserialized into associative arrays. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the deserialized value which can be a string, a number or an array. Note that structures are deserialized into associative arrays.
") (prototype . "mixed wddx_deserialize(string $packet)") (purpose . "Unserializes a WDDX packet") (id . "function.wddx-deserialize")) "wddx_add_vars" ((documentation . "Add variables to a WDDX packet with the specified ID bool wddx_add_vars(resource $packet_id, mixed $var_name [, mixed $... = '']) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns an object of class SimpleXMLElement with properties containing the data held within the xml document, or FALSE on failure.
Returns an object of class SimpleXMLElement with properties containing the data held within the XML document, or FALSE on failure.
Returns a SimpleXMLElement or FALSE on failure.
This function returns the previous value of use_errors.
No value is returned.
") (prototype . "void libxml_set_streams_context(resource $streams_context)") (purpose . "Set the streams context for the next libxml document load or write") (id . "function.libxml-set-streams-context")) "libxml_set_external_entity_loader" ((documentation . "Changes the default external entity loader void libxml_set_external_entity_loader(callable $resolver_function) No value is returned. (PHP 5 >= 5.4.0)") (versions . "PHP 5 >= 5.4.0") (return . "No value is returned.
") (prototype . "void libxml_set_external_entity_loader(callable $resolver_function)") (purpose . "Changes the default external entity loader") (id . "function.libxml-set-external-entity-loader")) "libxml_get_last_error" ((documentation . "Retrieve last error from libxml LibXMLError libxml_get_last_error() Returns a LibXMLError object if there is any error in the buffer, FALSE otherwise. (PHP 5 >= 5.1.0)") (versions . "PHP 5 >= 5.1.0") (return . " Returns a LibXMLError object if there is any error in the buffer, FALSE otherwise.
Returns an array with LibXMLError objects if there are any errors in the buffer, or an empty array otherwise.
") (prototype . "array libxml_get_errors()") (purpose . "Retrieve array of errors") (id . "function.libxml-get-errors")) "libxml_disable_entity_loader" ((documentation . "Disable the ability to load external entities bool libxml_disable_entity_loader([bool $disable = true]) Returns the previous value. (PHP 5 >= 5.2.11)") (versions . "PHP 5 >= 5.2.11") (return . "Returns the previous value.
") (prototype . "bool libxml_disable_entity_loader([bool $disable = true])") (purpose . "Disable the ability to load external entities") (id . "function.libxml-disable-entity-loader")) "libxml_clear_errors" ((documentation . "Clear libxml error buffer void libxml_clear_errors() No value is returned. (PHP 5 >= 5.1.0)") (versions . "PHP 5 >= 5.1.0") (return . "No value is returned.
") (prototype . "void libxml_clear_errors()") (purpose . "Clear libxml error buffer") (id . "function.libxml-clear-errors")) "dom_import_simplexml" ((documentation . "Gets a DOMElement object from a SimpleXMLElement object DOMElement dom_import_simplexml(SimpleXMLElement $node) The DOMElement node added or FALSE if any errors occur. (PHP 5)") (versions . "PHP 5") (return . " The DOMElement node added or FALSE if any errors occur.
Returns WIN32_NO_ERROR on success, FALSE if there is a problem with the parameters or a Win32 Error Code on failure.
Returns WIN32_NO_ERROR on success, FALSE if there is a problem with the parameters or a Win32 Error Code on failure.
Returns TRUE on success, FALSE if there is a problem with the parameters or a Win32 Error Code on failure.
Returns TRUE on success, FALSE if there is a problem with the parameters or a Win32 Error Code on failure.
Returns an array consisting of the following information on success, FALSE if there is a problem with the parameters or a Win32 Error Code on failure.
ServiceTypeThe dwServiceType. See Win32Service Service Type Bitmasks.
CurrentStateThe dwCurrentState. See Win32Service Service Status Constants.
ControlsAcceptedWhich service controls are accepted by the service. See Win32Service Service Control Message Accepted Bitmasks.
Win32ExitCodeIf the service exited, the return code from the process.
ServiceSpecificExitCodeIf the service exited with an error condition, the service specific code that is logged in the event log is visible here.
CheckPointIf 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.
WaitHintIf 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.
ProcessIdThe Windows process identifier. If 0, the process is not running.
ServiceFlagsThe dwServiceFlags. See Win32Service Service Service Flag Constants.
Returns WIN32_NO_ERROR on success, FALSE if there is a problem with the parameters or a Win32 Error Code on failure.
Returns a control constant which will be one of the Win32Service Service Control Message Constants: WIN32_SERVICE_CONTROL_CONTINUE, WIN32_SERVICE_CONTROL_INTERROGATE, WIN32_SERVICE_CONTROL_PAUSE, WIN32_SERVICE_CONTROL_PRESHUTDOWN, WIN32_SERVICE_CONTROL_SHUTDOWN, WIN32_SERVICE_CONTROL_STOP.
Returns WIN32_NO_ERROR on success, FALSE if there is a problem with the parameters or a Win32 Error Code on failure.
Returns WIN32_NO_ERROR on success, FALSE if there is a problem with the parameters or a Win32 Error Code on failure.
Returns WIN32_NO_ERROR on success, FALSE if there is a problem with the parameters or a Win32 Error Code on failure.
Returns FALSE on failure, or an array consisting of the following information on success:
pidThe process id.
exeThe path to the executable image.
mem An array containing information about the following memory utilization indicators: page_fault_count, peak_working_set_size, working_set_size, quota_peak_paged_pool_usage, quota_paged_pool_usage, quota_peak_non_paged_pool_usage, quota_non_paged_pool_usage, pagefile_usage and peak_pagefile_usage.
tms An array containing information about the following CPU time utilization indicators: created, kernel and user.
Returns FALSE on failure, or an array consisting of the following information on success:
loadThe current memory load in percent of physical memory.
unitThis is always 1024, and indicates that the following values are the count of 1024 bytes.
total_physThe amount of total physical memory.
avail_physThe amount of still available physical memory.
total_pagefileThe amount of total pageable memory (physical memory + paging file).
avail_pagefileThe amount of still available pageable memory (physical memory + paging file).
total_virtualThe amount of total virtual memory for a process.
avail_virtualThe amount of still available virtual memory for a process.
Returns FALSE on failure, or an array consisting of process statistics like win32_ps_stat_proc returns for all running processes on success.
No value is returned.
") (prototype . "void w32api_set_call_method(int $method)") (purpose . "Sets the calling method used") (id . "function.w32api-set-call-method")) "w32api_register_function" ((documentation . "Registers function function_name from library with PHP bool w32api_register_function(string $library, string $function_name, string $return_type) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.2.0)") (versions . "PHP 4 >= 4.2.0") (return . " Returns TRUE on success or FALSE on failure.
The return type is the one you set when you registered the function, the value is the one returned by the function itself.
") (prototype . "mixed w32api_invoke_function(string $funcname, mixed $argument [, mixed $... = ''])") (purpose . "Invokes function funcname with the arguments passed after the function name") (id . "function.w32api-invoke-function")) "w32api_init_dtype" ((documentation . "Creates an instance of the data type typename and fills it with the values passed resource w32api_init_dtype(string $typename, mixed $value [, mixed $... = '']) Returns a dynaparm resource. (PHP 4 >= 4.2.0)") (versions . "PHP 4 >= 4.2.0") (return . "Returns a dynaparm resource.
") (prototype . "resource w32api_init_dtype(string $typename, mixed $value [, mixed $... = ''])") (purpose . "Creates an instance of the data type typename and fills it with the values passed") (id . "function.w32api-init-dtype")) "w32api_deftype" ((documentation . "Defines a type for use with other w32api_functions bool w32api_deftype(string $typename, string $member1_type, string $member1_name [, string $... = '']) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.2.0)") (versions . "PHP 4 >= 4.2.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void printer_select_pen(resource $printer_handle, resource $pen_handle)") (purpose . "Select a pen") (id . "function.printer-select-pen")) "printer_select_font" ((documentation . "Select a font void printer_select_font(resource $printer_handle, resource $font_handle) No value is returned. (PECL printer SVN)") (versions . "PECL printer SVN") (return . "No value is returned.
") (prototype . "void printer_select_font(resource $printer_handle, resource $font_handle)") (purpose . "Select a font") (id . "function.printer-select-font")) "printer_select_brush" ((documentation . "Select a brush void printer_select_brush(resource $printer_handle, resource $brush_handle) No value is returned. (PECL printer SVN)") (versions . "PECL printer SVN") (return . "No value is returned.
") (prototype . "void printer_select_brush(resource $printer_handle, resource $brush_handle)") (purpose . "Select a brush") (id . "function.printer-select-brush")) "printer_open" ((documentation . "Opens a connection to a printer resource printer_open([string $printername = '']) Returns a printer handle on success or FALSE on failure. (PECL printer SVN)") (versions . "PECL printer SVN") (return . " Returns a printer handle on success or FALSE on failure.
Returns the logical font height or FALSE on failure.
Return an array of printers.
") (prototype . "array printer_list(int $enumtype [, string $name = '' [, int $level = '']])") (purpose . "Return an array of printers attached to the server") (id . "function.printer-list")) "printer_get_option" ((documentation . "Retrieve printer configuration data mixed printer_get_option(resource $printer_handle, string $option) Returns the value of option. (PECL printer SVN)") (versions . "PECL printer SVN") (return . " Returns the value of option.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void printer_draw_text(resource $printer_handle, string $text, int $x, int $y)") (purpose . "Draw text") (id . "function.printer-draw-text")) "printer_draw_roundrect" ((documentation . "Draw a rectangle with rounded corners void printer_draw_roundrect(resource $printer_handle, int $ul_x, int $ul_y, int $lr_x, int $lr_y, int $width, int $height) No value is returned. (PECL printer SVN)") (versions . "PECL printer SVN") (return . "No value is returned.
") (prototype . "void printer_draw_roundrect(resource $printer_handle, int $ul_x, int $ul_y, int $lr_x, int $lr_y, int $width, int $height)") (purpose . "Draw a rectangle with rounded corners") (id . "function.printer-draw-roundrect")) "printer_draw_rectangle" ((documentation . "Draw a rectangle void printer_draw_rectangle(resource $printer_handle, int $ul_x, int $ul_y, int $lr_x, int $lr_y) No value is returned. (PECL printer SVN)") (versions . "PECL printer SVN") (return . "No value is returned.
") (prototype . "void printer_draw_rectangle(resource $printer_handle, int $ul_x, int $ul_y, int $lr_x, int $lr_y)") (purpose . "Draw a rectangle") (id . "function.printer-draw-rectangle")) "printer_draw_pie" ((documentation . "Draw a pie void printer_draw_pie(resource $printer_handle, int $rec_x, int $rec_y, int $rec_x1, int $rec_y1, int $rad1_x, int $rad1_y, int $rad2_x, int $rad2_y) No value is returned. (PECL printer SVN)") (versions . "PECL printer SVN") (return . "No value is returned.
") (prototype . "void printer_draw_pie(resource $printer_handle, int $rec_x, int $rec_y, int $rec_x1, int $rec_y1, int $rad1_x, int $rad1_y, int $rad2_x, int $rad2_y)") (purpose . "Draw a pie") (id . "function.printer-draw-pie")) "printer_draw_line" ((documentation . "Draw a line void printer_draw_line(resource $printer_handle, int $from_x, int $from_y, int $to_x, int $to_y) No value is returned. (PECL printer SVN)") (versions . "PECL printer SVN") (return . "No value is returned.
") (prototype . "void printer_draw_line(resource $printer_handle, int $from_x, int $from_y, int $to_x, int $to_y)") (purpose . "Draw a line") (id . "function.printer-draw-line")) "printer_draw_elipse" ((documentation . "Draw an ellipse void printer_draw_elipse(resource $printer_handle, int $ul_x, int $ul_y, int $lr_x, int $lr_y) No value is returned. (PECL printer SVN)") (versions . "PECL printer SVN") (return . "No value is returned.
") (prototype . "void printer_draw_elipse(resource $printer_handle, int $ul_x, int $ul_y, int $lr_x, int $lr_y)") (purpose . "Draw an ellipse") (id . "function.printer-draw-elipse")) "printer_draw_chord" ((documentation . "Draw a chord void printer_draw_chord(resource $printer_handle, int $rec_x, int $rec_y, int $rec_x1, int $rec_y1, int $rad_x, int $rad_y, int $rad_x1, int $rad_y1) No value is returned. (PECL printer SVN)") (versions . "PECL printer SVN") (return . "No value is returned.
") (prototype . "void printer_draw_chord(resource $printer_handle, int $rec_x, int $rec_y, int $rec_x1, int $rec_y1, int $rad_x, int $rad_y, int $rad_x1, int $rad_y1)") (purpose . "Draw a chord") (id . "function.printer-draw-chord")) "printer_draw_bmp" ((documentation . "Draw a bmp bool printer_draw_bmp(resource $printer_handle, string $filename, int $x, int $y [, int $width = '', int $height]) Returns TRUE on success or FALSE on failure. (PECL printer SVN)") (versions . "PECL printer SVN") (return . " Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void printer_delete_pen(resource $pen_handle)") (purpose . "Delete a pen") (id . "function.printer-delete-pen")) "printer_delete_font" ((documentation . "Delete a font void printer_delete_font(resource $font_handle) No value is returned. (PECL printer SVN)") (versions . "PECL printer SVN") (return . "No value is returned.
") (prototype . "void printer_delete_font(resource $font_handle)") (purpose . "Delete a font") (id . "function.printer-delete-font")) "printer_delete_dc" ((documentation . "Delete a device context bool printer_delete_dc(resource $printer_handle) Returns TRUE on success or FALSE on failure. (PECL printer SVN)") (versions . "PECL printer SVN") (return . " Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void printer_delete_brush(resource $brush_handle)") (purpose . "Delete a brush") (id . "function.printer-delete-brush")) "printer_create_pen" ((documentation . "Create a new pen resource printer_create_pen(int $style, int $width, string $color) Returns a pen handle or FALSE on error. (PECL printer SVN)") (versions . "PECL printer SVN") (return . " Returns a pen handle or FALSE on error.
Returns a font handle on success or FALSE on error.
No value is returned.
") (prototype . "void printer_create_dc(resource $printer_handle)") (purpose . "Create a new device context") (id . "function.printer-create-dc")) "printer_create_brush" ((documentation . "Create a new brush resource printer_create_brush(int $style, string $color) Returns a brush handle or FALSE on error. (PECL printer SVN)") (versions . "PECL printer SVN") (return . " Returns a brush handle or FALSE on error.
No value is returned.
") (prototype . "void printer_close(resource $printer_handle)") (purpose . "Close an open printer connection") (id . "function.printer-close")) "printer_abort" ((documentation . "Deletes the printer's spool file void printer_abort(resource $printer_handle) No value is returned. (PECL printer SVN)") (versions . "PECL printer SVN") (return . "No value is returned.
") (prototype . "void printer_abort(resource $printer_handle)") (purpose . "Deletes the printer's spool file") (id . "function.printer-abort")) "variant_xor" ((documentation . "Performs a logical exclusion on two variants mixed variant_xor(mixed $left, mixed $right) Variant XOR Rules If left is If right is then the result is TRUE TRUE FALSE TRUE FALSE TRUE FALSE TRUE TRUE FALSE FALSE FALSE NULL NULL NULL (PHP 5)") (versions . "PHP 5") (return . "
If left is | If right is | then the result is |
|---|---|---|
TRUE | TRUE | FALSE |
TRUE | FALSE | TRUE |
FALSE | TRUE | TRUE |
FALSE | FALSE | FALSE |
NULL | NULL | NULL |
| If | Then |
|---|---|
| Both expressions are of the string type | Subtraction |
| One expression is a string type and the other a character | Subtraction |
| One expression is numeric and the other is a string | Subtraction. |
| Both expressions are numeric | Subtraction |
| Either expression is NULL | NULL is returned |
| Both expressions are empty | Empty string is returned |
No value is returned.
") (prototype . "void variant_set(variant $variant, mixed $value)") (purpose . "Assigns a new value for a variant object") (id . "function.variant-set")) "variant_set_type" ((documentation . "Convert a variant into another type \"in-place\" void variant_set_type(variant $variant, int $type) No value is returned. (PHP 5)") (versions . "PHP 5") (return . "No value is returned.
") (prototype . "void variant_set_type(variant $variant, int $type)") (purpose . "Convert a variant into another type \"in-place\"") (id . "function.variant-set-type")) "variant_round" ((documentation . "Rounds a variant to the specified number of decimal places mixed variant_round(mixed $variant, int $decimals) Returns the rounded value. (PHP 5)") (versions . "PHP 5") (return . "Returns the rounded value.
") (prototype . "mixed variant_round(mixed $variant, int $decimals)") (purpose . "Rounds a variant to the specified number of decimal places") (id . "function.variant-round")) "variant_pow" ((documentation . "Returns the result of performing the power function with two variants mixed variant_pow(mixed $left, mixed $right) Returns the result of left to the power of right. (PHP 5)") (versions . "PHP 5") (return . " Returns the result of left to the power of right.
If left is | If right is | then the result is |
|---|---|---|
TRUE | TRUE | TRUE |
TRUE | FALSE | TRUE |
TRUE | NULL | TRUE |
FALSE | TRUE | TRUE |
FALSE | FALSE | FALSE |
FALSE | NULL | NULL |
NULL | TRUE | TRUE |
NULL | FALSE | NULL |
NULL | NULL | NULL |
Returns the bitwise not negation. If variant is NULL, the result will also be NULL.
Returns the result of the logical negation.
") (prototype . "mixed variant_neg(mixed $variant)") (purpose . "Performs logical negation on a variant") (id . "function.variant-neg")) "variant_mul" ((documentation . "Multiplies the values of the two variants mixed variant_mul(mixed $left, mixed $right) Variant Multiplication Rules If Then Both expressions are of the string, Multiplication date, character, boolean type One expression is a string type and the Multiplication other a character One expression is numeric and the other Multiplication is a string Both expressions are numeric Multiplication Either expression is NULL NULL is returned Both expressions are empty Empty string is returned (PHP 5)") (versions . "PHP 5") (return . "
| If | Then |
|---|---|
| Both expressions are of the string, date, character, boolean type | Multiplication |
| One expression is a string type and the other a character | Multiplication |
| One expression is numeric and the other is a string | Multiplication |
| Both expressions are numeric | Multiplication |
| Either expression is NULL | NULL is returned |
| Both expressions are empty | Empty string is returned |
Returns the remainder of the division.
") (prototype . "mixed variant_mod(mixed $left, mixed $right)") (purpose . "Divides two variants and returns only the remainder") (id . "function.variant-mod")) "variant_int" ((documentation . "Returns the integer portion of a variant mixed variant_int(mixed $variant) If variant is negative, then the first negative integer greater than or equal to the variant is returned, otherwise returns the integer portion of the value of variant. (PHP 5)") (versions . "PHP 5") (return . " If variant is negative, then the first negative integer greater than or equal to the variant is returned, otherwise returns the integer portion of the value of variant.
If left is | If right is | then the result is |
|---|---|---|
TRUE | TRUE | TRUE |
TRUE | FALSE | TRUE |
TRUE | NULL | TRUE |
FALSE | TRUE | TRUE |
FALSE | FALSE | TRUE |
FALSE | NULL | TRUE |
NULL | TRUE | TRUE |
NULL | FALSE | NULL |
NULL | NULL | NULL |
| If | Then |
|---|---|
| Both expressions are of the string, date, character, boolean type | Division and integer is returned |
| One expression is a string type and the other a character | Division |
| One expression is numeric and the other is a string | Division |
| Both expressions are numeric | Division |
| Either expression is NULL | NULL is returned |
| Both expressions are empty | A com_exception with code DISP_E_DIVBYZERO is thrown |
This function returns an integer value that indicates the type of variant, which can be an instance of COM, DOTNET or VARIANT classes. The return value can be compared to one of the VT_XXX constants.
The return value for COM and DOTNET objects will usually be VT_DISPATCH; the only reason this function works for those classes is because COM and DOTNET are descendants of VARIANT.
In PHP versions prior to 5, you could obtain this information from instances of the VARIANT class ONLY, by reading a fake type property. See the VARIANT class for more information on this.
If variant is negative, then the first negative integer greater than or equal to the variant is returned, otherwise returns the integer portion of the value of variant.
If each bit in left is equal to the corresponding bit in right then TRUE is returned, otherwise FALSE is returned.
| If | Then |
|---|---|
| Both expressions are of the string, date, character, boolean type | Double is returned |
| One expression is a string type and the other a character | Division and a double is returned |
| One expression is numeric and the other is a string | Division and a double is returned. |
| Both expressions are numeric | Division and a double is returned |
| Either expression is NULL | NULL is returned |
right is empty and left is anything but empty | A com_exception with code DISP_E_DIVBYZERO is thrown |
left is empty and right is anything but empty. | 0 as type double is returned |
| Both expressions are empty | A com_exception with code DISP_E_OVERFLOW is thrown |
Returns a unix timestamp.
") (prototype . "int variant_date_to_timestamp(variant $variant)") (purpose . "Converts a variant date/time value to Unix timestamp") (id . "function.variant-date-to-timestamp")) "variant_date_from_timestamp" ((documentation . "Returns a variant date representation of a Unix timestamp variant variant_date_from_timestamp(int $timestamp) Returns a VT_DATE variant. (PHP 5)") (versions . "PHP 5") (return . " Returns a VT_DATE variant.
Returns one of the following:
| value | meaning |
|---|---|
VARCMP_LT | left is less than right |
VARCMP_EQ | left is equal to right |
VARCMP_GT | left is greater than right |
VARCMP_NULL | Either left, right or both are NULL |
Returns the result of the concatenation.
") (prototype . "mixed variant_cat(mixed $left, mixed $right)") (purpose . "concatenates two variant values together and returns the result") (id . "function.variant-cat")) "variant_cast" ((documentation . "Convert a variant into a new variant object of another type variant variant_cast(variant $variant, int $type) Returns a VT_DATE variant. (PHP 5)") (versions . "PHP 5") (return . " Returns a VT_DATE variant.
If left is | If right is | then the result is |
|---|---|---|
TRUE | TRUE | TRUE |
TRUE | FALSE | FALSE |
TRUE | NULL | NULL |
FALSE | TRUE | FALSE |
FALSE | FALSE | FALSE |
FALSE | NULL | FALSE |
NULL | TRUE | NULL |
NULL | FALSE | FALSE |
NULL | NULL | NULL |
Returns the result.
") (prototype . "mixed variant_add(mixed $left, mixed $right)") (purpose . "\"Adds\" two variant values together and returns the result") (id . "function.variant-add")) "variant_abs" ((documentation . "Returns the absolute value of a variant mixed variant_abs(mixed $val) Returns the absolute value of val. (PHP 5)") (versions . "PHP 5") (return . " Returns the absolute value of val.
No value is returned.
") (prototype . "void com_release()") (purpose . "Decreases the components reference counter [deprecated]") (id . "function.com-release")) "com_propset" ((documentation . "Alias of com_set com_propset() (PHP 4)") (versions . "PHP 4") (return . "") (prototype . " com_propset()") (purpose . "Alias of com_set") (id . "function.com-propset")) "com_propput" ((documentation . "Alias of com_set com_propput() (PHP 4)") (versions . "PHP 4") (return . "") (prototype . " com_propput()") (purpose . "Alias of com_set") (id . "function.com-propput")) "com_propget" ((documentation . "Alias of com_get com_propget() (PHP 4)") (versions . "PHP 4") (return . "") (prototype . " com_propget()") (purpose . "Alias of com_get") (id . "function.com-propget")) "com_print_typeinfo" ((documentation . "Print out a PHP class definition for a dispatchable interface bool com_print_typeinfo(object $comobject [, string $dispinterface = '' [, bool $wantsink = false]]) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
If a message or messages arrives before the timeout, they will be dispatched, and the function will return TRUE. If the timeout occurs and no messages were processed, the return value will be FALSE.
Returns TRUE on success or FALSE on failure.
Returns TRUE if the object can be enumerated, FALSE otherwise.
If the requested object is running, it will be returned to your script just like any other COM object.
") (prototype . "variant com_get_active_object(string $progid [, int $code_page = ''])") (purpose . "Returns a handle to an already running instance of a COM object") (id . "function.com-get-active-object")) "com_event_sink" ((documentation . "Connect events from a COM object to a PHP object bool com_event_sink(variant $comobject, object $sinkobject [, mixed $sinkinterface = '']) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns the GUID as a string.
") (prototype . "string com_create_guid()") (purpose . "Generate a globally unique identifier (GUID)") (id . "function.com-create-guid")) "com_addref" ((documentation . "Increases the components reference counter [deprecated] void com_addref() No value is returned. (PHP 4 >= 4.1.0)") (versions . "PHP 4 >= 4.1.0") (return . "No value is returned.
") (prototype . "void com_addref()") (purpose . "Increases the components reference counter [deprecated]") (id . "function.com-addref")) "dotnet_load" ((documentation . "Loads a DOTNET module int dotnet_load(string $assembly_name [, string $datatype_name = '' [, int $codepage = '']]) (PHP 4)") (versions . "PHP 4") (return . "") (prototype . "int dotnet_load(string $assembly_name [, string $datatype_name = '' [, int $codepage = '']])") (purpose . "Loads a DOTNET module") (id . "function.dotnet-load")) "xmlrpc_set_type" ((documentation . "Sets xmlrpc type, base64 or datetime, for a PHP string value bool xmlrpc_set_type(string $value, string $type) Returns TRUE on success or FALSE on failure. If successful, value is converted to an object. (PHP 4 >= 4.1.0, PHP 5)") (versions . "PHP 4 >= 4.1.0, PHP 5") (return . " Returns TRUE on success or FALSE on failure. If successful, value is converted to an object.
Returns TRUE if the argument means fault, FALSE otherwise. Fault description is available in $arg["faultString"], fault code is in $arg["faultCode"].
Returns the XML-RPC type.
") (prototype . "string xmlrpc_get_type(mixed $value)") (purpose . "Gets xmlrpc type for a PHP value") (id . "function.xmlrpc-get-type")) "xmlrpc_encode" ((documentation . "Generates XML for a PHP value string xmlrpc_encode(mixed $value) (PHP 4 >= 4.1.0, PHP 5)") (versions . "PHP 4 >= 4.1.0, PHP 5") (return . "") (prototype . "string xmlrpc_encode(mixed $value)") (purpose . "Generates XML for a PHP value") (id . "function.xmlrpc-encode")) "xmlrpc_encode_request" ((documentation . "Generates XML for a method request string xmlrpc_encode_request(string $method, mixed $params [, array $output_options = '']) Returns a string containing the XML representation of the request. (PHP 4 >= 4.1.0, PHP 5)") (versions . "PHP 4 >= 4.1.0, PHP 5") (return . "Returns a string containing the XML representation of the request.
") (prototype . "string xmlrpc_encode_request(string $method, mixed $params [, array $output_options = ''])") (purpose . "Generates XML for a method request") (id . "function.xmlrpc-encode-request")) "xmlrpc_decode" ((documentation . "Decodes XML into native PHP types mixed xmlrpc_decode(string $xml [, string $encoding = \"iso-8859-1\"]) Returns either an array, or an integer, or a string, or a boolean according to the response returned by the XMLRPC method. (PHP 4 >= 4.1.0, PHP 5)") (versions . "PHP 4 >= 4.1.0, PHP 5") (return . "Returns either an array, or an integer, or a string, or a boolean according to the response returned by the XMLRPC method.
") (prototype . "mixed xmlrpc_decode(string $xml [, string $encoding = \"iso-8859-1\"])") (purpose . "Decodes XML into native PHP types") (id . "function.xmlrpc-decode")) "xmlrpc_decode_request" ((documentation . "Decodes XML into native PHP types mixed xmlrpc_decode_request(string $xml, string $method [, string $encoding = '']) (PHP 4 >= 4.1.0, PHP 5)") (versions . "PHP 4 >= 4.1.0, PHP 5") (return . "") (prototype . "mixed xmlrpc_decode_request(string $xml, string $method [, string $encoding = ''])") (purpose . "Decodes XML into native PHP types") (id . "function.xmlrpc-decode-request")) "use_soap_error_handler" ((documentation . "Set whether to use the SOAP error handler bool use_soap_error_handler([bool $handler = true]) Returns the original value. (Unknown)") (versions . "Unknown") (return . "Returns the original value.
") (prototype . "bool use_soap_error_handler([bool $handler = true])") (purpose . "Set whether to use the SOAP error handler") (id . "function.use-soap-error-handler")) "is_soap_fault" ((documentation . "Checks if a SOAP call has failed bool is_soap_fault(mixed $object) This will return TRUE on error, and FALSE otherwise. (Unknown)") (versions . "Unknown") (return . " This will return TRUE on error, and FALSE otherwise.
Returns an » RFC 3986 encoded string.
") (prototype . "string oauth_urlencode(string $uri)") (purpose . "Encode a URI to RFC 3986") (id . "function.oauth-urlencode")) "oauth_get_sbs" ((documentation . "Generate a Signature Base String string oauth_get_sbs(string $http_method, string $uri [, array $request_parameters = '']) Returns a Signature Base String. (PECL OAuth >=0.99.7)") (versions . "PECL OAuth >=0.99.7") (return . "Returns a Signature Base String.
") (prototype . "string oauth_get_sbs(string $http_method, string $uri [, array $request_parameters = ''])") (purpose . "Generate a Signature Base String") (id . "function.oauth-get-sbs")) "var_export" ((documentation . "Outputs or returns a parsable string representation of a variable mixed var_export(mixed $expression [, bool $return = false]) Returns the variable representation when the return parameter is used and evaluates to TRUE. Otherwise, this function will return NULL. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . " Returns the variable representation when the return parameter is used and evaluates to TRUE. Otherwise, this function will return NULL.
No value is returned.
") (prototype . "string var_dump(mixed $expression [, mixed $... = ''])") (purpose . "Dumps information about a variable") (id . "function.var-dump")) "unset" ((documentation . "Unset a given variable void unset(mixed $var [, mixed $... = '']) No value is returned. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "No value is returned.
") (prototype . "void unset(mixed $var [, mixed $... = ''])") (purpose . "Unset a given variable") (id . "function.unset")) "unserialize" ((documentation . "Creates a PHP value from a stored representation mixed unserialize(string $str) The converted value is returned, and can be a boolean, integer, float, string, array or object. In case the passed string is not unserializeable, FALSE is returned and E_NOTICE is issued. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "The converted value is returned, and can be a boolean, integer, float, string, array or object.
In case the passed string is not unserializeable, FALSE is returned and E_NOTICE is issued.
The string value of var.
Returns TRUE on success or FALSE on failure.
Returns a string containing a byte-stream representation of value that can be stored anywhere.
Note that this is a binary string which may include null bytes, and needs to be stored and handled as such. For example, serialize output should generally be stored in a BLOB field in a database, rather than a CHAR or TEXT field.
") (prototype . "string serialize(mixed $value)") (purpose . "Generates a storable representation of a value") (id . "function.serialize")) "print_r" ((documentation . "Prints human-readable information about a variable mixed print_r(mixed $expression [, bool $return = false]) If given a string, integer or float, the value itself will be printed. If given an array, values will be presented in a format that shows keys and elements. Similar notation is used for objects. When the return parameter is TRUE, this function will return a string. Otherwise, the return value is TRUE. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "If given a string, integer or float, the value itself will be printed. If given an array, values will be presented in a format that shows keys and elements. Similar notation is used for objects.
When the return parameter is TRUE, this function will return a string. Otherwise, the return value is TRUE.
Returns TRUE if var exists and has value other than NULL, FALSE otherwise.
Returns TRUE if var is of type string, FALSE otherwise.
Returns TRUE if var is a scalar FALSE otherwise.
Returns TRUE if var is a resource, FALSE otherwise.
Returns TRUE if var is an object, FALSE otherwise.
Returns TRUE if var is a number or a numeric string, FALSE otherwise.
Returns TRUE if var is null, FALSE otherwise.
Returns TRUE if var is an integer, FALSE otherwise.
Returns TRUE if var is a float, FALSE otherwise.
Returns TRUE if name is callable, FALSE otherwise.
Returns TRUE if var is a boolean, FALSE otherwise.
Returns TRUE if var is an array, FALSE otherwise.
The integer value of var on success, or 0 on failure. Empty arrays return 0, non-empty arrays return 1.
The maximum value depends on the system. 32 bit systems have a maximum signed integer range of -2147483648 to 2147483647. So for example on such a system, intval('1000000000000') will return 2147483647. The maximum signed integer value for 64 bit systems is 9223372036854775807.
Strings will most likely return 0 although this depends on the leftmost characters of the string. The common rules of integer casting apply.
") (prototype . "integer intval(mixed $var [, int $base = 10])") (purpose . "Get the integer value of a variable") (id . "function.intval")) "import_request_variables" ((documentation . "Import GET/POST/Cookie variables into the global scope bool import_request_variables(string $types [, string $prefix = '']) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.1.0, PHP 5 < 5.4.0)") (versions . "PHP 4 >= 4.1.0, PHP 5 < 5.4.0") (return . " Returns TRUE on success or FALSE on failure.
Possible values for the returned string are:
If the given handle is a resource, this function will return a string representing its type. If the type is not identified by this function, the return value will be the string Unknown.
This function will return FALSE and generate an error if handle is not a resource.
A multidimensional array with all the variables.
") (prototype . "array get_defined_vars()") (purpose . "Returns an array of all defined variables") (id . "function.get-defined-vars")) "floatval" ((documentation . #("Get float value of a variable float floatval(mixed $var) The float value of the given variable. Empty arrays return 0, non-empty arrays return 1. Strings will most likely return 0 although this depends on the leftmost characters of the string. The common rules of float casting apply. (PHP 4 >= 4.2.0, PHP 5)" 267 280 (shr-url "language.types.float.html#language.types.float.casting"))) (versions . "PHP 4 >= 4.2.0, PHP 5") (return . "The float value of the given variable. Empty arrays return 0, non-empty arrays return 1.
Strings will most likely return 0 although this depends on the leftmost characters of the string. The common rules of float casting apply.
") (prototype . "float floatval(mixed $var)") (purpose . "Get float value of a variable") (id . "function.floatval")) "empty" ((documentation . "Determine whether a variable is empty bool empty(mixed $var) Returns FALSE if var exists and has a non-empty, non-zero value. Otherwise returns TRUE. The following things are considered to be empty: * \"\" (an empty string) * 0 (0 as an integer) * 0.0 (0 as a float) * \"0\" (0 as a string) * NULL * FALSE * array() (an empty array) * $var; (a variable declared, but without a value) (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns FALSE if var exists and has a non-empty, non-zero value. Otherwise returns TRUE.
The following things are considered to be empty:
NULLFALSENo value is returned.
") (prototype . "void debug_zval_dump(mixed $variable [, mixed $... = ''])") (purpose . "Dumps a string representation of an internal zend value to output") (id . "function.debug-zval-dump")) "boolval" ((documentation . "Get the boolean value of a variable boolean boolval(mixed $var) The boolean value of var. (PHP 5 >= 5.5.0)") (versions . "PHP 5 >= 5.5.0") (return . " The boolean value of var.
No value is returned.
") (prototype . "void deaggregate(object $object [, string $class_name = ''])") (purpose . "Removes the aggregated methods and properties from an object") (id . "function.deaggregate")) "aggregation_info" ((documentation . "Alias of aggregate_info aggregation_info() (PHP 4 >= 4.2.0 and < 4.3.0)") (versions . "PHP 4 >= 4.2.0 and < 4.3.0") (return . "") (prototype . " aggregation_info()") (purpose . "Alias of aggregate_info") (id . "function.aggregation-info")) "aggregate" ((documentation . "Dynamic class and object aggregation of methods and properties void aggregate(object $object, string $class_name) No value is returned. (PHP 4 >= 4.2.0)") (versions . "PHP 4 >= 4.2.0") (return . "No value is returned.
") (prototype . "void aggregate(object $object, string $class_name)") (purpose . "Dynamic class and object aggregation of methods and properties") (id . "function.aggregate")) "aggregate_properties" ((documentation . "Dynamic aggregation of class properties to an object void aggregate_properties(object $object, string $class_name) No value is returned. (PHP 4 >= 4.2.0)") (versions . "PHP 4 >= 4.2.0") (return . "No value is returned.
") (prototype . "void aggregate_properties(object $object, string $class_name)") (purpose . "Dynamic aggregation of class properties to an object") (id . "function.aggregate-properties")) "aggregate_properties_by_regexp" ((documentation . "Selective class properties aggregation to an object using a regular expression void aggregate_properties_by_regexp(object $object, string $class_name, string $regexp [, bool $exclude = false]) No value is returned. (PHP 4 >= 4.2.0)") (versions . "PHP 4 >= 4.2.0") (return . "No value is returned.
") (prototype . "void aggregate_properties_by_regexp(object $object, string $class_name, string $regexp [, bool $exclude = false])") (purpose . "Selective class properties aggregation to an object using a regular expression") (id . "function.aggregate-properties-by-regexp")) "aggregate_properties_by_list" ((documentation . "Selective dynamic class properties aggregation to an object void aggregate_properties_by_list(object $object, string $class_name, array $properties_list [, bool $exclude = false]) No value is returned. (PHP 4 >= 4.2.0)") (versions . "PHP 4 >= 4.2.0") (return . "No value is returned.
") (prototype . "void aggregate_properties_by_list(object $object, string $class_name, array $properties_list [, bool $exclude = false])") (purpose . "Selective dynamic class properties aggregation to an object") (id . "function.aggregate-properties-by-list")) "aggregate_methods" ((documentation . "Dynamic class and object aggregation of methods void aggregate_methods(object $object, string $class_name) No value is returned. (PHP 4 >= 4.2.0)") (versions . "PHP 4 >= 4.2.0") (return . "No value is returned.
") (prototype . "void aggregate_methods(object $object, string $class_name)") (purpose . "Dynamic class and object aggregation of methods") (id . "function.aggregate-methods")) "aggregate_methods_by_regexp" ((documentation . "Selective class methods aggregation to an object using a regular expression void aggregate_methods_by_regexp(object $object, string $class_name, string $regexp [, bool $exclude = false]) No value is returned. (PHP 4 >= 4.2.0)") (versions . "PHP 4 >= 4.2.0") (return . "No value is returned.
") (prototype . "void aggregate_methods_by_regexp(object $object, string $class_name, string $regexp [, bool $exclude = false])") (purpose . "Selective class methods aggregation to an object using a regular expression") (id . "function.aggregate-methods-by-regexp")) "aggregate_methods_by_list" ((documentation . "Selective dynamic class methods aggregation to an object void aggregate_methods_by_list(object $object, string $class_name, array $methods_list [, bool $exclude = false]) No value is returned. (PHP 4 >= 4.2.0)") (versions . "PHP 4 >= 4.2.0") (return . "No value is returned.
") (prototype . "void aggregate_methods_by_list(object $object, string $class_name, array $methods_list [, bool $exclude = false])") (purpose . "Selective dynamic class methods aggregation to an object") (id . "function.aggregate-methods-by-list")) "aggregate_info" ((documentation . "Gets aggregation information for a given object array aggregate_info(object $object) Returns the aggregation information as an associative array of arrays of methods and properties. The key for the main array is the name of the aggregated class. (PHP 4 >= 4.3.0)") (versions . "PHP 4 >= 4.3.0") (return . "Returns the aggregation information as an associative array of arrays of methods and properties. The key for the main array is the name of the aggregated class.
") (prototype . "array aggregate_info(object $object)") (purpose . "Gets aggregation information for a given object") (id . "function.aggregate-info")) "unregister_tick_function" ((documentation . "De-register a function for execution on each tick void unregister_tick_function(string $function_name) No value is returned. (PHP 4 >= 4.0.3, PHP 5)") (versions . "PHP 4 >= 4.0.3, PHP 5") (return . "No value is returned.
") (prototype . "void unregister_tick_function(string $function_name)") (purpose . "De-register a function for execution on each tick") (id . "function.unregister-tick-function")) "register_tick_function" ((documentation . "Register a function for execution on each tick bool register_tick_function(callable $function [, mixed $arg = '' [, mixed $... = '']]) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.3, PHP 5)") (versions . "PHP 4 >= 4.0.3, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void register_shutdown_function(callable $callback [, mixed $parameter = '' [, mixed $... = '']])") (purpose . "Register a function for execution on shutdown") (id . "function.register-shutdown-function")) "get_defined_functions" ((documentation . "Returns an array of all defined functions array get_defined_functions() Returns a multidimensional array containing a list of all defined functions, both built-in (internal) and user-defined. The internal functions will be accessible via $arr[\"internal\"], and the user defined ones using $arr[\"user\"] (see example below). (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . "Returns a multidimensional array containing a list of all defined functions, both built-in (internal) and user-defined. The internal functions will be accessible via $arr["internal"], and the user defined ones using $arr["user"] (see example below).
") (prototype . "array get_defined_functions()") (purpose . "Returns an array of all defined functions") (id . "function.get-defined-functions")) "function_exists" ((documentation . "Return TRUE if the given function has been defined bool function_exists(string $function_name) Returns TRUE if function_name exists and is a function, FALSE otherwise. Note: This function will return FALSE for constructs, such as include_once and echo. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE if function_name exists and is a function, FALSE otherwise.
") (prototype . "bool function_exists(string $function_name)") (purpose . "Return TRUE if the given function has been defined") (id . "function.function-exists")) "func_num_args" ((documentation . "Returns the number of arguments passed to the function int func_num_args() Returns the number of arguments passed into the current user-defined function. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Note:
This function will return
FALSEfor constructs, such as include_once and echo.
Returns the number of arguments passed into the current user-defined function.
") (prototype . "int func_num_args()") (purpose . "Returns the number of arguments passed to the function") (id . "function.func-num-args")) "func_get_args" ((documentation . "Returns an array comprising a function's argument list array func_get_args() Returns an array in which each element is a copy of the corresponding member of the current user-defined function's argument list. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns an array in which each element is a copy of the corresponding member of the current user-defined function's argument list.
") (prototype . "array func_get_args()") (purpose . "Returns an array comprising a function's argument list") (id . "function.func-get-args")) "func_get_arg" ((documentation . "Return an item from the argument list mixed func_get_arg(int $arg_num) Returns the specified argument, or FALSE on error. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns the specified argument, or FALSE on error.
Returns the function result, or FALSE on error.
Returns the function result, or FALSE on error.
Returns a unique function name as a string, or FALSE on error.
Returns the return value of the callback, or FALSE on error.
Returns the return value of the callback, or FALSE on error.
Returns the filtered data, or FALSE if the filter fails.
An array containing the values of the requested variables on success, or FALSE on failure. An array value will be FALSE if the filter fails, or NULL if the variable is not set.
Returns an array of names of all supported filters, empty array if there are no such filters. Indexes of this array are not filter IDs, they can be obtained with filter_id from a name instead.
") (prototype . "array filter_list()") (purpose . "Returns a list of all supported filters") (id . "function.filter-list")) "filter_input" ((documentation . "Gets a specific external variable by name and optionally filters it mixed filter_input(int $type, string $variable_name [, int $filter = FILTER_DEFAULT [, mixed $options = '']]) Value of the requested variable on success, FALSE if the filter fails, or NULL if the variable_name variable is not set. If the flag FILTER_NULL_ON_FAILURE is used, it returns FALSE if the variable is not set and NULL if the filter fails. (PHP 5 >= 5.2.0)") (versions . "PHP 5 >= 5.2.0") (return . " Value of the requested variable on success, FALSE if the filter fails, or NULL if the variable_name variable is not set. If the flag FILTER_NULL_ON_FAILURE is used, it returns FALSE if the variable is not set and NULL if the filter fails.
An array containing the values of the requested variables on success, or FALSE on failure. An array value will be FALSE if the filter fails, or NULL if the variable is not set. Or if the flag FILTER_NULL_ON_FAILURE is used, it returns FALSE if the variable is not set and NULL if the filter fails.
ID of a filter on success or FALSE if filter doesn't exist.
Returns TRUE on success or FALSE on failure.
Returns TRUE if every character in text is a hexadecimal 'digit', that is a decimal digit or a character from [A-Fa-f] , FALSE otherwise.
Returns TRUE if every character in text is an uppercase letter in the current locale.
Returns TRUE if every character in text creates some sort of white space, FALSE otherwise. Besides the blank character this also includes tab, vertical tab, line feed, carriage return and form feed characters.
Returns TRUE if every character in text is printable, but neither letter, digit or blank, FALSE otherwise.
Returns TRUE if every character in text will actually create output (including blanks). Returns FALSE if text contains control characters or characters that do not have any output or control function at all.
Returns TRUE if every character in text is a lowercase letter in the current locale.
Returns TRUE if every character in text is printable and actually creates visible output (no white space), FALSE otherwise.
Returns TRUE if every character in the string text is a decimal digit, FALSE otherwise.
Returns TRUE if every character in text is a control character from the current locale, FALSE otherwise.
Returns TRUE if every character in text is a letter from the current locale, FALSE otherwise.
Returns TRUE if every character in text is either a letter or a digit, FALSE otherwise.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Associative array of imported methods
") (prototype . "array classkit_import(string $filename)") (purpose . "Import new class method definitions from a file") (id . "function.classkit-import")) "trait_exists" ((documentation . "Checks if the trait exists bool trait_exists(string $traitname [, bool $autoload = '']) Returns TRUE if trait exists, FALSE if not, NULL in case of an error. (PHP 5 >= 5.4.0)") (versions . "PHP 5 >= 5.4.0") (return . " Returns TRUE if trait exists, FALSE if not, NULL in case of an error.
Returns TRUE if the property exists, FALSE if it doesn't exist or NULL in case of an error.
Returns TRUE if the method given by method_name has been defined for the given object, FALSE otherwise.
This function returns TRUE if the object object, belongs to a class which is a subclass of class_name, FALSE otherwise.
Returns TRUE if the object is of this class or has this class as one of its parents, FALSE otherwise.
Returns TRUE if the interface given by interface_name has been defined, FALSE otherwise.
Returns the name of the parent class of the class of which object is an instance or the name.
Note:
If the object does not have a parent or the class given does not exist
FALSEwill be returned.
If called without parameter outside object, this function returns FALSE.
Returns an associative array of defined object accessible non-static properties for the specified object in scope. If a property has not been assigned a value, it will be returned with a NULL value.
Returns an array with names of all declared traits in values. Returns NULL in case of a failure.
Returns an array of the names of the declared interfaces in the current script.
") (prototype . "array get_declared_interfaces()") (purpose . "Returns an array of all declared interfaces") (id . "function.get-declared-interfaces")) "get_declared_classes" ((documentation . #("Returns an array with the name of the defined classes array get_declared_classes() Returns an array of the names of the declared classes in the current script. Note: Note that depending on what extensions you have compiled or loaded into PHP, additional classes could be present. This means that you will not be able to define your own classes using these names. There is a list of predefined classes in the Predefined Classes section of the appendices. (PHP 4, PHP 5)" 432 450 (shr-url "reserved.classes.html"))) (versions . "PHP 4, PHP 5") (return . "Returns an array of the names of the declared classes in the current script.
") (prototype . "array get_declared_classes()") (purpose . "Returns an array with the name of the defined classes") (id . "function.get-declared-classes")) "get_class" ((documentation . "Returns the name of the class of an object string get_class([object $object = '']) Returns the name of the class of which object is an instance. Returns FALSE if object is not an object. If object is omitted when inside a class, the name of that class is returned. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Note:
Note that depending on what extensions you have compiled or loaded into PHP, additional classes could be present. This means that you will not be able to define your own classes using these names. There is a list of predefined classes in the Predefined Classes section of the appendices.
Returns the name of the class of which object is an instance. Returns FALSE if object is not an object.
If object is omitted when inside a class, the name of that class is returned.
Returns an associative array of declared properties visible from the current scope, with their default value. The resulting array elements are in the form of varname => value. In case of an error, it returns FALSE.
Returns an array of method names defined for the class specified by class_name. In case of an error, it returns NULL.
Returns the class name. Returns FALSE if called from outside a class.
Returns TRUE if class_name is a defined class, FALSE otherwise.
Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void __autoload(string $class)") (purpose . "Attempt to load undefined class") (id . "function.autoload")) "usort" ((documentation . "Sort an array by values using a user-defined comparison function bool usort(array $array, callable $value_compare_func) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the value of the first array element, or FALSE if the array is empty.
Returns an array of elements from start to end, inclusive.
Returns the array value in the previous place that's pointed to by the internal array pointer, or FALSE if there are no more elements.
Returns the array value in the next place that's pointed to by the internal array pointer, or FALSE if there are no more elements.
This function mayreturn Boolean FALSE, but may also return a non-Boolean value whichevaluates to FALSE. Please read the section on Booleans for moreinformation. Use the ===operator for testing the return value of thisfunction.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the assigned array.
") (prototype . "array list(mixed $var1 [, mixed $... = ''])") (purpose . "Assign variables as if they were an array") (id . "function.list")) "ksort" ((documentation . "Sort an array by key bool ksort(array $array [, int $sort_flags = SORT_REGULAR]) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
The key function simply returns the key of the array element that's currently being pointed to by the internal pointer. It does not move the pointer in any way. If the internal pointer points beyond the end of the elements list or the array is empty, key returns NULL.
Returns TRUE if needle is found in the array, FALSE otherwise.
Returns the number of variables successfully imported into the symbol table.
") (prototype . "int extract(array $array [, int $flags = EXTR_OVERWRITE [, string $prefix = '']])") (purpose . "Import variables into the current symbol table from an array") (id . "function.extract")) "end" ((documentation . "Set the internal pointer of an array to its last element mixed end(array $array) Returns the value of the last element or FALSE for empty array. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns the value of the last element or FALSE for empty array.
Returns the current key and value pair from the array array. This pair is returned in a four-element array, with the keys 0, 1, key, and value. Elements 0 and key contain the key name of the array element, and 1 and value contain the data.
If the internal pointer for the array points past the end of the array contents, each returns FALSE.
The current function simply returns the value of the array element that's currently being pointed to by the internal pointer. It does not move the pointer in any way. If the internal pointer points beyond the end of the elements list or the array is empty, current returns FALSE.
This function mayreturn Boolean FALSE, but may also return a non-Boolean value whichevaluates to FALSE. Please read the section on Booleans for moreinformation. Use the ===operator for testing the return value of thisfunction.
Returns the number of elements in array_or_countable. If the parameter is not an array or not an object with implemented Countable interface, 1 will be returned. There is one exception, if array_or_countable is NULL, 0 will be returned.
count may return 0 for a variable that isn't set, but it may also return 0 for a variable that has been initialized with an empty array. Use isset to test if a variable is set.
Returns the output array with all the variables added to it.
") (prototype . "array compact(mixed $varname1 [, mixed $... = ''])") (purpose . "Create array containing variables and their values") (id . "function.compact")) "asort" ((documentation . "Sort an array and maintain index association bool asort(array $array [, int $sort_flags = SORT_REGULAR]) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns an array of the parameters. The parameters can be given an index with the => operator. Read the section on the array type for more information on what an array is.
") (prototype . "array array([mixed $... = ''])") (purpose . "Create an array") (id . "function.array")) "array_walk" ((documentation . "Apply a user function to every member of an array bool array_walk(array $array, callable $callback [, mixed $userdata = '']) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns an indexed array of values.
") (prototype . "array array_values(array $array)") (purpose . "Return all the values of an array") (id . "function.array-values")) "array_unshift" ((documentation . "Prepend one or more elements to the beginning of an array int array_unshift(array $array, mixed $value1 [, mixed $... = '']) Returns the new number of elements in the array. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns the new number of elements in the array.
Returns the filtered array.
") (prototype . "array array_unique(array $array [, int $sort_flags = SORT_STRING])") (purpose . "Removes duplicate values from an array") (id . "function.array-unique")) "array_uintersect" ((documentation . "Computes the intersection of arrays, compares data by a callback function array array_uintersect(array $array1, array $array2 [, array $... = '', callable $value_compare_func]) Returns an array containing all the values of array1 that are present in all the arguments. (PHP 5)") (versions . "PHP 5") (return . " Returns an array containing all the values of array1 that are present in all the arguments.
Returns an array containing all the values of array1 that are present in all the arguments.
Returns an array containing all the values of array1 that are present in all the arguments.
Returns an array containing all the values of array1 that are not present in any of the other arguments.
Returns an array containing all the values from array1 that are not present in any of the other arguments.
array_udiff_assoc returns an array containing all the values from array1 that are not present in any of the other arguments. Note that the keys are used in the comparison unlike array_diff and array_udiff. The comparison of arrays' data is performed by using an user-supplied callback. In this aspect the behaviour is opposite to the behaviour of array_diff_assoc which uses internal function for comparison.
Returns the sum of values as an integer or float.
") (prototype . "number array_sum(array $array)") (purpose . "Calculate the sum of values in an array") (id . "function.array-sum")) "array_splice" ((documentation . "Remove a portion of the array and replace it with something else array array_splice(array $input, int $offset [, int $length = int [, mixed $replacement = array()]]) Returns the array consisting of the extracted elements. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the array consisting of the extracted elements.
") (prototype . "array array_splice(array $input, int $offset [, int $length = int [, mixed $replacement = array()]])") (purpose . "Remove a portion of the array and replace it with something else") (id . "function.array-splice")) "array_slice" ((documentation . "Extract a slice of the array array array_slice(array $array, int $offset [, int $length = '' [, bool $preserve_keys = false]]) Returns the slice. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the slice.
") (prototype . "array array_slice(array $array, int $offset [, int $length = '' [, bool $preserve_keys = false]])") (purpose . "Extract a slice of the array") (id . "function.array-slice")) "array_shift" ((documentation . "Shift an element off the beginning of array array array_shift(array $array) Returns the shifted value, or NULL if array is empty or is not an array. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns the shifted value, or NULL if array is empty or is not an array.
Returns the key for needle if it is found in the array, FALSE otherwise.
If needle is found in haystack more than once, the first matching key is returned. To return the keys for all matching values, use array_keys with the optional search_value parameter instead.
This function mayreturn Boolean FALSE, but may also return a non-Boolean value whichevaluates to FALSE. Please read the section on Booleans for moreinformation. Use the ===operator for testing the return value of thisfunction.
Returns the reversed array.
") (prototype . "array array_reverse(array $array [, bool $preserve_keys = false])") (purpose . "Return an array with elements in reverse order") (id . "function.array-reverse")) "array_replace" ((documentation . "Replaces elements from passed arrays into the first array array array_replace(array $array1, array $array2 [, array $... = '']) Returns an array, or NULL if an error occurs. (PHP 5 >= 5.3.0)") (versions . "PHP 5 >= 5.3.0") (return . " Returns an array, or NULL if an error occurs.
Returns an array, or NULL if an error occurs.
Returns the resulting value.
If the array is empty and initial is not passed, array_reduce returns NULL.
When picking only one entry, array_rand returns the key for a random entry. Otherwise, an array of keys for the random entries is returned. This is done so that random keys can be picked from the array as well as random values. Trying to pick more elements than there are in the array will result in an E_WARNING level error, and NULL will be returned.
Returns the new number of elements in the array.
") (prototype . "int array_push(array $array, mixed $value1 [, mixed $... = ''])") (purpose . "Push one or more elements onto the end of array") (id . "function.array-push")) "array_product" ((documentation . "Calculate the product of values in an array number array_product(array $array) Returns the product as an integer or float. (PHP 5 >= 5.1.0)") (versions . "PHP 5 >= 5.1.0") (return . "Returns the product as an integer or float.
") (prototype . "number array_product(array $array)") (purpose . "Calculate the product of values in an array") (id . "function.array-product")) "array_pop" ((documentation . "Pop the element off the end of array array array_pop(array $array) Returns the last value of array. If array is empty (or is not an array), NULL will be returned. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns the last value of array. If array is empty (or is not an array), NULL will be returned.
Returns a copy of the array padded to size specified by size with value value. If size is positive then the array is padded on the right, if it's negative then on the left. If the absolute value of size is less than or equal to the length of the array then no padding takes place.
Returns TRUE on success or FALSE on failure.
Returns the resulting array.
") (prototype . "array array_merge(array $array1 [, array $... = ''])") (purpose . "Merge one or more arrays") (id . "function.array-merge")) "array_merge_recursive" ((documentation . "Merge two or more arrays recursively array array_merge_recursive(array $array1 [, array $... = '']) An array of values resulted from merging the arguments together. (PHP 4 >= 4.0.1, PHP 5)") (versions . "PHP 4 >= 4.0.1, PHP 5") (return . "An array of values resulted from merging the arguments together.
") (prototype . "array array_merge_recursive(array $array1 [, array $... = ''])") (purpose . "Merge two or more arrays recursively") (id . "function.array-merge-recursive")) "array_map" ((documentation . "Applies the callback to the elements of the given arrays array array_map(callable $callback, array $array1 [, array $... = '']) Returns an array containing all the elements of array1 after applying the callback function to each one. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . " Returns an array containing all the elements of array1 after applying the callback function to each one.
Returns an array of all the keys in array.
Returns TRUE on success or FALSE on failure.
Returns an array containing all of the values in array1 whose values exist in all of the parameters.
Returns the values of array1 whose keys exist in all the arguments.
Returns the values of array1 whose values exist in all of the arguments.
Returns an associative array containing all the entries of array1 which have keys that are present in all arguments.
Returns an associative array containing all the values in array1 that are present in all of the arguments.
Returns the flipped array on success and NULL on failure.
Returns the filtered array.
") (prototype . "array array_filter(array $array [, callable $callback = Function()])") (purpose . "Filters elements of an array using a callback function") (id . "function.array-filter")) "array_fill" ((documentation . "Fill an array with values array array_fill(int $start_index, int $num, mixed $value) Returns the filled array (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . "Returns the filled array
") (prototype . "array array_fill(int $start_index, int $num, mixed $value)") (purpose . "Fill an array with values") (id . "function.array-fill")) "array_fill_keys" ((documentation . "Fill an array with values, specifying keys array array_fill_keys(array $keys, mixed $value) Returns the filled array (PHP 5 >= 5.2.0)") (versions . "PHP 5 >= 5.2.0") (return . "Returns the filled array
") (prototype . "array array_fill_keys(array $keys, mixed $value)") (purpose . "Fill an array with values, specifying keys") (id . "function.array-fill-keys")) "array_diff" ((documentation . "Computes the difference of arrays array array_diff(array $array1, array $array2 [, array $... = '']) Returns an array containing all the entries from array1 that are not present in any of the other arrays. (PHP 4 >= 4.0.1, PHP 5)") (versions . "PHP 4 >= 4.0.1, PHP 5") (return . " Returns an array containing all the entries from array1 that are not present in any of the other arrays.
Returns an array containing all the entries from array1 that are not present in any of the other arrays.
Returns an array containing all the entries from array1 that are not present in any of the other arrays.
Returns an array containing all the entries from array1 whose keys are not present in any of the other arrays.
Returns an array containing all the values from array1 that are not present in any of the other arrays.
Returns an associative array of values from array as keys and their count as value.
Returns the combined array, FALSE if the number of elements for each array isn't equal.
Returns an array of values representing a single column from the input array.
") (prototype . "array array_column(array $array, mixed $column_key [, mixed $index_key = null])") (purpose . "Return the values from a single column in the input array") (id . "function.array-column")) "array_chunk" ((documentation . "Split an array into chunks array array_chunk(array $array, int $size [, bool $preserve_keys = false]) Returns a multidimensional numerically indexed array, starting with zero, with each dimension containing size elements. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . " Returns a multidimensional numerically indexed array, starting with zero, with each dimension containing size elements.
Returns an array with its keys lower or uppercased, or FALSE if array is not an array.
Returns the given string wrapped at the specified length.
") (prototype . "string wordwrap(string $str [, int $width = 75 [, string $break = \"\\n\" [, bool $cut = false]]])") (purpose . "Wraps a string to a given number of characters") (id . "function.wordwrap")) "vsprintf" ((documentation . "Return a formatted string string vsprintf(string $format, array $args) Return array values as a formatted string according to format (which is described in the documentation for sprintf). (PHP 4 >= 4.1.0, PHP 5)") (versions . "PHP 4 >= 4.1.0, PHP 5") (return . " Return array values as a formatted string according to format (which is described in the documentation for sprintf).
Returns the length of the outputted string.
") (prototype . "int vprintf(string $format, array $args)") (purpose . "Output a formatted string") (id . "function.vprintf")) "vfprintf" ((documentation . "Write a formatted string to a stream int vfprintf(resource $handle, string $format, array $args) Returns the length of the outputted string. (PHP 5)") (versions . "PHP 5") (return . "Returns the length of the outputted string.
") (prototype . "int vfprintf(resource $handle, string $format, array $args)") (purpose . "Write a formatted string to a stream") (id . "function.vfprintf")) "ucwords" ((documentation . "Uppercase the first character of each word in a string string ucwords(string $str) Returns the modified string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the modified string.
") (prototype . "string ucwords(string $str)") (purpose . "Uppercase the first character of each word in a string") (id . "function.ucwords")) "ucfirst" ((documentation . "Make a string's first character uppercase string ucfirst(string $str) Returns the resulting string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the resulting string.
") (prototype . "string ucfirst(string $str)") (purpose . "Make a string's first character uppercase") (id . "function.ucfirst")) "trim" ((documentation . "Strip whitespace (or other characters) from the beginning and end of a string string trim(string $str [, string $character_mask = \" \\t\\n\\r\\0\\x0B\"]) The trimmed string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "The trimmed string.
") (prototype . "string trim(string $str [, string $character_mask = \" \\t\\n\\r\\0\\x0B\"])") (purpose . "Strip whitespace (or other characters) from the beginning and end of a string") (id . "function.trim")) "substr" ((documentation . "Return part of a string string substr(string $string, int $start [, int $length = '']) Returns the extracted part of string; or FALSE on failure, or an empty string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns the extracted part of string; or FALSE on failure, or an empty string.
The result string is returned. If string is an array then array is returned.
This function returns an integer.
") (prototype . "int substr_count(string $haystack, string $needle [, int $offset = '' [, int $length = '']])") (purpose . "Count the number of substring occurrences") (id . "function.substr-count")) "substr_compare" ((documentation . "Binary safe comparison of two strings from an offset, up to length characters int substr_compare(string $main_str, string $str, int $offset [, int $length = '' [, bool $case_insensitivity = false]]) Returns < 0 if main_str from position offset is less than str, > 0 if it is greater than str, and 0 if they are equal. If offset is equal to or greater than the length of main_str or length is set and is less than 1, substr_compare prints a warning and returns FALSE. (PHP 5)") (versions . "PHP 5") (return . " Returns < 0 if main_str from position offset is less than str, > 0 if it is greater than str, and 0 if they are equal. If offset is equal to or greater than the length of main_str or length is set and is less than 1, substr_compare prints a warning and returns FALSE.
Returns the translated string.
If replace_pairs contains a key which is an empty string (""), FALSE will be returned. If the str is not a scalar then it is not typecasted into a string, instead a warning is raised and NULL is returned.
Returns the uppercased string.
") (prototype . "string strtoupper(string $string)") (purpose . "Make a string uppercase") (id . "function.strtoupper")) "strtolower" ((documentation . "Make a string lowercase string strtolower(string $str) Returns the lowercased string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the lowercased string.
") (prototype . "string strtolower(string $str)") (purpose . "Make a string lowercase") (id . "function.strtolower")) "strtok" ((documentation . "Tokenize string string strtok(string $str, string $token) A string token. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "A string token.
") (prototype . "string strtok(string $str, string $token)") (purpose . "Tokenize string") (id . "function.strtok")) "strstr" ((documentation . "Find the first occurrence of a string string strstr(string $haystack, mixed $needle [, bool $before_needle = false]) Returns the portion of string, or FALSE if needle is not found. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns the portion of string, or FALSE if needle is not found.
Returns the length of the initial segment of subject which consists entirely of characters in mask.
Returns the position where the needle exists relative to the beginnning of the haystack string (independent of search direction or offset). Also note that string positions start at 0, and not 1.
Returns FALSE if the needle was not found.
This function mayreturn Boolean FALSE, but may also return a non-Boolean value whichevaluates to FALSE. Please read the section on Booleans for moreinformation. Use the ===operator for testing the return value of thisfunction.
Returns the position where the needle exists relative to the beginnning of the haystack string (independent of search direction or offset). Also note that string positions start at 0, and not 1.
Returns FALSE if the needle was not found.
This function mayreturn Boolean FALSE, but may also return a non-Boolean value whichevaluates to FALSE. Please read the section on Booleans for moreinformation. Use the ===operator for testing the return value of thisfunction.
Returns the reversed string.
") (prototype . "string strrev(string $string)") (purpose . "Reverse a string") (id . "function.strrev")) "strrchr" ((documentation . "Find the last occurrence of a character in a string string strrchr(string $haystack, mixed $needle) This function returns the portion of string, or FALSE if needle is not found. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " This function returns the portion of string, or FALSE if needle is not found.
Returns the position of where the needle exists relative to the beginning of the haystack string (independent of offset). Also note that string positions start at 0, and not 1.
Returns FALSE if the needle was not found.
This function mayreturn Boolean FALSE, but may also return a non-Boolean value whichevaluates to FALSE. Please read the section on Booleans for moreinformation. Use the ===operator for testing the return value of thisfunction.
Returns a string starting from the character found, or FALSE if it is not found.
Returns < 0 if str1 is less than str2; > 0 if str1 is greater than str2, and 0 if they are equal.
Returns < 0 if str1 is less than str2; > 0 if str1 is greater than str2, and 0 if they are equal.
Similar to other string comparison functions, this one returns < 0 if str1 is less than str2; > 0 if str1 is greater than str2, and 0 if they are equal.
Similar to other string comparison functions, this one returns < 0 if str1 is less than str2 > 0 if str1 is greater than str2, and 0 if they are equal.
The length of the string on success, and 0 if the string is empty.
Returns the matched substring. If needle is not found, returns FALSE.
Returns a string with backslashes stripped off. (\\' becomes ' and so on.) Double backslashes (\\\\) are made into a single backslash (\\).
") (prototype . "string stripslashes(string $str)") (purpose . "Un-quotes a quoted string") (id . "function.stripslashes")) "stripos" ((documentation . #("Find the position of the first occurrence of a case-insensitive substring in a string int stripos(string $haystack, string $needle [, int $offset = '']) Returns the position of where the needle exists relative to the beginnning of the haystack string (independent of offset). Also note that string positions start at 0, and not 1. Returns FALSE if the needle was not found. Warning This function mayreturn Boolean FALSE, but may also return a non-Boolean value whichevaluates to FALSE. Please read the section on Booleans for moreinformation. Use the ===operator for testing the return value of thisfunction. (PHP 5)" 518 526 (shr-url "language.types.boolean.html") 552 555 (shr-url "language.operators.comparison.html") 555 556 (shr-url "language.operators.comparison.html") 556 567 (shr-url "language.operators.comparison.html"))) (versions . "PHP 5") (return . " Returns the position of where the needle exists relative to the beginnning of the haystack string (independent of offset). Also note that string positions start at 0, and not 1.
Returns FALSE if the needle was not found.
This function mayreturn Boolean FALSE, but may also return a non-Boolean value whichevaluates to FALSE. Please read the section on Booleans for moreinformation. Use the ===operator for testing the return value of thisfunction.
Returns the unescaped string.
") (prototype . "string stripcslashes(string $str)") (purpose . "Un-quote string quoted with addcslashes") (id . "function.stripcslashes")) "strip_tags" ((documentation . "Strip HTML and PHP tags from a string string strip_tags(string $str [, string $allowable_tags = '']) Returns the stripped string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the stripped string.
") (prototype . "string strip_tags(string $str [, string $allowable_tags = ''])") (purpose . "Strip HTML and PHP tags from a string") (id . "function.strip-tags")) "strcspn" ((documentation . "Find length of initial segment not matching mask int strcspn(string $str1, string $str2 [, int $start = '' [, int $length = '']]) Returns the length of the segment as an integer. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the length of the segment as an integer.
") (prototype . "int strcspn(string $str1, string $str2 [, int $start = '' [, int $length = '']])") (purpose . "Find length of initial segment not matching mask") (id . "function.strcspn")) "strcoll" ((documentation . "Locale based string comparison int strcoll(string $str1, string $str2) Returns < 0 if str1 is less than str2; > 0 if str1 is greater than str2, and 0 if they are equal. (PHP 4 >= 4.0.5, PHP 5)") (versions . "PHP 4 >= 4.0.5, PHP 5") (return . " Returns < 0 if str1 is less than str2; > 0 if str1 is greater than str2, and 0 if they are equal.
Returns < 0 if str1 is less than str2; > 0 if str1 is greater than str2, and 0 if they are equal.
Returns < 0 if str1 is less than str2; > 0 if str1 is greater than str2, and 0 if they are equal.
Returns an array or an integer, depending on the format chosen.
If the optional split_length parameter is specified, the returned array will be broken down into chunks with each being split_length in length, otherwise each chunk will be one character in length.
FALSE is returned if split_length is less than 1. If the split_length length exceeds the length of string, the entire string is returned as the first (and only) array element.
Returns the shuffled string.
") (prototype . "string str_shuffle(string $str)") (purpose . "Randomly shuffles a string") (id . "function.str-shuffle")) "str_rot13" ((documentation . "Perform the rot13 transform on a string string str_rot13(string $str) Returns the ROT13 version of the given string. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . "Returns the ROT13 version of the given string.
") (prototype . "string str_rot13(string $str)") (purpose . "Perform the rot13 transform on a string") (id . "function.str-rot13")) "str_replace" ((documentation . "Replace all occurrences of the search string with the replacement string mixed str_replace(mixed $search, mixed $replace, mixed $subject [, int $count = '']) This function returns a string or an array with the replaced values. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "This function returns a string or an array with the replaced values.
") (prototype . "mixed str_replace(mixed $search, mixed $replace, mixed $subject [, int $count = ''])") (purpose . "Replace all occurrences of the search string with the replacement string") (id . "function.str-replace")) "str_repeat" ((documentation . "Repeat a string string str_repeat(string $input, int $multiplier) Returns the repeated string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the repeated string.
") (prototype . "string str_repeat(string $input, int $multiplier)") (purpose . "Repeat a string") (id . "function.str-repeat")) "str_pad" ((documentation . "Pad a string to a certain length with another string string str_pad(string $input, int $pad_length [, string $pad_string = \" \" [, int $pad_type = STR_PAD_RIGHT]]) Returns the padded string. (PHP 4 >= 4.0.1, PHP 5)") (versions . "PHP 4 >= 4.0.1, PHP 5") (return . "Returns the padded string.
") (prototype . "string str_pad(string $input, int $pad_length [, string $pad_string = \" \" [, int $pad_type = STR_PAD_RIGHT]])") (purpose . "Pad a string to a certain length with another string") (id . "function.str-pad")) "str_ireplace" ((documentation . "Case-insensitive version of str_replace. mixed str_ireplace(mixed $search, mixed $replace, mixed $subject [, int $count = '']) Returns a string or an array of replacements. (PHP 5)") (versions . "PHP 5") (return . "Returns a string or an array of replacements.
") (prototype . "mixed str_ireplace(mixed $search, mixed $replace, mixed $subject [, int $count = ''])") (purpose . "Case-insensitive version of str_replace.") (id . "function.str-ireplace")) "str_getcsv" ((documentation . "Parse a CSV string into an array array str_getcsv(string $input [, string $delimiter = ',' [, string $enclosure = '\"' [, string $escape = '\\\\']]]) Returns an indexed array containing the fields read. (PHP 5 >= 5.3.0)") (versions . "PHP 5 >= 5.3.0") (return . "Returns an indexed array containing the fields read.
") (prototype . "array str_getcsv(string $input [, string $delimiter = ',' [, string $enclosure = '\"' [, string $escape = '\\\\']]])") (purpose . "Parse a CSV string into an array") (id . "function.str-getcsv")) "sscanf" ((documentation . "Parses input from a string according to a format mixed sscanf(string $str, string $format [, mixed $... = '']) If only two parameters were passed to this function, the values parsed will be returned as an array. Otherwise, if optional parameters are passed, the function will return the number of assigned values. The optional parameters must be passed by reference. If there are more substrings expected in the format than there are available within str, -1 will be returned. (PHP 4 >= 4.0.1, PHP 5)") (versions . "PHP 4 >= 4.0.1, PHP 5") (return . "If only two parameters were passed to this function, the values parsed will be returned as an array. Otherwise, if optional parameters are passed, the function will return the number of assigned values. The optional parameters must be passed by reference.
If there are more substrings expected in the format than there are available within str, -1 will be returned.
Returns a string produced according to the formatting string format.
Returns the soundex key as a string.
") (prototype . "string soundex(string $str)") (purpose . "Calculate the soundex key of a string") (id . "function.soundex")) "similar_text" ((documentation . "Calculate the similarity between two strings int similar_text(string $first, string $second [, float $percent = '']) Returns the number of matching chars in both strings. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the number of matching chars in both strings.
") (prototype . "int similar_text(string $first, string $second [, float $percent = ''])") (purpose . "Calculate the similarity between two strings") (id . "function.similar-text")) "sha1" ((documentation . "Calculate the sha1 hash of a string string sha1(string $str [, bool $raw_output = false]) Returns the sha1 hash as a string. (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . "Returns the sha1 hash as a string.
") (prototype . "string sha1(string $str [, bool $raw_output = false])") (purpose . "Calculate the sha1 hash of a string") (id . "function.sha1")) "sha1_file" ((documentation . "Calculate the sha1 hash of a file string sha1_file(string $filename [, bool $raw_output = false]) Returns a string on success, FALSE otherwise. (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . " Returns a string on success, FALSE otherwise.
Returns the new current locale, or FALSE if the locale functionality is not implemented on your platform, the specified locale does not exist or the category name is invalid.
An invalid category name also causes a warning message. Category/locale names can be found in » RFC 1766 and » ISO 639. Different systems have different naming schemes for locales.
") (prototype . "string setlocale(int $category, array $locale [, string $... = ''])") (purpose . "Set locale information") (id . "function.setlocale")) "rtrim" ((documentation . "Strip whitespace (or other characters) from the end of a string string rtrim(string $str [, string $character_mask = '']) Returns the modified string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Note:
The return value of setlocale depends on the system that PHP is running. It returns exactly what the system setlocale function returns.
Returns the modified string.
") (prototype . "string rtrim(string $str [, string $character_mask = ''])") (purpose . "Strip whitespace (or other characters) from the end of a string") (id . "function.rtrim")) "quotemeta" ((documentation . "Quote meta characters string quotemeta(string $str) Returns the string with meta characters quoted, or FALSE if an empty string is given as str. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns the string with meta characters quoted, or FALSE if an empty string is given as str.
Returns the encoded string.
") (prototype . "string quoted_printable_encode(string $str)") (purpose . "Convert a 8 bit string to a quoted-printable string") (id . "function.quoted-printable-encode")) "quoted_printable_decode" ((documentation . "Convert a quoted-printable string to an 8 bit string string quoted_printable_decode(string $str) Returns the 8-bit binary string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the 8-bit binary string.
") (prototype . "string quoted_printable_decode(string $str)") (purpose . "Convert a quoted-printable string to an 8 bit string") (id . "function.quoted-printable-decode")) "printf" ((documentation . "Output a formatted string int printf(string $format [, mixed $args = '' [, mixed $... = '']]) Returns the length of the outputted string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the length of the outputted string.
") (prototype . "int printf(string $format [, mixed $args = '' [, mixed $... = '']])") (purpose . "Output a formatted string") (id . "function.printf")) "print" ((documentation . "Output a string int print(string $arg) Returns 1, always. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns 1, always.
") (prototype . "int print(string $arg)") (purpose . "Output a string") (id . "function.print")) "parse_str" ((documentation . "Parses the string into variables void parse_str(string $str [, array $arr = '']) No value is returned. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "No value is returned.
") (prototype . "void parse_str(string $str [, array $arr = ''])") (purpose . "Parses the string into variables") (id . "function.parse-str")) "ord" ((documentation . "Return ASCII value of character int ord(string $string) Returns the ASCII value as an integer. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the ASCII value as an integer.
") (prototype . "int ord(string $string)") (purpose . "Return ASCII value of character") (id . "function.ord")) "number_format" ((documentation . "Format a number with grouped thousands string number_format(float $number, int $decimals, string $dec_point, string $thousands_sep) A formatted version of number. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " A formatted version of number.
Returns the altered string.
") (prototype . "string nl2br(string $string [, bool $is_xhtml = true])") (purpose . "Inserts HTML line breaks before all newlines in a string") (id . "function.nl2br")) "nl_langinfo" ((documentation . "Query language and locale information string nl_langinfo(int $item) Returns the element as a string, or FALSE if item is not valid. (PHP 4 >= 4.1.0, PHP 5)") (versions . "PHP 4 >= 4.1.0, PHP 5") (return . " Returns the element as a string, or FALSE if item is not valid.
Returns the formatted string. Characters before and after the formatting string will be returned unchanged. Non-numeric number causes returning NULL and emitting E_WARNING.
Returns the metaphone key as a string, or FALSE on failure.
Returns the hash as a 32-character hexadecimal number.
") (prototype . "string md5(string $str [, bool $raw_output = false])") (purpose . "Calculate the md5 hash of a string") (id . "function.md5")) "md5_file" ((documentation . "Calculates the md5 hash of a given file string md5_file(string $filename [, bool $raw_output = false]) Returns a string on success, FALSE otherwise. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . " Returns a string on success, FALSE otherwise.
This function returns a string with whitespace stripped from the beginning of str. Without the second parameter, ltrim will strip these characters:
localeconv returns data based upon the current locale as set by setlocale. The associative array that is returned contains the following fields:
| Array element | Description |
|---|---|
| decimal_point | Decimal point character |
| thousands_sep | Thousands separator |
| grouping | Array containing numeric groupings |
| int_curr_symbol | International currency symbol (i.e. USD) |
| currency_symbol | Local currency symbol (i.e. $) |
| mon_decimal_point | Monetary decimal point character |
| mon_thousands_sep | Monetary thousands separator |
| mon_grouping | Array containing monetary groupings |
| positive_sign | Sign for positive values |
| negative_sign | Sign for negative values |
| int_frac_digits | International fractional digits |
| frac_digits | Local fractional digits |
| p_cs_precedes | TRUE if currency_symbol precedes a positive value, FALSE if it succeeds one |
| p_sep_by_space | TRUE if a space separates currency_symbol from a positive value, FALSE otherwise |
| n_cs_precedes | TRUE if currency_symbol precedes a negative value, FALSE if it succeeds one |
| n_sep_by_space | TRUE if a space separates currency_symbol from a negative value, FALSE otherwise |
| p_sign_posn |
|
| n_sign_posn |
|
The p_sign_posn, and n_sign_posn contain a string of formatting options. Each number representing one of the above listed conditions.
The grouping fields contain arrays that define the way numbers should be grouped. For example, the monetary grouping field for the nl_NL locale (in UTF-8 mode with the euro sign), would contain a 2 item array with the values 3 and 3. The higher the index in the array, the farther left the grouping is. If an array element is equal to CHAR_MAX, no further grouping is done. If an array element is equal to 0, the previous element should be used.
This function returns the Levenshtein-Distance between the two argument strings or -1, if one of the argument strings is longer than the limit of 255 characters.
") (prototype . "int levenshtein(string $str1, string $str2, int $cost_ins, int $cost_rep, int $cost_del)") (purpose . "Calculate Levenshtein distance between two strings") (id . "function.levenshtein")) "lcfirst" ((documentation . "Make a string's first character lowercase string lcfirst(string $str) Returns the resulting string. (PHP 5 >= 5.3.0)") (versions . "PHP 5 >= 5.3.0") (return . "Returns the resulting string.
") (prototype . "string lcfirst(string $str)") (purpose . "Make a string's first character lowercase") (id . "function.lcfirst")) "join" ((documentation . "Alias of implode join() (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "") (prototype . " join()") (purpose . "Alias of implode") (id . "function.join")) "implode" ((documentation . "Join array elements with a string string implode(string $glue, array $pieces) Returns a string containing a string representation of all the array elements in the same order, with the glue string between each element. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns a string containing a string representation of all the array elements in the same order, with the glue string between each element.
") (prototype . "string implode(string $glue, array $pieces)") (purpose . "Join array elements with a string") (id . "function.implode")) "htmlspecialchars" ((documentation . "Convert special characters to HTML entities string htmlspecialchars(string $string [, int $flags = ENT_COMPAT | ENT_HTML401 [, string $encoding = 'UTF-8' [, bool $double_encode = true]]]) The converted string. If the input string contains an invalid code unit sequence within the given encoding an empty string will be returned, unless either the ENT_IGNORE or ENT_SUBSTITUTE flags are set. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "The converted string.
If the input string contains an invalid code unit sequence within the given encoding an empty string will be returned, unless either the ENT_IGNORE or ENT_SUBSTITUTE flags are set.
Returns the decoded string.
") (prototype . "string htmlspecialchars_decode(string $string [, int $flags = ENT_COMPAT | ENT_HTML401])") (purpose . "Convert special HTML entities back to characters") (id . "function.htmlspecialchars-decode")) "htmlentities" ((documentation . "Convert all applicable characters to HTML entities string htmlentities(string $string [, int $flags = ENT_COMPAT | ENT_HTML401 [, string $encoding = 'UTF-8' [, bool $double_encode = true]]]) Returns the encoded string. If the input string contains an invalid code unit sequence within the given encoding an empty string will be returned, unless either the ENT_IGNORE or ENT_SUBSTITUTE flags are set. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the encoded string.
If the input string contains an invalid code unit sequence within the given encoding an empty string will be returned, unless either the ENT_IGNORE or ENT_SUBSTITUTE flags are set.
Returns the decoded string.
") (prototype . "string html_entity_decode(string $string [, int $flags = ENT_COMPAT | ENT_HTML401 [, string $encoding = 'UTF-8']])") (purpose . "Convert all HTML entities to their applicable characters") (id . "function.html-entity-decode")) "hex2bin" ((documentation . "Decodes a hexadecimally encoded binary string string hex2bin(string $data) Returns the binary representation of the given data or FALSE on failure. (PHP >= 5.4.0)") (versions . "PHP >= 5.4.0") (return . " Returns the binary representation of the given data or FALSE on failure.
Returns the visual string.
") (prototype . "string hebrevc(string $hebrew_text [, int $max_chars_per_line = ''])") (purpose . "Convert logical Hebrew text to visual text with newline conversion") (id . "function.hebrevc")) "hebrev" ((documentation . "Convert logical Hebrew text to visual text string hebrev(string $hebrew_text [, int $max_chars_per_line = '']) Returns the visual string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the visual string.
") (prototype . "string hebrev(string $hebrew_text [, int $max_chars_per_line = ''])") (purpose . "Convert logical Hebrew text to visual text") (id . "function.hebrev")) "get_html_translation_table" ((documentation . "Returns the translation table used by htmlspecialchars and htmlentities array get_html_translation_table([int $table = HTML_SPECIALCHARS [, int $flags = ENT_COMPAT | ENT_HTML401 [, string $encoding = 'UTF-8']]]) Returns the translation table as an array, with the original characters as keys and entities as values. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the translation table as an array, with the original characters as keys and entities as values.
") (prototype . "array get_html_translation_table([int $table = HTML_SPECIALCHARS [, int $flags = ENT_COMPAT | ENT_HTML401 [, string $encoding = 'UTF-8']]])") (purpose . "Returns the translation table used by htmlspecialchars and htmlentities") (id . "function.get-html-translation-table")) "fprintf" ((documentation . "Write a formatted string to a stream int fprintf(resource $handle, string $format [, mixed $args = '' [, mixed $... = '']]) Returns the length of the string written. (PHP 5)") (versions . "PHP 5") (return . "Returns the length of the string written.
") (prototype . "int fprintf(resource $handle, string $format [, mixed $args = '' [, mixed $... = '']])") (purpose . "Write a formatted string to a stream") (id . "function.fprintf")) "explode" ((documentation . "Split a string by string array explode(string $delimiter, string $string [, int $limit = '']) Returns an array of strings created by splitting the string parameter on boundaries formed by the delimiter. If delimiter is an empty string (\"\"), explode will return FALSE. If delimiter contains a value that is not contained in string and a negative limit is used, then an empty array will be returned, otherwise an array containing string will be returned. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns an array of strings created by splitting the string parameter on boundaries formed by the delimiter.
If delimiter is an empty string (""), explode will return FALSE. If delimiter contains a value that is not contained in string and a negative limit is used, then an empty array will be returned, otherwise an array containing string will be returned.
No value is returned.
") (prototype . "void echo(string $arg1 [, string $... = ''])") (purpose . "Output one or more strings") (id . "function.echo")) "crypt" ((documentation . "One-way string hashing string crypt(string $str [, string $salt = '']) Returns the hashed string or a string that is shorter than 13 characters and is guaranteed to differ from the salt on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the hashed string or a string that is shorter than 13 characters and is guaranteed to differ from the salt on failure.
") (prototype . "string crypt(string $str [, string $salt = ''])") (purpose . "One-way string hashing") (id . "function.crypt")) "crc32" ((documentation . "Calculates the crc32 polynomial of a string int crc32(string $str) Returns the crc32 checksum of str as an integer. (PHP 4 >= 4.0.1, PHP 5)") (versions . "PHP 4 >= 4.0.1, PHP 5") (return . " Returns the crc32 checksum of str as an integer.
Depending on mode count_chars returns one of the following:
Returns the uuencoded data.
") (prototype . "string convert_uuencode(string $data)") (purpose . "Uuencode a string") (id . "function.convert-uuencode")) "convert_uudecode" ((documentation . "Decode a uuencoded string string convert_uudecode(string $data) Returns the decoded data as a string or FALSE on failure. (PHP 5)") (versions . "PHP 5") (return . " Returns the decoded data as a string or FALSE on failure.
Returns the converted string.
") (prototype . "string convert_cyr_string(string $str, string $from, string $to)") (purpose . "Convert from one Cyrillic character set to another") (id . "function.convert-cyr-string")) "chunk_split" ((documentation . "Split a string into smaller chunks string chunk_split(string $body [, int $chunklen = 76 [, string $end = \"\\r\\n\"]]) Returns the chunked string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the chunked string.
") (prototype . "string chunk_split(string $body [, int $chunklen = 76 [, string $end = \"\\r\\n\"]])") (purpose . "Split a string into smaller chunks") (id . "function.chunk-split")) "chr" ((documentation . "Return a specific character string chr(int $ascii) Returns the specified character. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the specified character.
") (prototype . "string chr(int $ascii)") (purpose . "Return a specific character") (id . "function.chr")) "chop" ((documentation . "Alias of rtrim chop() (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "") (prototype . " chop()") (purpose . "Alias of rtrim") (id . "function.chop")) "bin2hex" ((documentation . "Convert binary data into hexadecimal representation string bin2hex(string $str) Returns the hexadecimal representation of the given string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the hexadecimal representation of the given string.
") (prototype . "string bin2hex(string $str)") (purpose . "Convert binary data into hexadecimal representation") (id . "function.bin2hex")) "addslashes" ((documentation . "Quote string with slashes string addslashes(string $str) Returns the escaped string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the escaped string.
") (prototype . "string addslashes(string $str)") (purpose . "Quote string with slashes") (id . "function.addslashes")) "addcslashes" ((documentation . "Quote string with slashes in a C style string addcslashes(string $str, string $charlist) Returns the escaped string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the escaped string.
") (prototype . "string addcslashes(string $str, string $charlist)") (purpose . "Quote string with slashes in a C style") (id . "function.addcslashes")) "ssdeep_fuzzy_hash" ((documentation . "Create a fuzzy hash from a string string ssdeep_fuzzy_hash(string $to_hash) Returns a string on success, FALSE otherwise. (PECL ssdeep >= 1.0.0)") (versions . "PECL ssdeep >= 1.0.0") (return . " Returns a string on success, FALSE otherwise.
Returns a string on success, FALSE otherwise.
Returns an integer from 0 to 100 on success, FALSE otherwise.
Returns a valid regular expression which will match string, ignoring case. This expression is string with each alphabetic character converted to a bracket expression; this bracket expression contains that character's uppercase and lowercase form. Other characters remain unchanged.
Returns an array of strings, each of which is a substring of string formed by splitting it on boundaries formed by the case insensitive regular expression pattern.
If there are n occurrences of pattern, the returned array will contain n+1 items. For example, if there is no occurrence of pattern, an array with only one element will be returned. Of course, this is also true if string is empty. If an error occurs, spliti returns FALSE.
Returns an array of strings, each of which is a substring of string formed by splitting it on boundaries formed by the case-sensitive regular expression pattern.
If there are n occurrences of pattern, the returned array will contain n+1 items. For example, if there is no occurrence of pattern, an array with only one element will be returned. Of course, this is also true if string is empty. If an error occurs, split returns FALSE.
Returns the length of the matched string if a match for pattern was found in string, or FALSE if no matches were found or an error occurred.
If the optional parameter regs was not passed or the length of the matched string is 0, this function returns 1.
The modified string is returned. If no matches are found in string, then it will be returned unchanged.
Returns the length of the matched string if a match for pattern was found in string, or FALSE if no matches were found or an error occurred.
If the optional parameter regs was not passed or the length of the matched string is 0, this function returns 1.
The modified string is returned. If no matches are found in string, then it will be returned unchanged.
Returns an array containing substrings of subject split along boundaries matched by pattern.
preg_replace returns an array if the subject parameter is an array, or a string otherwise.
If matches are found, the new subject will be returned, otherwise subject will be returned unchanged or NULL if an error occurred.
preg_replace_callback returns an array if the subject parameter is an array, or a string otherwise. On errors the return value is NULL
If matches are found, the new subject will be returned, otherwise subject will be returned unchanged.
Returns the quoted (escaped) string.
") (prototype . "string preg_quote(string $str [, string $delimiter = ''])") (purpose . "Quote regular expression characters") (id . "function.preg-quote")) "preg_match" ((documentation . #("Perform a regular expression match int preg_match(string $pattern, string $subject [, array $matches = '' [, int $flags = '' [, int $offset = '']]]) preg_match returns 1 if the pattern matches given subject, 0 if it does not, or FALSE if an error occurred. Warning This function mayreturn Boolean FALSE, but may also return a non-Boolean value whichevaluates to FALSE. Please read the section on Booleans for moreinformation. Use the ===operator for testing the return value of thisfunction. (PHP 4, PHP 5)" 400 408 (shr-url "language.types.boolean.html") 434 437 (shr-url "language.operators.comparison.html") 437 438 (shr-url "language.operators.comparison.html") 438 449 (shr-url "language.operators.comparison.html"))) (versions . "PHP 4, PHP 5") (return . " preg_match returns 1 if the pattern matches given subject, 0 if it does not, or FALSE if an error occurred.
This function mayreturn Boolean FALSE, but may also return a non-Boolean value whichevaluates to FALSE. Please read the section on Booleans for moreinformation. Use the ===operator for testing the return value of thisfunction.
Returns the number of full pattern matches (which might be zero), or FALSE if an error occurred.
Returns one of the following constants (explained on their own page):
PREG_NO_ERRORPREG_INTERNAL_ERRORPREG_BACKTRACK_LIMIT_ERROR (see also pcre.backtrack_limit)PREG_RECURSION_LIMIT_ERROR (see also pcre.recursion_limit)PREG_BAD_UTF8_ERRORPREG_BAD_UTF8_OFFSET_ERROR (since PHP 5.3.0) Returns an array indexed using the keys from the input array.
Returns an array if the subject parameter is an array, or a string otherwise.
If no matches are found or an error occurred, an empty array is returned when subject is an array or NULL otherwise.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the parsed string, or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns a BBCode_Container
") (prototype . "resource bbcode_create([array $bbcode_initial_tags = null])") (purpose . "Create a BBCode Resource") (id . "function.bbcode-create")) "bbcode_add_smiley" ((documentation . "Adds a smiley to the parser bool bbcode_add_smiley(resource $bbcode_container, string $smiley, string $replace_by) Returns TRUE on success or FALSE on failure. (PECL bbcode >= 0.10.2)") (versions . "PECL bbcode >= 0.10.2") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
The number of errors are returned as array.
") (prototype . "array session_pgsql_get_error([bool $with_error_message = false])") (purpose . "Returns number of errors and last error message") (id . "function.session-pgsql-get-error")) "session_pgsql_add_error" ((documentation . "Increments error counts and sets last error message bool session_pgsql_add_error(int $error_level [, string $error_message = '']) Returns TRUE on success or FALSE on failure. (PECL session_pgsql SVN)") (versions . "PECL session_pgsql SVN") (return . " Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void session_write_close()") (purpose . "Write session data and end session") (id . "function.session-write-close")) "session_unset" ((documentation . "Free all session variables void session_unset() No value is returned. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "No value is returned.
") (prototype . "void session_unset()") (purpose . "Free all session variables") (id . "function.session-unset")) "session_unregister" ((documentation . "Unregister a global variable from the current session bool session_unregister(string $name) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5 < 5.4.0)") (versions . "PHP 4, PHP 5 < 5.4.0") (return . " Returns TRUE on success or FALSE on failure.
PHP_SESSION_DISABLED if sessions are disabled. PHP_SESSION_NONE if sessions are enabled, but none exists. PHP_SESSION_ACTIVE if sessions are enabled, and one exists. This function returns TRUE if a session was successfully started, otherwise FALSE.
Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void session_set_cookie_params(int $lifetime [, string $path = '' [, string $domain = '' [, bool $secure = false [, bool $httponly = false]]]])") (purpose . "Set the session cookie parameters") (id . "function.session-set-cookie-params")) "session_save_path" ((documentation . "Get and/or set the current session save path string session_save_path([string $path = '']) Returns the path of the current directory used for data storage. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the path of the current directory used for data storage.
") (prototype . "string session_save_path([string $path = ''])") (purpose . "Get and/or set the current session save path") (id . "function.session-save-path")) "session_register" ((documentation . "Register one or more global variables with the current session bool session_register(mixed $name [, mixed $... = '']) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5 < 5.4.0)") (versions . "PHP 4, PHP 5 < 5.4.0") (return . " Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void session_register_shutdown()") (purpose . "Session shutdown function") (id . "function.session-register-shutdown")) "session_regenerate_id" ((documentation . "Update the current session id with a newly generated one bool session_regenerate_id([bool $delete_old_session = false]) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.3.2, PHP 5)") (versions . "PHP 4 >= 4.3.2, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns the name of the current session.
") (prototype . "string session_name([string $name = ''])") (purpose . "Get and/or set the current session name") (id . "function.session-name")) "session_module_name" ((documentation . "Get and/or set the current session module string session_module_name([string $module = '']) Returns the name of the current session module. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the name of the current session module.
") (prototype . "string session_module_name([string $module = ''])") (purpose . "Get and/or set the current session module") (id . "function.session-module-name")) "session_is_registered" ((documentation . "Find out whether a global variable is registered in a session bool session_is_registered(string $name) session_is_registered returns TRUE if there is a global variable with the name name registered in the current session, FALSE otherwise. (PHP 4, PHP 5 < 5.4.0)") (versions . "PHP 4, PHP 5 < 5.4.0") (return . " session_is_registered returns TRUE if there is a global variable with the name name registered in the current session, FALSE otherwise.
session_id returns the session id for the current session or the empty string ("") if there is no current session (no current session id exists).
") (prototype . "string session_id([string $id = ''])") (purpose . "Get and/or set the current session id") (id . "function.session-id")) "session_get_cookie_params" ((documentation . #("Get the session cookie parameters array session_get_cookie_params() Returns an array with the current session cookie information, the array contains the following items: * \"lifetime\" - The lifetime of the cookie in seconds. * \"path\" - The path where information is stored. * \"domain\" - The domain of the cookie. * \"secure\" - The cookie should only be sent over secure connections. * \"httponly\" - The cookie can only be accessed through the HTTP protocol. (PHP 4, PHP 5)" 175 185 (shr-url "session.configuration.html#ini.session.cookie-lifetime") 230 236 (shr-url "session.configuration.html#ini.session.cookie-path") 280 288 (shr-url "session.configuration.html#ini.session.cookie-domain") 320 328 (shr-url "session.configuration.html#ini.session.cookie-secure") 390 400 (shr-url "session.configuration.html#ini.session.cookie-httponly"))) (versions . "PHP 4, PHP 5") (return . "Returns an array with the current session cookie information, the array contains the following items:
Returns the contents of the current session encoded.
") (prototype . "string session_encode()") (purpose . "Encodes the current session data as a session encoded string") (id . "function.session-encode")) "session_destroy" ((documentation . "Destroys all data registered to a session bool session_destroy() Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the name of the current cache limiter.
") (prototype . "string session_cache_limiter([string $cache_limiter = ''])") (purpose . "Get and/or set the current cache limiter") (id . "function.session-cache-limiter")) "session_cache_expire" ((documentation . "Return current cache expire int session_cache_expire([string $new_cache_expire = '']) Returns the current setting of session.cache_expire. The value returned should be read in minutes, defaults to 180. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . "Returns the current setting of session.cache_expire. The value returned should be read in minutes, defaults to 180.
") (prototype . "int session_cache_expire([string $new_cache_expire = ''])") (purpose . "Return current cache expire") (id . "function.session-cache-expire")) "msession_unlock" ((documentation . "Unlock a session int msession_unlock(string $session, int $key) (PHP 4 >= 4.2.0, PHP 5 <= 5.1.2)") (versions . "PHP 4 >= 4.2.0, PHP 5 <= 5.1.2") (return . "") (prototype . "int msession_unlock(string $session, int $key)") (purpose . "Unlock a session") (id . "function.msession-unlock")) "msession_uniq" ((documentation . "Get unique id string msession_uniq(int $param [, string $classname = '' [, string $data = '']]) (PHP 4 >= 4.2.0, PHP 5 <= 5.1.2)") (versions . "PHP 4 >= 4.2.0, PHP 5 <= 5.1.2") (return . "") (prototype . "string msession_uniq(int $param [, string $classname = '' [, string $data = '']])") (purpose . "Get unique id") (id . "function.msession-uniq")) "msession_timeout" ((documentation . "Set/get session timeout int msession_timeout(string $session [, int $param = '']) (PHP 4 >= 4.2.0, PHP 5 <= 5.1.2)") (versions . "PHP 4 >= 4.2.0, PHP 5 <= 5.1.2") (return . "") (prototype . "int msession_timeout(string $session [, int $param = ''])") (purpose . "Set/get session timeout") (id . "function.msession-timeout")) "msession_set" ((documentation . "Set value in session bool msession_set(string $session, string $name, string $value) (PHP 4 >= 4.2.0, PHP 5 <= 5.1.2)") (versions . "PHP 4 >= 4.2.0, PHP 5 <= 5.1.2") (return . "") (prototype . "bool msession_set(string $session, string $name, string $value)") (purpose . "Set value in session") (id . "function.msession-set")) "msession_set_data" ((documentation . "Set data session unstructured data bool msession_set_data(string $session, string $value) (PHP 4 >= 4.2.0, PHP 5 <= 5.1.2)") (versions . "PHP 4 >= 4.2.0, PHP 5 <= 5.1.2") (return . "") (prototype . "bool msession_set_data(string $session, string $value)") (purpose . "Set data session unstructured data") (id . "function.msession-set-data")) "msession_set_array" ((documentation . "Set msession variables from an array void msession_set_array(string $session, array $tuples) (PHP 4 >= 4.2.0, PHP 5 <= 5.1.2)") (versions . "PHP 4 >= 4.2.0, PHP 5 <= 5.1.2") (return . "") (prototype . "void msession_set_array(string $session, array $tuples)") (purpose . "Set msession variables from an array") (id . "function.msession-set-array")) "msession_randstr" ((documentation . "Get random string string msession_randstr(int $param) (PHP 4 >= 4.2.0, PHP 5 <= 5.1.2)") (versions . "PHP 4 >= 4.2.0, PHP 5 <= 5.1.2") (return . "") (prototype . "string msession_randstr(int $param)") (purpose . "Get random string") (id . "function.msession-randstr")) "msession_plugin" ((documentation . "Call an escape function within the msession personality plugin string msession_plugin(string $session, string $val [, string $param = '']) (PHP 4 >= 4.2.0, PHP 5 <= 5.1.2)") (versions . "PHP 4 >= 4.2.0, PHP 5 <= 5.1.2") (return . "") (prototype . "string msession_plugin(string $session, string $val [, string $param = ''])") (purpose . "Call an escape function within the msession personality plugin") (id . "function.msession-plugin")) "msession_lock" ((documentation . "Lock a session int msession_lock(string $name) (PHP 4 >= 4.2.0, PHP 5 <= 5.1.2)") (versions . "PHP 4 >= 4.2.0, PHP 5 <= 5.1.2") (return . "") (prototype . "int msession_lock(string $name)") (purpose . "Lock a session") (id . "function.msession-lock")) "msession_listvar" ((documentation . "List sessions with variable array msession_listvar(string $name) Returns an associative array of value/session for all sessions with a variable named name. (PHP 4 >= 4.2.0, PHP 5 <= 5.1.2)") (versions . "PHP 4 >= 4.2.0, PHP 5 <= 5.1.2") (return . " Returns an associative array of value/session for all sessions with a variable named name.
Returns TRUE on success or FALSE on failure.
Returns an associative array with all the NSAPI response headers.
") (prototype . "array nsapi_response_headers()") (purpose . "Fetch all HTTP response headers") (id . "function.nsapi-response-headers")) "nsapi_request_headers" ((documentation . "Fetch all HTTP request headers array nsapi_request_headers() Returns an associative array with all the HTTP headers. (PHP 4 >= 4.3.3, PHP 5)") (versions . "PHP 4 >= 4.3.3, PHP 5") (return . "Returns an associative array with all the HTTP headers.
") (prototype . "array nsapi_request_headers()") (purpose . "Fetch all HTTP request headers") (id . "function.nsapi-request-headers")) "iis_stop_service" ((documentation . "Stops the service defined by ServiceId int iis_stop_service(string $service_id) (PECL iisfunc SVN)") (versions . "PECL iisfunc SVN") (return . "") (prototype . "int iis_stop_service(string $service_id)") (purpose . "Stops the service defined by ServiceId") (id . "function.iis-stop-service")) "iis_stop_server" ((documentation . "Stops the virtual web server int iis_stop_server(int $server_instance) (PECL iisfunc SVN)") (versions . "PECL iisfunc SVN") (return . "") (prototype . "int iis_stop_server(int $server_instance)") (purpose . "Stops the virtual web server") (id . "function.iis-stop-server")) "iis_start_service" ((documentation . "Starts the service defined by ServiceId int iis_start_service(string $service_id) (PECL iisfunc SVN)") (versions . "PECL iisfunc SVN") (return . "") (prototype . "int iis_start_service(string $service_id)") (purpose . "Starts the service defined by ServiceId") (id . "function.iis-start-service")) "iis_start_server" ((documentation . "Starts the virtual web server int iis_start_server(int $server_instance) (PECL iisfunc SVN)") (versions . "PECL iisfunc SVN") (return . "") (prototype . "int iis_start_server(int $server_instance)") (purpose . "Starts the virtual web server") (id . "function.iis-start-server")) "iis_set_server_rights" ((documentation . "Sets server rights int iis_set_server_rights(int $server_instance, string $virtual_path, int $directory_flags) (PECL iisfunc SVN)") (versions . "PECL iisfunc SVN") (return . "") (prototype . "int iis_set_server_rights(int $server_instance, string $virtual_path, int $directory_flags)") (purpose . "Sets server rights") (id . "function.iis-set-server-rights")) "iis_set_script_map" ((documentation . "Sets script mapping on a virtual directory int iis_set_script_map(int $server_instance, string $virtual_path, string $script_extension, string $engine_path, int $allow_scripting) (PECL iisfunc SVN)") (versions . "PECL iisfunc SVN") (return . "") (prototype . "int iis_set_script_map(int $server_instance, string $virtual_path, string $script_extension, string $engine_path, int $allow_scripting)") (purpose . "Sets script mapping on a virtual directory") (id . "function.iis-set-script-map")) "iis_set_dir_security" ((documentation . "Sets Directory Security int iis_set_dir_security(int $server_instance, string $virtual_path, int $directory_flags) (PECL iisfunc SVN)") (versions . "PECL iisfunc SVN") (return . "") (prototype . "int iis_set_dir_security(int $server_instance, string $virtual_path, int $directory_flags)") (purpose . "Sets Directory Security") (id . "function.iis-set-dir-security")) "iis_set_app_settings" ((documentation . "Creates application scope for a virtual directory int iis_set_app_settings(int $server_instance, string $virtual_path, string $application_scope) (PECL iisfunc SVN)") (versions . "PECL iisfunc SVN") (return . "") (prototype . "int iis_set_app_settings(int $server_instance, string $virtual_path, string $application_scope)") (purpose . "Creates application scope for a virtual directory") (id . "function.iis-set-app-settings")) "iis_remove_server" ((documentation . "Removes the virtual web server indicated by ServerInstance int iis_remove_server(int $server_instance) (PECL iisfunc SVN)") (versions . "PECL iisfunc SVN") (return . "") (prototype . "int iis_remove_server(int $server_instance)") (purpose . "Removes the virtual web server indicated by ServerInstance") (id . "function.iis-remove-server")) "iis_get_service_state" ((documentation . "Returns the state for the service defined by ServiceId int iis_get_service_state(string $service_id) (PECL iisfunc SVN)") (versions . "PECL iisfunc SVN") (return . "") (prototype . "int iis_get_service_state(string $service_id)") (purpose . "Returns the state for the service defined by ServiceId") (id . "function.iis-get-service-state")) "iis_get_server_rights" ((documentation . "Gets server rights int iis_get_server_rights(int $server_instance, string $virtual_path) (PECL iisfunc SVN)") (versions . "PECL iisfunc SVN") (return . "") (prototype . "int iis_get_server_rights(int $server_instance, string $virtual_path)") (purpose . "Gets server rights") (id . "function.iis-get-server-rights")) "iis_get_server_by_path" ((documentation . "Return the instance number associated with the Path int iis_get_server_by_path(string $path) Returns the server instance number. (PECL iisfunc SVN)") (versions . "PECL iisfunc SVN") (return . "Returns the server instance number.
") (prototype . "int iis_get_server_by_path(string $path)") (purpose . "Return the instance number associated with the Path") (id . "function.iis-get-server-by-path")) "iis_get_server_by_comment" ((documentation . "Return the instance number associated with the Comment int iis_get_server_by_comment(string $comment) (PECL iisfunc SVN)") (versions . "PECL iisfunc SVN") (return . "") (prototype . "int iis_get_server_by_comment(string $comment)") (purpose . "Return the instance number associated with the Comment") (id . "function.iis-get-server-by-comment")) "iis_get_script_map" ((documentation . "Gets script mapping on a virtual directory for a specific extension string iis_get_script_map(int $server_instance, string $virtual_path, string $script_extension) (PECL iisfunc SVN)") (versions . "PECL iisfunc SVN") (return . "") (prototype . "string iis_get_script_map(int $server_instance, string $virtual_path, string $script_extension)") (purpose . "Gets script mapping on a virtual directory for a specific extension") (id . "function.iis-get-script-map")) "iis_get_dir_security" ((documentation . "Gets Directory Security int iis_get_dir_security(int $server_instance, string $virtual_path) (PECL iisfunc SVN)") (versions . "PECL iisfunc SVN") (return . "") (prototype . "int iis_get_dir_security(int $server_instance, string $virtual_path)") (purpose . "Gets Directory Security") (id . "function.iis-get-dir-security")) "iis_add_server" ((documentation . "Creates a new virtual web server int iis_add_server(string $path, string $comment, string $server_ip, int $port, string $host_name, int $rights, int $start_server) (PECL iisfunc SVN)") (versions . "PECL iisfunc SVN") (return . "") (prototype . "int iis_add_server(string $path, string $comment, string $server_ip, int $port, string $host_name, int $rights, int $start_server)") (purpose . "Creates a new virtual web server") (id . "function.iis-add-server")) "fastcgi_finish_request" ((documentation . "Flushes all response data to the client boolean fastcgi_finish_request() Returns TRUE on success or FALSE on failure. (PHP 5 >= 5.3.3)") (versions . "PHP 5 >= 5.3.3") (return . " Returns TRUE on success or FALSE on failure.
Performs the virtual command on success, or returns FALSE on failure.
An associative array of all the HTTP headers in the current request, or FALSE on failure.
Returns TRUE on success or FALSE on failure.
An array of all Apache response headers on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
An associative array of all the HTTP headers in the current request, or FALSE on failure.
If called with one argument, it returns the current value of note note_name. If called with two arguments, it sets the value of note note_name to note_value and returns the previous value of note note_name. If the note cannot be retrieved, FALSE is returned.
An object of related URI information. The properties of this object are:
The value of the Apache environment variable on success, or FALSE on failure
Returns the Apache version on success or FALSE on failure.
An array of loaded Apache modules.
") (prototype . "array apache_get_modules()") (purpose . "Get a list of loaded Apache modules") (id . "function.apache-get-modules")) "apache_child_terminate" ((documentation . #("Terminate apache process after this request bool apache_child_terminate() Returns TRUE if PHP is running as an Apache 1 module, the Apache version is non-multithreaded, and the child_terminate PHP directive is enabled (disabled by default). If these conditions are not met, FALSE is returned and an error of level E_WARNING is generated. (PHP 4 >= 4.0.5, PHP 5)" 179 194 (shr-url "apache.configuration.html#ini.child-terminate"))) (versions . "PHP 4 >= 4.0.5, PHP 5") (return . " Returns TRUE if PHP is running as an Apache 1 module, the Apache version is non-multithreaded, and the child_terminate PHP directive is enabled (disabled by default). If these conditions are not met, FALSE is returned and an error of level E_WARNING is generated.
It returns a string on success and FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns a 32-bit hash number.
") (prototype . "int udm_hash32(resource $agent, string $str)") (purpose . "Return Hash32 checksum of gived string") (id . "function.udm-hash32")) "udm_get_res_param" ((documentation . "Get mnoGoSearch result parameters string udm_get_res_param(resource $res, int $param) udm_get_res_param returns result parameter value on success, FALSE on error. (PHP 4 >= 4.0.5, PHP 5 <= 5.0.5, PECL mnogosearch >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PHP 5 <= 5.0.5, PECL mnogosearch >= 1.0.0") (return . " udm_get_res_param returns result parameter value on success, FALSE on error.
udm_get_res_field returns result field value on success, FALSE on error.
Returns the number of documents.
") (prototype . "int udm_get_doc_count(resource $agent)") (purpose . "Get total number of documents in database") (id . "function.udm-get-doc-count")) "udm_free_res" ((documentation . "Free mnoGoSearch result bool udm_free_res(resource $res) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.5, PHP 5 <= 5.0.5, PECL mnogosearch >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PHP 5 <= 5.0.5, PECL mnogosearch >= 1.0.0") (return . " Returns TRUE on success or FALSE on failure.
udm_free_ispell_data always returns TRUE.
Returns TRUE on success or FALSE on failure.
Returns a result link identifier on success or FALSE on failure.
udm_error returns mnoGoSearch error message, empty string if no error.
") (prototype . "string udm_error(resource $agent)") (purpose . "Get mnoGoSearch error message") (id . "function.udm-error")) "udm_errno" ((documentation . "Get mnoGoSearch error number int udm_errno(resource $agent) Returns the mnoGoSearch error number, zero if no error. (PHP 4 >= 4.0.5, PHP 5 <= 5.0.5, PECL mnogosearch >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PHP 5 <= 5.0.5, PECL mnogosearch >= 1.0.0") (return . "Returns the mnoGoSearch error number, zero if no error.
") (prototype . "int udm_errno(resource $agent)") (purpose . "Get mnoGoSearch error number") (id . "function.udm-errno")) "udm_crc32" ((documentation . "Return CRC32 checksum of given string int udm_crc32(resource $agent, string $str) (PHP 4 >= 4.2.0, PHP 5 <= 5.0.5, PECL mnogosearch >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 <= 5.0.5, PECL mnogosearch >= 1.0.0") (return . "") (prototype . "int udm_crc32(resource $agent, string $str)") (purpose . "Return CRC32 checksum of given string") (id . "function.udm-crc32")) "udm_close_stored" ((documentation . "Close connection to stored int udm_close_stored(resource $agent, int $link) (PHP 4 >= 4.2.0)") (versions . "PHP 4 >= 4.2.0") (return . "") (prototype . "int udm_close_stored(resource $agent, int $link)") (purpose . "Close connection to stored") (id . "function.udm-close-stored")) "udm_clear_search_limits" ((documentation . "Clear all mnoGoSearch search restrictions bool udm_clear_search_limits(resource $agent) Returns TRUE. (PHP 4 >= 4.0.5, PHP 5 <= 5.0.5, PECL mnogosearch >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PHP 5 <= 5.0.5, PECL mnogosearch >= 1.0.0") (return . " Returns TRUE.
The returned array consists of pairs. Elements with even index numbers contain the category paths, odd elements contain the corresponding category names.
For example, the call $array=udm_cat_path($agent, '02031D'); may return the following array:
$array[0] will contain '' $array[1] will contain 'Root' $array[2] will contain '02' $array[3] will contain 'Sport' $array[4] will contain '0203' $array[5] will contain 'Auto' $array[4] will contain '02031D' $array[5] will contain 'Ferrari'
Returns an array listing all categories of the same level as the current category in the categories tree.
The returned array consists of pairs. Elements with even index numbers contain the category paths, odd elements contain the corresponding category names.
$array[0] will contain '020300' $array[1] will contain 'Audi' $array[2] will contain '020301' $array[3] will contain 'BMW' $array[4] will contain '020302' $array[5] will contain 'Opel' ... etc.
udm_api_version returns the mnoGoSearch API version number. E.g. if mnoGoSearch 3.1.10 API is used, this function will return 30110.
") (prototype . "int udm_api_version()") (purpose . "Get mnoGoSearch API version") (id . "function.udm-api-version")) "udm_alloc_agent" ((documentation . "Allocate mnoGoSearch session resource udm_alloc_agent(string $dbaddr [, string $dbmode = '']) Returns a mnogosearch agent identifier on success, FALSE on failure. This function creates a session with database parameters. (PHP 4 >= 4.0.5, PHP 5 <= 5.0.5, PECL mnogosearch >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PHP 5 <= 5.0.5, PECL mnogosearch >= 1.0.0") (return . " Returns a mnogosearch agent identifier on success, FALSE on failure. This function creates a session with database parameters.
Returns a resource link identifier on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the order number for a map or FALSE on error.
Returns the next key-value pair as an array, or FALSE on errors.
Returns the value, or FALSE on errors.
") (prototype . "string yp_master(string $domain, string $map)") (purpose . "Returns the machine name of the master NIS server for a map") (id . "function.yp-master")) "yp_get_default_domain" ((documentation . "Fetches the machine's default NIS domain string yp_get_default_domain() Returns the default domain of the node or FALSE. Can be used as the domain parameter for successive NIS calls. (PHP 4, PHP 5 <= 5.0.5)") (versions . "PHP 4, PHP 5 <= 5.0.5") (return . "
Returns the default domain of the node or FALSE. Can be used as the domain parameter for successive NIS calls.
Returns the first key-value pair as an array on success, or FALSE on errors.
Returns one of the YPERR_XXX error constants.
") (prototype . "int yp_errno()") (purpose . "Returns the error code of the previous operation") (id . "function.yp-errno")) "yp_err_string" ((documentation . "Returns the error string associated with the given error code string yp_err_string(int $errorcode) Returns the error message, as a string. (PHP 4 >= 4.0.6, PHP 5 <= 5.0.5)") (versions . "PHP 4 >= 4.0.6, PHP 5 <= 5.0.5") (return . "Returns the error message, as a string.
") (prototype . "string yp_err_string(int $errorcode)") (purpose . "Returns the error string associated with the given error code") (id . "function.yp-err-string")) "yp_cat" ((documentation . "Return an array containing the entire map array yp_cat(string $domain, string $map) Returns an array of all map entries, the maps key values as array indices and the maps entries as array data. (PHP 4 >= 4.0.6, PHP 5 <= 5.0.5)") (versions . "PHP 4 >= 4.0.6, PHP 5 <= 5.0.5") (return . "Returns an array of all map entries, the maps key values as array indices and the maps entries as array data.
") (prototype . "array yp_cat(string $domain, string $map)") (purpose . "Return an array containing the entire map") (id . "function.yp-cat")) "yp_all" ((documentation . "Traverse the map and call a function on each entry void yp_all(string $domain, string $map, string $callback) No value is returned. (PHP 4 >= 4.0.6, PHP 5 <= 5.0.5)") (versions . "PHP 4 >= 4.0.6, PHP 5 <= 5.0.5") (return . "No value is returned.
") (prototype . "void yp_all(string $domain, string $map, string $callback)") (purpose . "Traverse the map and call a function on each entry") (id . "function.yp-all")) "yaz_wait" ((documentation . "Wait for Z39.50 requests to complete mixed yaz_wait([array $options = '']) Returns TRUE on success or FALSE on failure. In event mode, returns resource or FALSE on failure. (PHP 4 >= 4.0.1, PECL yaz >= 0.9.0)") (versions . "PHP 4 >= 4.0.1, PECL yaz >= 0.9.0") (return . " Returns TRUE on success or FALSE on failure. In event mode, returns resource or FALSE on failure.
No value is returned.
") (prototype . "void yaz_syntax(resource $id, string $syntax)") (purpose . "Specifies the preferred record syntax for retrieval") (id . "function.yaz-syntax")) "yaz_sort" ((documentation . "Sets sorting criteria void yaz_sort(resource $id, string $criteria) No value is returned. (PHP 4 >= 4.0.7, PECL yaz >= 0.9.0)") (versions . "PHP 4 >= 4.0.7, PECL yaz >= 0.9.0") (return . "No value is returned.
") (prototype . "void yaz_sort(resource $id, string $criteria)") (purpose . "Sets sorting criteria") (id . "function.yaz-sort")) "yaz_set_option" ((documentation . "Sets one or more options for connection void yaz_set_option(resource $id, string $name, string $value, array $options) No value is returned. (PECL yaz >= 0.9.0)") (versions . "PECL yaz >= 0.9.0") (return . "No value is returned.
") (prototype . "void yaz_set_option(resource $id, string $name, string $value, array $options)") (purpose . "Sets one or more options for connection") (id . "function.yaz-set-option")) "yaz_search" ((documentation . "Prepares for a search bool yaz_search(resource $id, string $type, string $query) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.1, PECL yaz >= 0.9.0)") (versions . "PHP 4 >= 4.0.1, PECL yaz >= 0.9.0") (return . " Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void yaz_schema(resource $id, string $schema)") (purpose . "Specifies schema for retrieval") (id . "function.yaz-schema")) "yaz_scan" ((documentation . "Prepares for a scan void yaz_scan(resource $id, string $type, string $startterm [, array $flags = '']) No value is returned. (PHP 4 >= 4.0.5, PECL yaz >= 0.9.0)") (versions . "PHP 4 >= 4.0.5, PECL yaz >= 0.9.0") (return . "No value is returned.
") (prototype . "void yaz_scan(resource $id, string $type, string $startterm [, array $flags = ''])") (purpose . "Prepares for a scan") (id . "function.yaz-scan")) "yaz_scan_result" ((documentation . "Returns Scan Response result array yaz_scan_result(resource $id [, array $result = '']) 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. (PHP 4 >= 4.0.5, PECL yaz >= 0.9.0)") (versions . "PHP 4 >= 4.0.5, PECL yaz >= 0.9.0") (return . "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.
") (prototype . "array yaz_scan_result(resource $id [, array $result = ''])") (purpose . "Returns Scan Response result") (id . "function.yaz-scan-result")) "yaz_record" ((documentation . "Returns a record string yaz_record(resource $id, int $pos, string $type) 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. (PHP 4 >= 4.0.1, PECL yaz >= 0.9.0)") (versions . "PHP 4 >= 4.0.1, PECL yaz >= 0.9.0") (return . " 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.
") (prototype . "string yaz_record(resource $id, int $pos, string $type)") (purpose . "Returns a record") (id . "function.yaz-record")) "yaz_range" ((documentation . "Specifies a range of records to retrieve void yaz_range(resource $id, int $start, int $number) No value is returned. (PHP 4 >= 4.0.1, PECL yaz >= 0.9.0)") (versions . "PHP 4 >= 4.0.1, PECL yaz >= 0.9.0") (return . "No value is returned.
") (prototype . "void yaz_range(resource $id, int $start, int $number)") (purpose . "Specifies a range of records to retrieve") (id . "function.yaz-range")) "yaz_present" ((documentation . "Prepares for retrieval (Z39.50 present) bool yaz_present(resource $id) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.5, PECL yaz >= 0.9.0)") (versions . "PHP 4 >= 4.0.5, PECL yaz >= 0.9.0") (return . " Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void yaz_itemorder(resource $id, array $args)") (purpose . "Prepares for Z39.50 Item Order with an ILL-Request package") (id . "function.yaz-itemorder")) "yaz_hits" ((documentation . "Returns number of hits for last search int yaz_hits(resource $id [, array $searchresult = '']) 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) Note: The SearchResult facility requires PECL YAZ 1.0.5 or later and YAZ 2.1.9 or later. Note: Very few Z39.50 implementations support the SearchResult facility. (PHP 4 >= 4.0.1, PECL yaz >= 0.9.0)") (versions . "PHP 4 >= 4.0.1, PECL yaz >= 0.9.0") (return . "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.
| 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) |
Note:
The SearchResult facility requires PECL YAZ 1.0.5 or later and YAZ 2.1.9 or later.
") (prototype . "int yaz_hits(resource $id [, array $searchresult = ''])") (purpose . "Returns number of hits for last search") (id . "function.yaz-hits")) "yaz_get_option" ((documentation . "Returns value of option for connection string yaz_get_option(resource $id, string $name) Returns the value of the specified option or an empty string if the option wasn't set. (PECL yaz >= 0.9.0)") (versions . "PECL yaz >= 0.9.0") (return . "Note:
Very few Z39.50 implementations support the SearchResult facility.
Returns the value of the specified option or an empty string if the option wasn't set.
") (prototype . "string yaz_get_option(resource $id, string $name)") (purpose . "Returns value of option for connection") (id . "function.yaz-get-option")) "yaz_es" ((documentation . "Prepares for an Extended Service Request void yaz_es(resource $id, string $type, array $args) No value is returned. (PECL yaz >= 0.9.0)") (versions . "PECL yaz >= 0.9.0") (return . "No value is returned.
") (prototype . "void yaz_es(resource $id, string $type, array $args)") (purpose . "Prepares for an Extended Service Request") (id . "function.yaz-es")) "yaz_es_result" ((documentation . "Inspects Extended Services Result array yaz_es_result(resource $id) Returns array with element targetReference for the reference for the extended service operation (generated and returned from the server). (PHP 4 >= 4.2.0, PECL yaz >= 0.9.0)") (versions . "PHP 4 >= 4.2.0, PECL yaz >= 0.9.0") (return . "Returns array with element targetReference for the reference for the extended service operation (generated and returned from the server).
") (prototype . "array yaz_es_result(resource $id)") (purpose . "Inspects Extended Services Result") (id . "function.yaz-es-result")) "yaz_error" ((documentation . "Returns error description string yaz_error(resource $id) Returns an error text message for server (last request), identified by parameter id. An empty string is returned if the last operation was successful. (PHP 4 >= 4.0.1, PECL yaz >= 0.9.0)") (versions . "PHP 4 >= 4.0.1, PECL yaz >= 0.9.0") (return . " Returns an error text message for server (last request), identified by parameter id. An empty string is returned if the last operation was successful.
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.
") (prototype . "int yaz_errno(resource $id)") (purpose . "Returns error number") (id . "function.yaz-errno")) "yaz_element" ((documentation . "Specifies Element-Set Name for retrieval bool yaz_element(resource $id, string $elementset) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.1, PECL yaz >= 0.9.0)") (versions . "PHP 4 >= 4.0.1, PECL yaz >= 0.9.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
A connection resource on success, FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void yaz_ccl_conf(resource $id, array $config)") (purpose . "Configure CCL parser") (id . "function.yaz-ccl-conf")) "yaz_addinfo" ((documentation . "Returns additional error information string yaz_addinfo(resource $id) 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. (PHP 4 >= 4.0.1, PECL yaz >= 0.9.0)") (versions . "PHP 4 >= 4.0.1, PECL yaz >= 0.9.0") (return . "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.
") (prototype . "string yaz_addinfo(resource $id)") (purpose . "Returns additional error information") (id . "function.yaz-addinfo")) "tcpwrap_check" ((documentation . "Performs a tcpwrap check bool tcpwrap_check(string $daemon, string $address [, string $user = '' [, bool $nodns = false]]) This function returns TRUE if access should be granted, FALSE otherwise. (PECL tcpwrap >= 0.1.0)") (versions . "PECL tcpwrap >= 0.1.0") (return . " This function returns TRUE if access should be granted, FALSE otherwise.
Returns new revision number on success, returns FALSE on failure.
Returns a numerically indexed array of associative arrays detailing the status of items in the repository:
Array ( [0] => Array ( // information on item ) [1] => ...)
The information on the item is an associative array that can contain the following keys:
update was set to TRUE. Refer to status constants for possible values. update was set to TRUE. Refer to status constants for possible values. TRUE.) TRUE.) TRUE) These keys are only set if the item is versioned:
<?php
if (!defined('svn_wc_schedule_normal')) {
define('svn_wc_schedule_normal', 0); // nothing special
define('svn_wc_schedule_add', 1); // item will be added
define('svn_wc_schedule_delete', 2); // item will be deleted
define('svn_wc_schedule_replace', 3); // item will be added and deleted
}
?>TRUE.) TRUE.) TRUE.) update.) update.) update.) Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
On success, this function returns an array file listing in the format of:
[0] => 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] => ...
On success, this function returns an array file listing in the format of:
[0] => 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] => ...Note:
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:
| 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.
") (prototype . "array svn_log(string $repos_url [, int $start_revision = '' [, int $end_revision = '' [, int $limit = '' [, int $flags = SVN_DISCOVER_CHANGED_PATHS | SVN_STOP_ON_COPY]]]])") (purpose . "Returns the commit log messages of a repository URL") (id . "function.svn-log")) "svn_import" ((documentation . "Imports an unversioned path into a repository bool svn_import(string $path, string $url, bool $nonrecursive) Returns TRUE on success or FALSE on failure. (PECL svn >= 0.2.0)") (versions . "PECL svn >= 0.2.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
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.
") (prototype . "array svn_diff(string $path1, int $rev1, string $path2, int $rev2)") (purpose . "Recursively diffs two paths") (id . "function.svn-diff")) "svn_delete" ((documentation . "Delete items from a working copy or repository. bool svn_delete(string $path [, bool $force = false]) Returns TRUE on success or FALSE on failure. (PECL svn >= 0.4.0)") (versions . "PECL svn >= 0.4.0") (return . " Returns TRUE on success or FALSE on failure.
Returns array in form of:
array( 0 => integer revision number of commit 1 => string ISO 8601 date and time of commit 2 => name of committer)
Returns FALSE on failure.
String version number, usually in form of x.y.z.
") (prototype . "string svn_client_version()") (purpose . "Returns the version of the SVN client libraries") (id . "function.svn-client-version")) "svn_cleanup" ((documentation . "Recursively cleanup a working copy directory, finishing incomplete operations and removing locks bool svn_cleanup(string $workingdir) Returns TRUE on success or FALSE on failure. (PECL svn >= 0.1.0)") (versions . "PECL svn >= 0.1.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the string contents of the item from the repository on success, and FALSE on failure.
An array of SVN blame information separated by line which includes the revision number, line number, line of code, author, and date.
") (prototype . "array svn_blame(string $repository_url [, int $revision_no = SVN_REVISION_HEAD])") (purpose . "Get the SVN blame for a file") (id . "function.svn-blame")) "svn_auth_set_parameter" ((documentation . "Sets an authentication parameter void svn_auth_set_parameter(string $key, string $value) No value is returned. (PECL svn >= 0.1.0)") (versions . "PECL svn >= 0.1.0") (return . "No value is returned.
") (prototype . "void svn_auth_set_parameter(string $key, string $value)") (purpose . "Sets an authentication parameter") (id . "function.svn-auth-set-parameter")) "svn_auth_get_parameter" ((documentation . "Retrieves authentication parameter string svn_auth_get_parameter(string $key) Returns the string value of the parameter at key; returns NULL if parameter does not exist. (PECL svn >= 0.1.0)") (versions . "PECL svn >= 0.1.0") (return . " Returns the string value of the parameter at key; returns NULL if parameter does not exist.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
") (prototype . "array stomp_read_frame([string $class_name = \"stompFrame\", resource $link])") (purpose . "Reads the next frame") (id . "stomp.readframe")) "stomp_has_frame" ((documentation . "Indicates whether or not there is a frame ready to read bool stomp_has_frame(resource $link) Returns TRUE if a frame is ready to read, or FALSE otherwise. (PECL stomp >= 0.1.0)") (versions . "PECL stomp >= 0.1.0") (return . "Note:
A transaction header may be specified, indicating that the message acknowledgment should be part of the named transaction.
Returns TRUE if a frame is ready to read, or FALSE otherwise.
string session id on success or FALSE on failure.
Returns an array with 2 elements: sec and usec.
") (prototype . "array stomp_get_read_timeout(resource $link)") (purpose . "Gets read timeout") (id . "stomp.getreadtimeout")) "stomp_error" ((documentation . "Gets the last stomp error string stomp_error(resource $link) Returns an error string or FALSE if no error occurred. (PECL stomp >= 0.1.0)") (versions . "PECL stomp >= 0.1.0") (return . " Returns an error string or FALSE if no error occurred.
Returns TRUE on success or FALSE on failure.
") (prototype . "resource stomp_connect([string $broker = ini_get(\"stomp.default_broker_uri\") [, string $username = '' [, string $password = '' [, array $headers = '']]]])") (purpose . "Opens a connection") (id . "stomp.construct")) "stomp_commit" ((documentation . "Commits a transaction in progress bool stomp_commit(string $transaction_id [, array $headers = '', resource $link]) Returns TRUE on success or FALSE on failure. (PECL stomp >= 0.1.0)") (versions . "PECL stomp >= 0.1.0") (return . "Note:
A transaction header may be specified, indicating that the message acknowledgment should be part of the named transaction.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
It returns the current stomp extension version
") (prototype . "string stomp_version()") (purpose . "Gets the current stomp extension version") (id . "function.stomp-version")) "stomp_connect_error" ((documentation . "Returns a string description of the last connect error string stomp_connect_error() A string that describes the error, or NULL if no error occurred. (PECL stomp >= 0.3.0)") (versions . "PECL stomp >= 0.3.0") (return . " A string that describes the error, or NULL if no error occurred.
") (prototype . "resource ssh2_tunnel(resource $session, string $host, int $port)") (purpose . "Open a tunnel through a remote server") (id . "function.ssh2-tunnel")) "ssh2_shell" ((documentation . "Request an interactive shell resource ssh2_shell(resource $session [, string $term_type = \"vanilla\" [, array $env = '' [, int $width = 80 [, int $height = 25 [, int $width_height_type = SSH2_TERM_UNIT_CHARS]]]]]) (PECL ssh2 >= 0.9.0)") (versions . "PECL ssh2 >= 0.9.0") (return . "
") (prototype . "resource ssh2_shell(resource $session [, string $term_type = \"vanilla\" [, array $env = '' [, int $width = 80 [, int $height = 25 [, int $width_height_type = SSH2_TERM_UNIT_CHARS]]]]])") (purpose . "Request an interactive shell") (id . "function.ssh2-shell")) "ssh2_sftp" ((documentation . #("Initialize SFTP subsystem resource ssh2_sftp(resource $session) This method returns an SSH2 SFTP resource for use with all other ssh2_sftp_*() methods and the ssh2.sftp:// fopen wrapper. (PECL ssh2 >= 0.9.0)" 161 173 (shr-url "wrappers.ssh2.html"))) (versions . "PECL ssh2 >= 0.9.0") (return . "
This method returns an SSH2 SFTP resource for use with all other ssh2_sftp_*() methods and the ssh2.sftp:// fopen wrapper.
") (prototype . "resource ssh2_sftp(resource $session)") (purpose . "Initialize SFTP subsystem") (id . "function.ssh2-sftp")) "ssh2_sftp_unlink" ((documentation . "Delete a file bool ssh2_sftp_unlink(resource $sftp, string $filename) Returns TRUE on success or FALSE on failure. (PECL ssh2 >= 0.9.0)") (versions . "PECL ssh2 >= 0.9.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
See the documentation for stat for details on the values which may be returned.
") (prototype . "array ssh2_sftp_stat(resource $sftp, string $path)") (purpose . "Stat a file on a remote filesystem") (id . "function.ssh2-sftp-stat")) "ssh2_sftp_rmdir" ((documentation . "Remove a directory bool ssh2_sftp_rmdir(resource $sftp, string $dirname) Returns TRUE on success or FALSE on failure. (PECL ssh2 >= 0.9.0)") (versions . "PECL ssh2 >= 0.9.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the real path as a string.
") (prototype . "string ssh2_sftp_realpath(resource $sftp, string $filename)") (purpose . "Resolve the realpath of a provided path string") (id . "function.ssh2-sftp-realpath")) "ssh2_sftp_readlink" ((documentation . "Return the target of a symbolic link string ssh2_sftp_readlink(resource $sftp, string $link) Returns the target of the symbolic link. (PECL ssh2 >= 0.9.0)") (versions . "PECL ssh2 >= 0.9.0") (return . " Returns the target of the symbolic link.
Returns TRUE on success or FALSE on failure.
See the documentation for stat for details on the values which may be returned.
") (prototype . "array ssh2_sftp_lstat(resource $sftp, string $path)") (purpose . "Stat a symbolic link") (id . "function.ssh2-sftp-lstat")) "ssh2_sftp_chmod" ((documentation . "Changes file mode bool ssh2_sftp_chmod(resource $sftp, string $filename, int $mode) Returns TRUE on success or FALSE on failure. (PECL ssh2 >= 0.12)") (versions . "PECL ssh2 >= 0.12") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns a numerically indexed array of keys, each of which is an associative array containing: name, blob, and attrs 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. |
Returns an SSH2 Publickey Subsystem resource for use with all other ssh2_publickey_*() methods or FALSE on failure.
Returns TRUE on success or FALSE on failure.
") (prototype . "array ssh2_methods_negotiated(resource $session)") (purpose . "Return list of negotiated methods") (id . "function.ssh2-methods-negotiated")) "ssh2_fingerprint" ((documentation . "Retrieve fingerprint of remote server string ssh2_fingerprint(resource $session [, int $flags = SSH2_FINGERPRINT_MD5 | SSH2_FINGERPRINT_HEX]) Returns the hostkey hash as a string. (PECL ssh2 >= 0.9.0)") (versions . "PECL ssh2 >= 0.9.0") (return . "
Returns the hostkey hash as a string.
") (prototype . "string ssh2_fingerprint(resource $session [, int $flags = SSH2_FINGERPRINT_MD5 | SSH2_FINGERPRINT_HEX])") (purpose . "Retrieve fingerprint of remote server") (id . "function.ssh2-fingerprint")) "ssh2_fetch_stream" ((documentation . "Fetch an extended data stream resource ssh2_fetch_stream(resource $channel, int $streamid) Returns the requested stream resource. (PECL ssh2 >= 0.9.0)") (versions . "PECL ssh2 >= 0.9.0") (return . "Returns the requested stream resource.
") (prototype . "resource ssh2_fetch_stream(resource $channel, int $streamid)") (purpose . "Fetch an extended data stream") (id . "function.ssh2-fetch-stream")) "ssh2_exec" ((documentation . "Execute a command on a remote server resource ssh2_exec(resource $session, string $command [, string $pty = '' [, array $env = '' [, int $width = 80 [, int $height = 25 [, int $width_height_type = SSH2_TERM_UNIT_CHARS]]]]]) Returns a stream on success or FALSE on failure. (PECL ssh2 >= 0.9.0)") (versions . "PECL ssh2 >= 0.9.0") (return . " Returns a stream on success or FALSE on failure.
Returns a resource on success, or FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE if the server does accept "none" as an authentication method, or an array of accepted authentication methods on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the number of bytes successfully written to the socket or FALSE on failure. The error code can be retrieved with socket_last_error. This code may be passed to socket_strerror to get a textual explanation of the error.
") (prototype . "int socket_write(resource $socket, string $buffer [, int $length = ''])") (purpose . "Write to a socket") (id . "function.socket-write")) "socket_strerror" ((documentation . "Return a string describing a socket error string socket_strerror(int $errno) Returns the error message associated with the errno parameter. (PHP 4 >= 4.1.0, PHP 5)") (versions . "PHP 4 >= 4.1.0, PHP 5") (return . "Note:
It is perfectly valid for socket_write to return zero which means no bytes have been written. Be sure to use the === operator to check for
FALSEin case of an error.
Returns the error message associated with the errno parameter.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
socket_sendto returns the number of bytes sent to the remote host, or FALSE if an error occurred.
") (prototype . "int socket_sendmsg(resource $socket, array $message, int $flags)") (purpose . "Send a message") (id . "function.socket-sendmsg")) "socket_send" ((documentation . "Sends data to a connected socket int socket_send(resource $socket, string $buf, int $len, int $flags) socket_send returns the number of bytes sent, or FALSE on error. (PHP 4 >= 4.1.0, PHP 5)") (versions . "PHP 4 >= 4.1.0, PHP 5") (return . "
socket_send returns the number of bytes sent, or FALSE on error.
On success socket_select returns the number of socket resources contained in the modified arrays, which may be zero if the timeout expires before anything interesting happens. On error FALSE is returned. The error code can be retrieved with socket_last_error.
") (prototype . "int socket_select(array $read, array $write, array $except, int $tv_sec [, int $tv_usec = ''])") (purpose . "Runs the select() system call on the given arrays of sockets with a specified timeout") (id . "function.socket-select")) "socket_recvmsg" ((documentation . "Read a message int socket_recvmsg(resource $socket, string $message [, int $flags = '']) (PHP 5 >= 5.5.0)") (versions . "PHP 5 >= 5.5.0") (return . "Note:
Be sure to use the === operator when checking for an error. Since the socket_select may return 0 the comparison with == would evaluate to
TRUE:Example # Understanding socket_select's result
<?php
$e = NULL;
if (false === socket_select($r, $w, $e, 0)) {
echo \"socket_select() failed, reason: \" .
socket_strerror(socket_last_error()) . \"\\n\";
}
?>
") (prototype . "int socket_recvmsg(resource $socket, string $message [, int $flags = ''])") (purpose . "Read a message") (id . "function.socket-recvmsg")) "socket_recvfrom" ((documentation . "Receives data from a socket whether or not it is connection-oriented int socket_recvfrom(resource $socket, string $buf, int $len, int $flags, string $name [, int $port = '']) socket_recvfrom returns the number of bytes received, or FALSE if there was an error. The actual error code can be retrieved by calling socket_last_error. This error code may be passed to socket_strerror to get a textual explanation of the error. (PHP 4 >= 4.1.0, PHP 5)") (versions . "PHP 4 >= 4.1.0, PHP 5") (return . "
socket_recvfrom returns the number of bytes received, or FALSE if there was an error. The actual error code can be retrieved by calling socket_last_error. This error code may be passed to socket_strerror to get a textual explanation of the error.
socket_recv returns the number of bytes received, or FALSE if there was an error. The actual error code can be retrieved by calling socket_last_error. This error code may be passed to socket_strerror to get a textual explanation of the error.
socket_read returns the data as a string on success, or FALSE on error (including if the remote host has closed the connection). The error code can be retrieved with socket_last_error. This code may be passed to socket_strerror to get a textual representation of the error.
") (prototype . "string socket_read(resource $socket, int $length [, int $type = PHP_BINARY_READ])") (purpose . "Reads a maximum of length bytes from a socket") (id . "function.socket-read")) "socket_listen" ((documentation . "Listens for a connection on a socket bool socket_listen(resource $socket [, int $backlog = '']) Returns TRUE on success or FALSE on failure. The error code can be retrieved with socket_last_error. This code may be passed to socket_strerror to get a textual explanation of the error. (PHP 4 >= 4.1.0, PHP 5)") (versions . "PHP 4 >= 4.1.0, PHP 5") (return . "Note:
socket_read returns a zero length string ("") when there is no more data to read.
Returns TRUE on success or FALSE on failure. The error code can be retrieved with socket_last_error. This code may be passed to socket_strerror to get a textual explanation of the error.
This function returns a socket error code.
") (prototype . "int socket_last_error([resource $socket = ''])") (purpose . "Returns the last error on the socket") (id . "function.socket-last-error")) "socket_import_stream" ((documentation . "Import a stream resource socket_import_stream(resource $stream) Returns FALSE or NULL on failure. (PHP 5 >= 5.4.0)") (versions . "PHP 5 >= 5.4.0") (return . " Returns FALSE or NULL on failure.
Returns TRUE on success or FALSE on failure. socket_getsockname may also return FALSE if the socket type is not any of AF_INET, AF_INET6, or AF_UNIX, in which case the last socket error code is not updated.
Returns TRUE on success or FALSE on failure. socket_getpeername may also return FALSE if the socket type is not any of AF_INET, AF_INET6, or AF_UNIX, in which case the last socket error code is not updated.
Returns the value of the given option, or FALSE on errors.
socket_create returns a socket resource on success, or FALSE on error. The actual error code can be retrieved by calling socket_last_error. This error code may be passed to socket_strerror to get a textual explanation of the error.
Returns TRUE on success or FALSE on failure.
socket_create_listen returns a new socket resource on success or FALSE on error. The error code can be retrieved with socket_last_error. This code may be passed to socket_strerror to get a textual explanation of the error.
Returns TRUE on success or FALSE on failure. The error code can be retrieved with socket_last_error. This code may be passed to socket_strerror to get a textual explanation of the error.
") (prototype . "bool socket_connect(resource $socket, string $address [, int $port = ''])") (purpose . "Initiates a connection on a socket") (id . "function.socket-connect")) "socket_cmsg_space" ((documentation . "Calculate message buffer size int socket_cmsg_space(int $level, int $type) (PHP 5 >= 5.5.0)") (versions . "PHP 5 >= 5.5.0") (return . "Note:
If the socket is non-blocking then this function returns
FALSEwith an error Operation now in progress.
") (prototype . "int socket_cmsg_space(int $level, int $type)") (purpose . "Calculate message buffer size") (id . "function.socket-cmsg-space")) "socket_close" ((documentation . "Closes a socket resource void socket_close(resource $socket) No value is returned. (PHP 4 >= 4.1.0, PHP 5)") (versions . "PHP 4 >= 4.1.0, PHP 5") (return . "
No value is returned.
") (prototype . "void socket_close(resource $socket)") (purpose . "Closes a socket resource") (id . "function.socket-close")) "socket_clear_error" ((documentation . "Clears the error on the socket or the last error code void socket_clear_error([resource $socket = '']) No value is returned. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . "No value is returned.
") (prototype . "void socket_clear_error([resource $socket = ''])") (purpose . "Clears the error on the socket or the last error code") (id . "function.socket-clear-error")) "socket_bind" ((documentation . "Binds a name to a socket bool socket_bind(resource $socket, string $address [, int $port = '']) Returns TRUE on success or FALSE on failure. The error code can be retrieved with socket_last_error. This code may be passed to socket_strerror to get a textual explanation of the error. (PHP 4 >= 4.1.0, PHP 5)") (versions . "PHP 4 >= 4.1.0, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
The error code can be retrieved with socket_last_error. This code may be passed to socket_strerror to get a textual explanation of the error.
") (prototype . "bool socket_bind(resource $socket, string $address [, int $port = ''])") (purpose . "Binds a name to a socket") (id . "function.socket-bind")) "socket_accept" ((documentation . "Accepts a connection on a socket resource socket_accept(resource $socket) Returns a new socket resource on success, or FALSE on error. The actual error code can be retrieved by calling socket_last_error. This error code may be passed to socket_strerror to get a textual explanation of the error. (PHP 4 >= 4.1.0, PHP 5)") (versions . "PHP 4 >= 4.1.0, PHP 5") (return . " Returns a new socket resource on success, or FALSE on error. The actual error code can be retrieved by calling socket_last_error. This error code may be passed to socket_strerror to get a textual explanation of the error.
Returns an associative array with object ids and their respective object value starting from the object_id as root or FALSE on error.
Returns an array of SNMP object values starting from the object_id as root or FALSE on error.
Returns TRUE on success or FALSE on failure.
If the SNMP host rejects the data type, an E_WARNING message like "Warning: Error in packet. Reason: (badValue) The value given has the wrong type or length." is shown. If an unknown or invalid OID is specified the warning probably reads "Could not add variable".
") (prototype . "bool snmpset(string $host, string $community, string $object_id, string $type, mixed $value [, int $timeout = 1000000 [, int $retries = 5]])") (purpose . "Set the value of an SNMP object") (id . "function.snmpset")) "snmprealwalk" ((documentation . "Return all objects including their respective object ID within the specified one array snmprealwalk(string $host, string $community, string $object_id [, int $timeout = 1000000 [, int $retries = 5]]) Returns an associative array of the SNMP object ids and their values on success or FALSE on error. In case of an error, an E_WARNING message is shown. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns an associative array of the SNMP object ids and their values on success or FALSE on error. In case of an error, an E_WARNING message is shown.
Returns SNMP object value on success or FALSE on error. In case of an error, an E_WARNING message is shown.
Returns SNMP object value on success or FALSE on error.
Returns an array of SNMP object values starting from the object_id as root or FALSE on error.
Returns TRUE on success or FALSE on failure.
If the SNMP host rejects the data type, an E_WARNING message like "Warning: Error in packet. Reason: (badValue) The value given has the wrong type or length." is shown. If an unknown or invalid OID is specified the warning probably reads "Could not add variable".
") (prototype . "bool snmp3_set(string $host, string $sec_name, string $sec_level, string $auth_protocol, string $auth_passphrase, string $priv_protocol, string $priv_passphrase, string $object_id, string $type, string $value [, int $timeout = 1000000 [, int $retries = 5]])") (purpose . "Set the value of an SNMP object") (id . "function.snmp3-set")) "snmp3_real_walk" ((documentation . "Return all objects including their respective object ID within the specified one array snmp3_real_walk(string $host, string $sec_name, string $sec_level, string $auth_protocol, string $auth_passphrase, string $priv_protocol, string $priv_passphrase, string $object_id [, string $timeout = 1000000 [, string $retries = 5]]) Returns an associative array of the SNMP object ids and their values on success or FALSE on error. In case of an error, an E_WARNING message is shown. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns an associative array of the SNMP object ids and their values on success or FALSE on error. In case of an error, an E_WARNING message is shown.
Returns SNMP object value on success or FALSE on error. In case of an error, an E_WARNING message is shown.
Returns SNMP object value on success or FALSE on error.
Returns an array of SNMP object values starting from the object_id as root or FALSE on error.
Returns TRUE on success or FALSE on failure.
If the SNMP host rejects the data type, an E_WARNING message like "Warning: Error in packet. Reason: (badValue) The value given has the wrong type or length." is shown. If an unknown or invalid OID is specified the warning probably reads "Could not add variable".
") (prototype . "bool snmp2_set(string $host, string $community, string $object_id, string $type, string $value [, string $timeout = 1000000 [, string $retries = 5]])") (purpose . "Set the value of an SNMP object") (id . "function.snmp2-set")) "snmp2_real_walk" ((documentation . "Return all objects including their respective object ID within the specified one array snmp2_real_walk(string $host, string $community, string $object_id [, string $timeout = 1000000 [, string $retries = 5]]) Returns an associative array of the SNMP object ids and their values on success or FALSE on error. In case of an error, an E_WARNING message is shown. (PHP >= 5.2.0)") (versions . "PHP >= 5.2.0") (return . " Returns an associative array of the SNMP object ids and their values on success or FALSE on error. In case of an error, an E_WARNING message is shown.
Returns SNMP object value on success or FALSE on error. In case of an error, an E_WARNING message is shown.
Returns SNMP object value on success or FALSE on error.
No value is returned.
") (prototype . "bool snmp_set_quick_print(bool $quick_print)") (purpose . "Set the value of quick_print within the UCD SNMP library") (id . "function.snmp-set-quick-print")) "snmp_set_oid_output_format" ((documentation . "Set the OID output format bool snmp_set_oid_output_format(int $oid_format) No value is returned. (PHP 5 >= 5.2.0)") (versions . "PHP 5 >= 5.2.0") (return . "No value is returned.
") (prototype . "bool snmp_set_oid_output_format(int $oid_format)") (purpose . "Set the OID output format") (id . "function.snmp-set-oid-output-format")) "snmp_set_oid_numeric_print" ((documentation . "Set the OID output format void snmp_set_oid_numeric_print(int $oid_format) (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . "") (prototype . "void snmp_set_oid_numeric_print(int $oid_format)") (purpose . "Set the OID output format") (id . "function.snmp-set-oid-numeric-print")) "snmp_set_enum_print" ((documentation . "Return all values that are enums with their enum value instead of the raw integer bool snmp_set_enum_print(int $enum_print) (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . "") (prototype . "bool snmp_set_enum_print(int $enum_print)") (purpose . "Return all values that are enums with their enum value instead of the raw integer") (id . "function.snmp-set-enum-print")) "snmp_read_mib" ((documentation . "Reads and parses a MIB file into the active MIB tree bool snmp_read_mib(string $filename) (PHP 5)") (versions . "PHP 5") (return . "") (prototype . "bool snmp_read_mib(string $filename)") (purpose . "Reads and parses a MIB file into the active MIB tree") (id . "function.snmp-read-mib")) "snmp_get_valueretrieval" ((documentation . "Return the method how the SNMP values will be returned int snmp_get_valueretrieval() OR-ed combitantion of constants ( SNMP_VALUE_LIBRARY or SNMP_VALUE_PLAIN ) with possible SNMP_VALUE_OBJECT set. (PHP 4 >= 4.3.3, PHP 5)") (versions . "PHP 4 >= 4.3.3, PHP 5") (return . " OR-ed combitantion of constants ( SNMP_VALUE_LIBRARY or SNMP_VALUE_PLAIN ) with possible SNMP_VALUE_OBJECT set.
Returns TRUE if quick_print is on, FALSE otherwise.
No value is returned.
") (prototype . "void rrdc_disconnect()") (purpose . "Close any outstanding connection to rrd caching daemon") (id . "function.rrdc-disconnect")) "rrd_xport" ((documentation . "Exports the information about RRD database. array rrd_xport(array $options) Array with information about RRD database file, FALSE when error occurs. (PECL rrd >= 0.9.0)") (versions . "PECL rrd >= 0.9.0") (return . " Array with information about RRD database file, FALSE when error occurs.
String with rrdtool version number e.g. "1.4.3".
") (prototype . "string rrd_version()") (purpose . "Gets information about underlying rrdtool library") (id . "function.rrd-version")) "rrd_update" ((documentation . "Updates the RRD database. bool rrd_update(string $filename, array $options) Returns TRUE on success, FALSE when error occurs. (PECL rrd >= 0.9.0)") (versions . "PECL rrd >= 0.9.0") (return . " Returns TRUE on success, FALSE when error occurs.
Returns TRUE on success, FALSE otherwise.
Returns TRUE on success, FALSE otherwise.
Array of information about last update, FALSE when error occurs.
Integer as unix timestamp of the most recent data from the RRD database.
") (prototype . "int rrd_last(string $filename)") (purpose . "Gets unix timestamp of the last sample.") (id . "function.rrd-last")) "rrd_info" ((documentation . "Gets information about rrd file array rrd_info(string $filename) Array with information about requsted RRD file, FALSE when error occurs. (PECL rrd >= 0.9.0)") (versions . "PECL rrd >= 0.9.0") (return . " Array with information about requsted RRD file, FALSE when error occurs.
Array with information about generated image is returned, FALSE when error occurs.
Integer number of unix timestamp, FALSE if some error occurs.
Returns information about retrieved graph data.
") (prototype . "array rrd_fetch(string $filename, array $options)") (purpose . "Fetch the data for graph as array.") (id . "function.rrd-fetch")) "rrd_error" ((documentation . "Gets latest error message. string rrd_error() Latest error message. (PECL rrd >= 0.9.0)") (versions . "PECL rrd >= 0.9.0") (return . "Latest error message.
") (prototype . "string rrd_error()") (purpose . "Gets latest error message.") (id . "function.rrd-error")) "rrd_create" ((documentation . "Creates rrd database file bool rrd_create(string $filename, array $options) Returns TRUE on success or FALSE on failure. (PECL rrd >= 0.9.0)") (versions . "PECL rrd >= 0.9.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
If output exists prior to calling this function, setcookie will fail and return FALSE. If setcookie successfully runs, it will return TRUE. This does not indicate whether the user accepted the cookie.
Returns TRUE on success or FALSE on failure.
Returns the Internet IP address as a string.
") (prototype . "string long2ip(string $proper_address)") (purpose . "Converts an (IPv4) Internet network address into a string in Internet standard dotted format") (id . "function.long2ip")) "ip2long" ((documentation . "Converts a string containing an (IPv4) Internet Protocol dotted address into a proper address int ip2long(string $ip_address) Returns the IPv4 address or FALSE if ip_address is invalid. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns the IPv4 address or FALSE if ip_address is invalid.
Returns the in_addr representation of the given address, or FALSE if a syntactically invalid address is given (for example, an IPv4 address without dots or an IPv6 address without colons).
Returns a string representation of the address or FALSE on failure.
The current response code. By default the return value is int(200).
") (prototype . "int http_response_code([int $response_code = ''])") (purpose . "Get or Set the HTTP response code") (id . "function.http-response-code")) "headers_sent" ((documentation . "Checks if or where headers have been sent bool headers_sent([string $file = '' [, int $line = '']]) headers_sent will return FALSE if no HTTP headers have already been sent or TRUE otherwise. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " headers_sent will return FALSE if no HTTP headers have already been sent or TRUE otherwise.
Returns a numerically indexed array of headers.
") (prototype . "array headers_list()") (purpose . "Returns a list of response headers sent (or ready to send)") (id . "function.headers-list")) "header" ((documentation . "Send a raw HTTP header void header(string $string [, bool $replace = true [, int $http_response_code = '']]) No value is returned. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "No value is returned.
") (prototype . "void header(string $string [, bool $replace = true [, int $http_response_code = '']])") (purpose . "Send a raw HTTP header") (id . "function.header")) "header_remove" ((documentation . "Remove previously set headers void header_remove([string $name = '']) No value is returned. (PHP 5 >= 5.3.0)") (versions . "PHP 5 >= 5.3.0") (return . "No value is returned.
") (prototype . "void header_remove([string $name = ''])") (purpose . "Remove previously set headers") (id . "function.header-remove")) "header_register_callback" ((documentation . "Call a header function bool header_register_callback(callable $callback) Returns TRUE on success or FALSE on failure. ()") (versions . "") (return . " Returns TRUE on success or FALSE on failure.
Returns the Internet service name as a string.
") (prototype . "string getservbyport(int $port, string $protocol)") (purpose . "Get Internet service which corresponds to port and protocol") (id . "function.getservbyport")) "getservbyname" ((documentation . "Get port number associated with an Internet service and protocol int getservbyname(string $service, string $protocol) Returns the port number, or FALSE if service or protocol is not found. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns the port number, or FALSE if service or protocol is not found.
Returns the protocol name as a string, or FALSE on failure.
Returns the protocol number, or FALSE on failure.
Returns TRUE if any records are found; returns FALSE if no records were found or if an error occurred.
Returns a string with the hostname on success, otherwise FALSE is returned.
Returns an array of IPv4 addresses or FALSE if hostname could not be resolved.
Returns the IPv4 address or a string containing the unmodified hostname on failure.
Returns the host name on success, the unmodified ip_address on failure, or FALSE on malformed input.
fsockopen returns a file pointer which may be used together with the other file functions (such as fgets, fgetss, fwrite, fclose, and feof). If the call fails, it will return FALSE
This function returns an array of associative arrays, or FALSE on failure. Each associative array contains at minimum the following keys:
| Attribute | Meaning |
|---|---|
| host | The record in the DNS namespace to which the rest of the associated data refers. |
| class | dns_get_record only returns Internet class records and as such this parameter will always return IN. |
| type | String containing the record type. Additional attributes will also be contained in the resulting array dependant on the value of type. See table below. |
| ttl | "Time To Live" remaining for this record. This will not equal the record's original ttl, but will rather equal the original ttl minus whatever length of time has passed since the authoritative name server was queried. |
| Type | Extra Columns |
|---|---|
| A | ip: An IPv4 addresses in dotted decimal notation. |
| MX | pri: Priority of mail exchanger. Lower numbers indicate greater priority. target: FQDN of the mail exchanger. See also dns_get_mx. |
| CNAME | target: FQDN of location in DNS namespace to which the record is aliased. |
| NS | target: FQDN of the name server which is authoritative for this hostname. |
| PTR | target: Location within the DNS namespace to which this record points. |
| TXT | txt: Arbitrary string data associated with this record. |
| HINFO | cpu: IANA number designating the CPU of the machine referenced by this record. os: IANA number designating the Operating System on the machine referenced by this record. See IANA's » Operating System Names for the meaning of these values. |
| SOA | mname: FQDN of the machine from which the resource records originated. rname: Email address of the administrative contain for this domain. serial: Serial # of this revision of the requested domain. refresh: Refresh interval (seconds) secondary name servers should use when updating remote copies of this domain. retry: Length of time (seconds) to wait after a failed refresh before making a second attempt. expire: Maximum length of time (seconds) a secondary DNS server should retain remote copies of the zone data without a successful refresh before discarding. minimum-ttl: Minimum length of time (seconds) a client can continue to use a DNS resolution before it should request a new resolution from the server. Can be overridden by individual resource records. |
| AAAA | ipv6: IPv6 address |
| A6(PHP >= 5.1.0) | masklen: Length (in bits) to inherit from the target specified by chain. ipv6: Address for this specific record to merge with chain. chain: Parent record to merge with ipv6 data. |
| SRV | pri: (Priority) lowest priorities should be used first. weight: Ranking to weight which of commonly prioritized targets should be chosen at random. target and port: hostname and port where the requested service can be found. For additional information see: » RFC 2782 |
| NAPTR | order and pref: Equivalent to pri and weight above. flags, services, regex, and replacement: Parameters as defined by » RFC 2915. |
No value is returned.
| Variable | Constant equal | Meaning | Notes |
|---|---|---|---|
| $LOG_EMERG | LOG_EMERG | System is unusable | |
| $LOG_ALERT | LOG_ALERT | Immediate action required | |
| $LOG_CRIT | LOG_CRIT | Critical conditions | |
| $LOG_ERR | LOG_ERR | ||
| $LOG_WARNING | LOG_WARNING | ||
| $LOG_NOTICE | LOG_NOTICE | ||
| $LOG_INFO | LOG_INFO | ||
| $LOG_DEBUG | LOG_DEBUG | ||
| $LOG_KERN | LOG_KERN | ||
| $LOG_USER | LOG_USER | Genetic user level | |
| $LOG_MAIL | LOG_MAIL | Log to email | |
| $LOG_DAEMON | LOG_DAEMON | Other system daemons | |
| $LOG_AUTH | LOG_AUTH | ||
| $LOG_SYSLOG | LOG_SYSLOG | Not available on Netware | |
| $LOG_LPR | LOG_LPR | ||
| $LOG_NEWS | LOG_NEWS | Usenet new | Not available on HP-UX |
| $LOG_CRON | LOG_CRON | Not available on all platforms | |
| $LOG_AUTHPRIV | LOG_AUTHPRIV | Not available on AIX | |
| $LOG_LOCAL0 | LOG_LOCAL0 | Not available on Windows and Netware | |
| $LOG_LOCAL1 | LOG_LOCAL1 | Not available on Windows and Netware | |
| $LOG_LOCAL2 | LOG_LOCAL2 | Not available on Windows and Netware | |
| $LOG_LOCAL3 | LOG_LOCAL3 | Not available on Windows and Netware | |
| $LOG_LOCAL4 | LOG_LOCAL4 | Not available on Windows and Netware | |
| $LOG_LOCAL5 | LOG_LOCAL5 | Not available on Windows and Netware | |
| $LOG_LOCAL6 | LOG_LOCAL6 | Not available on Windows and Netware | |
| $LOG_LOCAL7 | LOG_LOCAL7 | Not available on Windows and Netware | |
| $LOG_PID | LOG_PID | ||
| $LOG_CONS | LOG_CONS | ||
| $LOG_ODELAY | LOG_ODELAY | ||
| $LOG_NDELAY | LOG_NDELAY | ||
| $LOG_NOWAIT | LOG_NOWAIT | Not available on BeOS | |
| $LOG_PERROR | LOG_PERROR | Not available on AIX |
This function has beenDEPRECATED as of PHP 5.3.0 and REMOVED as of PHP 5.4.0.
Returns TRUE on success or FALSE on failure.
Returns TRUE if any records are found; returns FALSE if no records were found or if an error occurred.
string representation of the reason code message.
") (prototype . "string mqseries_strerror(int $reason)") (purpose . "Returns the error message corresponding to a result code (MQRC).") (id . "function.mqseries-strerror")) "mqseries_set" ((documentation . "MQSeries MQSET void mqseries_set(resource $hconn, resource $hobj, int $selectorcount, array $selectors, int $intattrcount, array $intattrs, int $charattrlength, array $charattrs, resource $compCode, resource $reason) No value is returned. (PECL mqseries >= 0.10.0)") (versions . "PECL mqseries >= 0.10.0") (return . "No value is returned.
") (prototype . "void mqseries_set(resource $hconn, resource $hobj, int $selectorcount, array $selectors, int $intattrcount, array $intattrs, int $charattrlength, array $charattrs, resource $compCode, resource $reason)") (purpose . "MQSeries MQSET") (id . "function.mqseries-set")) "mqseries_put" ((documentation . "MQSeries MQPUT void mqseries_put(resource $hConn, resource $hObj, array $md, array $pmo, string $message, resource $compCode, resource $reason) No value is returned. (PECL mqseries >= 0.10.0)") (versions . "PECL mqseries >= 0.10.0") (return . "No value is returned.
") (prototype . "void mqseries_put(resource $hConn, resource $hObj, array $md, array $pmo, string $message, resource $compCode, resource $reason)") (purpose . "MQSeries MQPUT") (id . "function.mqseries-put")) "mqseries_put1" ((documentation . "MQSeries MQPUT1 void mqseries_put1(resource $hconn, resource $objDesc, resource $msgDesc, resource $pmo, string $buffer, resource $compCode, resource $reason) No value is returned. (PECL mqseries >= 0.10.0)") (versions . "PECL mqseries >= 0.10.0") (return . "No value is returned.
") (prototype . "void mqseries_put1(resource $hconn, resource $objDesc, resource $msgDesc, resource $pmo, string $buffer, resource $compCode, resource $reason)") (purpose . "MQSeries MQPUT1") (id . "function.mqseries-put1")) "mqseries_open" ((documentation . "MQSeries MQOPEN void mqseries_open(resource $hconn, array $objDesc, int $option, resource $hobj, resource $compCode, resource $reason) No value is returned. (PECL mqseries >= 0.10.0)") (versions . "PECL mqseries >= 0.10.0") (return . "No value is returned.
") (prototype . "void mqseries_open(resource $hconn, array $objDesc, int $option, resource $hobj, resource $compCode, resource $reason)") (purpose . "MQSeries MQOPEN") (id . "function.mqseries-open")) "mqseries_inq" ((documentation . "MQSeries MQINQ void mqseries_inq(resource $hconn, resource $hobj, int $selectorCount, array $selectors, int $intAttrCount, resource $intAttr, int $charAttrLength, resource $charAttr, resource $compCode, resource $reason) No value is returned. (PECL mqseries >= 0.10.0)") (versions . "PECL mqseries >= 0.10.0") (return . "No value is returned.
") (prototype . "void mqseries_inq(resource $hconn, resource $hobj, int $selectorCount, array $selectors, int $intAttrCount, resource $intAttr, int $charAttrLength, resource $charAttr, resource $compCode, resource $reason)") (purpose . "MQSeries MQINQ") (id . "function.mqseries-inq")) "mqseries_get" ((documentation . "MQSeries MQGET void mqseries_get(resource $hConn, resource $hObj, array $md, array $gmo, int $bufferLength, string $msg, int $data_length, resource $compCode, resource $reason) No value is returned. (PECL mqseries >= 0.10.0)") (versions . "PECL mqseries >= 0.10.0") (return . "No value is returned.
") (prototype . "void mqseries_get(resource $hConn, resource $hObj, array $md, array $gmo, int $bufferLength, string $msg, int $data_length, resource $compCode, resource $reason)") (purpose . "MQSeries MQGET") (id . "function.mqseries-get")) "mqseries_disc" ((documentation . "MQSeries MQDISC void mqseries_disc(resource $hconn, resource $compCode, resource $reason) No value is returned. (PECL mqseries >= 0.10.0)") (versions . "PECL mqseries >= 0.10.0") (return . "No value is returned.
") (prototype . "void mqseries_disc(resource $hconn, resource $compCode, resource $reason)") (purpose . "MQSeries MQDISC") (id . "function.mqseries-disc")) "mqseries_connx" ((documentation . "MQSeries MQCONNX void mqseries_connx(string $qManagerName, array $connOptions, resource $hconn, resource $compCode, resource $reason) No value is returned. (PECL mqseries >= 0.10.0)") (versions . "PECL mqseries >= 0.10.0") (return . "No value is returned.
") (prototype . "void mqseries_connx(string $qManagerName, array $connOptions, resource $hconn, resource $compCode, resource $reason)") (purpose . "MQSeries MQCONNX") (id . "function.mqseries-connx")) "mqseries_conn" ((documentation . "MQSeries MQCONN void mqseries_conn(string $qManagerName, resource $hconn, resource $compCode, resource $reason) No value is returned. (PECL mqseries >= 0.10.0)") (versions . "PECL mqseries >= 0.10.0") (return . "No value is returned.
") (prototype . "void mqseries_conn(string $qManagerName, resource $hconn, resource $compCode, resource $reason)") (purpose . "MQSeries MQCONN") (id . "function.mqseries-conn")) "mqseries_cmit" ((documentation . "MQSeries MQCMIT void mqseries_cmit(resource $hconn, resource $compCode, resource $reason) No value is returned. (PECL mqseries >= 0.10.0)") (versions . "PECL mqseries >= 0.10.0") (return . "No value is returned.
") (prototype . "void mqseries_cmit(resource $hconn, resource $compCode, resource $reason)") (purpose . "MQSeries MQCMIT") (id . "function.mqseries-cmit")) "mqseries_close" ((documentation . "MQSeries MQCLOSE void mqseries_close(resource $hconn, resource $hobj, int $options, resource $compCode, resource $reason) No value is returned. (PECL mqseries >= 0.10.0)") (versions . "PECL mqseries >= 0.10.0") (return . "No value is returned.
") (prototype . "void mqseries_close(resource $hconn, resource $hobj, int $options, resource $compCode, resource $reason)") (purpose . "MQSeries MQCLOSE") (id . "function.mqseries-close")) "mqseries_begin" ((documentation . "MQseries MQBEGIN void mqseries_begin(resource $hconn, array $beginOptions, resource $compCode, resource $reason) No value is returned. (PECL mqseries >= 0.10.0)") (versions . "PECL mqseries >= 0.10.0") (return . "No value is returned.
") (prototype . "void mqseries_begin(resource $hconn, array $beginOptions, resource $compCode, resource $reason)") (purpose . "MQseries MQBEGIN") (id . "function.mqseries-begin")) "mqseries_back" ((documentation . "MQSeries MQBACK void mqseries_back(resource $hconn, resource $compCode, resource $reason) No value is returned. (PECL mqseries >= 0.10.0)") (versions . "PECL mqseries >= 0.10.0") (return . "No value is returned.
") (prototype . "void mqseries_back(resource $hconn, resource $compCode, resource $reason)") (purpose . "MQSeries MQBACK") (id . "function.mqseries-back")) "memcache_debug" ((documentation . "Turn debug output on/off bool memcache_debug(bool $on_off) Returns TRUE if PHP was built with --enable-debug option, otherwise returns FALSE. (PECL memcache >= 0.2.0)") (versions . "PECL memcache >= 0.2.0") (return . " Returns TRUE if PHP was built with --enable-debug option, otherwise returns FALSE.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns a search result identifier or FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns a search result identifier or FALSE on error.
Returns entry identifier for the next entry in the result whose entries are being read starting with ldap_first_entry. If there are no more entries in the result then it returns FALSE.
Returns the next attribute in an entry on success and FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns a search result identifier or FALSE on error.
Returns an array of values for the attribute on success and FALSE on error. The number of values can be found by indexing "count" in the resultant array. Individual values are accessed by integer index in the array. The first index is 0.
LDAP allows more than one entry for an attribute, so it can, for example, store a number of email addresses for one person's directory entry all labeled with the attribute "mail"
return_value["count"] = number of values for attribute return_value[0] = first value of attribute return_value[i] = ith value of attribute
Returns an array of values for the attribute on success and FALSE on error. Individual values are accessed by integer index in the array. The first index is 0. The number of values can be found by indexing "count" in the resultant array.
Returns TRUE on success or FALSE on failure.
Returns a complete result information in a multi-dimensional array on success and FALSE on error.
The structure of the array is as follows. The attribute index is converted to lowercase. (Attributes are case-insensitive for directory servers, but not when used as array indices.)
return_value["count"] = number of entries in the resultreturn_value[0] : refers to the details of first entryreturn_value[i]["dn"] = DN of the ith entry in the resultreturn_value[i]["count"] = number of attributes in ith entryreturn_value[i][j] = NAME of the jth attribute in the ith entry in the resultreturn_value[i]["attribute"]["count"] = number of values for attribute in ith entryreturn_value[i]["attribute"][j] = jth value of attribute in ith entry
Returns the DN of the result entry and FALSE on error.
Returns a complete entry information in a multi-dimensional array on success and FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns the result entry identifier for the first entry on success and FALSE on error.
Returns the first attribute in the entry on success and FALSE on error.
Returns an array of all DN components. The first element in this array has count key and represents the number of returned values, next elements are numerically indexed DN components.
") (prototype . "array ldap_explode_dn(string $dn, int $with_attrib)") (purpose . "Splits DN into its component parts") (id . "function.ldap-explode-dn")) "ldap_error" ((documentation . "Return the LDAP error message of the last LDAP command string ldap_error(resource $link_identifier) Returns string error message. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns string error message.
") (prototype . "string ldap_error(resource $link_identifier)") (purpose . "Return the LDAP error message of the last LDAP command") (id . "function.ldap-error")) "ldap_errno" ((documentation . "Return the LDAP error number of the last LDAP command int ldap_errno(resource $link_identifier) Return the LDAP error number of the last LDAP command for this link. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Return the LDAP error number of the last LDAP command for this link.
") (prototype . "int ldap_errno(resource $link_identifier)") (purpose . "Return the LDAP error number of the last LDAP command") (id . "function.ldap-errno")) "ldap_err2str" ((documentation . "Convert LDAP error number into string error message string ldap_err2str(int $errno) Returns the error message, as a string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the error message, as a string.
") (prototype . "string ldap_err2str(int $errno)") (purpose . "Convert LDAP error number into string error message") (id . "function.ldap-err2str")) "ldap_dn2ufn" ((documentation . "Convert DN to User Friendly Naming format string ldap_dn2ufn(string $dn) Returns the user friendly name. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the user friendly name.
") (prototype . "string ldap_dn2ufn(string $dn)") (purpose . "Convert DN to User Friendly Naming format") (id . "function.ldap-dn2ufn")) "ldap_delete" ((documentation . "Delete an entry from a directory bool ldap_delete(resource $link_identifier, string $dn) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns number of entries in the result or FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns a positive LDAP link identifier on success, or FALSE on error. When OpenLDAP 2.x.x is used, ldap_connect will always return a resource as it does not actually connect but just initializes the connecting parameters. The actual connect happens with the next calls to ldap_* funcs, usually with ldap_bind.
If no arguments are specified then the link identifier of the already opened link will be returned.
") (prototype . "resource ldap_connect([string $hostname = '' [, int $port = 389]])") (purpose . "Connect to an LDAP server") (id . "function.ldap-connect")) "ldap_compare" ((documentation . "Compare value of attribute found in entry specified with DN mixed ldap_compare(resource $link_identifier, string $dn, string $attribute, string $value) Returns TRUE if value matches otherwise returns FALSE. Returns -1 on error. (PHP 4 >= 4.0.2, PHP 5)") (versions . "PHP 4 >= 4.0.2, PHP 5") (return . " Returns TRUE if value matches otherwise returns FALSE. Returns -1 on error.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Return the t61 translation of value.
Returns an exception object.
") (prototype . "object java_last_exception_get()") (purpose . "Get last Java exception") (id . "function.java-last-exception-get")) "java_last_exception_clear" ((documentation . "Clear last Java exception void java_last_exception_clear() No value is returned. (PHP 4 >= 4.0.2)") (versions . "PHP 4 >= 4.0.2") (return . "No value is returned.
") (prototype . "void java_last_exception_clear()") (purpose . "Clear last Java exception") (id . "function.java-last-exception-clear")) "hwapi_object_new" ((documentation . "Creates a new instance of class hwapi_object_new hw_api_object hwapi_object_new(array $parameter) ()") (versions . "") (return . "") (prototype . "hw_api_object hwapi_object_new(array $parameter)") (purpose . "Creates a new instance of class hwapi_object_new") (id . "function.hwapi-object-new")) "hwapi_hgcsp" ((documentation . "Returns object of class hw_api HW_API hwapi_hgcsp(string $hostname [, int $port = '']) Returns an instance of HW_API. (PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN)") (versions . "PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN") (return . "
Returns an instance of HW_API.
") (prototype . "HW_API hwapi_hgcsp(string $hostname [, int $port = ''])") (purpose . "Returns object of class hw_api") (id . "function.hwapi-hgcsp")) "hwapi_content_new" ((documentation . "Create new instance of class hw_api_content HW_API_Content hwapi_content_new(string $content, string $mimetype) ()") (versions . "") (return . "") (prototype . "HW_API_Content hwapi_content_new(string $content, string $mimetype)") (purpose . "Create new instance of class hw_api_content") (id . "function.hwapi-content-new")) "hwapi_attribute_new" ((documentation . "Creates instance of class hw_api_attribute HW_API_Attribute hwapi_attribute_new([string $name = '' [, string $value = '']]) Returns an instance of hw_api_attribute. ()") (versions . "") (return . "
Returns an instance of hw_api_attribute.
") (prototype . "HW_API_Attribute hwapi_attribute_new([string $name = '' [, string $value = '']])") (purpose . "Creates instance of class hw_api_attribute") (id . "function.hwapi-attribute-new")) "hw_Who" ((documentation . "List of currently logged in users array hw_Who(int $connection) Returns an array of users currently logged into the Hyperwave server. Each entry in this array is an array itself containing the elements id, name, system, onSinceDate, onSinceTime, TotalTime and self. 'self' is 1 if this entry belongs to the user who initiated the request. (PHP 4)") (versions . "PHP 4") (return . "Returns an array of users currently logged into the Hyperwave server. Each entry in this array is an array itself containing the elements id, name, system, onSinceDate, onSinceTime, TotalTime and self. 'self' is 1 if this entry belongs to the user who initiated the request.
") (prototype . "array hw_Who(int $connection)") (purpose . "List of currently logged in users") (id . "function.hw-who")) "hw_Unlock" ((documentation . "Unlock object bool hw_Unlock(int $connection, int $objectID) Returns TRUE on success or FALSE on failure. (PHP 4)") (versions . "PHP 4") (return . " Returns TRUE on success or FALSE on failure.
Returns 0.
") (prototype . "int hw_Root()") (purpose . "Root object id") (id . "function.hw-root")) "hw_PipeDocument" ((documentation . "Retrieve any document int hw_PipeDocument(int $connection, int $objectID [, array $url_prefixes = '']) Returns the Hyperwave document. (PHP 4)") (versions . "PHP 4") (return . "Returns the Hyperwave document.
") (prototype . "int hw_PipeDocument(int $connection, int $objectID [, array $url_prefixes = ''])") (purpose . "Retrieve any document") (id . "function.hw-pipedocument")) "hw_pConnect" ((documentation . "Make a persistent database connection int hw_pConnect(string $host, int $port [, string $username = '', string $password]) Returns a connection index on success, or FALSE if the connection could not be made. (PHP 4)") (versions . "PHP 4") (return . " Returns a connection index on success, or FALSE if the connection could not be made.
Returns TRUE on success or FALSE on failure.
Returns an array. The keys of the resulting array are the attributes names. Multi-value attributes like 'Title' in different languages form its own array. The keys of this array are the left part to the colon of the attribute value. This left part must be two characters long.
Other multi-value attributes without a prefix form an indexed array. If the optional parameter is missing the attributes 'Title', 'Description' and 'Keyword' are treated as language attributes and the attributes 'Group', 'Parent' and 'HtmlAttr' as non-prefixed multi-value attributes. By passing an array holding the type for each attribute you can alter this behaviour.
") (prototype . "array hw_objrec2array(string $object_record [, array $format = ''])") (purpose . "Convert attributes from object record to object array") (id . "function.hw-objrec2array")) "hw_New_Document" ((documentation . "Create new document int hw_New_Document(string $object_record, string $document_data, int $document_size) Returns the new Hyperwave document. (PHP 4)") (versions . "PHP 4") (return . "Returns the new Hyperwave document.
") (prototype . "int hw_New_Document(string $object_record, string $document_data, int $document_size)") (purpose . "Create new document") (id . "function.hw-new-document")) "hw_mv" ((documentation . "Moves objects int hw_mv(int $connection, array $object_id_array, int $source_id, int $destination_id) Returns the number of moved objects. (PHP 4)") (versions . "PHP 4") (return . "Returns the number of moved objects.
") (prototype . "int hw_mv(int $connection, array $object_id_array, int $source_id, int $destination_id)") (purpose . "Moves objects") (id . "function.hw-mv")) "hw_Modifyobject" ((documentation . "Modifies object record bool hw_Modifyobject(int $connection, int $object_to_change, array $remove, array $add [, int $mode = '']) Returns TRUE on success or FALSE on failure. (PHP 4)") (versions . "PHP 4") (return . " Returns TRUE on success or FALSE on failure.
Returns the virtual object id.
") (prototype . "int hw_mapid(int $connection, int $server_id, int $object_id)") (purpose . "Maps global id on virtual local id") (id . "function.hw-mapid")) "hw_InsertObject" ((documentation . "Inserts an object record int hw_InsertObject(int $connection, string $object_rec, string $parameter) (PHP 4)") (versions . "PHP 4") (return . "") (prototype . "int hw_InsertObject(int $connection, string $object_rec, string $parameter)") (purpose . "Inserts an object record") (id . "function.hw-insertobject")) "hw_InsertDocument" ((documentation . "Upload any document int hw_InsertDocument(int $connection, int $parent_id, int $hw_document) The functions returns the object id of the new document or FALSE. (PHP 4)") (versions . "PHP 4") (return . " The functions returns the object id of the new document or FALSE.
") (prototype . "int hw_InsDoc(resource $connection, int $parentID, string $object_record [, string $text = ''])") (purpose . "Insert document") (id . "function.hw-insdoc")) "hw_InsColl" ((documentation . "Insert collection int hw_InsColl(int $connection, int $objectID, array $object_array) (PHP 4)") (versions . "PHP 4") (return . "
") (prototype . "int hw_InsColl(int $connection, int $objectID, array $object_array)") (purpose . "Insert collection") (id . "function.hw-inscoll")) "hw_Info" ((documentation . "Info about connection string hw_Info(int $connection) The returned string has the following format:
The returned string has the following format: <Serverstring>, <Host>, <Port>, <Username>, <Port of Client>, <Byte swapping>
") (prototype . "string hw_Info(int $connection)") (purpose . "Info about connection") (id . "function.hw-info")) "hw_InCollections" ((documentation . "Check if object ids in collections array hw_InCollections(int $connection, array $object_id_array, array $collection_id_array, int $return_collections) Returns an array of object ids. (PHP 4)") (versions . "PHP 4") (return . "Returns an array of object ids.
") (prototype . "array hw_InCollections(int $connection, array $object_id_array, array $collection_id_array, int $return_collections)") (purpose . "Check if object ids in collections") (id . "function.hw-incollections")) "hw_Identify" ((documentation . "Identifies as user string hw_Identify(int $link, string $username, string $password) (PHP 4)") (versions . "PHP 4") (return . "") (prototype . "string hw_Identify(int $link, string $username, string $password)") (purpose . "Identifies as user") (id . "function.hw-identify")) "hw_getusername" ((documentation . "Name of currently logged in user string hw_getusername(int $connection) Returns the username as a string. (PHP 4)") (versions . "PHP 4") (return . "Returns the username as a string.
") (prototype . "string hw_getusername(int $connection)") (purpose . "Name of currently logged in user") (id . "function.hw-getusername")) "hw_GetText" ((documentation . "Retrieve text document int hw_GetText(int $connection, int $objectID [, mixed $rootID/prefix = '']) Returns the text document. (PHP 4)") (versions . "PHP 4") (return . "Returns the text document.
") (prototype . "int hw_GetText(int $connection, int $objectID [, mixed $rootID/prefix = ''])") (purpose . "Retrieve text document") (id . "function.hw-gettext")) "hw_GetSrcByDestObj" ((documentation . "Returns anchors pointing at object array hw_GetSrcByDestObj(int $connection, int $objectID) Returns an array of object records. (PHP 4)") (versions . "PHP 4") (return . "Returns an array of object records.
") (prototype . "array hw_GetSrcByDestObj(int $connection, int $objectID)") (purpose . "Returns anchors pointing at object") (id . "function.hw-getsrcbydestobj")) "hw_getremotechildren" ((documentation . "Gets children of remote document mixed hw_getremotechildren(int $connection, string $object_record) If the number of children is 1 the function will return the document itself formatted by the Hyperwave Gateway Interface (HGI). If the number of children is greater than 1 it will return an array of object record with each maybe the input value for another call to hw_getremotechildren. Those object records are virtual and do not exist in the Hyperwave server, therefore they do not have a valid object ID. How exactly such an object record looks like is up to the HGI. (PHP 4)") (versions . "PHP 4") (return . "If the number of children is 1 the function will return the document itself formatted by the Hyperwave Gateway Interface (HGI). If the number of children is greater than 1 it will return an array of object record with each maybe the input value for another call to hw_getremotechildren. Those object records are virtual and do not exist in the Hyperwave server, therefore they do not have a valid object ID. How exactly such an object record looks like is up to the HGI.
") (prototype . "mixed hw_getremotechildren(int $connection, string $object_record)") (purpose . "Gets children of remote document") (id . "function.hw-getremotechildren")) "hw_GetRemote" ((documentation . "Gets a remote document int hw_GetRemote(int $connection, int $objectID) Returns a remote document. (PHP 4)") (versions . "PHP 4") (return . "Returns a remote document.
") (prototype . "int hw_GetRemote(int $connection, int $objectID)") (purpose . "Gets a remote document") (id . "function.hw-getremote")) "hw_getrellink" ((documentation . "Get link from source to dest relative to rootid string hw_getrellink(int $link, int $rootid, int $sourceid, int $destid) (PHP 4)") (versions . "PHP 4") (return . "") (prototype . "string hw_getrellink(int $link, int $rootid, int $sourceid, int $destid)") (purpose . "Get link from source to dest relative to rootid") (id . "function.hw-getrellink")) "hw_GetParentsObj" ((documentation . "Object records of parents array hw_GetParentsObj(int $connection, int $objectID) Returns an indexed array of object records plus an associated array with statistical information about the object records. The associated array is the last entry of the returned array. (PHP 4)") (versions . "PHP 4") (return . "Returns an indexed array of object records plus an associated array with statistical information about the object records. The associated array is the last entry of the returned array.
") (prototype . "array hw_GetParentsObj(int $connection, int $objectID)") (purpose . "Object records of parents") (id . "function.hw-getparentsobj")) "hw_GetParents" ((documentation . "Object ids of parents array hw_GetParents(int $connection, int $objectID) Returns an indexed array of object ids. Each object id belongs to a parent of the object with ID objectID. (PHP 4)") (versions . "PHP 4") (return . " Returns an indexed array of object ids. Each object id belongs to a parent of the object with ID objectID.
Returns an array of object records.
") (prototype . "array hw_GetObjectByQueryObj(int $connection, string $query, int $max_hits)") (purpose . "Search object") (id . "function.hw-getobjectbyqueryobj")) "hw_GetObjectByQueryCollObj" ((documentation . "Search object in collection array hw_GetObjectByQueryCollObj(int $connection, int $objectID, string $query, int $max_hits) Returns an array of object records. (PHP 4)") (versions . "PHP 4") (return . "Returns an array of object records.
") (prototype . "array hw_GetObjectByQueryCollObj(int $connection, int $objectID, string $query, int $max_hits)") (purpose . "Search object in collection") (id . "function.hw-getobjectbyquerycollobj")) "hw_GetObjectByQueryColl" ((documentation . "Search object in collection array hw_GetObjectByQueryColl(int $connection, int $objectID, string $query, int $max_hits) Returns an array of object ids. (PHP 4)") (versions . "PHP 4") (return . "Returns an array of object ids.
") (prototype . "array hw_GetObjectByQueryColl(int $connection, int $objectID, string $query, int $max_hits)") (purpose . "Search object in collection") (id . "function.hw-getobjectbyquerycoll")) "hw_GetObjectByQuery" ((documentation . "Search object array hw_GetObjectByQuery(int $connection, string $query, int $max_hits) Returns an array of object ids. (PHP 4)") (versions . "PHP 4") (return . "Returns an array of object ids.
") (prototype . "array hw_GetObjectByQuery(int $connection, string $query, int $max_hits)") (purpose . "Search object") (id . "function.hw-getobjectbyquery")) "hw_GetObject" ((documentation . "Object record mixed hw_GetObject(int $connection, mixed $objectID [, string $query = '']) Returns the object record for the given object ID if the second parameter is an integer. If the second parameter is an array of integer the function will return an array of object records. In such a case the last parameter is also evaluated which is a query string. (PHP 4)") (versions . "PHP 4") (return . "Returns the object record for the given object ID if the second parameter is an integer.
If the second parameter is an array of integer the function will return an array of object records. In such a case the last parameter is also evaluated which is a query string.
") (prototype . "mixed hw_GetObject(int $connection, mixed $objectID [, string $query = ''])") (purpose . "Object record") (id . "function.hw-getobject")) "hw_GetChildDocCollObj" ((documentation . "Object records of child documents of collection array hw_GetChildDocCollObj(int $connection, int $objectID) Returns an array of object records. (PHP 4)") (versions . "PHP 4") (return . "Returns an array of object records.
") (prototype . "array hw_GetChildDocCollObj(int $connection, int $objectID)") (purpose . "Object records of child documents of collection") (id . "function.hw-getchilddoccollobj")) "hw_GetChildDocColl" ((documentation . "Object ids of child documents of collection array hw_GetChildDocColl(int $connection, int $objectID) Returns an array of object ids. (PHP 4)") (versions . "PHP 4") (return . "Returns an array of object ids.
") (prototype . "array hw_GetChildDocColl(int $connection, int $objectID)") (purpose . "Object ids of child documents of collection") (id . "function.hw-getchilddoccoll")) "hw_GetChildCollObj" ((documentation . "Object records of child collections array hw_GetChildCollObj(int $connection, int $objectID) Returns an array of object records. (PHP 4)") (versions . "PHP 4") (return . "Returns an array of object records.
") (prototype . "array hw_GetChildCollObj(int $connection, int $objectID)") (purpose . "Object records of child collections") (id . "function.hw-getchildcollobj")) "hw_GetChildColl" ((documentation . "Object ids of child collections array hw_GetChildColl(int $connection, int $objectID) Returns an array of object ids. (PHP 4)") (versions . "PHP 4") (return . "Returns an array of object ids.
") (prototype . "array hw_GetChildColl(int $connection, int $objectID)") (purpose . "Object ids of child collections") (id . "function.hw-getchildcoll")) "hw_GetAndLock" ((documentation . "Return object record and lock object string hw_GetAndLock(int $connection, int $objectID) Returns the object record for the object with ID objectID. (PHP 4)") (versions . "PHP 4") (return . " Returns the object record for the object with ID objectID.
Returns an array of object records.
") (prototype . "array hw_GetAnchorsObj(int $connection, int $objectID)") (purpose . "Object records of anchors of document") (id . "function.hw-getanchorsobj")) "hw_GetAnchors" ((documentation . "Object ids of anchors of document array hw_GetAnchors(int $connection, int $objectID) Returns an array of object ids. (PHP 4)") (versions . "PHP 4") (return . "Returns an array of object ids.
") (prototype . "array hw_GetAnchors(int $connection, int $objectID)") (purpose . "Object ids of anchors of document") (id . "function.hw-getanchors")) "hw_Free_Document" ((documentation . "Frees hw_document bool hw_Free_Document(int $hw_document) Returns TRUE on success or FALSE on failure. (PHP 4)") (versions . "PHP 4") (return . " Returns TRUE on success or FALSE on failure.
Returns a string containing the last error message or 'No Error'. If FALSE is returned, this function failed.
Returns the last error number or 0 if no error occurred.
") (prototype . "int hw_Error(int $connection)") (purpose . "Error number") (id . "function.hw-error")) "hw_EditText" ((documentation . "Retrieve text document bool hw_EditText(int $connection, int $hw_document) Returns TRUE on success or FALSE on failure. (PHP 4)") (versions . "PHP 4") (return . " Returns TRUE on success or FALSE on failure.
Returns the size in bytes of the document.
") (prototype . "int hw_Document_Size(int $hw_document)") (purpose . "Size of hw_document") (id . "function.hw-document-size")) "hw_Document_SetContent" ((documentation . "Sets/replaces content of hw_document bool hw_Document_SetContent(int $hw_document, string $content) Returns TRUE on success or FALSE on failure. (PHP 4)") (versions . "PHP 4") (return . " Returns TRUE on success or FALSE on failure.
Returns the content of the document. If the document is an HTML document the content is everything after the BODY tag. Information from the HEAD and BODY tag is in the stored in the object record.
") (prototype . "string hw_Document_Content(int $hw_document)") (purpose . "Returns content of hw_document") (id . "function.hw-document-content")) "hw_Document_BodyTag" ((documentation . "Body tag of hw_document string hw_Document_BodyTag(int $hw_document [, string $prefix = '']) Returns the BODY tag as a string. (PHP 4)") (versions . "PHP 4") (return . "Returns the BODY tag as a string.
") (prototype . "string hw_Document_BodyTag(int $hw_document [, string $prefix = ''])") (purpose . "Body tag of hw_document") (id . "function.hw-document-bodytag")) "hw_Document_Attributes" ((documentation . "Object record of hw_document string hw_Document_Attributes(int $hw_document) Returns the object record of the document. (PHP 4)") (versions . "PHP 4") (return . "Returns the object record of the document.
") (prototype . "string hw_Document_Attributes(int $hw_document)") (purpose . "Object record of hw_document") (id . "function.hw-document-attributes")) "hw_DocByAnchorObj" ((documentation . "Object record object belonging to anchor string hw_DocByAnchorObj(int $connection, int $anchorID) Returns an object record. (PHP 4)") (versions . "PHP 4") (return . "Returns an object record.
") (prototype . "string hw_DocByAnchorObj(int $connection, int $anchorID)") (purpose . "Object record object belonging to anchor") (id . "function.hw-docbyanchorobj")) "hw_DocByAnchor" ((documentation . "Object id object belonging to anchor int hw_DocByAnchor(int $connection, int $anchorID) Returns the document object id. (PHP 4)") (versions . "PHP 4") (return . "Returns the document object id.
") (prototype . "int hw_DocByAnchor(int $connection, int $anchorID)") (purpose . "Object id object belonging to anchor") (id . "function.hw-docbyanchor")) "hw_Deleteobject" ((documentation . "Deletes object bool hw_Deleteobject(int $connection, int $object_to_delete) Returns TRUE on success or FALSE on failure. (PHP 4)") (versions . "PHP 4") (return . " Returns TRUE on success or FALSE on failure.
Returns the number of copied objects.
") (prototype . "int hw_cp(int $connection, array $object_id_array, int $destination_id)") (purpose . "Copies objects") (id . "function.hw-cp")) "hw_connection_info" ((documentation . "Prints information about the connection to Hyperwave server void hw_connection_info(int $link) (PHP 4)") (versions . "PHP 4") (return . "") (prototype . "void hw_connection_info(int $link)") (purpose . "Prints information about the connection to Hyperwave server") (id . "function.hw-connection-info")) "hw_Connect" ((documentation . "Opens a connection int hw_Connect(string $host, int $port [, string $username = '', string $password]) Returns a connection index on success, or FALSE if the connection could not be made. (PHP 4)") (versions . "PHP 4") (return . " Returns a connection index on success, or FALSE if the connection could not be made.
Returns TRUE on success or FALSE on failure.
Returns an array of object records. Each object record belongs to a child of the collection with ID objectID. The array contains all children both documents and collections.
Returns an array of object ids. Each id belongs to a child of the collection with ID objectID. The array contains all children both documents and collections.
Returns an object record.
") (prototype . "string hw_Array2Objrec(array $object_array)") (purpose . "Convert attributes from object array to object record") (id . "function.hw-array2objrec")) "http_build_url" ((documentation . "Build a URL string http_build_url([mixed $url = '' [, mixed $parts = '' [, int $flags = HTTP_URL_REPLACE [, array $new_url = '']]]]) Returns the new URL as string on success or FALSE on failure. (PECL pecl_http >= 0.21.0)") (versions . "PECL pecl_http >= 0.21.0") (return . " Returns the new URL as string on success or FALSE on failure.
Returns the built query as string on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns FALSE or exits on success with the specified redirection status code. See the INI settinghttp.force_exit for what "exits" means.
Returns the HTTP response(s) as string onsuccess, or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the ID of the request method on success or FALSE on failure.
Returns the request method name as string on success or FALSE on failure.
Returns TRUE if the request method is known, else FALSE.
Returns encoded string on success or FALSE on failure.
Returns the HTTP response(s) as string onsuccess, or FALSE on failure.
Returns the HTTP response(s) as string onsuccess, or FALSE on failure.
Returns the HTTP response(s) as string onsuccess, or FALSE on failure.
Returns the HTTP response(s) as string onsuccess, or FALSE on failure.
Returns the HTTP response(s) as string onsuccess, or FALSE on failure.
Returns the HTTP response(s) as string onsuccess, or FALSE on failure.
Returns the HTTP response(s) as string onsuccess, or FALSE on failure.
Returns the prior ident as string on success or FALSE on failure.
Returns persistent handles statistics as stdClass object on success or FALSE on failure.
No value is returned.
") (prototype . "string http_persistent_handles_clean([string $ident = ''])") (purpose . "Clean up persistent handles") (id . "function.http-persistent-handles-clean")) "http_parse_params" ((documentation . "Parse parameter list object http_parse_params(string $param [, int $flags = HTTP_PARAMS_DEFAULT]) Returns parameter list as stdClass object. (PECL pecl_http >= 1.0.0)") (versions . "PECL pecl_http >= 1.0.0") (return . "Returns parameter list as stdClass object.
") (prototype . "object http_parse_params(string $param [, int $flags = HTTP_PARAMS_DEFAULT])") (purpose . "Parse parameter list") (id . "function.http-parse-params")) "http_parse_message" ((documentation . "Parse HTTP messages object http_parse_message(string $message) Returns a hierarchical object structure of the parsed messages. (PECL pecl_http >= 0.12.0)") (versions . "PECL pecl_http >= 0.12.0") (return . "Returns a hierarchical object structure of the parsed messages.
") (prototype . "object http_parse_message(string $message)") (purpose . "Parse HTTP messages") (id . "function.http-parse-message")) "http_parse_headers" ((documentation . "Parse HTTP headers array http_parse_headers(string $header) Returns an array on success or FALSE on failure. (PECL pecl_http >= 0.10.0)") (versions . "PECL pecl_http >= 0.10.0") (return . " Returns an array on success or FALSE on failure.
Returns a stdClass object on success or FALSE on failure.
Returns the negotiated language or the default language (i.e. first array entry) if none match.
") (prototype . "string http_negotiate_language(array $supported [, array $result = ''])") (purpose . "Negotiate client's preferred language") (id . "function.http-negotiate-language")) "http_negotiate_content_type" ((documentation . "Negotiate client's preferred content type string http_negotiate_content_type(array $supported [, array $result = '']) Returns the negotiated content type or the default content type (i.e. first array entry) if none match. (PECL pecl_http >= 0.19.0)") (versions . "PECL pecl_http >= 0.19.0") (return . "Returns the negotiated content type or the default content type (i.e. first array entry) if none match.
") (prototype . "string http_negotiate_content_type(array $supported [, array $result = ''])") (purpose . "Negotiate client's preferred content type") (id . "function.http-negotiate-content-type")) "http_negotiate_charset" ((documentation . "Negotiate client's preferred character set string http_negotiate_charset(array $supported [, array $result = '']) Returns the negotiated charset or the default charset (i.e. first array entry) if none match. (PECL pecl_http >= 0.1.0)") (versions . "PECL pecl_http >= 0.1.0") (return . "Returns the negotiated charset or the default charset (i.e. first array entry) if none match.
") (prototype . "string http_negotiate_charset(array $supported [, array $result = ''])") (purpose . "Negotiate client's preferred character set") (id . "function.http-negotiate-charset")) "http_support" ((documentation . "Check built-in HTTP support int http_support([int $feature = '']) Returns integer, whether requested feature is supported, or a bitmask with all supported features if feature was omitted. (PECL pecl_http >= 0.15.0)") (versions . "PECL pecl_http >= 0.15.0") (return . " Returns integer, whether requested feature is supported, or a bitmask with all supported features if feature was omitted.
Returns TRUE if header value matches, else FALSE.
Returns TRUE if timestamp represents an earlier date than the header, else FALSE.
Returns TRUE if ETag matches or the header contained the asterisk ("*"), else FALSE.
Returns an associative array of incoming request headers.
") (prototype . "array http_get_request_headers()") (purpose . "Get request headers as array") (id . "function.http-get-request-headers")) "http_get_request_body" ((documentation . "Get request body as string string http_get_request_body() Returns the raw request body as string on success or NULL on failure. (PECL pecl_http >= 0.10.0)") (versions . "PECL pecl_http >= 0.10.0") (return . " Returns the raw request body as string on success or NULL on failure.
Returns the raw request body as stream on success or NULL on failure.
Returns the HTTP date as string.
") (prototype . "string http_date([int $timestamp = ''])") (purpose . "Compose HTTP RFC compliant date") (id . "function.http-date")) "http_build_cookie" ((documentation . "Build cookie string string http_build_cookie(array $cookie) Returns the cookie(s) as string. (PECL pecl_http >= 1.2.0)") (versions . "PECL pecl_http >= 1.2.0") (return . "Returns the cookie(s) as string.
") (prototype . "string http_build_cookie(array $cookie)") (purpose . "Build cookie string") (id . "function.http-build-cookie")) "http_inflate" ((documentation . "Inflate data string http_inflate(string $data) Returns the decoded string on success, or NULL on failure. (PECL pecl_http >= 0.15.0)") (versions . "PECL pecl_http >= 0.15.0") (return . " Returns the decoded string on success, or NULL on failure.
Returns the encoded string on success, or NULL on failure.
Returns the decoded string on success or FALSE on failure.
Returns FALSE or exits on success with 304 Not Modified if the entity is cached. See the INI settinghttp.force_exit for what "exits" means.
Returns FALSE or exits on success with 304 Not Modified if the entity is cached. See the INI settinghttp.force_exit for what "exits" means.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Return out_params array with values or FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Return value of the action.
") (prototype . "mixed gupnp_service_proxy_action_get(resource $proxy, string $action, string $name, int $type)") (purpose . "Send action to the service and get value") (id . "function.gupnp-service-proxy-action-get")) "gupnp_service_notify" ((documentation . "Notifies listening clients bool gupnp_service_notify(resource $service, string $name, int $type, mixed $value) Returns TRUE on success or FALSE on failure. (PECL gupnp >= 0.1.0)") (versions . "PECL gupnp >= 0.1.0") (return . " Returns TRUE on success or FALSE on failure.
Return the state variable data or FALSE.
Return array wich contains the information of the service (like location, url, udn and etc).
") (prototype . "array gupnp_service_info_get(resource $proxy)") (purpose . "Get full info of service") (id . "function.gupnp-service-info-get")) "gupnp_service_info_get_introspection" ((documentation . "Get resource introspection of service mixed gupnp_service_info_get_introspection(resource $proxy [, mixed $callback = '' [, mixed $arg = '']]) Return true if callback function was defined. Return introspection identifier if callback function was omited. (PECL gupnp >= 0.1.0)") (versions . "PECL gupnp >= 0.1.0") (return . "Return true if callback function was defined. Return introspection identifier if callback function was omited.
") (prototype . "mixed gupnp_service_info_get_introspection(resource $proxy [, mixed $callback = '' [, mixed $arg = '']])") (purpose . "Get resource introspection of service") (id . "function.gupnp-service-info-get-introspection")) "gupnp_service_freeze_notify" ((documentation . "Freeze new notifications bool gupnp_service_freeze_notify(resource $service) Returns TRUE on success or FALSE on failure. (PECL gupnp >= 0.1.0)") (versions . "PECL gupnp >= 0.1.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
The value of the variable.
") (prototype . "mixed gupnp_service_action_get(resource $action, string $name, int $type)") (purpose . "Retrieves the specified action arguments") (id . "function.gupnp-service-action-get")) "gupnp_root_device_stop" ((documentation . "Stop main loop bool gupnp_root_device_stop(resource $root_device) Returns TRUE on success or FALSE on failure. (PECL gupnp >= 0.1.0)") (versions . "PECL gupnp >= 0.1.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
A root device identifier.
") (prototype . "resource gupnp_root_device_new(resource $context, string $location, string $description_dir)") (purpose . "Create a new root device") (id . "function.gupnp-root-device-new")) "gupnp_root_device_get_relative_location" ((documentation . "Get the relative location of root device. string gupnp_root_device_get_relative_location(resource $root_device) The relative location of root device (PECL gupnp >= 0.1.0)") (versions . "PECL gupnp >= 0.1.0") (return . "The relative location of root device
") (prototype . "string gupnp_root_device_get_relative_location(resource $root_device)") (purpose . "Get the relative location of root device.") (id . "function.gupnp-root-device-get-relative-location")) "gupnp_root_device_get_available" ((documentation . "Check whether root device is available bool gupnp_root_device_get_available(resource $root_device) Returns TRUE on success or FALSE on failure. (PECL gupnp >= 0.1.0)") (versions . "PECL gupnp >= 0.1.0") (return . " Returns TRUE on success or FALSE on failure.
Return array wich contains the information of the root device (like location, url, udn and etc).
") (prototype . "array gupnp_device_info_get(resource $root_device)") (purpose . "Get info of root device") (id . "function.gupnp-device-info-get")) "gupnp_device_info_get_service" ((documentation . "Get the service with type resource gupnp_device_info_get_service(resource $root_device, string $type) A service identifier. (PECL gupnp >= 0.1.0)") (versions . "PECL gupnp >= 0.1.0") (return . "A service identifier.
") (prototype . "resource gupnp_device_info_get_service(resource $root_device, string $type)") (purpose . "Get the service with type") (id . "function.gupnp-device-info-get-service")) "gupnp_device_action_callback_set" ((documentation . "Set device callback function bool gupnp_device_action_callback_set(resource $root_device, int $signal, string $action_name, mixed $callback [, mixed $arg = '']) Returns TRUE on success or FALSE on failure. (PECL gupnp >= 0.1.0)") (versions . "PECL gupnp >= 0.1.0") (return . " Returns TRUE on success or FALSE on failure.
A control point identifier.
") (prototype . "resource gupnp_control_point_new(resource $context, string $target)") (purpose . "Create a new control point") (id . "function.gupnp-control-point-new")) "gupnp_control_point_callback_set" ((documentation . "Set control point callback bool gupnp_control_point_callback_set(resource $cpoint, int $signal, mixed $callback [, mixed $arg = '']) Returns TRUE on success or FALSE on failure. (PECL gupnp >= 0.1.0)") (versions . "PECL gupnp >= 0.1.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void gupnp_context_set_subscription_timeout(resource $context, int $timeout)") (purpose . "Sets the event subscription timeout") (id . "function.gupnp-context-set-subscription-timeout")) "gupnp_context_new" ((documentation . "Create a new context resource gupnp_context_new([string $host_ip = '' [, int $port = '']]) A context identifier. (PECL gupnp >= 0.1.0)") (versions . "PECL gupnp >= 0.1.0") (return . "A context identifier.
") (prototype . "resource gupnp_context_new([string $host_ip = '' [, int $port = '']])") (purpose . "Create a new context") (id . "function.gupnp-context-new")) "gupnp_context_host_path" ((documentation . "Start hosting bool gupnp_context_host_path(resource $context, string $local_path, string $server_path) Returns TRUE on success or FALSE on failure. (PECL gupnp >= 0.1.0)") (versions . "PECL gupnp >= 0.1.0") (return . " Returns TRUE on success or FALSE on failure.
The event subscription timeout in seconds.
") (prototype . "int gupnp_context_get_subscription_timeout(resource $context)") (purpose . "Get the event subscription timeout") (id . "function.gupnp-context-get-subscription-timeout")) "gupnp_context_get_port" ((documentation . "Get the port int gupnp_context_get_port(resource $context) Returns the port number for the current context and FALSE on error. (PECL gupnp >= 0.1.0)") (versions . "PECL gupnp >= 0.1.0") (return . " Returns the port number for the current context and FALSE on error.
Returns the IP address for the current context and FALSE on error.
Returns an associative array whose components are:
Upon failure, the additional data entry of the returned array will hold the parsed line.
") (prototype . "array gopher_parsedir(string $dirent)") (purpose . "Translate a gopher formatted directory entry into an associative array.") (id . "function.gopher-parsedir")) "gearman_job_handle" ((documentation . "Get the job handle string gearman_job_handle() The opaque job handle. (PECL gearman >= 0.5.0)") (versions . "PECL gearman >= 0.5.0") (return . "The opaque job handle.
") (prototype . "string gearman_job_handle()") (purpose . "Get the job handle") (id . "gearmantask.jobhandle")) "gearman_job_status" ((documentation . "Get the status of a background job array gearman_job_status(string $job_handle) 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. (PECL gearman >= 0.5.0)") (versions . "PECL gearman >= 0.5.0") (return . "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.
") (prototype . "array gearman_job_status(string $job_handle)") (purpose . "Get the status of a background job") (id . "gearmanclient.jobstatus")) "ftp_systype" ((documentation . "Returns the system type identifier of the remote FTP server string ftp_systype(resource $ftp_stream) Returns the remote system type, or FALSE on error. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns the remote system type, or FALSE on error.
Returns a SSL-FTP stream on success or FALSE on error.
Returns the file size on success, or -1 on error.
") (prototype . "int ftp_size(resource $ftp_stream, string $remote_file)") (purpose . "Returns the size of the given file") (id . "function.ftp-size")) "ftp_site" ((documentation . "Sends a SITE command to the server bool ftp_site(resource $ftp_stream, string $command) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE if the option could be set; FALSE if not. A warning message will be thrown if the option is not supported or the passed value doesn't match the expected value for the given option.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns an array where each element corresponds to one line of text.
The output is not parsed in any way. The system type identifier returned by ftp_systype can be used to determine how the results should be interpreted.
") (prototype . "array ftp_rawlist(resource $ftp_stream, string $directory [, bool $recursive = false])") (purpose . "Returns a detailed list of files in the given directory") (id . "function.ftp-rawlist")) "ftp_raw" ((documentation . "Sends an arbitrary command to an FTP server array ftp_raw(resource $ftp_stream, string $command) Returns the server's response as an array of strings. No parsing is performed on the response string, nor does ftp_raw determine if the command succeeded. (PHP 5)") (versions . "PHP 5") (return . "Returns the server's response as an array of strings. No parsing is performed on the response string, nor does ftp_raw determine if the command succeeded.
") (prototype . "array ftp_raw(resource $ftp_stream, string $command)") (purpose . "Sends an arbitrary command to an FTP server") (id . "function.ftp-raw")) "ftp_quit" ((documentation . "Alias of ftp_close ftp_quit() (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "") (prototype . " ftp_quit()") (purpose . "Alias of ftp_close") (id . "function.ftp-quit")) "ftp_pwd" ((documentation . "Returns the current directory name string ftp_pwd(resource $ftp_stream) Returns the current directory name or FALSE on error. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns the current directory name or FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns an array of filenames from the specified directory on success or FALSE on error.
Returns FTP_FAILED or FTP_FINISHED or FTP_MOREDATA.
Returns FTP_FAILED or FTP_FINISHED or FTP_MOREDATA.
Returns FTP_FAILED or FTP_FINISHED or FTP_MOREDATA.
Returns FTP_FAILED or FTP_FINISHED or FTP_MOREDATA.
Returns FTP_FAILED or FTP_FINISHED or FTP_MOREDATA.
Returns the newly created directory name on success or FALSE on error.
Returns the last modified time as a Unix timestamp on success, or -1 on error.
") (prototype . "int ftp_mdtm(resource $ftp_stream, string $remote_file)") (purpose . "Returns the last modified time of the given file") (id . "function.ftp-mdtm")) "ftp_login" ((documentation . "Logs in to an FTP connection bool ftp_login(resource $ftp_stream, string $username, string $password) Returns TRUE on success or FALSE on failure. If login fails, PHP will also throw a warning. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure. If login fails, PHP will also throw a warning.
Returns TRUE on success or FALSE on failure.
Returns the value on success or FALSE if the given option is not supported. In the latter case, a warning message is also thrown.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE if the command was successful (server sent response code: 200); otherwise returns FALSE.
Returns TRUE on success or FALSE on failure.
Returns a FTP stream on success or FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns the new file permissions on success or FALSE on error.
Returns TRUE on success or FALSE on failure. If changing directory fails, PHP will also throw a warning.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns non-zero if events are available to be fetched using fam_next_event, zero otherwise.
") (prototype . "int fam_pending(resource $fam)") (purpose . "Check for pending FAM events") (id . "function.fam-pending")) "fam_open" ((documentation . "Open connection to FAM daemon resource fam_open([string $appname = '']) Returns a resource representing a connection to the FAM service on success or FALSE on errors. (PHP 5 <= 5.0.5)") (versions . "PHP 5 <= 5.0.5") (return . " Returns a resource representing a connection to the FAM service on success or FALSE on errors.
Returns an array that contains a FAM event code in the 'code' element, the path of the file this event applies to in the 'filename' element and optionally a hostname in the 'hostname' element.
The possible event codes are described in detail in the constants part of this section.
") (prototype . "array fam_next_event(resource $fam)") (purpose . "Get next pending FAM event") (id . "function.fam-next-event")) "fam_monitor_file" ((documentation . "Monitor a regular file for changes resource fam_monitor_file(resource $fam, string $filename) Returns a monitoring resource or FALSE on errors. (PHP 5 <= 5.0.5)") (versions . "PHP 5 <= 5.0.5") (return . " Returns a monitoring resource or FALSE on errors.
Returns a monitoring resource or FALSE on errors.
Returns a monitoring resource or FALSE on errors.
No value is returned.
") (prototype . "void fam_close(resource $fam)") (purpose . "Close FAM connection") (id . "function.fam-close")) "fam_cancel_monitor" ((documentation . "Terminate monitoring bool fam_cancel_monitor(resource $fam, resource $fam_monitor) Returns TRUE on success or FALSE on failure. (PHP 5 <= 5.0.5)") (versions . "PHP 5 <= 5.0.5") (return . " Returns TRUE on success or FALSE on failure.
Returns an associative array with the following elements:
| Indice | Value description |
|---|---|
| version_number | cURL 24 bit version number |
| version | cURL version number, as a string |
| ssl_version_number | OpenSSL 24 bit version number |
| ssl_version | OpenSSL version number, as a string |
| libz_version | zlib version number, as a string |
| host | Information about the host where cURL was built |
| age | |
| features | A bitmask of the CURL_VERSION_XXX constants |
| protocols | An array of protocols names supported by cURL |
Returns decoded string or FALSE on failure.
Returns error description or NULL for invalid error code.
Returns TRUE on success or FALSE on failure.
Returns resource of type "cURL Share Handle".
") (prototype . "resource curl_share_init()") (purpose . "Initialize a cURL share handle") (id . "function.curl-share-init")) "curl_share_close" ((documentation . "Close a cURL share handle void curl_share_close(resource $sh) No value is returned. (PHP 5 >= 5.5.0)") (versions . "PHP 5 >= 5.5.0") (return . "No value is returned.
") (prototype . "void curl_share_close(resource $sh)") (purpose . "Close a cURL share handle") (id . "function.curl-share-close")) "curl_setopt" ((documentation . "Set an option for a cURL transfer bool curl_setopt(resource $ch, int $option, mixed $value) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.2, PHP 5)") (versions . "PHP 4 >= 4.0.2, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE if all options were successfully set. If an option could not be successfully set, FALSE is immediately returned, ignoring any future options in the options array.
No value is returned.
") (prototype . "void curl_reset(resource $ch)") (purpose . "Reset all options of a libcurl session handle") (id . "function.curl-reset")) "curl_pause" ((documentation . "Pause and unpause a connection int curl_pause(resource $ch, int $bitmask) Returns an error code (CURLE_OK for no error). (PHP 5 >= 5.5.0)") (versions . "PHP 5 >= 5.5.0") (return . " Returns an error code (CURLE_OK for no error).
Returns error string for valid error code, NULL otherwise.
Returns TRUE on success or FALSE on failure.
On success, returns the number of descriptors contained in the descriptor sets. On failure, this function will return -1 on a select failure or timeout (from the underlying select system call).
") (prototype . "int curl_multi_select(resource $mh [, float $timeout = 1.0])") (purpose . "Wait for activity on any curl_multi connection") (id . "function.curl-multi-select")) "curl_multi_remove_handle" ((documentation . "Remove a multi handle from a set of cURL handles int curl_multi_remove_handle(resource $mh, resource $ch) Returns 0 on success, or one of the CURLM_XXX error codes. (PHP 5)") (versions . "PHP 5") (return . " Returns 0 on success, or one of the CURLM_XXX error codes.
Returns a cURL multi handle resource on success, FALSE on failure.
On success, returns an associative array for the message, FALSE on failure.
| Key: | Value: |
|---|---|
| msg | The CURLMSG_DONE constant. Other return values are currently not available. |
| result | One of the CURLE_* constants. If everything is OK, the CURLE_OK will be the result. |
| handle | Resource of type curl indicates the handle which it concerns. |
Return the content of a cURL handle if CURLOPT_RETURNTRANSFER is set.
A cURL code defined in the cURL Predefined Constants.
") (prototype . "int curl_multi_exec(resource $mh, int $still_running)") (purpose . "Run the sub-connections of the current cURL handle") (id . "function.curl-multi-exec")) "curl_multi_close" ((documentation . "Close a set of cURL handles void curl_multi_close(resource $mh) No value is returned. (PHP 5)") (versions . "PHP 5") (return . "Note:
This only returns errors regarding the whole multi stack. There might still have occurred problems on individual transfers even when this function returns
CURLM_OK.
No value is returned.
") (prototype . "void curl_multi_close(resource $mh)") (purpose . "Close a set of cURL handles") (id . "function.curl-multi-close")) "curl_multi_add_handle" ((documentation . "Add a normal cURL handle to a cURL multi handle int curl_multi_add_handle(resource $mh, resource $ch) Returns 0 on success, or one of the CURLM_XXX errors code. (PHP 5)") (versions . "PHP 5") (return . " Returns 0 on success, or one of the CURLM_XXX errors code.
Returns a cURL handle on success, FALSE on errors.
If opt is given, returns its value. Otherwise, returns an associative array with the following elements (which correspond to opt), or FALSE on failure:
CURLINFO_HEADER_OUT is set by a previous call to curl_setopt) Returns a CURLFile object.
") (prototype . "CURLFile curl_file_create(string $filename [, string $mimetype = '' [, string $postname = '']])") (purpose . "Create a CURLFile object") (id . "curlfile.construct")) "curl_exec" ((documentation . #("Perform a cURL session mixed curl_exec(resource $ch) Returns TRUE on success or FALSE on failure. However, if the CURLOPT_RETURNTRANSFER option is set, it will return the result on success, FALSE on failure. (PHP 4 >= 4.0.2, PHP 5)" 149 152 (shr-url "function.curl-setopt.html"))) (versions . "PHP 4 >= 4.0.2, PHP 5") (return . " Returns TRUE on success or FALSE on failure. However, if the CURLOPT_RETURNTRANSFER option is set, it will return the result on success, FALSE on failure.
Returns escaped string or FALSE on failure.
Returns the error message or '' (the empty string) if no error occurred.
") (prototype . "string curl_error(resource $ch)") (purpose . "Return a string containing the last error for the current session") (id . "function.curl-error")) "curl_errno" ((documentation . "Return the last error number int curl_errno(resource $ch) Returns the error number or 0 (zero) if no error occurred. (PHP 4 >= 4.0.3, PHP 5)") (versions . "PHP 4 >= 4.0.3, PHP 5") (return . "Returns the error number or 0 (zero) if no error occurred.
") (prototype . "int curl_errno(resource $ch)") (purpose . "Return the last error number") (id . "function.curl-errno")) "curl_copy_handle" ((documentation . "Copy a cURL handle along with all of its preferences resource curl_copy_handle(resource $ch) Returns a new cURL handle. (PHP 5)") (versions . "PHP 5") (return . "Returns a new cURL handle.
") (prototype . "resource curl_copy_handle(resource $ch)") (purpose . "Copy a cURL handle along with all of its preferences") (id . "function.curl-copy-handle")) "curl_close" ((documentation . "Close a cURL session void curl_close(resource $ch) No value is returned. (PHP 4 >= 4.0.2, PHP 5)") (versions . "PHP 4 >= 4.0.2, PHP 5") (return . "No value is returned.
") (prototype . "void curl_close(resource $ch)") (purpose . "Close a cURL session") (id . "function.curl-close")) "chdb_create" ((documentation . "Creates a chdb file bool chdb_create(string $pathname, array $data) Returns TRUE on success or FALSE on failure. (PECL chdb >= 0.1.0)") (versions . "PECL chdb >= 0.1.0") (return . " Returns TRUE on success or FALSE on failure.
") (prototype . "bool untaint(string $string [, string $... = ''])") (purpose . "Untaint strings") (id . "function.untaint")) "taint" ((documentation . "Taint a string bool taint(string $string [, string $... = '']) Return TRUE if the transformation is done. Always return TRUE if the taint extension is not enabled. (PECL taint >=0.1.0)") (versions . "PECL taint >=0.1.0") (return . "
Return TRUE if the transformation is done. Always return TRUE if the taint extension is not enabled.
") (prototype . "bool taint(string $string [, string $... = ''])") (purpose . "Taint a string") (id . "function.taint")) "is_tainted" ((documentation . "Checks whether a string is tainted bool is_tainted(string $string) Return TRUE if the string is tainted, FALSE otherwise. (PECL taint >=0.1.0)") (versions . "PECL taint >=0.1.0") (return . "Return TRUE if the string is tainted, FALSE otherwise.
") (prototype . "bool is_tainted(string $string)") (purpose . "Checks whether a string is tainted") (id . "function.is-tainted")) "yaml_parse" ((documentation . "Parse a YAML stream mixed yaml_parse(string $input [, int $pos = '' [, int $ndocs = '' [, array $callbacks = '']]]) Returns the value encoded in input in appropriate PHP type or FALSE on failure. If pos is -1 an array will be returned with one entry for each document found in the stream. (PECL yaml >= 0.4.0)") (versions . "PECL yaml >= 0.4.0") (return . " Returns the value encoded in input in appropriate PHP type or FALSE on failure. If pos is -1 an array will be returned with one entry for each document found in the stream.
Returns the value encoded in input in appropriate PHP type or FALSE on failure. If pos is -1 an array will be returned with one entry for each document found in the stream.
Returns the value encoded in input in appropriate PHP type or FALSE on failure. If pos is -1 an array will be returned with one entry for each document found in the stream.
Returns a YAML encoded string on success.
") (prototype . "string yaml_emit(mixed $data [, int $encoding = YAML_ANY_ENCODING [, int $linebreak = YAML_ANY_BREAK [, array $callbacks = '']]])") (purpose . "Returns the YAML representation of a value") (id . "function.yaml-emit")) "yaml_emit_file" ((documentation . "Send the YAML representation of a value to a file bool yaml_emit_file(string $filename, mixed $data [, int $encoding = YAML_ANY_ENCODING [, int $linebreak = YAML_ANY_BREAK [, array $callbacks = '']]]) Returns TRUE on success. (PECL yaml >= 0.5.0)") (versions . "PECL yaml >= 0.5.0") (return . " Returns TRUE on success.
Returns a string in which all non-alphanumeric characters except -_. have been replaced with a percent (%) sign followed by two hex digits and spaces encoded as plus (+) signs. It is encoded the same way that the posted data from a WWW form is encoded, that is the same way as in application/x-www-form-urlencoded media type. This differs from the » RFC 3986 encoding (see rawurlencode) in that for historical reasons, spaces are encoded as plus (+) signs.
") (prototype . "string urlencode(string $str)") (purpose . "URL-encodes string") (id . "function.urlencode")) "urldecode" ((documentation . "Decodes URL-encoded string string urldecode(string $str) Returns the decoded string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the decoded string.
") (prototype . "string urldecode(string $str)") (purpose . "Decodes URL-encoded string") (id . "function.urldecode")) "rawurlencode" ((documentation . #("URL-encode according to RFC 3986 string rawurlencode(string $str) Returns a string in which all non-alphanumeric characters except -_.~ have been replaced with a percent (%) sign followed by two hex digits. This is the encoding described in » RFC 3986 for protecting literal characters from being interpreted as special URL delimiters, and for protecting URLs from being mangled by transmission media with character conversions (like some email systems). Note: Prior to PHP 5.3.0, rawurlencode encoded tildes (~) as per » RFC 1738. (PHP 4, PHP 5)" 243 253 (shr-url "http://www.faqs.org/rfcs/rfc3986") 532 533 (shr-url "http://www.faqs.org/rfcs/rfc1738") 533 534 (shr-url "http://www.faqs.org/rfcs/rfc1738") 534 537 (shr-url "http://www.faqs.org/rfcs/rfc1738") 537 538 (shr-url "http://www.faqs.org/rfcs/rfc1738") 538 542 (shr-url "http://www.faqs.org/rfcs/rfc1738") 542 546 (shr-url "http://www.faqs.org/rfcs/rfc1738"))) (versions . "PHP 4, PHP 5") (return . "Returns a string in which all non-alphanumeric characters except -_.~ have been replaced with a percent (%) sign followed by two hex digits. This is the encoding described in » RFC 3986 for protecting literal characters from being interpreted as special URL delimiters, and for protecting URLs from being mangled by transmission media with character conversions (like some email systems).
") (prototype . "string rawurlencode(string $str)") (purpose . "URL-encode according to RFC 3986") (id . "function.rawurlencode")) "rawurldecode" ((documentation . "Decode URL-encoded strings string rawurldecode(string $str) Returns the decoded URL, as a string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Note:
Prior to PHP 5.3.0, rawurlencode encoded tildes (~) as per » RFC 1738.
Returns the decoded URL, as a string.
") (prototype . "string rawurldecode(string $str)") (purpose . "Decode URL-encoded strings") (id . "function.rawurldecode")) "parse_url" ((documentation . "Parse a URL and return its components mixed parse_url(string $url [, int $component = -1]) On seriously malformed URLs, parse_url may return FALSE. If the component parameter is omitted, an associative array is returned. At least one element will be present within the array. Potential keys within this array are: * scheme - e.g. http * host * port * user * pass * path * query - after the question mark ? * fragment - after the hashmark # If the component parameter is specified, parse_url returns a string (or an integer, in the case of PHP_URL_PORT) instead of an array. If the requested component doesn't exist within the given URL, NULL will be returned. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " On seriously malformed URLs, parse_url may return FALSE.
If the component parameter is omitted, an associative array is returned. At least one element will be present within the array. Potential keys within this array are:
If the component parameter is specified, parse_url returns a string (or an integer, in the case of PHP_URL_PORT) instead of an array. If the requested component doesn't exist within the given URL, NULL will be returned.
Returns a URL-encoded string.
") (prototype . "string http_build_query(mixed $query_data [, string $numeric_prefix = '' [, string $arg_separator = '' [, int $enc_type = '']]])") (purpose . "Generate URL-encoded query string") (id . "function.http-build-query")) "get_meta_tags" ((documentation . "Extracts all meta tag content attributes from a file and returns an array array get_meta_tags(string $filename [, bool $use_include_path = false]) Returns an array with all the parsed meta tags. The value of the name property becomes the key, the value of the content property becomes the value of the returned array, so you can easily use standard array functions to traverse it or access single values. Special characters in the value of the name property are substituted with '_', the rest is converted to lower case. If two meta tags have the same name, only the last one is returned. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns an array with all the parsed meta tags.
The value of the name property becomes the key, the value of the content property becomes the value of the returned array, so you can easily use standard array functions to traverse it or access single values. Special characters in the value of the name property are substituted with '_', the rest is converted to lower case. If two meta tags have the same name, only the last one is returned.
") (prototype . "array get_meta_tags(string $filename [, bool $use_include_path = false])") (purpose . "Extracts all meta tag content attributes from a file and returns an array") (id . "function.get-meta-tags")) "get_headers" ((documentation . "Fetches all the headers sent by the server in response to a HTTP request array get_headers(string $url [, int $format = '']) Returns an indexed or associative array with the headers, or FALSE on failure. (PHP 5)") (versions . "PHP 5") (return . " Returns an indexed or associative array with the headers, or FALSE on failure.
The encoded data, as a string or FALSE on failure.
Returns the original data or FALSE on failure. The returned data may be binary.
The symbolic name of the given token.
An array of token identifiers. Each individual token identifier is either a single character (i.e.: ;, ., >, !, etc...), or a three element array containing the token index in element 0, the string content of the original token in element 1 and the line number in element 2.
") (prototype . "array token_get_all(string $source)") (purpose . "Split given source into PHP tokens") (id . "function.token-get-all")) "tidy_warning_count" ((documentation . "Returns the Number of Tidy warnings encountered for specified document int tidy_warning_count(tidy $object) Returns the number of warnings. (PHP 5, PECL tidy >= 0.5.2)") (versions . "PHP 5, PECL tidy >= 0.5.2") (return . "Returns the number of warnings.
") (prototype . "int tidy_warning_count(tidy $object)") (purpose . "Returns the Number of Tidy warnings encountered for specified document") (id . "function.tidy-warning-count")) "tidy_setopt" ((documentation . "Updates the configuration settings for the specified tidy document bool tidy_setopt(string $option, mixed $value) Returns TRUE on success or FALSE on failure. (PECL tidy >= 0.5.2)") (versions . "PECL tidy >= 0.5.2") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void tidy_load_config(string $filename, string $encoding)") (purpose . "Load an ASCII Tidy configuration file with the specified encoding") (id . "function.tidy-load-config")) "tidy_get_output" ((documentation . "Return a string representing the parsed tidy markup string tidy_get_output(tidy $object) Returns the parsed tidy markup. (PHP 5, PECL tidy >= 0.5.2)") (versions . "PHP 5, PECL tidy >= 0.5.2") (return . "Returns the parsed tidy markup.
") (prototype . "string tidy_get_output(tidy $object)") (purpose . "Return a string representing the parsed tidy markup") (id . "function.tidy-get-output")) "tidy_error_count" ((documentation . "Returns the Number of Tidy errors encountered for specified document int tidy_error_count(tidy $object) Returns the number of errors. (PHP 5, PECL tidy >= 0.5.2)") (versions . "PHP 5, PECL tidy >= 0.5.2") (return . "Returns the number of errors.
") (prototype . "int tidy_error_count(tidy $object)") (purpose . "Returns the Number of Tidy errors encountered for specified document") (id . "function.tidy-error-count")) "tidy_config_count" ((documentation . "Returns the Number of Tidy configuration errors encountered for specified document int tidy_config_count(tidy $object) Returns the number of errors. (PHP 5, PECL tidy >= 0.5.2)") (versions . "PHP 5, PECL tidy >= 0.5.2") (return . "Returns the number of errors.
") (prototype . "int tidy_config_count(tidy $object)") (purpose . "Returns the Number of Tidy configuration errors encountered for specified document") (id . "function.tidy-config-count")) "tidy_access_count" ((documentation . "Returns the Number of Tidy accessibility warnings encountered for specified document int tidy_access_count(tidy $object) Returns the number of warnings. (PHP 5, PECL tidy >= 0.5.2)") (versions . "PHP 5, PECL tidy >= 0.5.2") (return . "Returns the number of warnings.
") (prototype . "int tidy_access_count(tidy $object)") (purpose . "Returns the Number of Tidy accessibility warnings encountered for specified document") (id . "function.tidy-access-count")) "ob_tidyhandler" ((documentation . "ob_start callback function to repair the buffer string ob_tidyhandler(string $input [, int $mode = '']) Returns the modified buffer. (PHP 5)") (versions . "PHP 5") (return . "Returns the modified buffer.
") (prototype . "string ob_tidyhandler(string $input [, int $mode = ''])") (purpose . "ob_start callback function to repair the buffer") (id . "function.ob-tidyhandler")) "tidy_get_root" ((documentation . "Returns a tidyNode object representing the root of the tidy parse tree tidyNode tidy_get_root(tidy $object) Returns the tidyNode object. ()") (versions . "") (return . "Returns the tidyNode object.
") (prototype . "tidyNode tidy_get_root(tidy $object)") (purpose . "Returns a tidyNode object representing the root of the tidy parse tree") (id . "tidy.root")) "tidy_repair_string" ((documentation . "Repair a string using an optionally provided configuration file string tidy_repair_string(string $data [, mixed $config = '' [, string $encoding = '']]) Returns the repaired string. ()") (versions . "") (return . "Returns the repaired string.
") (prototype . "string tidy_repair_string(string $data [, mixed $config = '' [, string $encoding = '']])") (purpose . "Repair a string using an optionally provided configuration file") (id . "tidy.repairstring")) "tidy_repair_file" ((documentation . "Repair a file and return it as a string string tidy_repair_file(string $filename [, mixed $config = '' [, string $encoding = '' [, bool $use_include_path = false]]]) Returns the repaired contents as a string. ()") (versions . "") (return . "Returns the repaired contents as a string.
") (prototype . "string tidy_repair_file(string $filename [, mixed $config = '' [, string $encoding = '' [, bool $use_include_path = false]]])") (purpose . "Repair a file and return it as a string") (id . "tidy.repairfile")) "tidy_parse_string" ((documentation . "Parse a document stored in a string tidy tidy_parse_string(string $input [, mixed $config = '' [, string $encoding = '']]) Returns a new tidy instance. ()") (versions . "") (return . "Returns a new tidy instance.
") (prototype . "tidy tidy_parse_string(string $input [, mixed $config = '' [, string $encoding = '']])") (purpose . "Parse a document stored in a string") (id . "tidy.parsestring")) "tidy_parse_file" ((documentation . "Parse markup in file or URI tidy tidy_parse_file(string $filename [, mixed $config = '' [, string $encoding = '' [, bool $use_include_path = false]]]) Returns TRUE on success or FALSE on failure. ()") (versions . "") (return . " Returns TRUE on success or FALSE on failure.
This function returns TRUE if the specified tidy object is a generic XML document (non HTML/XHTML), or FALSE otherwise.
This function is not yet implemented in the Tidylib itself, so it always return FALSE.
This function returns TRUE if the specified tidy object is a XHTML document, or FALSE otherwise.
This function is not yet implemented in the Tidylib itself, so it always return FALSE.
Returns the tidyNode object.
") (prototype . "tidyNode tidy_get_html(tidy $object)") (purpose . "Returns a tidyNode object starting from the tag of the tidy parse tree") (id . "tidy.html")) "tidy_get_head" ((documentation . "Returns a tidyNode object starting from the tag of the tidy parse tree tidyNode tidy_get_head(tidy $object) Returns the tidyNode object. ()") (versions . "") (return . "Returns the tidyNode object.
") (prototype . "tidyNode tidy_get_head(tidy $object)") (purpose . "Returns a tidyNode object starting from the tag of the tidy parse tree") (id . "tidy.head")) "tidy_get_status" ((documentation . "Get status of specified document int tidy_get_status(tidy $object) Returns 0 if no error/warning was raised, 1 for warnings or accessibility errors, or 2 for errors. ()") (versions . "") (return . "Returns 0 if no error/warning was raised, 1 for warnings or accessibility errors, or 2 for errors.
") (prototype . "int tidy_get_status(tidy $object)") (purpose . "Get status of specified document") (id . "tidy.getstatus")) "tidy_get_release" ((documentation . "Get release date (version) for Tidy library string tidy_get_release() Returns a string with the release date of the Tidy library. ()") (versions . "") (return . "Returns a string with the release date of the Tidy library.
") (prototype . "string tidy_get_release()") (purpose . "Get release date (version) for Tidy library") (id . "tidy.getrelease")) "tidy_get_opt_doc" ((documentation . "Returns the documentation for the given option name string tidy_get_opt_doc(string $optname, tidy $object) Returns a string if the option exists and has documentation available, or FALSE otherwise. ()") (versions . "") (return . " Returns a string if the option exists and has documentation available, or FALSE otherwise.
Returns the value of the specified option. The return type depends on the type of the specified one.
Returns the detected HTML version.
This function is not yet implemented in the Tidylib itself, so it always return 0.
Returns an array of configuration options.
For an explanation about each option, visit » http://tidy.sourceforge.net/docs/quickref.html.
") (prototype . "array tidy_get_config(tidy $object)") (purpose . "Get current Tidy configuration") (id . "tidy.getconfig")) "tidy_get_error_buffer" ((documentation . "Return warnings and errors which occurred parsing the specified document string tidy.$errorBuffer(tidy $tidy) Returns the error buffer as a string. ()") (versions . "") (return . "Returns the error buffer as a string.
") (prototype . "string tidy.$errorBuffer(tidy $tidy)") (purpose . "Return warnings and errors which occurred parsing the specified document") (id . "tidy.props.errorbuffer")) "tidy_diagnose" ((documentation . "Run configured diagnostics on parsed and repaired markup bool tidy_diagnose(tidy $object) Returns TRUE on success or FALSE on failure. (PHP 5, PECL tidy >= 0.5.2)") (versions . "PHP 5, PECL tidy >= 0.5.2") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns a tidyNode object starting from the <body> tag of the tidy parse tree.
") (prototype . "tidyNode tidy_get_body(tidy $object)") (purpose . "Returns a tidyNode object starting from the tag of the tidy parse tree") (id . "tidy.body")) "stream_wrapper_unregister" ((documentation . "Unregister a URL wrapper bool stream_wrapper_unregister(string $protocol) Returns TRUE on success or FALSE on failure. (PHP 5 >= 5.1.0)") (versions . "PHP 5 >= 5.1.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
stream_wrapper_register will return FALSE if the protocol already has a handler.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the created stream, or FALSE on error.
Returns a result code, as an integer.
") (prototype . "int stream_socket_sendto(resource $socket, string $data [, int $flags = '' [, string $address = '']])") (purpose . "Sends a message to a socket, whether it is connected or not") (id . "function.stream-socket-sendto")) "stream_socket_recvfrom" ((documentation . "Receives data from a socket, connected or not string stream_socket_recvfrom(resource $socket, int $length [, int $flags = '' [, string $address = '']]) Returns the read data, as a string (PHP 5)") (versions . "PHP 5") (return . "Returns the read data, as a string
") (prototype . "string stream_socket_recvfrom(resource $socket, int $length [, int $flags = '' [, string $address = '']])") (purpose . "Receives data from a socket, connected or not") (id . "function.stream-socket-recvfrom")) "stream_socket_pair" ((documentation . "Creates a pair of connected, indistinguishable socket streams array stream_socket_pair(int $domain, int $type, int $protocol) Returns an array with the two socket resources on success, or FALSE on failure. (PHP 5 >= 5.1.0)") (versions . "PHP 5 >= 5.1.0") (return . " Returns an array with the two socket resources on success, or FALSE on failure.
The name of the socket.
") (prototype . "string stream_socket_get_name(resource $handle, bool $want_peer)") (purpose . "Retrieve the name of the local or remote sockets") (id . "function.stream-socket-get-name")) "stream_socket_enable_crypto" ((documentation . "Turns encryption on/off on an already connected socket mixed stream_socket_enable_crypto(resource $stream, bool $enable [, int $crypto_type = '' [, resource $session_stream = '']]) Returns TRUE on success, FALSE if negotiation has failed or 0 if there isn't enough data and you should try again (only for non-blocking sockets). (PHP 5 >= 5.1.0)") (versions . "PHP 5 >= 5.1.0") (return . " Returns TRUE on success, FALSE if negotiation has failed or 0 if there isn't enough data and you should try again (only for non-blocking sockets).
On success a stream resource is returned which may be used together with the other file functions (such as fgets, fgetss, fwrite, fclose, and feof), FALSE on failure.
Returns a stream to the accepted socket connection or FALSE on failure.
Returns 0 on success, or EOF if the request cannot be honored.
") (prototype . "int stream_set_write_buffer(resource $stream, int $buffer)") (purpose . "Sets write file buffering on the given stream") (id . "function.stream-set-write-buffer")) "stream_set_timeout" ((documentation . "Set timeout period on a stream bool stream_set_timeout(resource $stream, int $seconds [, int $microseconds = '']) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns 0 on success, or EOF if the request cannot be honored.
") (prototype . "int stream_set_read_buffer(resource $stream, int $buffer)") (purpose . "Set read file buffering on the given stream") (id . "function.stream-set-read-buffer")) "stream_set_chunk_size" ((documentation . "Set the stream chunk size int stream_set_chunk_size(resource $fp, int $chunk_size) Returns the previous chunk size on success. Will return FALSE if chunk_size is less than 1 or greater than PHP_INT_MAX. (PHP 5 >= 5.4.0)") (versions . "PHP 5 >= 5.4.0") (return . "Returns the previous chunk size on success.
Will return FALSE if chunk_size is less than 1 or greater than PHP_INT_MAX.
Returns TRUE on success or FALSE on failure.
On success stream_select returns the number of stream resources contained in the modified arrays, which may be zero if the timeout expires before anything interesting happens. On error FALSE is returned and a warning raised (this can happen if the system call is interrupted by an incoming signal).
Returns a string containing the resolved absolute filename, or FALSE on failure.
No value is returned.
") (prototype . "callable stream_notification_callback(int $notification_code, int $severity, string $message, int $message_code, int $bytes_transferred, int $bytes_max)") (purpose . "A callback function for the notification context paramater") (id . "function.stream-notification-callback")) "stream_is_local" ((documentation . "Checks if a stream is a local stream bool stream_is_local(mixed $stream_or_url) Returns TRUE on success or FALSE on failure. (PHP 5 >= 5.2.4)") (versions . "PHP 5 >= 5.2.4") (return . " Returns TRUE on success or FALSE on failure.
Returns an indexed array containing the name of all stream wrappers available on the running system.
") (prototype . "array stream_get_wrappers()") (purpose . "Retrieve list of registered streams") (id . "function.stream-get-wrappers")) "stream_get_transports" ((documentation . "Retrieve list of registered socket transports array stream_get_transports() Returns an indexed array of socket transports names. (PHP 5)") (versions . "PHP 5") (return . "Returns an indexed array of socket transports names.
") (prototype . "array stream_get_transports()") (purpose . "Retrieve list of registered socket transports") (id . "function.stream-get-transports")) "stream_get_meta_data" ((documentation . #("Retrieves header/meta data from streams/file pointers array stream_get_meta_data(resource $stream) The result array contains the following items: * timed_out (bool) - TRUE if the stream timed out while waiting for data on the last call to fread or fgets. * blocked (bool) - TRUE if the stream is in blocking IO mode. See stream_set_blocking. * eof (bool) - TRUE if the stream has reached end-of-file. Note that for socket streams this member can be TRUE even when unread_bytes is non-zero. To determine if there is more data to be read, use feof instead of reading this item. * unread_bytes (int) - the number of bytes currently contained in the PHP's own internal buffer. Note: You shouldn't use this value in a script. * stream_type (string) - a label describing the underlying implementation of the stream. * wrapper_type (string) - a label describing the protocol wrapper implementation layered over the stream. See Supported Protocols and Wrappers for more information about wrappers. * wrapper_data (mixed) - wrapper specific data attached to this stream. See Supported Protocols and Wrappers for more information about wrappers and their wrapper data. * mode (string) - the type of access required for this stream (see Table 1 of the fopen() reference) * seekable (bool) - whether the current stream can be seeked. * uri (string) - the URI/filename associated with this stream. (PHP 4 >= 4.3.0, PHP 5)" 965 999 (shr-url "wrappers.html") 1118 1127 (shr-url "wrappers.html") 1127 1128 (shr-url "wrappers.html") 1128 1137 (shr-url "wrappers.html") 1137 1138 (shr-url "wrappers.html") 1138 1141 (shr-url "wrappers.html") 1141 1142 (shr-url "wrappers.html") 1142 1150 (shr-url "wrappers.html") 1300 1307 (shr-url "function.fopen.html"))) (versions . "PHP 4 >= 4.3.0, PHP 5") (return . "The result array contains the following items:
timed_out (bool) - TRUE if the stream timed out while waiting for data on the last call to fread or fgets.
blocked (bool) - TRUE if the stream is in blocking IO mode. See stream_set_blocking.
eof (bool) - TRUE if the stream has reached end-of-file. Note that for socket streams this member can be TRUE even when unread_bytes is non-zero. To determine if there is more data to be read, use feof instead of reading this item.
unread_bytes (int) - the number of bytes currently contained in the PHP's own internal buffer.
Note: You shouldn't use this value in a script.
stream_type (string) - a label describing the underlying implementation of the stream.
wrapper_type (string) - a label describing the protocol wrapper implementation layered over the stream. See Supported Protocols and Wrappers for more information about wrappers.
wrapper_data (mixed) - wrapper specific data attached to this stream. See Supported Protocols and Wrappers for more information about wrappers and their wrapper data.
mode (string) - the type of access required for this stream (see Table 1 of the fopen() reference)
seekable (bool) - whether the current stream can be seeked.
uri (string) - the URI/filename associated with this stream.
Returns a string of up to length bytes read from the file pointed to by handle.
If an error occurs, returns FALSE.
Returns an indexed array containing the name of all stream filters available.
") (prototype . "array stream_get_filters()") (purpose . "Retrieve list of registered filters") (id . "function.stream-get-filters")) "stream_get_contents" ((documentation . "Reads remainder of a stream into a string string stream_get_contents(resource $handle [, int $maxlength = -1 [, int $offset = -1]]) Returns a string or FALSE on failure. (PHP 5)") (versions . "PHP 5") (return . " Returns a string or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
stream_filter_register will return FALSE if the filtername is already defined.
Returns a resource which can be used to refer to this filter instance during a call to stream_filter_remove.
") (prototype . "resource stream_filter_prepend(resource $stream, string $filtername [, int $read_write = '' [, mixed $params = '']])") (purpose . "Attach a filter to a stream") (id . "function.stream-filter-prepend")) "stream_filter_append" ((documentation . "Attach a filter to a stream resource stream_filter_append(resource $stream, string $filtername [, int $read_write = '' [, mixed $params = '']]) Returns a resource which can be used to refer to this filter instance during a call to stream_filter_remove. (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . "Returns a resource which can be used to refer to this filter instance during a call to stream_filter_remove.
") (prototype . "resource stream_filter_append(resource $stream, string $filtername [, int $read_write = '' [, mixed $params = '']])") (purpose . "Attach a filter to a stream") (id . "function.stream-filter-append")) "stream_encoding" ((documentation . "Set character set for stream encoding bool stream_encoding(resource $stream [, string $encoding = '']) ()") (versions . "") (return . "") (prototype . "bool stream_encoding(resource $stream [, string $encoding = ''])") (purpose . "Set character set for stream encoding") (id . "function.stream-encoding")) "stream_copy_to_stream" ((documentation . "Copies data from one stream to another int stream_copy_to_stream(resource $source, resource $dest [, int $maxlength = -1 [, int $offset = '']]) Returns the total count of bytes copied. (PHP 5)") (versions . "PHP 5") (return . "Returns the total count of bytes copied.
") (prototype . "int stream_copy_to_stream(resource $source, resource $dest [, int $maxlength = -1 [, int $offset = '']])") (purpose . "Copies data from one stream to another") (id . "function.stream-copy-to-stream")) "stream_context_set_params" ((documentation . "Set parameters for a stream/wrapper/context bool stream_context_set_params(resource $stream_or_context, array $params) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the default stream context.
") (prototype . "resource stream_context_set_default(array $options)") (purpose . "Set the default stream context") (id . "function.stream-context-set-default")) "stream_context_get_params" ((documentation . "Retrieves parameters from a context array stream_context_get_params(resource $stream_or_context) Returns an associate array containing all context options and parameters. (PHP 5 >= 5.3.0)") (versions . "PHP 5 >= 5.3.0") (return . "Returns an associate array containing all context options and parameters.
") (prototype . "array stream_context_get_params(resource $stream_or_context)") (purpose . "Retrieves parameters from a context") (id . "function.stream-context-get-params")) "stream_context_get_options" ((documentation . "Retrieve options for a stream/wrapper/context array stream_context_get_options(resource $stream_or_context) Returns an associative array with the options. (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . "Returns an associative array with the options.
") (prototype . "array stream_context_get_options(resource $stream_or_context)") (purpose . "Retrieve options for a stream/wrapper/context") (id . "function.stream-context-get-options")) "stream_context_get_default" ((documentation . "Retrieve the default stream context resource stream_context_get_default([array $options = '']) A stream context resource. (PHP 5 >= 5.1.0)") (versions . "PHP 5 >= 5.1.0") (return . "A stream context resource.
") (prototype . "resource stream_context_get_default([array $options = ''])") (purpose . "Retrieve the default stream context") (id . "function.stream-context-get-default")) "stream_context_create" ((documentation . "Creates a stream context resource stream_context_create([array $options = '' [, array $params = '']]) A stream context resource. (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . "A stream context resource.
") (prototype . "resource stream_context_create([array $options = '' [, array $params = '']])") (purpose . "Creates a stream context") (id . "function.stream-context-create")) "stream_bucket_prepend" ((documentation . "Prepend bucket to brigade void stream_bucket_prepend(resource $brigade, resource $bucket) No value is returned. (PHP 5)") (versions . "PHP 5") (return . "No value is returned.
") (prototype . "void stream_bucket_prepend(resource $brigade, resource $bucket)") (purpose . "Prepend bucket to brigade") (id . "function.stream-bucket-prepend")) "stream_bucket_new" ((documentation . "Create a new bucket for use on the current stream object stream_bucket_new(resource $stream, string $buffer) (PHP 5)") (versions . "PHP 5") (return . "") (prototype . "object stream_bucket_new(resource $stream, string $buffer)") (purpose . "Create a new bucket for use on the current stream") (id . "function.stream-bucket-new")) "stream_bucket_make_writeable" ((documentation . "Return a bucket object from the brigade for operating on object stream_bucket_make_writeable(resource $brigade) (PHP 5)") (versions . "PHP 5") (return . "") (prototype . "object stream_bucket_make_writeable(resource $brigade)") (purpose . "Return a bucket object from the brigade for operating on") (id . "function.stream-bucket-make-writeable")) "stream_bucket_append" ((documentation . "Append bucket to brigade void stream_bucket_append(resource $brigade, resource $bucket) (PHP 5)") (versions . "PHP 5") (return . "") (prototype . "void stream_bucket_append(resource $brigade, resource $bucket)") (purpose . "Append bucket to brigade") (id . "function.stream-bucket-append")) "set_socket_blocking" ((documentation . "Alias of stream_set_blocking set_socket_blocking() (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "") (prototype . " set_socket_blocking()") (purpose . "Alias of stream_set_blocking") (id . "function.set-socket-blocking")) "spl_object_hash" ((documentation . "Return hash id for given object string spl_object_hash(object $obj) A string that is unique for each currently existing object and is always the same for each object. (PHP 5 >= 5.2.0)") (versions . "PHP 5 >= 5.2.0") (return . "A string that is unique for each currently existing object and is always the same for each object.
") (prototype . "string spl_object_hash(object $obj)") (purpose . "Return hash id for given object") (id . "function.spl-object-hash")) "spl_classes" ((documentation . "Return available SPL classes array spl_classes() Returns an array containing the currently available SPL classes. (PHP 5)") (versions . "PHP 5") (return . "Returns an array containing the currently available SPL classes.
") (prototype . "array spl_classes()") (purpose . "Return available SPL classes") (id . "function.spl-classes")) "spl_autoload" ((documentation . "Default implementation for __autoload() void spl_autoload(string $class_name [, string $file_extensions = spl_autoload_extensions()]) No value is returned. (PHP 5 >= 5.1.2)") (versions . "PHP 5 >= 5.1.2") (return . "No value is returned.
") (prototype . "void spl_autoload(string $class_name [, string $file_extensions = spl_autoload_extensions()])") (purpose . "Default implementation for __autoload()") (id . "function.spl-autoload")) "spl_autoload_unregister" ((documentation . "Unregister given function as __autoload() implementation bool spl_autoload_unregister(mixed $autoload_function) Returns TRUE on success or FALSE on failure. (PHP 5 >= 5.1.2)") (versions . "PHP 5 >= 5.1.2") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
An array of all registered __autoload functions. If the autoload stack is not activated then the return value is FALSE. If no function is registered the return value will be an empty array.
A comma delimited list of default file extensions for spl_autoload.
") (prototype . "string spl_autoload_extensions([string $file_extensions = ''])") (purpose . "Register and return default file extensions for spl_autoload") (id . "function.spl-autoload-extensions")) "spl_autoload_call" ((documentation . "Try all registered __autoload() function to load the requested class void spl_autoload_call(string $class_name) No value is returned. (PHP 5 >= 5.1.2)") (versions . "PHP 5 >= 5.1.2") (return . "No value is returned.
") (prototype . "void spl_autoload_call(string $class_name)") (purpose . "Try all registered __autoload() function to load the requested class") (id . "function.spl-autoload-call")) "iterator_to_array" ((documentation . "Copy the iterator into an array array iterator_to_array(Traversable $iterator [, bool $use_keys = true]) An array containing the elements of the iterator. (PHP 5 >= 5.1.0)") (versions . "PHP 5 >= 5.1.0") (return . " An array containing the elements of the iterator.
The number of elements in iterator.
Returns the iteration count.
") (prototype . "int iterator_apply(Traversable $iterator, callable $function [, array $args = ''])") (purpose . "Call a function for every element in an iterator") (id . "function.iterator-apply")) "class_uses" ((documentation . "Return the traits used by the given class array class_uses(mixed $class [, bool $autoload = true]) An array on success, or FALSE on error. (PHP 5 >= 5.4.0)") (versions . "PHP 5 >= 5.4.0") (return . " An array on success, or FALSE on error.
An array on success, or FALSE on error.
An array on success, or FALSE on error.
Returns an array containing argument information.
") (prototype . "array parsekit_func_arginfo(mixed $function)") (purpose . "Return information regarding function argument(s)") (id . "function.parsekit-func-arginfo")) "parsekit_compile_string" ((documentation . "Compile a string of PHP code and return the resulting op array array parsekit_compile_string(string $phpcode [, array $errors = '' [, int $options = PARSEKIT_QUIET]]) Returns a complex multi-layer array structure as detailed below. (PECL parsekit >= 0.2.0)") (versions . "PECL parsekit >= 0.2.0") (return . "Returns a complex multi-layer array structure as detailed below.
") (prototype . "array parsekit_compile_string(string $phpcode [, array $errors = '' [, int $options = PARSEKIT_QUIET]])") (purpose . "Compile a string of PHP code and return the resulting op array") (id . "function.parsekit-compile-string")) "parsekit_compile_file" ((documentation . "Compile a string of PHP code and return the resulting op array array parsekit_compile_file(string $filename [, array $errors = '' [, int $options = PARSEKIT_QUIET]]) Returns a complex multi-layer array structure as detailed below. (PECL parsekit >= 0.2.0)") (versions . "PECL parsekit >= 0.2.0") (return . "Returns a complex multi-layer array structure as detailed below.
") (prototype . "array parsekit_compile_file(string $filename [, array $errors = '' [, int $options = PARSEKIT_QUIET]])") (purpose . "Compile a string of PHP code and return the resulting op array") (id . "function.parsekit-compile-file")) "usleep" ((documentation . "Delay execution in microseconds void usleep(int $micro_seconds) No value is returned. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "No value is returned.
") (prototype . "void usleep(int $micro_seconds)") (purpose . "Delay execution in microseconds") (id . "function.usleep")) "unpack" ((documentation . "Unpack data from binary string array unpack(string $format, string $data) Returns an associative array containing unpacked elements of binary string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns an associative array containing unpacked elements of binary string.
") (prototype . "array unpack(string $format, string $data)") (purpose . "Unpack data from binary string") (id . "function.unpack")) "uniqid" ((documentation . "Generate a unique ID string uniqid([string $prefix = \"\" [, bool $more_entropy = false]]) Returns the unique identifier, as a string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the unique identifier, as a string.
") (prototype . "string uniqid([string $prefix = \"\" [, bool $more_entropy = false]])") (purpose . "Generate a unique ID") (id . "function.uniqid")) "time_sleep_until" ((documentation . "Make the script sleep until the specified time bool time_sleep_until(float $timestamp) Returns TRUE on success or FALSE on failure. (PHP 5 >= 5.1.0)") (versions . "PHP 5 >= 5.1.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
If the delay was interrupted by a signal, an associative array will be returned with the components:
Returns an array with three samples (last 1, 5 and 15 minutes).
") (prototype . "array sys_getloadavg()") (purpose . "Gets system load average") (id . "function.sys-getloadavg")) "sleep" ((documentation . "Delay execution int sleep(int $seconds) Returns zero on success, or FALSE on error. If the call was interrupted by a signal, sleep returns a non-zero value. On Windows, this value will always be 192 (the value of the WAIT_IO_COMPLETION constant within the Windows API). On other platforms, the return value will be the number of seconds left to sleep. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns zero on success, or FALSE on error.
If the call was interrupted by a signal, sleep returns a non-zero value. On Windows, this value will always be 192 (the value of the WAIT_IO_COMPLETION constant within the Windows API). On other platforms, the return value will be the number of seconds left to sleep.
The stripped source code will be returned on success, or an empty string on failure.
") (prototype . "string php_strip_whitespace(string $filename)") (purpose . "Return source with stripped comments and whitespace") (id . "function.php-strip-whitespace")) "php_check_syntax" ((documentation . "Check the PHP syntax of (and execute) the specified file bool php_check_syntax(string $filename [, string $error_message = '']) Returns TRUE if the lint check passed, and FALSE if the link check failed or if filename cannot be opened. (PHP 5 <= 5.0.4)") (versions . "PHP 5 <= 5.0.4") (return . "Note:
This function works as described as of PHP 5.0.1. Before this it would only return an empty string. For more information on this bug and its prior behavior, see bug report » #29606.
Returns TRUE if the lint check passed, and FALSE if the link check failed or if filename cannot be opened.
Returns a binary string containing data.
") (prototype . "string pack(string $format [, mixed $args = '' [, mixed $... = '']])") (purpose . "Pack data into binary string") (id . "function.pack")) "ignore_user_abort" ((documentation . "Set whether a client disconnect should abort script execution int ignore_user_abort([string $value = '']) Returns the previous setting, as an integer. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the previous setting, as an integer.
") (prototype . "int ignore_user_abort([string $value = ''])") (purpose . "Set whether a client disconnect should abort script execution") (id . "function.ignore-user-abort")) "highlight_string" ((documentation . "Syntax highlighting of a string mixed highlight_string(string $str [, bool $return = false]) If return is set to TRUE, returns the highlighted code as a string instead of printing it out. Otherwise, it will return TRUE on success, FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " If return is set to TRUE, returns the highlighted code as a string instead of printing it out. Otherwise, it will return TRUE on success, FALSE on failure.
If return is set to TRUE, returns the highlighted code as a string instead of printing it out. Otherwise, it will return TRUE on success, FALSE on failure.
No value is returned.
") (prototype . "void __halt_compiler()") (purpose . "Halts the compiler execution") (id . "function.halt-compiler")) "get_browser" ((documentation . "Tells what the user's browser is capable of mixed get_browser([string $user_agent = '' [, bool $return_array = false]]) The information is returned in an object or an array which will contain various data elements representing, for instance, the browser's major and minor version numbers and ID string; TRUE/FALSE values for features such as frames, JavaScript, and cookies; and so forth. The cookies value simply means that the browser itself is capable of accepting cookies and does not mean the user has enabled the browser to accept cookies or not. The only way to test if cookies are accepted is to set one with setcookie, reload, and check for the value. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " The information is returned in an object or an array which will contain various data elements representing, for instance, the browser's major and minor version numbers and ID string; TRUE/FALSE values for features such as frames, JavaScript, and cookies; and so forth.
The cookies value simply means that the browser itself is capable of accepting cookies and does not mean the user has enabled the browser to accept cookies or not. The only way to test if cookies are accepted is to set one with setcookie, reload, and check for the value.
") (prototype . "mixed get_browser([string $user_agent = '' [, bool $return_array = false]])") (purpose . "Tells what the user's browser is capable of") (id . "function.get-browser")) "exit" ((documentation . "Output a message and terminate the current script void exit(int $status) No value is returned. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "No value is returned.
") (prototype . "void exit(int $status)") (purpose . "Output a message and terminate the current script") (id . "function.exit")) "eval" ((documentation . "Evaluate a string as PHP code mixed eval(string $code) eval returns NULL unless return is called in the evaluated code, in which case the value passed to return is returned. If there is a parse error in the evaluated code, eval returns FALSE and execution of the following code continues normally. It is not possible to catch a parse error in eval using set_error_handler. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " eval returns NULL unless return is called in the evaluated code, in which case the value passed to return is returned. If there is a parse error in the evaluated code, eval returns FALSE and execution of the following code continues normally. It is not possible to catch a parse error in eval using set_error_handler.
Returns TRUE if the named constant given by name has been defined, FALSE otherwise.
Returns TRUE on success or FALSE on failure.
Returns the value of the constant, or NULL if the constant is not defined.
Returns 1 if the script timed out, 0 otherwise.
") (prototype . "int connection_timeout()") (purpose . "Check if the script timed out") (id . "function.connection-timeout")) "connection_status" ((documentation . "Returns connection status bitfield int connection_status() Returns the connection status bitfield, which can be used against the CONNECTION_XXX constants to determine the connection status. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the connection status bitfield, which can be used against the CONNECTION_XXX constants to determine the connection status.
") (prototype . "int connection_status()") (purpose . "Returns connection status bitfield") (id . "function.connection-status")) "connection_aborted" ((documentation . "Check whether client disconnected int connection_aborted() Returns 1 if client disconnected, 0 otherwise. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns 1 if client disconnected, 0 otherwise.
") (prototype . "int connection_aborted()") (purpose . "Check whether client disconnected") (id . "function.connection-aborted")) "judy_version" ((documentation . "Return or print the current PHP Judy version string judy_version() Return a string of the PHP Judy version. (PECL judy >= 0.1.1)") (versions . "PECL judy >= 0.1.1") (return . "Return a string of the PHP Judy version.
") (prototype . "string judy_version()") (purpose . "Return or print the current PHP Judy version") (id . "function.judy-version")) "judy_type" ((documentation . #("Return the type of a Judy array int judy_type(Judy $array) Return an integer corresponding to a Judy type. (PECL judy >= 0.1.1)" 103 107 (shr-url "class.judy.html#judy.types"))) (versions . "PECL judy >= 0.1.1") (return . "Return an integer corresponding to a Judy type.
") (prototype . "int judy_type(Judy $array)") (purpose . "Return the type of a Judy array") (id . "function.judy-type")) "json_last_error" ((documentation . #("Returns the last error occurred int json_last_error() Returns an integer, the value can be one of the following constants: JSON error codes Constant Meaning Availability JSON_ERROR_NONE No error has occurred JSON_ERROR_DEPTH The maximum stack depth has been exceeded JSON_ERROR_STATE_MISMATCH Invalid or malformed JSON JSON_ERROR_CTRL_CHAR Control character error, possibly incorrectly encoded JSON_ERROR_SYNTAX Syntax error JSON_ERROR_UTF8 Malformed UTF-8 PHP 5.3.3 characters, possibly incorrectly encoded JSON_ERROR_RECURSION One or more recursive PHP 5.5.0 references in the value to be encoded JSON_ERROR_INF_OR_NAN One or more NAN or INF PHP 5.5.0 values in the value to be encoded JSON_ERROR_UNSUPPORTED_TY A value of a type that PHP 5.5.0 PE cannot be encoded was given (PHP 5 >= 5.3.0)" 962 965 (shr-url "language.types.float.html#language.types.float.nan") 969 972 (shr-url "function.is-infinite.html"))) (versions . "PHP 5 >= 5.3.0") (return . "Returns an integer, the value can be one of the following constants:
| Constant | Meaning | Availability |
|---|---|---|
JSON_ERROR_NONE | No error has occurred | |
JSON_ERROR_DEPTH | The maximum stack depth has been exceeded | |
JSON_ERROR_STATE_MISMATCH | Invalid or malformed JSON | |
JSON_ERROR_CTRL_CHAR | Control character error, possibly incorrectly encoded | |
JSON_ERROR_SYNTAX | Syntax error | |
JSON_ERROR_UTF8 | Malformed UTF-8 characters, possibly incorrectly encoded | PHP 5.3.3 |
JSON_ERROR_RECURSION | One or more recursive references in the value to be encoded | PHP 5.5.0 |
JSON_ERROR_INF_OR_NAN | One or more NAN or INF values in the value to be encoded | PHP 5.5.0 |
JSON_ERROR_UNSUPPORTED_TYPE | A value of a type that cannot be encoded was given | PHP 5.5.0 |
Returns the error message on success or NULL with wrong parameters.
Returns a JSON encoded string on success or FALSE on failure.
Returns the value encoded in json in appropriate PHP type. Values true, false and null (case-insensitive) are returned as TRUE, FALSE and NULL respectively. NULL is returned if the json cannot be decoded or if the encoded data is deeper than the recursion limit.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
The MSE, or FALSE on error.
Returns TRUE on success, or FALSE otherwise.
The updated MSE, or FALSE on error.
Returns a train data resource on success, or FALSE on error.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
No value is returned.
") (prototype . "void fann_set_error_log(resource $errdat, string $log_file)") (purpose . "Sets where the errors are logged to") (id . "function.fann-set-error-log")) "fann_set_cascade_weight_multiplier" ((documentation . "Sets the weight multiplier bool fann_set_cascade_weight_multiplier(resource $ann, float $cascade_weight_multiplier) Returns TRUE on success, or FALSE otherwise. (PECL fann >= 1.0.0)") (versions . "PECL fann >= 1.0.0") (return . "Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Array of output values, or FALSE on error
Returns TRUE on success, or FALSE otherwise.
No value is returned.
") (prototype . "void fann_reset_errstr(resource $errdat)") (purpose . "Resets the last error string") (id . "function.fann-reset-errstr")) "fann_reset_errno" ((documentation . "Resets the last error number void fann_reset_errno(resource $errdat) No value is returned. (PECL fann >= 1.0.0)") (versions . "PECL fann >= 1.0.0") (return . "No value is returned.
") (prototype . "void fann_reset_errno(resource $errdat)") (purpose . "Resets the last error number") (id . "function.fann-reset-errno")) "fann_read_train_from_file" ((documentation . "Reads a file that stores training data resource fann_read_train_from_file(string $filename) Returns a train data resource on success, or FALSE on error. (PECL fann >= 1.0.0)") (versions . "PECL fann >= 1.0.0") (return . " Returns a train data resource on success, or FALSE on error.
Returns TRUE on success, or FALSE otherwise.
No value is returned.
") (prototype . "void fann_print_error(string $errdat)") (purpose . "Prints the error string") (id . "function.fann-print-error")) "fann_num_output_train_data" ((documentation . "Returns the number of outputs in each of the training patterns in the train data resource fann_num_output_train_data(resource $data) The number of outputs, or FALSE on error. (PECL fann >= 1.0.0)") (versions . "PECL fann >= 1.0.0") (return . " The number of outputs, or FALSE on error.
The number of inputs, or FALSE on error.
New merged train data resource, or FALSE on error.
Number of elements in the train data resource, or FALSE on error.
Returns TRUE on success, or FALSE otherwise.
Training algorithm constant, or FALSE on error.
The stop function constant, or FALSE on error.
The error function constant, or FALSE on error.
Total number of neurons in the entire network, or FALSE on error.
Total number of connections in the entire network, or FALSE on error
The sarprop weight decay shift, or FALSE on error.
The sarprop temperature, or FALSE on error.
The sarprop step error threshold factor, or FALSE on error.
The sarprop step error shift , or FALSE on error.
The increase factor, or FALSE on error.
The initial step-size, or FALSE on error.
The minimum step-size, or FALSE on error.
The maximum step-size, or FALSE on error.
The decrease factor, or FALSE on error.
The mu factor, or FALSE on error.
The decay, or FALSE on error.
Number of output neurons, or FALSE on error
The number of leayers in the neural network, or FALSE on error.
Number of input neurons, or FALSE on error
Network type constant, or FALSE on error.
The mean square error, or FALSE on error.
The learning rate, or FALSE on error.
Returns TRUE on success, or FALSE otherwise.
The learning momentum, or FALSE on error.
An array of numbers of neurons in each leayer
") (prototype . "array fann_get_layer_array(resource $ann)") (purpose . "Get the number of neurons in each layer in the network") (id . "function.fann-get-layer-array")) "fann_get_errstr" ((documentation . "Returns the last errstr string fann_get_errstr(resource $errdat) The last error string, or FALSE on error. (PECL fann >= 1.0.0)") (versions . "PECL fann >= 1.0.0") (return . " The last error string, or FALSE on error.
The error number, or FALSE on error.
The connection rate used when the network was created, or FALSE on error.
An array of connections in the network
") (prototype . "array fann_get_connection_array(resource $ann)") (purpose . "Get connections in the network") (id . "function.fann-get-connection-array")) "fann_get_cascade_weight_multiplier" ((documentation . "Returns the weight multiplier float fann_get_cascade_weight_multiplier(resource $ann) The weight multiplier, or FALSE on error. (PECL fann >= 1.0.0)") (versions . "PECL fann >= 1.0.0") (return . " The weight multiplier, or FALSE on error.
The number of cascade output stagnation epochs, or FALSE on error.
The cascade output change fraction, or FALSE on error.
The number of candidates used during training, or FALSE on error.
The number of candidate groups, or FALSE on error.
The minimum out epochs, or FALSE on error.
The minimum candidate epochs, or FALSE on error.
The maximum out epochs, or FALSE on error.
The maximum candidate epochs, or FALSE on error.
The number of cascade candidate stagnation epochs, or FALSE on error.
The candidate limit, or FALSE on error.
The cascade candidate change fraction, or FALSE on error.
The cascade activation steepnesses, or FALSE on error.
The number of activation steepnesses, or FALSE on error.
The cascade activation functions, or FALSE on error.
The number of cascade activation functions, or FALSE on error.
The number of bits fail, or FALSE on error.
The bit fail limit, or FALSE on error.
An array of numbers of bias in each layer
") (prototype . "array fann_get_bias_array(resource $ann)") (purpose . "Get the number of bias in each layer in the network") (id . "function.fann-get-bias-array")) "fann_get_activation_steepness" ((documentation . "Returns the activation steepness for supplied neuron and layer number float fann_get_activation_steepness(resource $ann, int $layer, int $neuron) The activation steepness for the neuron or -1 if the neuron is not defined in the neural network, or FALSE on error. (PECL fann >= 1.0.0)") (versions . "PECL fann >= 1.0.0") (return . " The activation steepness for the neuron or -1 if the neuron is not defined in the neural network, or FALSE on error.
Learning functions constant or -1 if the neuron is not defined in the neural network, or FALSE on error.
Returns a train data resource on success, or FALSE on error.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns a train data resource on success, or FALSE on error.
Returns a train data resource on success, or FALSE on error.
Returns a neural network resource on success, or FALSE on error.
Returns a neural network resource on success, or FALSE on error.
Returns a neural network resource on success, or FALSE on error.
Returns a neural network resource on success, or FALSE on error.
Returns a neural network resource on success, or FALSE on error.
Returns a neural network resource on success, or FALSE on error.
Returns a neural network resource on success, or FALSE on error.
Returns a copy of neural network resource on success, or FALSE on error
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns TRUE on success, or FALSE otherwise.
Returns the time zone on success, or FALSE if the country and region code combo cannot be found.
Returns the region name on success, or FALSE if the country and region code combo cannot be found.
Returns the associative array on success, or FALSE if the address cannot be found in the database.
Returns the associative array on success, or FALSE if the address cannot be found in the database.
Returns the organization name on success, or FALSE if the address cannot be found in the database.
Returns the ISP name on success, or FALSE if the address cannot be found in the database.
Returns the connection type.
") (prototype . "int geoip_id_by_name(string $hostname)") (purpose . "Get the Internet connection type") (id . "function.geoip-id-by-name")) "geoip_db_get_all_info" ((documentation . "Returns detailed information about all GeoIP database types array geoip_db_get_all_info() Returns the associative array. (PECL geoip >= 1.0.1)") (versions . "PECL geoip >= 1.0.1") (return . "Returns the associative array.
") (prototype . "array geoip_db_get_all_info()") (purpose . "Returns detailed information about all GeoIP database types") (id . "function.geoip-db-get-all-info")) "geoip_db_filename" ((documentation . "Returns the filename of the corresponding GeoIP Database string geoip_db_filename(int $database) Returns the filename of the corresponding database, or NULL on error. (PECL geoip >= 1.0.1)") (versions . "PECL geoip >= 1.0.1") (return . " Returns the filename of the corresponding database, or NULL on error.
Returns TRUE is database exists, FALSE if not found, or NULL on error.
Returns the corresponding database version, or NULL on error.
Returns the country name on success, or FALSE if the address cannot be found in the database.
Returns the three letter country code on success, or FALSE if the address cannot be found in the database.
Returns the two letter ISO country code on success, or FALSE if the address cannot be found in the database.
Returns the two letter continent code on success, or FALSE if the address cannot be found in the database.
| Code | Continent name |
|---|---|
| AF | Africa |
| AN | Antarctica |
| AS | Asia |
| EU | Europe |
| NA | North america |
| OC | Oceania |
| SA | South america |
The size of the written data, or FALSE on failure.
Returns an int, which represents the number of bytes the shared memory block occupies.
") (prototype . "int shmop_size(int $shmid)") (purpose . "Get size of shared memory block") (id . "function.shmop-size")) "shmop_read" ((documentation . "Read data from shared memory block string shmop_read(int $shmid, int $start, int $count) Returns the data or FALSE on failure. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . " Returns the data or FALSE on failure.
On success shmop_open will return an id that you can use to access the shared memory segment you've created. FALSE is returned on failure.
Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void shmop_close(int $shmid)") (purpose . "Close shared memory block") (id . "function.shmop-close")) "shm_remove" ((documentation . "Removes shared memory from Unix systems bool shm_remove(resource $shm_identifier) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE if the entry exists, otherwise FALSE
Returns the variable with the given key.
") (prototype . "mixed shm_get_var(resource $shm_identifier, int $variable_key)") (purpose . "Returns a variable from shared memory") (id . "function.shm-get-var")) "shm_detach" ((documentation . "Disconnects from shared memory segment bool shm_detach(resource $shm_identifier) shm_detach always returns TRUE. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " shm_detach always returns TRUE.
Returns a shared memory segment identifier.
") (prototype . "resource shm_attach(int $key [, int $memsize = '' [, int $perm = 0666]])") (purpose . "Creates or open a shared memory segment") (id . "function.shm-attach")) "sem_remove" ((documentation . "Remove a semaphore bool sem_remove(resource $sem_identifier) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.1.0, PHP 5)") (versions . "PHP 4 >= 4.1.0, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns a positive semaphore identifier on success, or FALSE on error.
Returns TRUE on success or FALSE on failure.
The return value is an array whose keys and values have the following meanings:
| msg_perm.uid | The uid of the owner of the queue. |
| msg_perm.gid | The gid of the owner of the queue. |
| msg_perm.mode | The file access mode of the queue. |
| msg_stime | The time that the last message was sent to the queue. |
| msg_rtime | The time that the last message was received from the queue. |
| msg_ctime | The time that the queue was last changed. |
| msg_qnum | The number of messages waiting to be read from the queue. |
| msg_qbytes | The maximum number of bytes allowed in one message queue. On Linux, this value may be read and modified via /proc/sys/kernel/msgmnb. |
| msg_lspid | The pid of the process that sent the last message to the queue. |
| msg_lrpid | The pid of the process that received the last message from the queue. |
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Upon successful completion the message queue data structure is updated as follows: msg_lspid is set to the process-ID of the calling process, msg_qnum is incremented by 1 and msg_stime is set to the current time.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Upon successful completion the message queue data structure is updated as follows: msg_lrpid is set to the process-ID of the calling process, msg_qnum is decremented by 1 and msg_rtime is set to the current time.
") (prototype . "bool msg_receive(resource $queue, int $desiredmsgtype, int $msgtype, int $maxsize, mixed $message [, bool $unserialize = true [, int $flags = '' [, int $errorcode = '']]])") (purpose . "Receive a message from a message queue") (id . "function.msg-receive")) "msg_queue_exists" ((documentation . "Check whether a message queue exists bool msg_queue_exists(int $key) Returns TRUE on success or FALSE on failure. (PHP 5 >= 5.3.0)") (versions . "PHP 5 >= 5.3.0") (return . " Returns TRUE on success or FALSE on failure.
Returns a resource handle that can be used to access the System V message queue.
") (prototype . "resource msg_get_queue(int $key [, int $perms = 0666])") (purpose . "Create or attach to a message queue") (id . "function.msg-get-queue")) "ftok" ((documentation . "Convert a pathname and a project identifier to a System V IPC key int ftok(string $pathname, string $proj) On success the return value will be the created key value, otherwise - 1 is returned. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . "On success the return value will be the created key value, otherwise -1 is returned.
") (prototype . "int ftok(string $pathname, string $proj)") (purpose . "Convert a pathname and a project identifier to a System V IPC key") (id . "function.ftok")) "system" ((documentation . "Execute an external program and display the output string system(string $command [, int $return_var = '']) Returns the last line of the command output on success, and FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns the last line of the command output on success, and FALSE on failure.
The output from the executed command or NULL if an error occurred or the command produces no output.
") (prototype . "string shell_exec(string $cmd)") (purpose . "Execute command via shell and return the complete output as a string") (id . "function.shell-exec")) "proc_terminate" ((documentation . "Kills a process opened by proc_open bool proc_terminate(resource $process [, int $signal = 15]) Returns the termination status of the process that was run. (PHP 5)") (versions . "PHP 5") (return . "Note:
This function can return
NULLboth when an error occurs or the program produces no output. It is not possible to detect execution failures using this function. exec should be used when access to the program exit code is required.
Returns the termination status of the process that was run.
") (prototype . "bool proc_terminate(resource $process [, int $signal = 15])") (purpose . "Kills a process opened by proc_open") (id . "function.proc-terminate")) "proc_open" ((documentation . "Execute a command and open file pointers for input/output resource proc_open(string $cmd, array $descriptorspec, array $pipes [, string $cwd = '' [, array $env = '' [, array $other_options = '']]]) Returns a resource representing the process, which should be freed using proc_close when you are finished with it. On failure returns FALSE. (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . " Returns a resource representing the process, which should be freed using proc_close when you are finished with it. On failure returns FALSE.
Returns TRUE on success or FALSE on failure. If an error occurs, like the user lacks permission to change the priority, an error of level E_WARNING is also generated.
An array of collected information on success, and FALSE on failure. The returned array contains the following elements:
| element | type | description |
|---|---|---|
| command | string | The command string that was passed to proc_open. |
| pid | int | process id |
| running | bool | TRUE if the process is still running, FALSE if it has terminated. |
| signaled | bool | TRUE if the child process has been terminated by an uncaught signal. Always set to FALSE on Windows. |
| stopped | bool | TRUE if the child process has been stopped by a signal. Always set to FALSE on Windows. |
| exitcode | int | The exit code returned by the process (which is only meaningful if running is FALSE). Only first call of this function return real value, next calls return -1. |
| termsig | int | The number of the signal that caused the child process to terminate its execution (only meaningful if signaled is TRUE). |
| stopsig | int | The number of the signal that caused the child process to stop its execution (only meaningful if stopped is TRUE). |
Returns the termination status of the process that was run. In case of an error then -1 is returned.
") (prototype . "int proc_close(resource $process)") (purpose . "Close a process opened by proc_open and return the exit code of that process") (id . "function.proc-close")) "passthru" ((documentation . "Execute an external program and display raw output void passthru(string $command [, int $return_var = '']) No value is returned. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "No value is returned.
") (prototype . "void passthru(string $command [, int $return_var = ''])") (purpose . "Execute an external program and display raw output") (id . "function.passthru")) "exec" ((documentation . "Execute an external program string exec(string $command [, array $output = '' [, int $return_var = '']]) The last line from the result of the command. If you need to execute a command and have all the data from the command passed directly back without any interference, use the passthru function. To get the output of the executed command, be sure to set and use the output parameter. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "The last line from the result of the command. If you need to execute a command and have all the data from the command passed directly back without any interference, use the passthru function.
To get the output of the executed command, be sure to set and use the output parameter.
The escaped string.
") (prototype . "string escapeshellcmd(string $command)") (purpose . "Escape shell metacharacters") (id . "function.escapeshellcmd")) "escapeshellarg" ((documentation . "Escape a string to be used as a shell argument string escapeshellarg(string $arg) The escaped string. (PHP 4 >= 4.0.3, PHP 5)") (versions . "PHP 4 >= 4.0.3, PHP 5") (return . "The escaped string.
") (prototype . "string escapeshellarg(string $arg)") (purpose . "Escape a string to be used as a shell argument") (id . "function.escapeshellarg")) "posix_uname" ((documentation . "Get system name array posix_uname() Returns a hash of strings with information about the system. The indices of the hash are * sysname - operating system name (e.g. Linux) * nodename - system name (e.g. valiant) * release - operating system release (e.g. 2.2.10) * version - operating system version (e.g. #4 Tue Jul 20 17:01:36 MEST 1999) * machine - system architecture (e.g. i586) * domainname - DNS domainname (e.g. example.com) domainname is a GNU extension and not part of POSIX.1, so this field is only available on GNU systems or when using the GNU libc. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns a hash of strings with information about the system. The indices of the hash are
domainname is a GNU extension and not part of POSIX.1, so this field is only available on GNU systems or when using the GNU libc.
") (prototype . "array posix_uname()") (purpose . "Get system name") (id . "function.posix-uname")) "posix_ttyname" ((documentation . "Determine terminal device name string posix_ttyname(int $fd) On success, returns a string of the absolute path of the fd. On failure, returns FALSE (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " On success, returns a string of the absolute path of the fd. On failure, returns FALSE
Returns a hash of strings with information about the current process CPU usage. The indices of the hash are:
Returns the error message, as a string.
") (prototype . "string posix_strerror(int $errno)") (purpose . "Retrieve the system error message associated with the given errno") (id . "function.posix-strerror")) "posix_setuid" ((documentation . "Set the UID of the current process bool posix_setuid(int $uid) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns the session id, or -1 on errors.
") (prototype . "int posix_setsid()") (purpose . "Make the current process a session leader") (id . "function.posix-setsid")) "posix_setpgid" ((documentation . "Set process group id for job control bool posix_setpgid(int $pid, int $pgid) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE if fd is an open descriptor connected to a terminal and FALSE otherwise.
Returns TRUE on success or FALSE on failure.
Returns the user id, as an integer
") (prototype . "int posix_getuid()") (purpose . "Return the real user ID of the current process") (id . "function.posix-getuid")) "posix_getsid" ((documentation . "Get the current sid of the process int posix_getsid(int $pid) Returns the identifier, as an integer. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the identifier, as an integer.
") (prototype . "int posix_getsid(int $pid)") (purpose . "Get the current sid of the process") (id . "function.posix-getsid")) "posix_getrlimit" ((documentation . "Return info about system resource limits array posix_getrlimit() Returns an associative array of elements for each limit that is defined. Each limit has a soft and a hard limit. List of possible limits returned Limit name Limit description core The maximum size of the core file. When 0, not core files are created. When core files are larger than this size, they will be truncated at this size. totalmem The maximum size of the memory of the process, in bytes. virtualmem The maximum size of the virtual memory for the process, in bytes. data The maximum size of the data segment for the process, in bytes. stack The maximum size of the process stack, in bytes. rss The maximum number of virtual pages resident in RAM maxproc The maximum number of processes that can be created for the real user ID of the calling process. memlock The maximum number of bytes of memory that may be locked into RAM. cpu The amount of time the process is allowed to use the CPU. filesize The maximum size of the data segment for the process, in bytes. openfiles One more than the maximum number of open file descriptors. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns an associative array of elements for each limit that is defined. Each limit has a soft and a hard limit.
| Limit name | Limit description |
|---|---|
| core | The maximum size of the core file. When 0, not core files are created. When core files are larger than this size, they will be truncated at this size. |
| totalmem | The maximum size of the memory of the process, in bytes. |
| virtualmem | The maximum size of the virtual memory for the process, in bytes. |
| data | The maximum size of the data segment for the process, in bytes. |
| stack | The maximum size of the process stack, in bytes. |
| rss | The maximum number of virtual pages resident in RAM |
| maxproc | The maximum number of processes that can be created for the real user ID of the calling process. |
| memlock | The maximum number of bytes of memory that may be locked into RAM. |
| cpu | The amount of time the process is allowed to use the CPU. |
| filesize | The maximum size of the data segment for the process, in bytes. |
| openfiles | One more than the maximum number of open file descriptors. |
Returns an associative array with the following elements:
| Element | Description |
|---|---|
| name | The name element contains the username of the user. This is a short, usually less than 16 character "handle" of the user, not the real, full name. |
| passwd | The passwd element contains the user's password in an encrypted format. Often, for example on a system employing "shadow" passwords, an asterisk is returned instead. |
| uid | User ID, should be the same as the uid parameter used when calling the function, and hence redundant. |
| gid | The group ID of the user. Use the function posix_getgrgid to resolve the group name and a list of its members. |
| gecos | GECOS is an obsolete term that refers to the finger information field on a Honeywell batch processing system. The field, however, lives on, and its contents have been formalized by POSIX. The field contains a comma separated list containing the user's full name, office phone, office number, and home phone number. On most systems, only the user's full name is available. |
| dir | This element contains the absolute path to the home directory of the user. |
| shell | The shell element contains the absolute path to the executable of the user's default shell. |
On success an array with the following elements is returned, else FALSE is returned:
| Element | Description |
|---|---|
| name | The name element contains the username of the user. This is a short, usually less than 16 character "handle" of the user, not the real, full name. This should be the same as the username parameter used when calling the function, and hence redundant. |
| passwd | The passwd element contains the user's password in an encrypted format. Often, for example on a system employing "shadow" passwords, an asterisk is returned instead. |
| uid | User ID of the user in numeric form. |
| gid | The group ID of the user. Use the function posix_getgrgid to resolve the group name and a list of its members. |
| gecos | GECOS is an obsolete term that refers to the finger information field on a Honeywell batch processing system. The field, however, lives on, and its contents have been formalized by POSIX. The field contains a comma separated list containing the user's full name, office phone, office number, and home phone number. On most systems, only the user's full name is available. |
| dir | This element contains the absolute path to the home directory of the user. |
| shell | The shell element contains the absolute path to the executable of the user's default shell. |
Returns the identifier, as an integer.
") (prototype . "int posix_getppid()") (purpose . "Return the parent process identifier") (id . "function.posix-getppid")) "posix_getpid" ((documentation . "Return the current process identifier int posix_getpid() Returns the identifier, as an integer. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the identifier, as an integer.
") (prototype . "int posix_getpid()") (purpose . "Return the current process identifier") (id . "function.posix-getpid")) "posix_getpgrp" ((documentation . "Return the current process group identifier int posix_getpgrp() Returns the identifier, as an integer. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the identifier, as an integer.
") (prototype . "int posix_getpgrp()") (purpose . "Return the current process group identifier") (id . "function.posix-getpgrp")) "posix_getpgid" ((documentation . "Get process group id for job control int posix_getpgid(int $pid) Returns the identifier, as an integer. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the identifier, as an integer.
") (prototype . "int posix_getpgid(int $pid)") (purpose . "Get process group id for job control") (id . "function.posix-getpgid")) "posix_getlogin" ((documentation . "Return login name string posix_getlogin() Returns the login name of the user, as a string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the login name of the user, as a string.
") (prototype . "string posix_getlogin()") (purpose . "Return login name") (id . "function.posix-getlogin")) "posix_getgroups" ((documentation . "Return the group set of the current process array posix_getgroups() Returns an array of integers containing the numeric group ids of the group set of the current process. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns an array of integers containing the numeric group ids of the group set of the current process.
") (prototype . "array posix_getgroups()") (purpose . "Return the group set of the current process") (id . "function.posix-getgroups")) "posix_getgrnam" ((documentation . "Return info about a group by name array posix_getgrnam(string $name) The array elements returned are: The group information array Element Description name The name element contains the name of the group. This is a short, usually less than 16 character \"handle\" of the group, not the real, full name. This should be the same as the name parameter used when calling the function, and hence redundant. passwd The passwd element contains the group's password in an encrypted format. Often, for example on a system employing \"shadow\" passwords, an asterisk is returned instead. gid Group ID of the group in numeric form. members This consists of an array of string's for all the members in the group. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "The array elements returned are:
| Element | Description |
|---|---|
| name | The name element contains the name of the group. This is a short, usually less than 16 character "handle" of the group, not the real, full name. This should be the same as the name parameter used when calling the function, and hence redundant. |
| passwd | The passwd element contains the group's password in an encrypted format. Often, for example on a system employing "shadow" passwords, an asterisk is returned instead. |
| gid | Group ID of the group in numeric form. |
| members | This consists of an array of string's for all the members in the group. |
The array elements returned are:
| Element | Description |
|---|---|
| name | The name element contains the name of the group. This is a short, usually less than 16 character "handle" of the group, not the real, full name. |
| passwd | The passwd element contains the group's password in an encrypted format. Often, for example on a system employing "shadow" passwords, an asterisk is returned instead. |
| gid | Group ID, should be the same as the gid parameter used when calling the function, and hence redundant. |
| members | This consists of an array of string's for all the members in the group. |
Returns the real group id, as an integer.
") (prototype . "int posix_getgid()") (purpose . "Return the real group ID of the current process") (id . "function.posix-getgid")) "posix_geteuid" ((documentation . "Return the effective user ID of the current process int posix_geteuid() Returns the user id, as an integer (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the user id, as an integer
") (prototype . "int posix_geteuid()") (purpose . "Return the effective user ID of the current process") (id . "function.posix-geteuid")) "posix_getegid" ((documentation . "Return the effective group ID of the current process int posix_getegid() Returns an integer of the effective group ID. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns an integer of the effective group ID.
") (prototype . "int posix_getegid()") (purpose . "Return the effective group ID of the current process") (id . "function.posix-getegid")) "posix_getcwd" ((documentation . "Pathname of current directory string posix_getcwd() Returns a string of the absolute pathname on success. On error, returns FALSE and sets errno which can be checked with posix_get_last_error. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns a string of the absolute pathname on success. On error, returns FALSE and sets errno which can be checked with posix_get_last_error.
Returns the errno (error number) set by the last posix function that failed. If no errors exist, 0 is returned.
") (prototype . "int posix_get_last_error()") (purpose . "Retrieve the error number set by the last posix function that failed") (id . "function.posix-get-last-error")) "posix_errno" ((documentation . "Alias of posix_get_last_error posix_errno() (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . "") (prototype . " posix_errno()") (purpose . "Alias of posix_get_last_error") (id . "function.posix-errno")) "posix_ctermid" ((documentation . "Get path name of controlling terminal string posix_ctermid() Upon successful completion, returns string of the pathname to the current controlling terminal. Otherwise FALSE is returned and errno is set, which can be checked with posix_get_last_error. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Upon successful completion, returns string of the pathname to the current controlling terminal. Otherwise FALSE is returned and errno is set, which can be checked with posix_get_last_error.
Returns TRUE on success or FALSE on failure.
Returns the signal number, as an integer.
") (prototype . "int pcntl_wtermsig(int $status)") (purpose . "Returns the signal which caused the child to terminate") (id . "function.pcntl-wtermsig")) "pcntl_wstopsig" ((documentation . "Returns the signal which caused the child to stop int pcntl_wstopsig(int $status) Returns the signal number. (PHP 4 >= 4.1.0, PHP 5)") (versions . "PHP 4 >= 4.1.0, PHP 5") (return . "Returns the signal number.
") (prototype . "int pcntl_wstopsig(int $status)") (purpose . "Returns the signal which caused the child to stop") (id . "function.pcntl-wstopsig")) "pcntl_wifstopped" ((documentation . "Checks whether the child process is currently stopped bool pcntl_wifstopped(int $status) Returns TRUE if the child process which caused the return is currently stopped, FALSE otherwise. (PHP 4 >= 4.1.0, PHP 5)") (versions . "PHP 4 >= 4.1.0, PHP 5") (return . " Returns TRUE if the child process which caused the return is currently stopped, FALSE otherwise.
Returns TRUE if the child process exited because of a signal which was not caught, FALSE otherwise.
Returns TRUE if the child status code represents a normal exit, FALSE otherwise.
Returns the return code, as an integer.
") (prototype . "int pcntl_wexitstatus(int $status)") (purpose . "Returns the return code of a terminated child") (id . "function.pcntl-wexitstatus")) "pcntl_waitpid" ((documentation . "Waits on or returns the status of a forked child int pcntl_waitpid(int $pid, int $status [, int $options = '']) pcntl_waitpid returns the process ID of the child which exited, -1 on error or zero if WNOHANG was used and no child was available (PHP 4 >= 4.1.0, PHP 5)") (versions . "PHP 4 >= 4.1.0, PHP 5") (return . " pcntl_waitpid returns the process ID of the child which exited, -1 on error or zero if WNOHANG was used and no child was available
pcntl_wait returns the process ID of the child which exited, -1 on error or zero if WNOHANG was provided as an option (on wait3-available systems) and no child was available.
") (prototype . "int pcntl_wait(int $status [, int $options = ''])") (purpose . "Waits on or returns the status of a forked child") (id . "function.pcntl-wait")) "pcntl_strerror" ((documentation . "Retrieve the system error message associated with the given errno string pcntl_strerror(int $errno) Returns error description on success or FALSE on failure. (PHP 5 >= 5.3.4)") (versions . "PHP 5 >= 5.3.4") (return . " Returns error description on success or FALSE on failure.
On success, pcntl_sigwaitinfo returns a signal number.
") (prototype . "int pcntl_sigwaitinfo(array $set [, array $siginfo = ''])") (purpose . "Waits for signals") (id . "function.pcntl-sigwaitinfo")) "pcntl_sigtimedwait" ((documentation . "Waits for signals, with a timeout int pcntl_sigtimedwait(array $set [, array $siginfo = '' [, int $seconds = '' [, int $nanoseconds = '']]]) On success, pcntl_sigtimedwait returns a signal number. (PHP 5 >= 5.3.0)") (versions . "PHP 5 >= 5.3.0") (return . "On success, pcntl_sigtimedwait returns a signal number.
") (prototype . "int pcntl_sigtimedwait(array $set [, array $siginfo = '' [, int $seconds = '' [, int $nanoseconds = '']]])") (purpose . "Waits for signals, with a timeout") (id . "function.pcntl-sigtimedwait")) "pcntl_sigprocmask" ((documentation . "Sets and retrieves blocked signals bool pcntl_sigprocmask(int $how, array $set [, array $oldset = '']) Returns TRUE on success or FALSE on failure. (PHP 5 >= 5.3.0)") (versions . "PHP 5 >= 5.3.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
pcntl_getpriority returns the priority of the process or FALSE on error. A lower numerical value causes more favorable scheduling.
This function mayreturn Boolean FALSE, but may also return a non-Boolean value whichevaluates to FALSE. Please read the section on Booleans for moreinformation. Use the ===operator for testing the return value of thisfunction.
Returns error code.
") (prototype . "int pcntl_get_last_error()") (purpose . "Retrieve the error number set by the last pcntl function which failed") (id . "function.pcntl-get-last-error")) "pcntl_fork" ((documentation . "Forks the currently running process int pcntl_fork() On success, the PID of the child process is returned in the parent's thread of execution, and a 0 is returned in the child's thread of execution. On failure, a -1 will be returned in the parent's context, no child process will be created, and a PHP error is raised. (PHP 4 >= 4.1.0, PHP 5)") (versions . "PHP 4 >= 4.1.0, PHP 5") (return . "On success, the PID of the child process is returned in the parent's thread of execution, and a 0 is returned in the child's thread of execution. On failure, a -1 will be returned in the parent's context, no child process will be created, and a PHP error is raised.
") (prototype . "int pcntl_fork()") (purpose . "Forks the currently running process") (id . "function.pcntl-fork")) "pcntl_exec" ((documentation . "Executes specified program in current process space void pcntl_exec(string $path [, array $args = '' [, array $envs = '']]) Returns FALSE on error and does not return on success. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . " Returns FALSE on error and does not return on success.
Returns the time in seconds that any previously scheduled alarm had remaining before it was to be delivered, or 0 if there was no previously scheduled alarm.
") (prototype . "int pcntl_alarm(int $seconds)") (purpose . "Set an alarm clock for delivery of a signal") (id . "function.pcntl-alarm")) "event_set" ((documentation . "Prepare an event bool event_set(resource $event, mixed $fd, int $events, mixed $callback [, mixed $arg = '']) event_set returns TRUE on success or FALSE on error. (PECL libevent >= 0.0.1)") (versions . "PECL libevent >= 0.0.1") (return . " event_set returns TRUE on success or FALSE on error.
event_new returns a new event resource on success or FALSE on error.
event_del returns TRUE on success or FALSE on error.
event_buffer_write returns TRUE on success or FALSE on error.
Returns TRUE on success or FALSE on failure.
event_buffer_priority_set returns TRUE on success or FALSE on error.
event_buffer_new returns new buffered event resource on success or FALSE on error.
event_buffer_enable returns TRUE on success or FALSE on error.
event_buffer_disable returns TRUE on success or FALSE on error.
event_buffer_base_set returns TRUE on success or FALSE on error.
event_base_set returns TRUE on success or FALSE on error.
event_base_priority_init returns TRUE on success or FALSE on error.
event_base_new returns valid event base resource on success or FALSE on error.
event_base_loopexit returns TRUE on success or FALSE on error.
event_base_loopbreak returns TRUE on success or FALSE on error.
event_base_loop returns 0 on success, -1 on error and 1 if no events were registered.
") (prototype . "int event_base_loop(resource $event_base [, int $flags = ''])") (purpose . "Handle events") (id . "function.event-base-loop")) "event_base_free" ((documentation . "Destroy event base void event_base_free(resource $event_base) (PECL libevent >= 0.0.1)") (versions . "PECL libevent >= 0.0.1") (return . "") (prototype . "void event_base_free(resource $event_base)") (purpose . "Destroy event base") (id . "function.event-base-free")) "event_add" ((documentation . "Add an event to the set of monitored events bool event_add(resource $event [, int $timeout = -1]) event_add returns TRUE on success or FALSE on error. (PECL libevent >= 0.0.1)") (versions . "PECL libevent >= 0.0.1") (return . " event_add returns TRUE on success or FALSE on error.
Returns an open PTY stream to the processes stdio, stdout, and stderr.
On failure this function returns FALSE.
Returns value associated with the pattern that was matched.
On failure this function returns: EXP_EOF, EXP_TIMEOUT or EXP_FULLBUFFER
eio_write returns request resource on success or FALSE on error.
eio_utime returns request resource on success or FALSE on error.
eio_unlink returns request resource on success or FALSE on error.
eio_busy returns request resource on success or FALSE on error.
eio_syncfs returns request resource on success or FALSE on error.
eio_sync returns request resource on success or FALSE on error.
eio_sync_file_range returns request resource on success or FALSE on error.
eio_symlink returns request resource on success or FALSE on error.
eio_statvfs returns request resource on success or FALSE on error. On success assigns result argument of callback to an array.
eio_stat returns request resource on success or FALSE on error. On success assigns result argument of callback to an array.
No value is returned.
") (prototype . "void eio_set_min_parallel(string $nthreads)") (purpose . "Set minimum parallel thread number") (id . "function.eio-set-min-parallel")) "eio_set_max_poll_time" ((documentation . "Set maximum poll time void eio_set_max_poll_time(float $nseconds) No value is returned. (PECL eio >= 0.0.1dev)") (versions . "PECL eio >= 0.0.1dev") (return . "No value is returned.
") (prototype . "void eio_set_max_poll_time(float $nseconds)") (purpose . "Set maximum poll time") (id . "function.eio-set-max-poll-time")) "eio_set_max_poll_reqs" ((documentation . "Set maximum number of requests processed in a poll. void eio_set_max_poll_reqs(int $nreqs) No value is returned. (PECL eio >= 0.0.1dev)") (versions . "PECL eio >= 0.0.1dev") (return . "No value is returned.
") (prototype . "void eio_set_max_poll_reqs(int $nreqs)") (purpose . "Set maximum number of requests processed in a poll.") (id . "function.eio-set-max-poll-reqs")) "eio_set_max_parallel" ((documentation . "Set maximum parallel threads void eio_set_max_parallel(int $nthreads) No value is returned. (PECL eio >= 0.0.1dev)") (versions . "PECL eio >= 0.0.1dev") (return . "No value is returned.
") (prototype . "void eio_set_max_parallel(int $nthreads)") (purpose . "Set maximum parallel threads") (id . "function.eio-set-max-parallel")) "eio_set_max_idle" ((documentation . "Set maximum number of idle threads. void eio_set_max_idle(int $nthreads) No value is returned. (PECL eio >= 0.0.1dev)") (versions . "PECL eio >= 0.0.1dev") (return . "No value is returned.
") (prototype . "void eio_set_max_idle(int $nthreads)") (purpose . "Set maximum number of idle threads.") (id . "function.eio-set-max-idle")) "eio_sendfile" ((documentation . "Transfer data between file descriptors resource eio_sendfile(mixed $out_fd, mixed $in_fd, int $offset, int $length [, int $pri = '' [, callable $callback = '' [, string $data = '']]]) eio_sendfile returns request resource on success or FALSE on error. (PECL eio >= 0.0.1dev)") (versions . "PECL eio >= 0.0.1dev") (return . " eio_sendfile returns request resource on success or FALSE on error.
eio_seek returns request resource on success or FALSE on error.
eio_rmdir returns request resource on success or FALSE on error.
eio_rename returns request resource on success or FALSE on error.
") (prototype . "resource eio_realpath(string $path, int $pri, callable $callback [, string $data = null])") (purpose . "Get the canonicalized absolute pathname.") (id . "function.eio-realpath")) "eio_readlink" ((documentation . "Read value of a symbolic link. resource eio_readlink(string $path, int $pri, callable $callback [, string $data = null]) eio_readlink returns request resource on success or FALSE on error. (PECL eio >= 0.0.1dev)") (versions . "PECL eio >= 0.0.1dev") (return . "
eio_readlink returns request resource on success or FALSE on error.
eio_readdir returns request resource on success, or FALSE on error. Sets result argument of callback function according to flags:
EIO_READDIR_DENTS (integer) EIO_READDIR_DIRS_FIRST (integer) EIO_READDIR_STAT_ORDER (integer) EIO_READDIR_FOUND_UNKNOWN (integer) Node types:
EIO_DT_UNKNOWN (integer) EIO_DT_FIFO (integer) EIO_DT_CHR (integer) EIO_DT_MPC (integer) EIO_DT_DIR (integer) EIO_DT_NAM (integer) EIO_DT_BLK (integer) EIO_DT_MPB (integer) EIO_DT_REG (integer) EIO_DT_NWK (integer) EIO_DT_CMP (integer) EIO_DT_LNK (integer) EIO_DT_SOCK (integer) EIO_DT_DOOR (integer) EIO_DT_WHT (integer) EIO_DT_MAX (integer) eio_readahead returns request resource on success or FALSE on error.
eio_read stores read bytes in result argument of callback function.
If any request invocation returns a non-zero value, returns that value. Otherwise, it returns 0.
eio_open returns file descriptor in result argument of callback on success; otherwise, result is equal to -1.
eio_nthreads returns number of threads currently in use.
") (prototype . "int eio_nthreads()") (purpose . "Returns number of threads currently in use") (id . "function.eio-nthreads")) "eio_nreqs" ((documentation . "Returns number of requests to be processed int eio_nreqs() eio_nreqs returns number of requests to be processed. (PECL eio >= 0.0.1dev)") (versions . "PECL eio >= 0.0.1dev") (return . "eio_nreqs returns number of requests to be processed.
") (prototype . "int eio_nreqs()") (purpose . "Returns number of requests to be processed") (id . "function.eio-nreqs")) "eio_nready" ((documentation . "Returns number of not-yet handled requests int eio_nready() eio_nready returns number of not-yet handled requests (PECL eio >= 0.0.1dev)") (versions . "PECL eio >= 0.0.1dev") (return . "eio_nready returns number of not-yet handled requests
") (prototype . "int eio_nready()") (purpose . "Returns number of not-yet handled requests") (id . "function.eio-nready")) "eio_npending" ((documentation . "Returns number of finished, but unhandled requests int eio_npending() eio_npending returns number of finished, but unhandled requests. (PECL eio >= 0.0.1dev)") (versions . "PECL eio >= 0.0.1dev") (return . "eio_npending returns number of finished, but unhandled requests.
") (prototype . "int eio_npending()") (purpose . "Returns number of finished, but unhandled requests") (id . "function.eio-npending")) "eio_nop" ((documentation . "Does nothing, except go through the whole request cycle. resource eio_nop([int $pri = EIO_PRI_DEFAULT [, callable $callback = null [, mixed $data = null]]]) eio_nop returns request resource on success or FALSE on error. (PECL eio >= 0.0.1dev)") (versions . "PECL eio >= 0.0.1dev") (return . " eio_nop returns request resource on success or FALSE on error.
eio_mknod returns request resource on success or FALSE on error.
eio_mkdir returns request resource on success or FALSE on error.
eio_lstat returns request resource on success or FALSE on error.
") (prototype . "resource eio_link(string $path, string $new_path [, int $pri = EIO_PRI_DEFAULT [, callable $callback = null [, mixed $data = null]]])") (purpose . "Create a hardlink for file") (id . "function.eio-link")) "eio_init" ((documentation . "(Re-)initialize Eio void eio_init() No value is returned. (PECL eio = 1.0.0)") (versions . "PECL eio = 1.0.0") (return . "
No value is returned.
") (prototype . "void eio_init()") (purpose . "(Re-)initialize Eio") (id . "function.eio-init")) "eio_grp" ((documentation . "Createsa request group. resource eio_grp(callable $callback [, string $data = null]) eio_grp returns request group resource on success or FALSE on error. (PECL eio >= 0.0.1dev)") (versions . "PECL eio >= 0.0.1dev") (return . " eio_grp returns request group resource on success or FALSE on error.
No value is returned.
") (prototype . "void eio_grp_limit(resource $grp, int $limit)") (purpose . "Set group limit") (id . "function.eio-grp-limit")) "eio_grp_cancel" ((documentation . "Cancels a request group void eio_grp_cancel(resource $grp) No value is returned. (PECL eio >= 0.0.1dev)") (versions . "PECL eio >= 0.0.1dev") (return . "No value is returned.
") (prototype . "void eio_grp_cancel(resource $grp)") (purpose . "Cancels a request group") (id . "function.eio-grp-cancel")) "eio_grp_add" ((documentation . "Adds a request to the request group. void eio_grp_add(resource $grp, resource $req) eio_grp_add doesn't return a value. (PECL eio >= 0.0.1dev)") (versions . "PECL eio >= 0.0.1dev") (return . "eio_grp_add doesn't return a value.
") (prototype . "void eio_grp_add(resource $grp, resource $req)") (purpose . "Adds a request to the request group.") (id . "function.eio-grp-add")) "eio_get_last_error" ((documentation . "Returns string describing the last error associated with a request resource string eio_get_last_error(resource $req) eio_get_last_error returns string describing the last error associated with the request resource specified by req. Warning This function isEXPERIMENTAL. The behaviour of this function, its name, andsurrounding documentation may change without notice in a future release of PHP.This function should be used at your own risk. (PECL eio >= 1.0.0)") (versions . "PECL eio >= 1.0.0") (return . " eio_get_last_error returns string describing the last error associated with the request resource specified by req.
This function isEXPERIMENTAL. The behaviour of this function, its name, andsurrounding documentation may change without notice in a future release of PHP.This function should be used at your own risk.
eio_get_event_stream returns stream on success; otherwise, NULL
eio_futime returns request resource on success or FALSE on error.
eio_ftruncate returns request resource on success or FALSE on error.
eio_fsync returns request resource on success or FALSE on error.
eio_fstatvfs returns request resource on success or FALSE on error.
eio_busy returns request resource on success or FALSE on error.
eio_fdatasync returns request resource on success or FALSE on error.
eio_fchmod returns request resource on success or FALSE on error.
eio_fallocate returns request resource on success or FALSE on error.
eio_event_loop returns TRUE on success or FALSE on error.
eio_dup2 returns request resource on success or FALSE on error.
eio_custom returns request resource on success or FALSE on error.
eio_close returns request resource on success or FALSE on error.
eio_chown returns request resource on success or FALSE on error.
eio_chmod returns request resource on success or FALSE on error.
No value is returned.
") (prototype . "void eio_cancel(resource $req)") (purpose . "Cancels a request") (id . "function.eio-cancel")) "eio_busy" ((documentation . "Artificially increase load. Could be useful in tests, benchmarking. resource eio_busy(int $delay [, int $pri = EIO_PRI_DEFAULT [, callable $callback = null [, mixed $data = null]]]) eio_busy returns request resource on success or FALSE on error. (PECL eio >= 0.0.1dev)") (versions . "PECL eio >= 0.0.1dev") (return . " eio_busy returns request resource on success or FALSE on error.
No value is returned.
") (prototype . "void swf_viewport(float $xmin, float $xmax, float $ymin, float $ymax)") (purpose . "Select an area for future drawing") (id . "function.swf-viewport")) "swf_translate" ((documentation . "Translate the current transformations void swf_translate(float $x, float $y, float $z) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_translate(float $x, float $y, float $z)") (purpose . "Translate the current transformations") (id . "function.swf-translate")) "swf_textwidth" ((documentation . "Get the width of a string float swf_textwidth(string $str) Returns the line width, as a float. (PHP 4)") (versions . "PHP 4") (return . "Returns the line width, as a float.
") (prototype . "float swf_textwidth(string $str)") (purpose . "Get the width of a string") (id . "function.swf-textwidth")) "swf_startsymbol" ((documentation . "Define a symbol void swf_startsymbol(int $objid) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_startsymbol(int $objid)") (purpose . "Define a symbol") (id . "function.swf-startsymbol")) "swf_startshape" ((documentation . "Start a complex shape void swf_startshape(int $objid) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_startshape(int $objid)") (purpose . "Start a complex shape") (id . "function.swf-startshape")) "swf_startdoaction" ((documentation . "Start a description of an action list for the current frame void swf_startdoaction() No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_startdoaction()") (purpose . "Start a description of an action list for the current frame") (id . "function.swf-startdoaction")) "swf_startbutton" ((documentation . "Start the definition of a button void swf_startbutton(int $objid, int $type) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_startbutton(int $objid, int $type)") (purpose . "Start the definition of a button") (id . "function.swf-startbutton")) "swf_showframe" ((documentation . "Display the current frame void swf_showframe() No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_showframe()") (purpose . "Display the current frame") (id . "function.swf-showframe")) "swf_shapemoveto" ((documentation . "Move the current position void swf_shapemoveto(float $x, float $y) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_shapemoveto(float $x, float $y)") (purpose . "Move the current position") (id . "function.swf-shapemoveto")) "swf_shapelineto" ((documentation . "Draw a line void swf_shapelineto(float $x, float $y) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_shapelineto(float $x, float $y)") (purpose . "Draw a line") (id . "function.swf-shapelineto")) "swf_shapelinesolid" ((documentation . "Set the current line style void swf_shapelinesolid(float $r, float $g, float $b, float $a, float $width) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_shapelinesolid(float $r, float $g, float $b, float $a, float $width)") (purpose . "Set the current line style") (id . "function.swf-shapelinesolid")) "swf_shapefillsolid" ((documentation . "Set the current fill style to the specified color void swf_shapefillsolid(float $r, float $g, float $b, float $a) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_shapefillsolid(float $r, float $g, float $b, float $a)") (purpose . "Set the current fill style to the specified color") (id . "function.swf-shapefillsolid")) "swf_shapefilloff" ((documentation . "Turns off filling void swf_shapefilloff() No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_shapefilloff()") (purpose . "Turns off filling") (id . "function.swf-shapefilloff")) "swf_shapefillbitmaptile" ((documentation . "Set current fill mode to tiled bitmap void swf_shapefillbitmaptile(int $bitmapid) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_shapefillbitmaptile(int $bitmapid)") (purpose . "Set current fill mode to tiled bitmap") (id . "function.swf-shapefillbitmaptile")) "swf_shapefillbitmapclip" ((documentation . "Set current fill mode to clipped bitmap void swf_shapefillbitmapclip(int $bitmapid) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_shapefillbitmapclip(int $bitmapid)") (purpose . "Set current fill mode to clipped bitmap") (id . "function.swf-shapefillbitmapclip")) "swf_shapecurveto" ((documentation . "Draw a quadratic bezier curve between two points void swf_shapecurveto(float $x1, float $y1, float $x2, float $y2) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_shapecurveto(float $x1, float $y1, float $x2, float $y2)") (purpose . "Draw a quadratic bezier curve between two points") (id . "function.swf-shapecurveto")) "swf_shapecurveto3" ((documentation . "Draw a cubic bezier curve void swf_shapecurveto3(float $x1, float $y1, float $x2, float $y2, float $x3, float $y3) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_shapecurveto3(float $x1, float $y1, float $x2, float $y2, float $x3, float $y3)") (purpose . "Draw a cubic bezier curve") (id . "function.swf-shapecurveto3")) "swf_shapearc" ((documentation . "Draw a circular arc void swf_shapearc(float $x, float $y, float $r, float $ang1, float $ang2) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_shapearc(float $x, float $y, float $r, float $ang1, float $ang2)") (purpose . "Draw a circular arc") (id . "function.swf-shapearc")) "swf_setframe" ((documentation . "Switch to a specified frame void swf_setframe(int $framenumber) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_setframe(int $framenumber)") (purpose . "Switch to a specified frame") (id . "function.swf-setframe")) "swf_setfont" ((documentation . "Change the current font void swf_setfont(int $fontid) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_setfont(int $fontid)") (purpose . "Change the current font") (id . "function.swf-setfont")) "swf_scale" ((documentation . "Scale the current transformation void swf_scale(float $x, float $y, float $z) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_scale(float $x, float $y, float $z)") (purpose . "Scale the current transformation") (id . "function.swf-scale")) "swf_rotate" ((documentation . "Rotate the current transformation void swf_rotate(float $angle, string $axis) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_rotate(float $angle, string $axis)") (purpose . "Rotate the current transformation") (id . "function.swf-rotate")) "swf_removeobject" ((documentation . "Remove an object void swf_removeobject(int $depth) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_removeobject(int $depth)") (purpose . "Remove an object") (id . "function.swf-removeobject")) "swf_pushmatrix" ((documentation . "Push the current transformation matrix back onto the stack void swf_pushmatrix() No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_pushmatrix()") (purpose . "Push the current transformation matrix back onto the stack") (id . "function.swf-pushmatrix")) "swf_posround" ((documentation . "Enables or Disables the rounding of the translation when objects are placed or moved void swf_posround(int $round) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_posround(int $round)") (purpose . "Enables or Disables the rounding of the translation when objects are placed or moved") (id . "function.swf-posround")) "swf_popmatrix" ((documentation . "Restore a previous transformation matrix void swf_popmatrix() No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_popmatrix()") (purpose . "Restore a previous transformation matrix") (id . "function.swf-popmatrix")) "swf_polarview" ((documentation . "Define the viewer's position with polar coordinates void swf_polarview(float $dist, float $azimuth, float $incidence, float $twist) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_polarview(float $dist, float $azimuth, float $incidence, float $twist)") (purpose . "Define the viewer's position with polar coordinates") (id . "function.swf-polarview")) "swf_placeobject" ((documentation . "Place an object onto the screen void swf_placeobject(int $objid, int $depth) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_placeobject(int $objid, int $depth)") (purpose . "Place an object onto the screen") (id . "function.swf-placeobject")) "swf_perspective" ((documentation . "Define a perspective projection transformation void swf_perspective(float $fovy, float $aspect, float $near, float $far) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_perspective(float $fovy, float $aspect, float $near, float $far)") (purpose . "Define a perspective projection transformation") (id . "function.swf-perspective")) "swf_ortho" ((documentation . "Defines an orthographic mapping of user coordinates onto the current viewport void swf_ortho(float $xmin, float $xmax, float $ymin, float $ymax, float $zmin, float $zmax) No value is returned. (PHP 4 >= 4.0.1)") (versions . "PHP 4 >= 4.0.1") (return . "No value is returned.
") (prototype . "void swf_ortho(float $xmin, float $xmax, float $ymin, float $ymax, float $zmin, float $zmax)") (purpose . "Defines an orthographic mapping of user coordinates onto the current viewport") (id . "function.swf-ortho")) "swf_ortho2" ((documentation . "Defines 2D orthographic mapping of user coordinates onto the current viewport void swf_ortho2(float $xmin, float $xmax, float $ymin, float $ymax) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_ortho2(float $xmin, float $xmax, float $ymin, float $ymax)") (purpose . "Defines 2D orthographic mapping of user coordinates onto the current viewport") (id . "function.swf-ortho2")) "swf_openfile" ((documentation . "Open a new Shockwave Flash file void swf_openfile(string $filename, float $width, float $height, float $framerate, float $r, float $g, float $b) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_openfile(string $filename, float $width, float $height, float $framerate, float $r, float $g, float $b)") (purpose . "Open a new Shockwave Flash file") (id . "function.swf-openfile")) "swf_oncondition" ((documentation . "Describe a transition used to trigger an action list void swf_oncondition(int $transition) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_oncondition(int $transition)") (purpose . "Describe a transition used to trigger an action list") (id . "function.swf-oncondition")) "swf_nextid" ((documentation . "Returns the next free object id int swf_nextid() Returns the id, as an integer. (PHP 4)") (versions . "PHP 4") (return . "Returns the id, as an integer.
") (prototype . "int swf_nextid()") (purpose . "Returns the next free object id") (id . "function.swf-nextid")) "swf_mulcolor" ((documentation . "Sets the global multiply color to the rgba value specified void swf_mulcolor(float $r, float $g, float $b, float $a) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_mulcolor(float $r, float $g, float $b, float $a)") (purpose . "Sets the global multiply color to the rgba value specified") (id . "function.swf-mulcolor")) "swf_modifyobject" ((documentation . "Modify an object void swf_modifyobject(int $depth, int $how) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_modifyobject(int $depth, int $how)") (purpose . "Modify an object") (id . "function.swf-modifyobject")) "swf_lookat" ((documentation . "Define a viewing transformation void swf_lookat(float $view_x, float $view_y, float $view_z, float $reference_x, float $reference_y, float $reference_z, float $twist) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_lookat(float $view_x, float $view_y, float $view_z, float $reference_x, float $reference_y, float $reference_z, float $twist)") (purpose . "Define a viewing transformation") (id . "function.swf-lookat")) "swf_labelframe" ((documentation . "Label the current frame void swf_labelframe(string $name) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_labelframe(string $name)") (purpose . "Label the current frame") (id . "function.swf-labelframe")) "swf_getframe" ((documentation . "Get the frame number of the current frame int swf_getframe() Returns the current frame number, as an integer. (PHP 4)") (versions . "PHP 4") (return . "Returns the current frame number, as an integer.
") (prototype . "int swf_getframe()") (purpose . "Get the frame number of the current frame") (id . "function.swf-getframe")) "swf_getfontinfo" ((documentation . "Gets font information array swf_getfontinfo() Returns an associative array with the following parameters: * Aheight - The height in pixels of a capital A. * xheight - The height in pixels of a lowercase x. (PHP 4)") (versions . "PHP 4") (return . "Returns an associative array with the following parameters:
Returns an array with the following elements:
No value is returned.
") (prototype . "void swf_fonttracking(float $tracking)") (purpose . "Set the current font tracking") (id . "function.swf-fonttracking")) "swf_fontslant" ((documentation . "Set the font slant void swf_fontslant(float $slant) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_fontslant(float $slant)") (purpose . "Set the font slant") (id . "function.swf-fontslant")) "swf_fontsize" ((documentation . "Change the font size void swf_fontsize(float $size) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_fontsize(float $size)") (purpose . "Change the font size") (id . "function.swf-fontsize")) "swf_endsymbol" ((documentation . "End the definition of a symbol void swf_endsymbol() No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_endsymbol()") (purpose . "End the definition of a symbol") (id . "function.swf-endsymbol")) "swf_endshape" ((documentation . "Completes the definition of the current shape void swf_endshape() No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_endshape()") (purpose . "Completes the definition of the current shape") (id . "function.swf-endshape")) "swf_enddoaction" ((documentation . "End the current action void swf_enddoaction() No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_enddoaction()") (purpose . "End the current action") (id . "function.swf-enddoaction")) "swf_endbutton" ((documentation . "End the definition of the current button void swf_endbutton() No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_endbutton()") (purpose . "End the definition of the current button") (id . "function.swf-endbutton")) "swf_definetext" ((documentation . "Define a text string void swf_definetext(int $objid, string $str, int $docenter) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_definetext(int $objid, string $str, int $docenter)") (purpose . "Define a text string") (id . "function.swf-definetext")) "swf_definerect" ((documentation . "Define a rectangle void swf_definerect(int $objid, float $x1, float $y1, float $x2, float $y2, float $width) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_definerect(int $objid, float $x1, float $y1, float $x2, float $y2, float $width)") (purpose . "Define a rectangle") (id . "function.swf-definerect")) "swf_definepoly" ((documentation . "Define a polygon void swf_definepoly(int $objid, array $coords, int $npoints, float $width) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_definepoly(int $objid, array $coords, int $npoints, float $width)") (purpose . "Define a polygon") (id . "function.swf-definepoly")) "swf_defineline" ((documentation . "Define a line void swf_defineline(int $objid, float $x1, float $y1, float $x2, float $y2, float $width) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_defineline(int $objid, float $x1, float $y1, float $x2, float $y2, float $width)") (purpose . "Define a line") (id . "function.swf-defineline")) "swf_definefont" ((documentation . "Defines a font void swf_definefont(int $fontid, string $fontname) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_definefont(int $fontid, string $fontname)") (purpose . "Defines a font") (id . "function.swf-definefont")) "swf_definebitmap" ((documentation . "Define a bitmap void swf_definebitmap(int $objid, string $image_name) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_definebitmap(int $objid, string $image_name)") (purpose . "Define a bitmap") (id . "function.swf-definebitmap")) "swf_closefile" ((documentation . "Close the current Shockwave Flash file void swf_closefile([int $return_file = '']) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_closefile([int $return_file = ''])") (purpose . "Close the current Shockwave Flash file") (id . "function.swf-closefile")) "swf_addcolor" ((documentation . "Set the global add color to the rgba value specified void swf_addcolor(float $r, float $g, float $b, float $a) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_addcolor(float $r, float $g, float $b, float $a)") (purpose . "Set the global add color to the rgba value specified") (id . "function.swf-addcolor")) "swf_addbuttonrecord" ((documentation . "Controls location, appearance and active area of the current button void swf_addbuttonrecord(int $states, int $shapeid, int $depth) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_addbuttonrecord(int $states, int $shapeid, int $depth)") (purpose . "Controls location, appearance and active area of the current button") (id . "function.swf-addbuttonrecord")) "swf_actionwaitforframe" ((documentation . "Skip actions if a frame has not been loaded void swf_actionwaitforframe(int $framenumber, int $skipcount) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_actionwaitforframe(int $framenumber, int $skipcount)") (purpose . "Skip actions if a frame has not been loaded") (id . "function.swf-actionwaitforframe")) "swf_actiontogglequality" ((documentation . "Toggle between low and high quality void swf_actiontogglequality() No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_actiontogglequality()") (purpose . "Toggle between low and high quality") (id . "function.swf-actiontogglequality")) "swf_actionstop" ((documentation . "Stop playing the flash movie at the current frame void swf_actionstop() No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_actionstop()") (purpose . "Stop playing the flash movie at the current frame") (id . "function.swf-actionstop")) "swf_actionsettarget" ((documentation . "Set the context for actions void swf_actionsettarget(string $target) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_actionsettarget(string $target)") (purpose . "Set the context for actions") (id . "function.swf-actionsettarget")) "swf_actionprevframe" ((documentation . "Go backwards one frame void swf_actionprevframe() No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_actionprevframe()") (purpose . "Go backwards one frame") (id . "function.swf-actionprevframe")) "swf_actionplay" ((documentation . "Start playing the flash movie from the current frame void swf_actionplay() No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_actionplay()") (purpose . "Start playing the flash movie from the current frame") (id . "function.swf-actionplay")) "swf_actionnextframe" ((documentation . "Go forward one frame void swf_actionnextframe() No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_actionnextframe()") (purpose . "Go forward one frame") (id . "function.swf-actionnextframe")) "swf_actiongotolabel" ((documentation . "Display a frame with the specified label void swf_actiongotolabel(string $label) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_actiongotolabel(string $label)") (purpose . "Display a frame with the specified label") (id . "function.swf-actiongotolabel")) "swf_actiongotoframe" ((documentation . "Play a frame and then stop void swf_actiongotoframe(int $framenumber) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_actiongotoframe(int $framenumber)") (purpose . "Play a frame and then stop") (id . "function.swf-actiongotoframe")) "swf_actiongeturl" ((documentation . "Get a URL from a Shockwave Flash movie void swf_actiongeturl(string $url, string $target) No value is returned. (PHP 4)") (versions . "PHP 4") (return . "No value is returned.
") (prototype . "void swf_actiongeturl(string $url, string $target)") (purpose . "Get a URL from a Shockwave Flash movie") (id . "function.swf-actiongeturl")) "rpm_version" ((documentation . "Returns a string representing the current version of the rpmreader extension string rpm_version() rpm_version will return a string representing the rpmreader version currently loaded in PHP. (PECL rpmreader >= 0.3.0)") (versions . "PECL rpmreader >= 0.3.0") (return . "rpm_version will return a string representing the rpmreader version currently loaded in PHP.
") (prototype . "string rpm_version()") (purpose . "Returns a string representing the current version of the rpmreader extension") (id . "function.rpm-version")) "rpm_open" ((documentation . "Opens an RPM file resource rpm_open(string $filename) If the open succeeds, then rpm_open will return a file pointer resource to the newly opened file. On error, the function will return FALSE. (PECL rpmreader >= 0.1.0)") (versions . "PECL rpmreader >= 0.1.0") (return . " If the open succeeds, then rpm_open will return a file pointer resource to the newly opened file. On error, the function will return FALSE.
Returns TRUE on success or FALSE on failure.
The return value can be of various types depending on the tagnum supplied to the function.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
The width of a glyph in points.
") (prototype . "float ps_symbol_width(resource $psdoc, int $ord [, int $fontid = '' [, float $size = 0.0]])") (purpose . "Gets width of a glyph") (id . "function.ps-symbol-width")) "ps_symbol_name" ((documentation . "Gets name of a glyph string ps_symbol_name(resource $psdoc, int $ord [, int $fontid = '']) The name of a glyph in the given font. (PECL ps >= 1.2.0)") (versions . "PECL ps >= 1.2.0") (return . "The name of a glyph in the given font.
") (prototype . "string ps_symbol_name(resource $psdoc, int $ord [, int $fontid = ''])") (purpose . "Gets name of a glyph") (id . "function.ps-symbol-name")) "ps_stroke" ((documentation . "Draws the current path bool ps_stroke(resource $psdoc) Returns TRUE on success or FALSE on failure. (PECL ps >= 1.1.0)") (versions . "PECL ps >= 1.1.0") (return . " Returns TRUE on success or FALSE on failure.
Width of a string in points.
") (prototype . "float ps_stringwidth(resource $psdoc, string $text [, int $fontid = '' [, float $size = 0.0]])") (purpose . "Gets width of a string") (id . "function.ps-stringwidth")) "ps_string_geometry" ((documentation . "Gets geometry of a string array ps_string_geometry(resource $psdoc, string $text [, int $fontid = '' [, float $size = 0.0]]) 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. (PECL ps >= 1.2.0)") (versions . "PECL ps >= 1.2.0") (return . "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.
") (prototype . "array ps_string_geometry(resource $psdoc, string $text [, int $fontid = '' [, float $size = 0.0]])") (purpose . "Gets geometry of a string") (id . "function.ps-string-geometry")) "ps_show" ((documentation . "Output text bool ps_show(resource $psdoc, string $text) Returns TRUE on success or FALSE on failure. (PECL ps >= 1.1.0)") (versions . "PECL ps >= 1.1.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Number of characters that could not be written.
") (prototype . "int ps_show_boxed(resource $psdoc, string $text, float $left, float $bottom, float $width, float $height, string $hmode [, string $feature = ''])") (purpose . "Output text in a box") (id . "function.ps-show-boxed")) "ps_shfill" ((documentation . "Fills an area with a shading bool ps_shfill(resource $psdoc, int $shadingid) Returns TRUE on success or FALSE on failure. (PECL ps >= 1.3.0)") (versions . "PECL ps >= 1.3.0") (return . " Returns TRUE on success or FALSE on failure.
Returns the identifier of the pattern or FALSE on failure.
The identifier of the pattern or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns identifier of image or zero in case of an error. The identifier is a positive number greater than 0.
") (prototype . "int ps_open_image(resource $psdoc, string $type, string $source, string $data, int $lenght, int $width, int $height, int $components, int $bpc, string $params)") (purpose . "Reads an image for later placement") (id . "function.ps-open-image")) "ps_open_image_file" ((documentation . "Opens image from file int ps_open_image_file(resource $psdoc, string $type, string $filename [, string $stringparam = '' [, int $intparam = '']]) Returns identifier of image or zero in case of an error. The identifier is a positive number greater than 0. (PECL ps >= 1.1.0)") (versions . "PECL ps >= 1.1.0") (return . "Returns identifier of image or zero in case of an error. The identifier is a positive number greater than 0.
") (prototype . "int ps_open_image_file(resource $psdoc, string $type, string $filename [, string $stringparam = '' [, int $intparam = '']])") (purpose . "Opens image from file") (id . "function.ps-open-image-file")) "ps_open_file" ((documentation . "Opens a file for output bool ps_open_file(resource $psdoc [, string $filename = '']) Returns TRUE on success or FALSE on failure. (PECL ps >= 1.1.0)") (versions . "PECL ps >= 1.1.0") (return . " Returns TRUE on success or FALSE on failure.
Resource of PostScript document or FALSE on failure. The return value is passed to all other functions as the first argument.
Returns TRUE on success or FALSE on failure.
The id of the new spot color or 0 in case of an error.
") (prototype . "int ps_makespotcolor(resource $psdoc, string $name [, int $reserved = ''])") (purpose . "Create spot color") (id . "function.ps-makespotcolor")) "ps_lineto" ((documentation . "Draws a line bool ps_lineto(resource $psdoc, float $x, float $y) Returns TRUE on success or FALSE on failure. (PECL ps >= 1.1.0)") (versions . "PECL ps >= 1.1.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
An array of integers indicating the position of possible breaks in the text or FALSE on failure.
Returns the value of the parameter or FALSE.
Returns the value of the parameter or FALSE on failure.
Returns the identifier of the font or zero in case of an error. The identifier is a positive number.
") (prototype . "int ps_findfont(resource $psdoc, string $fontname, string $encoding [, bool $embed = false])") (purpose . "Loads a font") (id . "function.ps-findfont")) "ps_fill" ((documentation . "Fills the current path bool ps_fill(resource $psdoc) Returns TRUE on success or FALSE on failure. (PECL ps >= 1.1.0)") (versions . "PECL ps >= 1.1.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns NULL on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
The identifier of the pattern or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
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.
") (prototype . "int ps_add_bookmark(resource $psdoc, string $text [, int $parent = '' [, int $open = '']])") (purpose . "Add bookmark to current page") (id . "function.ps-add-bookmark")) "PDF_utf8_to_utf16" ((documentation . "Convert string from UTF-8 to UTF-16 string PDF_utf8_to_utf16(resource $pdfdoc, string $utf8string, string $ordering) (PECL pdflib >= 2.0.3)") (versions . "PECL pdflib >= 2.0.3") (return . "") (prototype . "string PDF_utf8_to_utf16(resource $pdfdoc, string $utf8string, string $ordering)") (purpose . "Convert string from UTF-8 to UTF-16") (id . "function.pdf-utf8-to-utf16")) "PDF_utf32_to_utf16" ((documentation . "Convert string from UTF-32 to UTF-16 string PDF_utf32_to_utf16(resource $pdfdoc, string $utf32string, string $ordering) (PECL pdflib >= Unknown future)") (versions . "PECL pdflib >= Unknown future") (return . "") (prototype . "string PDF_utf32_to_utf16(resource $pdfdoc, string $utf32string, string $ordering)") (purpose . "Convert string from UTF-32 to UTF-16") (id . "function.pdf-utf32-to-utf16")) "PDF_utf16_to_utf8" ((documentation . "Convert string from UTF-16 to UTF-8 string PDF_utf16_to_utf8(resource $pdfdoc, string $utf16string) (PECL pdflib >= 2.0.3)") (versions . "PECL pdflib >= 2.0.3") (return . "") (prototype . "string PDF_utf16_to_utf8(resource $pdfdoc, string $utf16string)") (purpose . "Convert string from UTF-16 to UTF-8") (id . "function.pdf-utf16-to-utf8")) "PDF_translate" ((documentation . "Set origin of coordinate system bool PDF_translate(resource $p, float $tx, float $ty) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_translate(resource $p, float $tx, float $ty)") (purpose . "Set origin of coordinate system") (id . "function.pdf-translate")) "PDF_suspend_page" ((documentation . "Suspend page bool PDF_suspend_page(resource $pdfdoc, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_suspend_page(resource $pdfdoc, string $optlist)") (purpose . "Suspend page") (id . "function.pdf-suspend-page")) "PDF_stroke" ((documentation . "Stroke path bool PDF_stroke(resource $p) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_stroke(resource $p)") (purpose . "Stroke path") (id . "function.pdf-stroke")) "PDF_stringwidth" ((documentation . "Return width of text float PDF_stringwidth(resource $p, string $text, int $font, float $fontsize) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "float PDF_stringwidth(resource $p, string $text, int $font, float $fontsize)") (purpose . "Return width of text") (id . "function.pdf-stringwidth")) "PDF_skew" ((documentation . "Skew the coordinate system bool PDF_skew(resource $p, float $alpha, float $beta) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_skew(resource $p, float $alpha, float $beta)") (purpose . "Skew the coordinate system") (id . "function.pdf-skew")) "PDF_show" ((documentation . "Output text at current position bool PDF_show(resource $pdfdoc, string $text) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_show(resource $pdfdoc, string $text)") (purpose . "Output text at current position") (id . "function.pdf-show")) "PDF_show_xy" ((documentation . "Output text at given position bool PDF_show_xy(resource $p, string $text, float $x, float $y) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_show_xy(resource $p, string $text, float $x, float $y)") (purpose . "Output text at given position") (id . "function.pdf-show-xy")) "PDF_show_boxed" ((documentation . "Output text in a box [deprecated] int PDF_show_boxed(resource $p, string $text, float $left, float $top, float $width, float $height, string $mode, string $feature) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "int PDF_show_boxed(resource $p, string $text, float $left, float $top, float $width, float $height, string $mode, string $feature)") (purpose . "Output text in a box [deprecated]") (id . "function.pdf-show-boxed")) "PDF_shfill" ((documentation . "Fill area with shading bool PDF_shfill(resource $pdfdoc, int $shading) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_shfill(resource $pdfdoc, int $shading)") (purpose . "Fill area with shading") (id . "function.pdf-shfill")) "PDF_shading" ((documentation . "Define blend int PDF_shading(resource $pdfdoc, string $shtype, float $x0, float $y0, float $x1, float $y1, float $c1, float $c2, float $c3, float $c4, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "int PDF_shading(resource $pdfdoc, string $shtype, float $x0, float $y0, float $x1, float $y1, float $c1, float $c2, float $c3, float $c4, string $optlist)") (purpose . "Define blend") (id . "function.pdf-shading")) "PDF_shading_pattern" ((documentation . "Define shading pattern int PDF_shading_pattern(resource $pdfdoc, int $shading, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "int PDF_shading_pattern(resource $pdfdoc, int $shading, string $optlist)") (purpose . "Define shading pattern") (id . "function.pdf-shading-pattern")) "PDF_setrgbcolor" ((documentation . "Set fill and stroke rgb color values [deprecated] bool PDF_setrgbcolor(resource $p, float $red, float $green, float $blue) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_setrgbcolor(resource $p, float $red, float $green, float $blue)") (purpose . "Set fill and stroke rgb color values [deprecated]") (id . "function.pdf-setrgbcolor")) "PDF_setrgbcolor_stroke" ((documentation . "Set stroke rgb color values [deprecated] bool PDF_setrgbcolor_stroke(resource $p, float $red, float $green, float $blue) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_setrgbcolor_stroke(resource $p, float $red, float $green, float $blue)") (purpose . "Set stroke rgb color values [deprecated]") (id . "function.pdf-setrgbcolor-stroke")) "PDF_setrgbcolor_fill" ((documentation . "Set fill rgb color values [deprecated] bool PDF_setrgbcolor_fill(resource $p, float $red, float $green, float $blue) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_setrgbcolor_fill(resource $p, float $red, float $green, float $blue)") (purpose . "Set fill rgb color values [deprecated]") (id . "function.pdf-setrgbcolor-fill")) "PDF_setpolydash" ((documentation . "Set complicated dash pattern [deprecated] PDF_setpolydash() (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . " PDF_setpolydash()") (purpose . "Set complicated dash pattern [deprecated]") (id . "function.pdf-setpolydash")) "PDF_setmiterlimit" ((documentation . "Set miter limit bool PDF_setmiterlimit(resource $pdfdoc, float $miter) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_setmiterlimit(resource $pdfdoc, float $miter)") (purpose . "Set miter limit") (id . "function.pdf-setmiterlimit")) "PDF_setmatrix" ((documentation . "Set current transformation matrix bool PDF_setmatrix(resource $p, float $a, float $b, float $c, float $d, float $e, float $f) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_setmatrix(resource $p, float $a, float $b, float $c, float $d, float $e, float $f)") (purpose . "Set current transformation matrix") (id . "function.pdf-setmatrix")) "PDF_setlinewidth" ((documentation . "Set line width bool PDF_setlinewidth(resource $p, float $width) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_setlinewidth(resource $p, float $width)") (purpose . "Set line width") (id . "function.pdf-setlinewidth")) "PDF_setlinejoin" ((documentation . "Set linejoin parameter bool PDF_setlinejoin(resource $p, int $value) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_setlinejoin(resource $p, int $value)") (purpose . "Set linejoin parameter") (id . "function.pdf-setlinejoin")) "PDF_setlinecap" ((documentation . "Set linecap parameter bool PDF_setlinecap(resource $p, int $linecap) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_setlinecap(resource $p, int $linecap)") (purpose . "Set linecap parameter") (id . "function.pdf-setlinecap")) "PDF_setgray" ((documentation . "Set color to gray [deprecated] bool PDF_setgray(resource $p, float $g) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_setgray(resource $p, float $g)") (purpose . "Set color to gray [deprecated]") (id . "function.pdf-setgray")) "PDF_setgray_stroke" ((documentation . "Set stroke color to gray [deprecated] bool PDF_setgray_stroke(resource $p, float $g) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_setgray_stroke(resource $p, float $g)") (purpose . "Set stroke color to gray [deprecated]") (id . "function.pdf-setgray-stroke")) "PDF_setgray_fill" ((documentation . "Set fill color to gray [deprecated] bool PDF_setgray_fill(resource $p, float $g) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_setgray_fill(resource $p, float $g)") (purpose . "Set fill color to gray [deprecated]") (id . "function.pdf-setgray-fill")) "PDF_setfont" ((documentation . "Set font bool PDF_setfont(resource $pdfdoc, int $font, float $fontsize) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_setfont(resource $pdfdoc, int $font, float $fontsize)") (purpose . "Set font") (id . "function.pdf-setfont")) "PDF_setflat" ((documentation . "Set flatness bool PDF_setflat(resource $pdfdoc, float $flatness) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_setflat(resource $pdfdoc, float $flatness)") (purpose . "Set flatness") (id . "function.pdf-setflat")) "PDF_setdashpattern" ((documentation . "Set dash pattern bool PDF_setdashpattern(resource $pdfdoc, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_setdashpattern(resource $pdfdoc, string $optlist)") (purpose . "Set dash pattern") (id . "function.pdf-setdashpattern")) "PDF_setdash" ((documentation . "Set simple dash pattern bool PDF_setdash(resource $pdfdoc, float $b, float $w) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_setdash(resource $pdfdoc, float $b, float $w)") (purpose . "Set simple dash pattern") (id . "function.pdf-setdash")) "PDF_setcolor" ((documentation . "Set fill and stroke color bool PDF_setcolor(resource $p, string $fstype, string $colorspace, float $c1, float $c2, float $c3, float $c4) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_setcolor(resource $p, string $fstype, string $colorspace, float $c1, float $c2, float $c3, float $c4)") (purpose . "Set fill and stroke color") (id . "function.pdf-setcolor")) "PDF_set_word_spacing" ((documentation . "Set spacing between words [deprecated] PDF_set_word_spacing() (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . " PDF_set_word_spacing()") (purpose . "Set spacing between words [deprecated]") (id . "function.pdf-set-word-spacing")) "PDF_set_value" ((documentation . "Set numerical parameter bool PDF_set_value(resource $p, string $key, float $value) (PHP 4 >= 4.0.1, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.1, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_set_value(resource $p, string $key, float $value)") (purpose . "Set numerical parameter") (id . "function.pdf-set-value")) "PDF_set_text_rise" ((documentation . "Set text rise [deprecated] PDF_set_text_rise() (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . " PDF_set_text_rise()") (purpose . "Set text rise [deprecated]") (id . "function.pdf-set-text-rise")) "PDF_set_text_rendering" ((documentation . "Determine text rendering [deprecated] PDF_set_text_rendering() (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . " PDF_set_text_rendering()") (purpose . "Determine text rendering [deprecated]") (id . "function.pdf-set-text-rendering")) "PDF_set_text_pos" ((documentation . "Set text position bool PDF_set_text_pos(resource $p, float $x, float $y) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_set_text_pos(resource $p, float $x, float $y)") (purpose . "Set text position") (id . "function.pdf-set-text-pos")) "PDF_set_text_matrix" ((documentation . "Set text matrix [deprecated] PDF_set_text_matrix() (PHP 4 <= 4.0.4)") (versions . "PHP 4 <= 4.0.4") (return . "") (prototype . " PDF_set_text_matrix()") (purpose . "Set text matrix [deprecated]") (id . "function.pdf-set-text-matrix")) "PDF_set_parameter" ((documentation . "Set string parameter bool PDF_set_parameter(resource $p, string $key, string $value) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_set_parameter(resource $p, string $key, string $value)") (purpose . "Set string parameter") (id . "function.pdf-set-parameter")) "PDF_set_leading" ((documentation . "Set distance between text lines [deprecated] PDF_set_leading() (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . " PDF_set_leading()") (purpose . "Set distance between text lines [deprecated]") (id . "function.pdf-set-leading")) "PDF_set_layer_dependency" ((documentation . "Define relationships among layers bool PDF_set_layer_dependency(resource $pdfdoc, string $type, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_set_layer_dependency(resource $pdfdoc, string $type, string $optlist)") (purpose . "Define relationships among layers") (id . "function.pdf-set-layer-dependency")) "PDF_set_info" ((documentation . "Fill document info field bool PDF_set_info(resource $p, string $key, string $value) (PHP 4 >= 4.0.1, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.1, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_set_info(resource $p, string $key, string $value)") (purpose . "Fill document info field") (id . "function.pdf-set-info")) "PDF_set_info_title" ((documentation . "Fill the title document info field [deprecated] PDF_set_info_title() (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . " PDF_set_info_title()") (purpose . "Fill the title document info field [deprecated]") (id . "function.pdf-set-info-title")) "PDF_set_info_subject" ((documentation . "Fill the subject document info field [deprecated] PDF_set_info_subject() (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . " PDF_set_info_subject()") (purpose . "Fill the subject document info field [deprecated]") (id . "function.pdf-set-info-subject")) "PDF_set_info_keywords" ((documentation . "Fill the keywords document info field [deprecated] PDF_set_info_keywords() (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . " PDF_set_info_keywords()") (purpose . "Fill the keywords document info field [deprecated]") (id . "function.pdf-set-info-keywords")) "PDF_set_info_creator" ((documentation . "Fill the creator document info field [deprecated] PDF_set_info_creator() (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . " PDF_set_info_creator()") (purpose . "Fill the creator document info field [deprecated]") (id . "function.pdf-set-info-creator")) "PDF_set_info_author" ((documentation . "Fill the author document info field [deprecated] PDF_set_info_author() (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . " PDF_set_info_author()") (purpose . "Fill the author document info field [deprecated]") (id . "function.pdf-set-info-author")) "PDF_set_horiz_scaling" ((documentation . "Set horizontal text scaling [deprecated] PDF_set_horiz_scaling() (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . " PDF_set_horiz_scaling()") (purpose . "Set horizontal text scaling [deprecated]") (id . "function.pdf-set-horiz-scaling")) "PDF_set_gstate" ((documentation . "Activate graphics state object bool PDF_set_gstate(resource $pdfdoc, int $gstate) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_set_gstate(resource $pdfdoc, int $gstate)") (purpose . "Activate graphics state object") (id . "function.pdf-set-gstate")) "PDF_set_duration" ((documentation . "Set duration between pages [deprecated] PDF_set_duration() (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . " PDF_set_duration()") (purpose . "Set duration between pages [deprecated]") (id . "function.pdf-set-duration")) "PDF_set_char_spacing" ((documentation . "Set character spacing [deprecated] PDF_set_char_spacing() (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . " PDF_set_char_spacing()") (purpose . "Set character spacing [deprecated]") (id . "function.pdf-set-char-spacing")) "PDF_set_border_style" ((documentation . "Set border style of annotations [deprecated] bool PDF_set_border_style(resource $pdfdoc, string $style, float $width) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_set_border_style(resource $pdfdoc, string $style, float $width)") (purpose . "Set border style of annotations [deprecated]") (id . "function.pdf-set-border-style")) "PDF_set_border_dash" ((documentation . "Set border dash style of annotations [deprecated] bool PDF_set_border_dash(resource $pdfdoc, float $black, float $white) (PHP 4 >= 4.0.1, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.1, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_set_border_dash(resource $pdfdoc, float $black, float $white)") (purpose . "Set border dash style of annotations [deprecated]") (id . "function.pdf-set-border-dash")) "PDF_set_border_color" ((documentation . "Set border color of annotations [deprecated] bool PDF_set_border_color(resource $p, float $red, float $green, float $blue) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_set_border_color(resource $p, float $red, float $green, float $blue)") (purpose . "Set border color of annotations [deprecated]") (id . "function.pdf-set-border-color")) "PDF_scale" ((documentation . "Scale coordinate system bool PDF_scale(resource $p, float $sx, float $sy) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_scale(resource $p, float $sx, float $sy)") (purpose . "Scale coordinate system") (id . "function.pdf-scale")) "PDF_save" ((documentation . "Save graphics state bool PDF_save(resource $p) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_save(resource $p)") (purpose . "Save graphics state") (id . "function.pdf-save")) "PDF_rotate" ((documentation . "Rotate coordinate system bool PDF_rotate(resource $p, float $phi) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_rotate(resource $p, float $phi)") (purpose . "Rotate coordinate system") (id . "function.pdf-rotate")) "PDF_resume_page" ((documentation . "Resume page bool PDF_resume_page(resource $pdfdoc, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_resume_page(resource $pdfdoc, string $optlist)") (purpose . "Resume page") (id . "function.pdf-resume-page")) "PDF_restore" ((documentation . "Restore graphics state bool PDF_restore(resource $p) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_restore(resource $p)") (purpose . "Restore graphics state") (id . "function.pdf-restore")) "PDF_rect" ((documentation . "Draw rectangle bool PDF_rect(resource $p, float $x, float $y, float $width, float $height) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_rect(resource $p, float $x, float $y, float $width, float $height)") (purpose . "Draw rectangle") (id . "function.pdf-rect")) "PDF_process_pdi" ((documentation . "Process imported PDF document int PDF_process_pdi(resource $pdfdoc, int $doc, int $page, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "int PDF_process_pdi(resource $pdfdoc, int $doc, int $page, string $optlist)") (purpose . "Process imported PDF document") (id . "function.pdf-process-pdi")) "PDF_place_pdi_page" ((documentation . "Place PDF page [deprecated] bool PDF_place_pdi_page(resource $pdfdoc, int $page, float $x, float $y, float $sx, float $sy) (PHP 4 >= 4.0.6, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.6, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_place_pdi_page(resource $pdfdoc, int $page, float $x, float $y, float $sx, float $sy)") (purpose . "Place PDF page [deprecated]") (id . "function.pdf-place-pdi-page")) "PDF_place_image" ((documentation . "Place image on the page [deprecated] bool PDF_place_image(resource $pdfdoc, int $image, float $x, float $y, float $scale) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_place_image(resource $pdfdoc, int $image, float $x, float $y, float $scale)") (purpose . "Place image on the page [deprecated]") (id . "function.pdf-place-image")) "PDF_pcos_get_string" ((documentation . "Get value of pCOS path with type name, string, or boolean string PDF_pcos_get_string(resource $p, int $doc, string $path) (PECL pdflib >= 2.1.0)") (versions . "PECL pdflib >= 2.1.0") (return . "") (prototype . "string PDF_pcos_get_string(resource $p, int $doc, string $path)") (purpose . "Get value of pCOS path with type name, string, or boolean") (id . "function.pdf-pcos-get-string")) "PDF_pcos_get_stream" ((documentation . "Get contents of pCOS path with type stream, fstream, or string string PDF_pcos_get_stream(resource $p, int $doc, string $optlist, string $path) (PECL pdflib >= 2.1.0)") (versions . "PECL pdflib >= 2.1.0") (return . "") (prototype . "string PDF_pcos_get_stream(resource $p, int $doc, string $optlist, string $path)") (purpose . "Get contents of pCOS path with type stream, fstream, or string") (id . "function.pdf-pcos-get-stream")) "PDF_pcos_get_number" ((documentation . "Get value of pCOS path with type number or boolean float PDF_pcos_get_number(resource $p, int $doc, string $path) (PECL pdflib >= 2.1.0)") (versions . "PECL pdflib >= 2.1.0") (return . "") (prototype . "float PDF_pcos_get_number(resource $p, int $doc, string $path)") (purpose . "Get value of pCOS path with type number or boolean") (id . "function.pdf-pcos-get-number")) "PDF_open_tiff" ((documentation . "Open TIFF image [deprecated] PDF_open_tiff() (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . " PDF_open_tiff()") (purpose . "Open TIFF image [deprecated]") (id . "function.pdf-open-tiff")) "PDF_open_pdi" ((documentation . "Open PDF file [deprecated] int PDF_open_pdi(resource $pdfdoc, string $filename, string $optlist, int $len) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "int PDF_open_pdi(resource $pdfdoc, string $filename, string $optlist, int $len)") (purpose . "Open PDF file [deprecated]") (id . "function.pdf-open-pdi")) "PDF_open_pdi_page" ((documentation . "Prepare a page int PDF_open_pdi_page(resource $p, int $doc, int $pagenumber, string $optlist) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "int PDF_open_pdi_page(resource $p, int $doc, int $pagenumber, string $optlist)") (purpose . "Prepare a page") (id . "function.pdf-open-pdi-page")) "PDF_open_pdi_document" ((documentation . "Prepare a pdi document int PDF_open_pdi_document(resource $p, string $filename, string $optlist) (PECL pdflib >= 2.1.0)") (versions . "PECL pdflib >= 2.1.0") (return . "") (prototype . "int PDF_open_pdi_document(resource $p, string $filename, string $optlist)") (purpose . "Prepare a pdi document") (id . "function.pdf-open-pdi-document")) "PDF_open_memory_image" ((documentation . "Open image created with PHP's image functions [not supported] int PDF_open_memory_image(resource $p, resource $image) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "int PDF_open_memory_image(resource $p, resource $image)") (purpose . "Open image created with PHP's image functions [not supported]") (id . "function.pdf-open-memory-image")) "PDF_open_jpeg" ((documentation . "Open JPEG image [deprecated] PDF_open_jpeg() (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . " PDF_open_jpeg()") (purpose . "Open JPEG image [deprecated]") (id . "function.pdf-open-jpeg")) "PDF_open_image" ((documentation . "Use image data [deprecated] int PDF_open_image(resource $p, string $imagetype, string $source, string $data, int $length, int $width, int $height, int $components, int $bpc, string $params) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "int PDF_open_image(resource $p, string $imagetype, string $source, string $data, int $length, int $width, int $height, int $components, int $bpc, string $params)") (purpose . "Use image data [deprecated]") (id . "function.pdf-open-image")) "PDF_open_image_file" ((documentation . "Read image from file [deprecated] int PDF_open_image_file(resource $p, string $imagetype, string $filename, string $stringparam, int $intparam) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "int PDF_open_image_file(resource $p, string $imagetype, string $filename, string $stringparam, int $intparam)") (purpose . "Read image from file [deprecated]") (id . "function.pdf-open-image-file")) "PDF_open_gif" ((documentation . "Open GIF image [deprecated] PDF_open_gif() (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . " PDF_open_gif()") (purpose . "Open GIF image [deprecated]") (id . "function.pdf-open-gif")) "PDF_open_file" ((documentation . "Create PDF file [deprecated] bool PDF_open_file(resource $p, string $filename) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_open_file(resource $p, string $filename)") (purpose . "Create PDF file [deprecated]") (id . "function.pdf-open-file")) "PDF_open_ccitt" ((documentation . "Open raw CCITT image [deprecated] int PDF_open_ccitt(resource $pdfdoc, string $filename, int $width, int $height, int $BitReverse, int $k, int $Blackls1) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "int PDF_open_ccitt(resource $pdfdoc, string $filename, int $width, int $height, int $BitReverse, int $k, int $Blackls1)") (purpose . "Open raw CCITT image [deprecated]") (id . "function.pdf-open-ccitt")) "PDF_new" ((documentation . "Create PDFlib object resource PDF_new() (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "resource PDF_new()") (purpose . "Create PDFlib object") (id . "function.pdf-new")) "PDF_moveto" ((documentation . "Set current point bool PDF_moveto(resource $p, float $x, float $y) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_moveto(resource $p, float $x, float $y)") (purpose . "Set current point") (id . "function.pdf-moveto")) "PDF_makespotcolor" ((documentation . "Make spot color int PDF_makespotcolor(resource $p, string $spotname) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "int PDF_makespotcolor(resource $p, string $spotname)") (purpose . "Make spot color") (id . "function.pdf-makespotcolor")) "PDF_load_image" ((documentation . "Open image file int PDF_load_image(resource $pdfdoc, string $imagetype, string $filename, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "int PDF_load_image(resource $pdfdoc, string $imagetype, string $filename, string $optlist)") (purpose . "Open image file") (id . "function.pdf-load-image")) "PDF_load_iccprofile" ((documentation . "Search and prepare ICC profile int PDF_load_iccprofile(resource $pdfdoc, string $profilename, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "int PDF_load_iccprofile(resource $pdfdoc, string $profilename, string $optlist)") (purpose . "Search and prepare ICC profile") (id . "function.pdf-load-iccprofile")) "PDF_load_font" ((documentation . "Search and prepare font int PDF_load_font(resource $pdfdoc, string $fontname, string $encoding, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "int PDF_load_font(resource $pdfdoc, string $fontname, string $encoding, string $optlist)") (purpose . "Search and prepare font") (id . "function.pdf-load-font")) "PDF_load_3ddata" ((documentation . "Load 3D model int PDF_load_3ddata(resource $pdfdoc, string $filename, string $optlist) (PECL pdflib >= 2.1.0)") (versions . "PECL pdflib >= 2.1.0") (return . "") (prototype . "int PDF_load_3ddata(resource $pdfdoc, string $filename, string $optlist)") (purpose . "Load 3D model") (id . "function.pdf-load-3ddata")) "PDF_lineto" ((documentation . "Draw a line bool PDF_lineto(resource $p, float $x, float $y) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_lineto(resource $p, float $x, float $y)") (purpose . "Draw a line") (id . "function.pdf-lineto")) "PDF_initgraphics" ((documentation . "Reset graphic state bool PDF_initgraphics(resource $p) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_initgraphics(resource $p)") (purpose . "Reset graphic state") (id . "function.pdf-initgraphics")) "PDF_info_textline" ((documentation . "Perform textline formatting and query metrics float PDF_info_textline(resource $pdfdoc, string $text, string $keyword, string $optlist) (PECL pdflib >= 2.1.0)") (versions . "PECL pdflib >= 2.1.0") (return . "") (prototype . "float PDF_info_textline(resource $pdfdoc, string $text, string $keyword, string $optlist)") (purpose . "Perform textline formatting and query metrics") (id . "function.pdf-info-textline")) "PDF_info_textflow" ((documentation . "Query textflow state float PDF_info_textflow(resource $pdfdoc, int $textflow, string $keyword) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "float PDF_info_textflow(resource $pdfdoc, int $textflow, string $keyword)") (purpose . "Query textflow state") (id . "function.pdf-info-textflow")) "PDF_info_table" ((documentation . "Retrieve table information float PDF_info_table(resource $pdfdoc, int $table, string $keyword) (PECL pdflib >= 2.1.0)") (versions . "PECL pdflib >= 2.1.0") (return . "") (prototype . "float PDF_info_table(resource $pdfdoc, int $table, string $keyword)") (purpose . "Retrieve table information") (id . "function.pdf-info-table")) "PDF_info_matchbox" ((documentation . "Query matchbox information float PDF_info_matchbox(resource $pdfdoc, string $boxname, int $num, string $keyword) (PECL pdflib >= 2.1.0)") (versions . "PECL pdflib >= 2.1.0") (return . "") (prototype . "float PDF_info_matchbox(resource $pdfdoc, string $boxname, int $num, string $keyword)") (purpose . "Query matchbox information") (id . "function.pdf-info-matchbox")) "PDF_info_font" ((documentation . "Query detailed information about a loaded font float PDF_info_font(resource $pdfdoc, int $font, string $keyword, string $optlist) (PECL pdflib >= 2.1.0)") (versions . "PECL pdflib >= 2.1.0") (return . "") (prototype . "float PDF_info_font(resource $pdfdoc, int $font, string $keyword, string $optlist)") (purpose . "Query detailed information about a loaded font") (id . "function.pdf-info-font")) "PDF_get_value" ((documentation . "Get numerical parameter float PDF_get_value(resource $p, string $key, float $modifier) (PHP 4 >= 4.0.1, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.1, PECL pdflib >= 1.0.0") (return . "") (prototype . "float PDF_get_value(resource $p, string $key, float $modifier)") (purpose . "Get numerical parameter") (id . "function.pdf-get-value")) "PDF_get_pdi_value" ((documentation . "Get PDI numerical parameter [deprecated] float PDF_get_pdi_value(resource $p, string $key, int $doc, int $page, int $reserved) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "float PDF_get_pdi_value(resource $p, string $key, int $doc, int $page, int $reserved)") (purpose . "Get PDI numerical parameter [deprecated]") (id . "function.pdf-get-pdi-value")) "PDF_get_pdi_parameter" ((documentation . "Get PDI string parameter [deprecated] string PDF_get_pdi_parameter(resource $p, string $key, int $doc, int $page, int $reserved) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "string PDF_get_pdi_parameter(resource $p, string $key, int $doc, int $page, int $reserved)") (purpose . "Get PDI string parameter [deprecated]") (id . "function.pdf-get-pdi-parameter")) "PDF_get_parameter" ((documentation . "Get string parameter string PDF_get_parameter(resource $p, string $key, float $modifier) (PHP 4 >= 4.0.1, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.1, PECL pdflib >= 1.0.0") (return . "") (prototype . "string PDF_get_parameter(resource $p, string $key, float $modifier)") (purpose . "Get string parameter") (id . "function.pdf-get-parameter")) "PDF_get_minorversion" ((documentation . "Get minor version number [deprecated] int PDF_get_minorversion() (PHP 4 >= 4.2.0, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PECL pdflib >= 1.0.0") (return . "") (prototype . "int PDF_get_minorversion()") (purpose . "Get minor version number [deprecated]") (id . "function.pdf-get-minorversion")) "PDF_get_majorversion" ((documentation . "Get major version number [deprecated] int PDF_get_majorversion() (PHP 4 >= 4.2.0, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PECL pdflib >= 1.0.0") (return . "") (prototype . "int PDF_get_majorversion()") (purpose . "Get major version number [deprecated]") (id . "function.pdf-get-majorversion")) "PDF_get_image_width" ((documentation . "Get image width [deprecated] PDF_get_image_width() (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . " PDF_get_image_width()") (purpose . "Get image width [deprecated]") (id . "function.pdf-get-image-width")) "PDF_get_image_height" ((documentation . "Get image height [deprecated] PDF_get_image_height() (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . " PDF_get_image_height()") (purpose . "Get image height [deprecated]") (id . "function.pdf-get-image-height")) "PDF_get_fontsize" ((documentation . "Font handling [deprecated] PDF_get_fontsize() (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . " PDF_get_fontsize()") (purpose . "Font handling [deprecated]") (id . "function.pdf-get-fontsize")) "PDF_get_fontname" ((documentation . "Get font name [deprecated] PDF_get_fontname() (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . " PDF_get_fontname()") (purpose . "Get font name [deprecated]") (id . "function.pdf-get-fontname")) "PDF_get_font" ((documentation . "Get font [deprecated] PDF_get_font() (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . " PDF_get_font()") (purpose . "Get font [deprecated]") (id . "function.pdf-get-font")) "PDF_get_errnum" ((documentation . "Get error number int PDF_get_errnum(resource $pdfdoc) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "int PDF_get_errnum(resource $pdfdoc)") (purpose . "Get error number") (id . "function.pdf-get-errnum")) "PDF_get_errmsg" ((documentation . "Get error text string PDF_get_errmsg(resource $pdfdoc) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "string PDF_get_errmsg(resource $pdfdoc)") (purpose . "Get error text") (id . "function.pdf-get-errmsg")) "PDF_get_buffer" ((documentation . "Get PDF output buffer string PDF_get_buffer(resource $p) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "string PDF_get_buffer(resource $p)") (purpose . "Get PDF output buffer") (id . "function.pdf-get-buffer")) "PDF_get_apiname" ((documentation . "Get name of unsuccessfull API function string PDF_get_apiname(resource $pdfdoc) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "string PDF_get_apiname(resource $pdfdoc)") (purpose . "Get name of unsuccessfull API function") (id . "function.pdf-get-apiname")) "PDF_fit_textline" ((documentation . "Place single line of text bool PDF_fit_textline(resource $pdfdoc, string $text, float $x, float $y, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_fit_textline(resource $pdfdoc, string $text, float $x, float $y, string $optlist)") (purpose . "Place single line of text") (id . "function.pdf-fit-textline")) "PDF_fit_textflow" ((documentation . "Format textflow in rectangular area string PDF_fit_textflow(resource $pdfdoc, int $textflow, float $llx, float $lly, float $urx, float $ury, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "string PDF_fit_textflow(resource $pdfdoc, int $textflow, float $llx, float $lly, float $urx, float $ury, string $optlist)") (purpose . "Format textflow in rectangular area") (id . "function.pdf-fit-textflow")) "PDF_fit_table" ((documentation . "Place table on page string PDF_fit_table(resource $pdfdoc, int $table, float $llx, float $lly, float $urx, float $ury, string $optlist) (PECL pdflib >= 2.1.0)") (versions . "PECL pdflib >= 2.1.0") (return . "") (prototype . "string PDF_fit_table(resource $pdfdoc, int $table, float $llx, float $lly, float $urx, float $ury, string $optlist)") (purpose . "Place table on page") (id . "function.pdf-fit-table")) "PDF_fit_pdi_page" ((documentation . "Place imported PDF page bool PDF_fit_pdi_page(resource $pdfdoc, int $page, float $x, float $y, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_fit_pdi_page(resource $pdfdoc, int $page, float $x, float $y, string $optlist)") (purpose . "Place imported PDF page") (id . "function.pdf-fit-pdi-page")) "PDF_fit_image" ((documentation . "Place image or template bool PDF_fit_image(resource $pdfdoc, int $image, float $x, float $y, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_fit_image(resource $pdfdoc, int $image, float $x, float $y, string $optlist)") (purpose . "Place image or template") (id . "function.pdf-fit-image")) "PDF_findfont" ((documentation . "Prepare font for later use [deprecated] int PDF_findfont(resource $p, string $fontname, string $encoding, int $embed) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "int PDF_findfont(resource $p, string $fontname, string $encoding, int $embed)") (purpose . "Prepare font for later use [deprecated]") (id . "function.pdf-findfont")) "PDF_fill" ((documentation . "Fill current path bool PDF_fill(resource $p) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_fill(resource $p)") (purpose . "Fill current path") (id . "function.pdf-fill")) "PDF_fill_textblock" ((documentation . "Fill text block with variable data int PDF_fill_textblock(resource $pdfdoc, int $page, string $blockname, string $text, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "int PDF_fill_textblock(resource $pdfdoc, int $page, string $blockname, string $text, string $optlist)") (purpose . "Fill text block with variable data") (id . "function.pdf-fill-textblock")) "PDF_fill_stroke" ((documentation . "Fill and stroke path bool PDF_fill_stroke(resource $p) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_fill_stroke(resource $p)") (purpose . "Fill and stroke path") (id . "function.pdf-fill-stroke")) "PDF_fill_pdfblock" ((documentation . "Fill PDF block with variable data int PDF_fill_pdfblock(resource $pdfdoc, int $page, string $blockname, int $contents, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "int PDF_fill_pdfblock(resource $pdfdoc, int $page, string $blockname, int $contents, string $optlist)") (purpose . "Fill PDF block with variable data") (id . "function.pdf-fill-pdfblock")) "PDF_fill_imageblock" ((documentation . "Fill image block with variable data int PDF_fill_imageblock(resource $pdfdoc, int $page, string $blockname, int $image, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "int PDF_fill_imageblock(resource $pdfdoc, int $page, string $blockname, int $image, string $optlist)") (purpose . "Fill image block with variable data") (id . "function.pdf-fill-imageblock")) "PDF_endpath" ((documentation . "End current path bool PDF_endpath(resource $p) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_endpath(resource $p)") (purpose . "End current path") (id . "function.pdf-endpath")) "PDF_end_template" ((documentation . "Finish template bool PDF_end_template(resource $p) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_end_template(resource $p)") (purpose . "Finish template") (id . "function.pdf-end-template")) "PDF_end_pattern" ((documentation . "Finish pattern bool PDF_end_pattern(resource $p) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_end_pattern(resource $p)") (purpose . "Finish pattern") (id . "function.pdf-end-pattern")) "PDF_end_page" ((documentation . "Finish page bool PDF_end_page(resource $p) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_end_page(resource $p)") (purpose . "Finish page") (id . "function.pdf-end-page")) "PDF_end_page_ext" ((documentation . "Finish page bool PDF_end_page_ext(resource $pdfdoc, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_end_page_ext(resource $pdfdoc, string $optlist)") (purpose . "Finish page") (id . "function.pdf-end-page-ext")) "PDF_end_layer" ((documentation . "Deactivate all active layers bool PDF_end_layer(resource $pdfdoc) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_end_layer(resource $pdfdoc)") (purpose . "Deactivate all active layers") (id . "function.pdf-end-layer")) "PDF_end_item" ((documentation . "Close structure element or other content item bool PDF_end_item(resource $pdfdoc, int $id) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_end_item(resource $pdfdoc, int $id)") (purpose . "Close structure element or other content item") (id . "function.pdf-end-item")) "PDF_end_glyph" ((documentation . "Terminate glyph definition for Type 3 font bool PDF_end_glyph(resource $pdfdoc) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_end_glyph(resource $pdfdoc)") (purpose . "Terminate glyph definition for Type 3 font") (id . "function.pdf-end-glyph")) "PDF_end_font" ((documentation . "Terminate Type 3 font definition bool PDF_end_font(resource $pdfdoc) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_end_font(resource $pdfdoc)") (purpose . "Terminate Type 3 font definition") (id . "function.pdf-end-font")) "PDF_end_document" ((documentation . "Close PDF file bool PDF_end_document(resource $pdfdoc, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_end_document(resource $pdfdoc, string $optlist)") (purpose . "Close PDF file") (id . "function.pdf-end-document")) "PDF_encoding_set_char" ((documentation . "Add glyph name and/or Unicode value bool PDF_encoding_set_char(resource $pdfdoc, string $encoding, int $slot, string $glyphname, int $uv) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_encoding_set_char(resource $pdfdoc, string $encoding, int $slot, string $glyphname, int $uv)") (purpose . "Add glyph name and/or Unicode value") (id . "function.pdf-encoding-set-char")) "PDF_delete" ((documentation . "Delete PDFlib object bool PDF_delete(resource $pdfdoc) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_delete(resource $pdfdoc)") (purpose . "Delete PDFlib object") (id . "function.pdf-delete")) "PDF_delete_textflow" ((documentation . "Delete textflow object bool PDF_delete_textflow(resource $pdfdoc, int $textflow) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_delete_textflow(resource $pdfdoc, int $textflow)") (purpose . "Delete textflow object") (id . "function.pdf-delete-textflow")) "PDF_delete_table" ((documentation . "Delete table object bool PDF_delete_table(resource $pdfdoc, int $table, string $optlist) (PECL pdflib >= 2.1.0)") (versions . "PECL pdflib >= 2.1.0") (return . "") (prototype . "bool PDF_delete_table(resource $pdfdoc, int $table, string $optlist)") (purpose . "Delete table object") (id . "function.pdf-delete-table")) "PDF_delete_pvf" ((documentation . "Delete PDFlib virtual file int PDF_delete_pvf(resource $pdfdoc, string $filename) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "int PDF_delete_pvf(resource $pdfdoc, string $filename)") (purpose . "Delete PDFlib virtual file") (id . "function.pdf-delete-pvf")) "PDF_define_layer" ((documentation . "Create layer definition int PDF_define_layer(resource $pdfdoc, string $name, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "int PDF_define_layer(resource $pdfdoc, string $name, string $optlist)") (purpose . "Create layer definition") (id . "function.pdf-define-layer")) "PDF_curveto" ((documentation . "Draw Bezier curve bool PDF_curveto(resource $p, float $x1, float $y1, float $x2, float $y2, float $x3, float $y3) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_curveto(resource $p, float $x1, float $y1, float $x2, float $y2, float $x3, float $y3)") (purpose . "Draw Bezier curve") (id . "function.pdf-curveto")) "PDF_create_textflow" ((documentation . "Create textflow object int PDF_create_textflow(resource $pdfdoc, string $text, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "int PDF_create_textflow(resource $pdfdoc, string $text, string $optlist)") (purpose . "Create textflow object") (id . "function.pdf-create-textflow")) "PDF_create_pvf" ((documentation . "Create PDFlib virtual file bool PDF_create_pvf(resource $pdfdoc, string $filename, string $data, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_create_pvf(resource $pdfdoc, string $filename, string $data, string $optlist)") (purpose . "Create PDFlib virtual file") (id . "function.pdf-create-pvf")) "PDF_create_gstate" ((documentation . "Create graphics state object int PDF_create_gstate(resource $pdfdoc, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "int PDF_create_gstate(resource $pdfdoc, string $optlist)") (purpose . "Create graphics state object") (id . "function.pdf-create-gstate")) "PDF_create_fieldgroup" ((documentation . "Create form field group bool PDF_create_fieldgroup(resource $pdfdoc, string $name, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_create_fieldgroup(resource $pdfdoc, string $name, string $optlist)") (purpose . "Create form field group") (id . "function.pdf-create-fieldgroup")) "PDF_create_field" ((documentation . "Create form field bool PDF_create_field(resource $pdfdoc, float $llx, float $lly, float $urx, float $ury, string $name, string $type, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_create_field(resource $pdfdoc, float $llx, float $lly, float $urx, float $ury, string $name, string $type, string $optlist)") (purpose . "Create form field") (id . "function.pdf-create-field")) "PDF_create_bookmark" ((documentation . "Create bookmark int PDF_create_bookmark(resource $pdfdoc, string $text, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "int PDF_create_bookmark(resource $pdfdoc, string $text, string $optlist)") (purpose . "Create bookmark") (id . "function.pdf-create-bookmark")) "PDF_create_annotation" ((documentation . "Create rectangular annotation bool PDF_create_annotation(resource $pdfdoc, float $llx, float $lly, float $urx, float $ury, string $type, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_create_annotation(resource $pdfdoc, float $llx, float $lly, float $urx, float $ury, string $type, string $optlist)") (purpose . "Create rectangular annotation") (id . "function.pdf-create-annotation")) "PDF_create_action" ((documentation . "Create action for objects or events int PDF_create_action(resource $pdfdoc, string $type, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "int PDF_create_action(resource $pdfdoc, string $type, string $optlist)") (purpose . "Create action for objects or events") (id . "function.pdf-create-action")) "PDF_create_3dview" ((documentation . "Create 3D view int PDF_create_3dview(resource $pdfdoc, string $username, string $optlist) (PECL pdflib >= 2.1.0)") (versions . "PECL pdflib >= 2.1.0") (return . "") (prototype . "int PDF_create_3dview(resource $pdfdoc, string $username, string $optlist)") (purpose . "Create 3D view") (id . "function.pdf-create-3dview")) "PDF_continue_text" ((documentation . "Output text in next line bool PDF_continue_text(resource $p, string $text) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_continue_text(resource $p, string $text)") (purpose . "Output text in next line") (id . "function.pdf-continue-text")) "PDF_concat" ((documentation . "Concatenate a matrix to the CTM bool PDF_concat(resource $p, float $a, float $b, float $c, float $d, float $e, float $f) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_concat(resource $p, float $a, float $b, float $c, float $d, float $e, float $f)") (purpose . "Concatenate a matrix to the CTM") (id . "function.pdf-concat")) "PDF_closepath" ((documentation . "Close current path bool PDF_closepath(resource $p) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_closepath(resource $p)") (purpose . "Close current path") (id . "function.pdf-closepath")) "PDF_closepath_stroke" ((documentation . "Close and stroke path bool PDF_closepath_stroke(resource $p) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_closepath_stroke(resource $p)") (purpose . "Close and stroke path") (id . "function.pdf-closepath-stroke")) "PDF_closepath_fill_stroke" ((documentation . "Close, fill and stroke current path bool PDF_closepath_fill_stroke(resource $p) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_closepath_fill_stroke(resource $p)") (purpose . "Close, fill and stroke current path") (id . "function.pdf-closepath-fill-stroke")) "PDF_close" ((documentation . "Close pdf resource [deprecated] bool PDF_close(resource $p) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_close(resource $p)") (purpose . "Close pdf resource [deprecated]") (id . "function.pdf-close")) "PDF_close_pdi" ((documentation . "Close the input PDF document [deprecated] bool PDF_close_pdi(resource $p, int $doc) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_close_pdi(resource $p, int $doc)") (purpose . "Close the input PDF document [deprecated]") (id . "function.pdf-close-pdi")) "PDF_close_pdi_page" ((documentation . "Close the page handle bool PDF_close_pdi_page(resource $p, int $page) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_close_pdi_page(resource $p, int $page)") (purpose . "Close the page handle") (id . "function.pdf-close-pdi-page")) "PDF_close_image" ((documentation . "Close image bool PDF_close_image(resource $p, int $image) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_close_image(resource $p, int $image)") (purpose . "Close image") (id . "function.pdf-close-image")) "PDF_clip" ((documentation . "Clip to current path bool PDF_clip(resource $p) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_clip(resource $p)") (purpose . "Clip to current path") (id . "function.pdf-clip")) "PDF_circle" ((documentation . "Draw a circle bool PDF_circle(resource $pdfdoc, float $x, float $y, float $r) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_circle(resource $pdfdoc, float $x, float $y, float $r)") (purpose . "Draw a circle") (id . "function.pdf-circle")) "PDF_begin_template" ((documentation . "Start template definition [deprecated] int PDF_begin_template(resource $pdfdoc, float $width, float $height) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "int PDF_begin_template(resource $pdfdoc, float $width, float $height)") (purpose . "Start template definition [deprecated]") (id . "function.pdf-begin-template")) "PDF_begin_template_ext" ((documentation . "Start template definition int PDF_begin_template_ext(resource $pdfdoc, float $width, float $height, string $optlist) (PECL pdflib >= 2.1.0)") (versions . "PECL pdflib >= 2.1.0") (return . "") (prototype . "int PDF_begin_template_ext(resource $pdfdoc, float $width, float $height, string $optlist)") (purpose . "Start template definition") (id . "function.pdf-begin-template-ext")) "PDF_begin_pattern" ((documentation . "Start pattern definition int PDF_begin_pattern(resource $pdfdoc, float $width, float $height, float $xstep, float $ystep, int $painttype) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "int PDF_begin_pattern(resource $pdfdoc, float $width, float $height, float $xstep, float $ystep, int $painttype)") (purpose . "Start pattern definition") (id . "function.pdf-begin-pattern")) "PDF_begin_page" ((documentation . "Start new page [deprecated] bool PDF_begin_page(resource $pdfdoc, float $width, float $height) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_begin_page(resource $pdfdoc, float $width, float $height)") (purpose . "Start new page [deprecated]") (id . "function.pdf-begin-page")) "PDF_begin_page_ext" ((documentation . "Start new page bool PDF_begin_page_ext(resource $pdfdoc, float $width, float $height, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_begin_page_ext(resource $pdfdoc, float $width, float $height, string $optlist)") (purpose . "Start new page") (id . "function.pdf-begin-page-ext")) "PDF_begin_layer" ((documentation . "Start layer bool PDF_begin_layer(resource $pdfdoc, int $layer) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_begin_layer(resource $pdfdoc, int $layer)") (purpose . "Start layer") (id . "function.pdf-begin-layer")) "PDF_begin_item" ((documentation . "Open structure element or other content item int PDF_begin_item(resource $pdfdoc, string $tag, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "int PDF_begin_item(resource $pdfdoc, string $tag, string $optlist)") (purpose . "Open structure element or other content item") (id . "function.pdf-begin-item")) "PDF_begin_glyph" ((documentation . "Start glyph definition for Type 3 font bool PDF_begin_glyph(resource $pdfdoc, string $glyphname, float $wx, float $llx, float $lly, float $urx, float $ury) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_begin_glyph(resource $pdfdoc, string $glyphname, float $wx, float $llx, float $lly, float $urx, float $ury)") (purpose . "Start glyph definition for Type 3 font") (id . "function.pdf-begin-glyph")) "PDF_begin_font" ((documentation . "Start a Type 3 font definition bool PDF_begin_font(resource $pdfdoc, string $filename, float $a, float $b, float $c, float $d, float $e, float $f, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_begin_font(resource $pdfdoc, string $filename, float $a, float $b, float $c, float $d, float $e, float $f, string $optlist)") (purpose . "Start a Type 3 font definition") (id . "function.pdf-begin-font")) "PDF_begin_document" ((documentation . "Create new PDF file int PDF_begin_document(resource $pdfdoc, string $filename, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "int PDF_begin_document(resource $pdfdoc, string $filename, string $optlist)") (purpose . "Create new PDF file") (id . "function.pdf-begin-document")) "PDF_attach_file" ((documentation . "Add file attachment for current page [deprecated] bool PDF_attach_file(resource $pdfdoc, float $llx, float $lly, float $urx, float $ury, string $filename, string $description, string $author, string $mimetype, string $icon) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_attach_file(resource $pdfdoc, float $llx, float $lly, float $urx, float $ury, string $filename, string $description, string $author, string $mimetype, string $icon)") (purpose . "Add file attachment for current page [deprecated]") (id . "function.pdf-attach-file")) "PDF_arcn" ((documentation . "Draw a clockwise circular arc segment bool PDF_arcn(resource $p, float $x, float $y, float $r, float $alpha, float $beta) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_arcn(resource $p, float $x, float $y, float $r, float $alpha, float $beta)") (purpose . "Draw a clockwise circular arc segment") (id . "function.pdf-arcn")) "PDF_arc" ((documentation . "Draw a counterclockwise circular arc segment bool PDF_arc(resource $p, float $x, float $y, float $r, float $alpha, float $beta) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_arc(resource $p, float $x, float $y, float $r, float $alpha, float $beta)") (purpose . "Draw a counterclockwise circular arc segment") (id . "function.pdf-arc")) "PDF_add_weblink" ((documentation . "Add weblink for current page [deprecated] bool PDF_add_weblink(resource $pdfdoc, float $lowerleftx, float $lowerlefty, float $upperrightx, float $upperrighty, string $url) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_add_weblink(resource $pdfdoc, float $lowerleftx, float $lowerlefty, float $upperrightx, float $upperrighty, string $url)") (purpose . "Add weblink for current page [deprecated]") (id . "function.pdf-add-weblink")) "PDF_add_thumbnail" ((documentation . "Add thumbnail for current page bool PDF_add_thumbnail(resource $pdfdoc, int $image) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_add_thumbnail(resource $pdfdoc, int $image)") (purpose . "Add thumbnail for current page") (id . "function.pdf-add-thumbnail")) "PDF_add_textflow" ((documentation . "Create Textflow or add text to existing Textflow int PDF_add_textflow(resource $pdfdoc, int $textflow, string $text, string $optlist) (PECL pdflib >= 2.1.0)") (versions . "PECL pdflib >= 2.1.0") (return . "") (prototype . "int PDF_add_textflow(resource $pdfdoc, int $textflow, string $text, string $optlist)") (purpose . "Create Textflow or add text to existing Textflow") (id . "function.pdf-add-textflow")) "PDF_add_table_cell" ((documentation . "Add a cell to a new or existing table int PDF_add_table_cell(resource $pdfdoc, int $table, int $column, int $row, string $text, string $optlist) (PECL pdflib >= 2.1.0)") (versions . "PECL pdflib >= 2.1.0") (return . "") (prototype . "int PDF_add_table_cell(resource $pdfdoc, int $table, int $column, int $row, string $text, string $optlist)") (purpose . "Add a cell to a new or existing table") (id . "function.pdf-add-table-cell")) "PDF_add_pdflink" ((documentation . "Add file link annotation for current page [deprecated] bool PDF_add_pdflink(resource $pdfdoc, float $bottom_left_x, float $bottom_left_y, float $up_right_x, float $up_right_y, string $filename, int $page, string $dest) (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_add_pdflink(resource $pdfdoc, float $bottom_left_x, float $bottom_left_y, float $up_right_x, float $up_right_y, string $filename, int $page, string $dest)") (purpose . "Add file link annotation for current page [deprecated]") (id . "function.pdf-add-pdflink")) "PDF_add_outline" ((documentation . "Add bookmark for current page [deprecated] PDF_add_outline() (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . " PDF_add_outline()") (purpose . "Add bookmark for current page [deprecated]") (id . "function.pdf-add-outline")) "PDF_add_note" ((documentation . "Set annotation for current page [deprecated] bool PDF_add_note(resource $pdfdoc, float $llx, float $lly, float $urx, float $ury, string $contents, string $title, string $icon, int $open) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_add_note(resource $pdfdoc, float $llx, float $lly, float $urx, float $ury, string $contents, string $title, string $icon, int $open)") (purpose . "Set annotation for current page [deprecated]") (id . "function.pdf-add-note")) "PDF_add_nameddest" ((documentation . "Create named destination bool PDF_add_nameddest(resource $pdfdoc, string $name, string $optlist) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_add_nameddest(resource $pdfdoc, string $name, string $optlist)") (purpose . "Create named destination") (id . "function.pdf-add-nameddest")) "PDF_add_locallink" ((documentation . "Add link annotation for current page [deprecated] bool PDF_add_locallink(resource $pdfdoc, float $lowerleftx, float $lowerlefty, float $upperrightx, float $upperrighty, int $page, string $dest) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_add_locallink(resource $pdfdoc, float $lowerleftx, float $lowerlefty, float $upperrightx, float $upperrighty, int $page, string $dest)") (purpose . "Add link annotation for current page [deprecated]") (id . "function.pdf-add-locallink")) "PDF_add_launchlink" ((documentation . "Add launch annotation for current page [deprecated] bool PDF_add_launchlink(resource $pdfdoc, float $llx, float $lly, float $urx, float $ury, string $filename) (PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.5, PECL pdflib >= 1.0.0") (return . "") (prototype . "bool PDF_add_launchlink(resource $pdfdoc, float $llx, float $lly, float $urx, float $ury, string $filename)") (purpose . "Add launch annotation for current page [deprecated]") (id . "function.pdf-add-launchlink")) "PDF_add_bookmark" ((documentation . "Add bookmark for current page [deprecated] PDF_add_bookmark() (PHP 4 >= 4.0.1, PECL pdflib >= 1.0.0)") (versions . "PHP 4 >= 4.0.1, PECL pdflib >= 1.0.0") (return . "") (prototype . " PDF_add_bookmark()") (purpose . "Add bookmark for current page [deprecated]") (id . "function.pdf-add-bookmark")) "PDF_add_annotation" ((documentation . "Add annotation [deprecated] PDF_add_annotation() (PHP 4, PECL pdflib >= 1.0.0)") (versions . "PHP 4, PECL pdflib >= 1.0.0") (return . "") (prototype . " PDF_add_annotation()") (purpose . "Add annotation [deprecated]") (id . "function.pdf-add-annotation")) "PDF_activate_item" ((documentation . "Activate structure element or other content item bool PDF_activate_item(resource $pdfdoc, int $id) (PECL pdflib >= 2.0.0)") (versions . "PECL pdflib >= 2.0.0") (return . "") (prototype . "bool PDF_activate_item(resource $pdfdoc, int $id)") (purpose . "Activate structure element or other content item") (id . "function.pdf-activate-item")) "ming_useswfversion" ((documentation . "Sets the SWF version void ming_useswfversion(int $version) No value is returned. (PHP 4 >= 4.2.0, PHP 5 <= 5.3.0, PECL ming SVN)") (versions . "PHP 4 >= 4.2.0, PHP 5 <= 5.3.0, PECL ming SVN") (return . "No value is returned.
") (prototype . "void ming_useswfversion(int $version)") (purpose . "Sets the SWF version") (id . "function.ming-useswfversion")) "ming_useconstants" ((documentation . "Use constant pool void ming_useconstants(int $use) No value is returned. (PHP 5 <= 5.3.0, PECL ming SVN)") (versions . "PHP 5 <= 5.3.0, PECL ming SVN") (return . "No value is returned.
") (prototype . "void ming_useconstants(int $use)") (purpose . "Use constant pool") (id . "function.ming-useconstants")) "ming_setswfcompression" ((documentation . "Sets the SWF output compression void ming_setswfcompression(int $level) No value is returned. (PHP 5.2.1-5.3.0, PECL ming SVN)") (versions . "PHP 5.2.1-5.3.0, PECL ming SVN") (return . "No value is returned.
") (prototype . "void ming_setswfcompression(int $level)") (purpose . "Sets the SWF output compression") (id . "function.ming-setswfcompression")) "ming_setscale" ((documentation . "Set the global scaling factor. void ming_setscale(float $scale) No value is returned. (PHP 4 >= 4.0.5, PHP 5, PECL ming SVN)") (versions . "PHP 4 >= 4.0.5, PHP 5, PECL ming SVN") (return . "No value is returned.
") (prototype . "void ming_setscale(float $scale)") (purpose . "Set the global scaling factor.") (id . "function.ming-setscale")) "ming_setcubicthreshold" ((documentation . "Set cubic threshold void ming_setcubicthreshold(int $threshold) No value is returned. (PHP 4 >= 4.0.5, PHP 5, PECL ming SVN)") (versions . "PHP 4 >= 4.0.5, PHP 5, PECL ming SVN") (return . "No value is returned.
") (prototype . "void ming_setcubicthreshold(int $threshold)") (purpose . "Set cubic threshold") (id . "function.ming-setcubicthreshold")) "ming_keypress" ((documentation . "Returns the action flag for keyPress(char) int ming_keypress(string $char) (PHP 5 <= 5.3.0, PECL ming SVN)") (versions . "PHP 5 <= 5.3.0, PECL ming SVN") (return . "") (prototype . "int ming_keypress(string $char)") (purpose . "Returns the action flag for keyPress(char)") (id . "function.ming-keypress")) "gnupg_verify" ((documentation . "Verifies a signed text array gnupg_verify(resource $identifier, string $signed_text, string $signature [, string $plaintext = '']) On success, this function returns information about the signature. On failure, this function returns FALSE. (PECL gnupg >= 0.1)") (versions . "PECL gnupg >= 0.1") (return . " On success, this function returns information about the signature. On failure, this function returns FALSE.
On success, this function returns the signed text or the signature. On failure, this function returns FALSE.
Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void gnupg_seterrormode(resource $identifier, int $errormode)") (purpose . "Sets the mode for error_reporting") (id . "function.gnupg-seterrormode")) "gnupg_setarmor" ((documentation . "Toggle armored output bool gnupg_setarmor(resource $identifier, int $armor) Returns TRUE on success or FALSE on failure. (PECL gnupg >= 0.1)") (versions . "PECL gnupg >= 0.1") (return . " Returns TRUE on success or FALSE on failure.
Returns an array with information about all keys that matches the given pattern or FALSE, if an error has occurred.
A GnuPG resource connection used by other GnuPG functions.
") (prototype . "resource gnupg_init()") (purpose . "Initialize a connection") (id . "function.gnupg-init")) "gnupg_import" ((documentation . "Imports a key array gnupg_import(resource $identifier, string $keydata) On success, this function returns and info-array about the importprocess. On failure, this function returns FALSE. (PECL gnupg >= 0.3)") (versions . "PECL gnupg >= 0.3") (return . " On success, this function returns and info-array about the importprocess. On failure, this function returns FALSE.
Returns the currently active protocol, which can be one of GNUPG_PROTOCOL_OpenPGP or GNUPG_PROTOCOL_CMS.
Returns an errortext, if an error has occurred, otherwise FALSE.
On success, this function returns the keydata. On failure, this function returns FALSE.
On success, this function returns the encrypted and signed text. On failure, this function returns FALSE.
On success, this function returns the encrypted text. On failure, this function returns FALSE.
On success, this function returns information about the signature and fills the plaintext parameter with the decrypted text. On failure, this function returns FALSE.
On success, this function returns the decrypted text. On failure, this function returns FALSE.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the document as a string, or FALSE on error.
Returns a FDF document handle, or FALSE on error.
Returns a FDF document handle, or FALSE on error.
Returns the field name as a string.
") (prototype . "string fdf_next_field_name(resource $fdf_document [, string $fieldname = ''])") (purpose . "Get the next field name") (id . "function.fdf-next-field-name")) "fdf_header" ((documentation . "Sets FDF-specific output headers void fdf_header() No value is returned. (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . "No value is returned.
") (prototype . "void fdf_header()") (purpose . "Sets FDF-specific output headers") (id . "function.fdf-header")) "fdf_get_version" ((documentation . "Gets version number for FDF API or file string fdf_get_version([resource $fdf_document = '']) 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. (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . "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.
") (prototype . "string fdf_get_version([resource $fdf_document = ''])") (purpose . "Gets version number for FDF API or file") (id . "function.fdf-get-version")) "fdf_get_value" ((documentation . "Get the value of a field mixed fdf_get_value(resource $fdf_document, string $fieldname [, int $which = -1]) Returns the field value. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the field value.
") (prototype . "mixed fdf_get_value(resource $fdf_document, string $fieldname [, int $which = -1])") (purpose . "Get the value of a field") (id . "function.fdf-get-value")) "fdf_get_status" ((documentation . "Get the value of the /STATUS key string fdf_get_status(resource $fdf_document) Returns the key value, as a string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the key value, as a string.
") (prototype . "string fdf_get_status(resource $fdf_document)") (purpose . "Get the value of the /STATUS key") (id . "function.fdf-get-status")) "fdf_get_opt" ((documentation . "Gets a value from the opt array of a field mixed fdf_get_opt(resource $fdf_document, string $fieldname [, int $element = -1]) (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . "") (prototype . "mixed fdf_get_opt(resource $fdf_document, string $fieldname [, int $element = -1])") (purpose . "Gets a value from the opt array of a field") (id . "function.fdf-get-opt")) "fdf_get_flags" ((documentation . "Gets the flags of a field int fdf_get_flags(resource $fdf_document, string $fieldname, int $whichflags) (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . "") (prototype . "int fdf_get_flags(resource $fdf_document, string $fieldname, int $whichflags)") (purpose . "Gets the flags of a field") (id . "function.fdf-get-flags")) "fdf_get_file" ((documentation . "Get the value of the /F key string fdf_get_file(resource $fdf_document) Returns the key value, as a string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the key value, as a string.
") (prototype . "string fdf_get_file(resource $fdf_document)") (purpose . "Get the value of the /F key") (id . "function.fdf-get-file")) "fdf_get_encoding" ((documentation . "Get the value of the /Encoding key string fdf_get_encoding(resource $fdf_document) Returns the encoding as a string. An empty string is returned if the default PDFDocEncoding/Unicode scheme is used. (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . "Returns the encoding as a string. An empty string is returned if the default PDFDocEncoding/Unicode scheme is used.
") (prototype . "string fdf_get_encoding(resource $fdf_document)") (purpose . "Get the value of the /Encoding key") (id . "function.fdf-get-encoding")) "fdf_get_attachment" ((documentation . "Extracts uploaded file embedded in the FDF array fdf_get_attachment(resource $fdf_document, string $fieldname, string $savepath) The returned array contains the following fields: * path - path were the file got stored * size - size of the stored file in bytes * type - mimetype if given in the FDF (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . "The returned array contains the following fields:
path - path were the file got stored size - size of the stored file in bytes type - mimetype if given in the FDF Returns TRUE on success or FALSE on failure.
Returns the error message as a string, or the string no error if nothing went wrong.
") (prototype . "string fdf_error([int $error_code = -1])") (purpose . "Return error description for FDF error code") (id . "function.fdf-error")) "fdf_errno" ((documentation . "Return error code for last fdf operation int fdf_errno() Returns the error code as an integer, or zero if there was no errors. (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . "Returns the error code as an integer, or zero if there was no errors.
") (prototype . "int fdf_errno()") (purpose . "Return error code for last fdf operation") (id . "function.fdf-errno")) "fdf_enum_values" ((documentation . "Call a user defined function for each document value bool fdf_enum_values(resource $fdf_document, callable $function [, mixed $userdata = '']) (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . "") (prototype . "bool fdf_enum_values(resource $fdf_document, callable $function [, mixed $userdata = ''])") (purpose . "Call a user defined function for each document value") (id . "function.fdf-enum-values")) "fdf_create" ((documentation . "Create a new FDF document resource fdf_create() Returns a FDF document handle, or FALSE on error. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns a FDF document handle, or FALSE on error.
No value is returned.
") (prototype . "void fdf_close(resource $fdf_document)") (purpose . "Close an FDF document") (id . "function.fdf-close")) "fdf_add_template" ((documentation . "Adds a template into the FDF document bool fdf_add_template(resource $fdf_document, int $newpage, string $filename, string $template, int $rename) (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "") (prototype . "bool fdf_add_template(resource $fdf_document, int $newpage, string $filename, string $template, int $rename)") (purpose . "Adds a template into the FDF document") (id . "function.fdf-add-template")) "fdf_add_doc_javascript" ((documentation . "Adds javascript code to the FDF document bool fdf_add_doc_javascript(resource $fdf_document, string $script_name, string $script_code) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns an array with calculated data or false on failure.
") (prototype . "array trader_wma(array $real [, integer $timePeriod = ''])") (purpose . "Weighted Moving Average") (id . "function.trader-wma")) "trader_willr" ((documentation . "Williams' %R array trader_willr(array $high, array $low, array $close [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_willr(array $high, array $low, array $close [, integer $timePeriod = ''])") (purpose . "Williams' %R") (id . "function.trader-willr")) "trader_wclprice" ((documentation . "Weighted Close Price array trader_wclprice(array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_wclprice(array $high, array $low, array $close)") (purpose . "Weighted Close Price") (id . "function.trader-wclprice")) "trader_var" ((documentation . "Variance array trader_var(array $real [, integer $timePeriod = '' [, float $nbDev = '']]) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_var(array $real [, integer $timePeriod = '' [, float $nbDev = '']])") (purpose . "Variance") (id . "function.trader-var")) "trader_ultosc" ((documentation . "Ultimate Oscillator array trader_ultosc(array $high, array $low, array $close [, integer $timePeriod1 = '' [, integer $timePeriod2 = '' [, integer $timePeriod3 = '']]]) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_ultosc(array $high, array $low, array $close [, integer $timePeriod1 = '' [, integer $timePeriod2 = '' [, integer $timePeriod3 = '']]])") (purpose . "Ultimate Oscillator") (id . "function.trader-ultosc")) "trader_typprice" ((documentation . "Typical Price array trader_typprice(array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_typprice(array $high, array $low, array $close)") (purpose . "Typical Price") (id . "function.trader-typprice")) "trader_tsf" ((documentation . "Time Series Forecast array trader_tsf(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_tsf(array $real [, integer $timePeriod = ''])") (purpose . "Time Series Forecast") (id . "function.trader-tsf")) "trader_trix" ((documentation . "1-day Rate-Of-Change (ROC) of a Triple Smooth EMA array trader_trix(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_trix(array $real [, integer $timePeriod = ''])") (purpose . "1-day Rate-Of-Change (ROC) of a Triple Smooth EMA") (id . "function.trader-trix")) "trader_trima" ((documentation . "Triangular Moving Average array trader_trima(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_trima(array $real [, integer $timePeriod = ''])") (purpose . "Triangular Moving Average") (id . "function.trader-trima")) "trader_trange" ((documentation . "True Range array trader_trange(array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_trange(array $high, array $low, array $close)") (purpose . "True Range") (id . "function.trader-trange")) "trader_tema" ((documentation . "Triple Exponential Moving Average array trader_tema(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_tema(array $real [, integer $timePeriod = ''])") (purpose . "Triple Exponential Moving Average") (id . "function.trader-tema")) "trader_tanh" ((documentation . "Vector Trigonometric Tanh array trader_tanh(array $real) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_tanh(array $real)") (purpose . "Vector Trigonometric Tanh") (id . "function.trader-tanh")) "trader_tan" ((documentation . "Vector Trigonometric Tan array trader_tan(array $real) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_tan(array $real)") (purpose . "Vector Trigonometric Tan") (id . "function.trader-tan")) "trader_t3" ((documentation . "Triple Exponential Moving Average (T3) array trader_t3(array $real [, integer $timePeriod = '' [, float $vFactor = '']]) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_t3(array $real [, integer $timePeriod = '' [, float $vFactor = '']])") (purpose . "Triple Exponential Moving Average (T3)") (id . "function.trader-t3")) "trader_sum" ((documentation . "Summation array trader_sum(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_sum(array $real [, integer $timePeriod = ''])") (purpose . "Summation") (id . "function.trader-sum")) "trader_sub" ((documentation . "Vector Arithmetic Subtraction array trader_sub(array $real0, array $real1) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_sub(array $real0, array $real1)") (purpose . "Vector Arithmetic Subtraction") (id . "function.trader-sub")) "trader_stochrsi" ((documentation . "Stochastic Relative Strength Index array trader_stochrsi(array $real [, integer $timePeriod = '' [, integer $fastK_Period = '' [, integer $fastD_Period = '' [, integer $fastD_MAType = '']]]]) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_stochrsi(array $real [, integer $timePeriod = '' [, integer $fastK_Period = '' [, integer $fastD_Period = '' [, integer $fastD_MAType = '']]]])") (purpose . "Stochastic Relative Strength Index") (id . "function.trader-stochrsi")) "trader_stochf" ((documentation . "Stochastic Fast array trader_stochf(array $high, array $low, array $close [, integer $fastK_Period = '' [, integer $fastD_Period = '' [, integer $fastD_MAType = '']]]) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_stochf(array $high, array $low, array $close [, integer $fastK_Period = '' [, integer $fastD_Period = '' [, integer $fastD_MAType = '']]])") (purpose . "Stochastic Fast") (id . "function.trader-stochf")) "trader_stoch" ((documentation . "Stochastic array trader_stoch(array $high, array $low, array $close [, integer $fastK_Period = '' [, integer $slowK_Period = '' [, integer $slowK_MAType = '' [, integer $slowD_Period = '' [, integer $slowD_MAType = '']]]]]) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_stoch(array $high, array $low, array $close [, integer $fastK_Period = '' [, integer $slowK_Period = '' [, integer $slowK_MAType = '' [, integer $slowD_Period = '' [, integer $slowD_MAType = '']]]]])") (purpose . "Stochastic") (id . "function.trader-stoch")) "trader_stddev" ((documentation . "Standard Deviation array trader_stddev(array $real [, integer $timePeriod = '' [, float $nbDev = '']]) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_stddev(array $real [, integer $timePeriod = '' [, float $nbDev = '']])") (purpose . "Standard Deviation") (id . "function.trader-stddev")) "trader_sqrt" ((documentation . "Vector Square Root array trader_sqrt(array $real) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_sqrt(array $real)") (purpose . "Vector Square Root") (id . "function.trader-sqrt")) "trader_sma" ((documentation . "Simple Moving Average array trader_sma(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_sma(array $real [, integer $timePeriod = ''])") (purpose . "Simple Moving Average") (id . "function.trader-sma")) "trader_sinh" ((documentation . "Vector Trigonometric Sinh array trader_sinh(array $real) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_sinh(array $real)") (purpose . "Vector Trigonometric Sinh") (id . "function.trader-sinh")) "trader_sin" ((documentation . "Vector Trigonometric Sin array trader_sin(array $real) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_sin(array $real)") (purpose . "Vector Trigonometric Sin") (id . "function.trader-sin")) "trader_set_unstable_period" ((documentation . "Set unstable period void trader_set_unstable_period(integer $functionId, integer $timePeriod) No value is returned. (PECL trader >= 0.2.2)") (versions . "PECL trader >= 0.2.2") (return . "No value is returned.
") (prototype . "void trader_set_unstable_period(integer $functionId, integer $timePeriod)") (purpose . "Set unstable period") (id . "function.trader-set-unstable-period")) "trader_set_compat" ((documentation . "Set compatibility mode void trader_set_compat(integer $compatId) No value is returned. (PECL trader >= 0.2.2)") (versions . "PECL trader >= 0.2.2") (return . "No value is returned.
") (prototype . "void trader_set_compat(integer $compatId)") (purpose . "Set compatibility mode") (id . "function.trader-set-compat")) "trader_sarext" ((documentation . "Parabolic SAR - Extended array trader_sarext(array $high, array $low [, float $startValue = '' [, float $offsetOnReverse = '' [, float $accelerationInitLong = '' [, float $accelerationLong = '' [, float $accelerationMaxLong = '' [, float $accelerationInitShort = '' [, float $accelerationShort = '' [, float $accelerationMaxShort = '']]]]]]]]) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_sarext(array $high, array $low [, float $startValue = '' [, float $offsetOnReverse = '' [, float $accelerationInitLong = '' [, float $accelerationLong = '' [, float $accelerationMaxLong = '' [, float $accelerationInitShort = '' [, float $accelerationShort = '' [, float $accelerationMaxShort = '']]]]]]]])") (purpose . "Parabolic SAR - Extended") (id . "function.trader-sarext")) "trader_sar" ((documentation . "Parabolic SAR array trader_sar(array $high, array $low [, float $acceleration = '' [, float $maximum = '']]) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_sar(array $high, array $low [, float $acceleration = '' [, float $maximum = '']])") (purpose . "Parabolic SAR") (id . "function.trader-sar")) "trader_rsi" ((documentation . "Relative Strength Index array trader_rsi(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_rsi(array $real [, integer $timePeriod = ''])") (purpose . "Relative Strength Index") (id . "function.trader-rsi")) "trader_rocr" ((documentation . "Rate of change ratio: (price/prevPrice) array trader_rocr(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_rocr(array $real [, integer $timePeriod = ''])") (purpose . "Rate of change ratio: (price/prevPrice)") (id . "function.trader-rocr")) "trader_rocr100" ((documentation . "Rate of change ratio 100 scale: (price/prevPrice)*100 array trader_rocr100(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_rocr100(array $real [, integer $timePeriod = ''])") (purpose . "Rate of change ratio 100 scale: (price/prevPrice)*100") (id . "function.trader-rocr100")) "trader_rocp" ((documentation . "Rate of change Percentage: (price-prevPrice)/prevPrice array trader_rocp(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_rocp(array $real [, integer $timePeriod = ''])") (purpose . "Rate of change Percentage: (price-prevPrice)/prevPrice") (id . "function.trader-rocp")) "trader_roc" ((documentation . "Rate of change : ((price/prevPrice)-1)*100 array trader_roc(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_roc(array $real [, integer $timePeriod = ''])") (purpose . "Rate of change : ((price/prevPrice)-1)*100") (id . "function.trader-roc")) "trader_ppo" ((documentation . "Percentage Price Oscillator array trader_ppo(array $real [, integer $fastPeriod = '' [, integer $slowPeriod = '' [, integer $mAType = '']]]) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_ppo(array $real [, integer $fastPeriod = '' [, integer $slowPeriod = '' [, integer $mAType = '']]])") (purpose . "Percentage Price Oscillator") (id . "function.trader-ppo")) "trader_plus_dm" ((documentation . "Plus Directional Movement array trader_plus_dm(array $high, array $low [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_plus_dm(array $high, array $low [, integer $timePeriod = ''])") (purpose . "Plus Directional Movement") (id . "function.trader-plus-dm")) "trader_plus_di" ((documentation . "Plus Directional Indicator array trader_plus_di(array $high, array $low, array $close [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_plus_di(array $high, array $low, array $close [, integer $timePeriod = ''])") (purpose . "Plus Directional Indicator") (id . "function.trader-plus-di")) "trader_obv" ((documentation . "On Balance Volume array trader_obv(array $real, array $volume) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_obv(array $real, array $volume)") (purpose . "On Balance Volume") (id . "function.trader-obv")) "trader_natr" ((documentation . "Normalized Average True Range array trader_natr(array $high, array $low, array $close [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_natr(array $high, array $low, array $close [, integer $timePeriod = ''])") (purpose . "Normalized Average True Range") (id . "function.trader-natr")) "trader_mult" ((documentation . "Vector Arithmetic Mult array trader_mult(array $real0, array $real1) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_mult(array $real0, array $real1)") (purpose . "Vector Arithmetic Mult") (id . "function.trader-mult")) "trader_mom" ((documentation . "Momentum array trader_mom(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_mom(array $real [, integer $timePeriod = ''])") (purpose . "Momentum") (id . "function.trader-mom")) "trader_minus_dm" ((documentation . "Minus Directional Movement array trader_minus_dm(array $high, array $low [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_minus_dm(array $high, array $low [, integer $timePeriod = ''])") (purpose . "Minus Directional Movement") (id . "function.trader-minus-dm")) "trader_minus_di" ((documentation . "Minus Directional Indicator array trader_minus_di(array $high, array $low, array $close [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_minus_di(array $high, array $low, array $close [, integer $timePeriod = ''])") (purpose . "Minus Directional Indicator") (id . "function.trader-minus-di")) "trader_minmaxindex" ((documentation . "Indexes of lowest and highest values over a specified period array trader_minmaxindex(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_minmaxindex(array $real [, integer $timePeriod = ''])") (purpose . "Indexes of lowest and highest values over a specified period") (id . "function.trader-minmaxindex")) "trader_minmax" ((documentation . "Lowest and highest values over a specified period array trader_minmax(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_minmax(array $real [, integer $timePeriod = ''])") (purpose . "Lowest and highest values over a specified period") (id . "function.trader-minmax")) "trader_minindex" ((documentation . "Index of lowest value over a specified period array trader_minindex(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_minindex(array $real [, integer $timePeriod = ''])") (purpose . "Index of lowest value over a specified period") (id . "function.trader-minindex")) "trader_min" ((documentation . "Lowest value over a specified period array trader_min(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_min(array $real [, integer $timePeriod = ''])") (purpose . "Lowest value over a specified period") (id . "function.trader-min")) "trader_midprice" ((documentation . "Midpoint Price over period array trader_midprice(array $high, array $low [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_midprice(array $high, array $low [, integer $timePeriod = ''])") (purpose . "Midpoint Price over period") (id . "function.trader-midprice")) "trader_midpoint" ((documentation . "MidPoint over period array trader_midpoint(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_midpoint(array $real [, integer $timePeriod = ''])") (purpose . "MidPoint over period") (id . "function.trader-midpoint")) "trader_mfi" ((documentation . "Money Flow Index array trader_mfi(array $high, array $low, array $close, array $volume [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_mfi(array $high, array $low, array $close, array $volume [, integer $timePeriod = ''])") (purpose . "Money Flow Index") (id . "function.trader-mfi")) "trader_medprice" ((documentation . "Median Price array trader_medprice(array $high, array $low) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_medprice(array $high, array $low)") (purpose . "Median Price") (id . "function.trader-medprice")) "trader_maxindex" ((documentation . "Index of highest value over a specified period array trader_maxindex(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_maxindex(array $real [, integer $timePeriod = ''])") (purpose . "Index of highest value over a specified period") (id . "function.trader-maxindex")) "trader_max" ((documentation . "Highest value over a specified period array trader_max(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_max(array $real [, integer $timePeriod = ''])") (purpose . "Highest value over a specified period") (id . "function.trader-max")) "trader_mavp" ((documentation . "Moving average with variable period array trader_mavp(array $real, array $periods [, integer $minPeriod = '' [, integer $maxPeriod = '' [, integer $mAType = '']]]) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_mavp(array $real, array $periods [, integer $minPeriod = '' [, integer $maxPeriod = '' [, integer $mAType = '']]])") (purpose . "Moving average with variable period") (id . "function.trader-mavp")) "trader_mama" ((documentation . "MESA Adaptive Moving Average array trader_mama(array $real [, float $fastLimit = '' [, float $slowLimit = '']]) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_mama(array $real [, float $fastLimit = '' [, float $slowLimit = '']])") (purpose . "MESA Adaptive Moving Average") (id . "function.trader-mama")) "trader_macdfix" ((documentation . "Moving Average Convergence/Divergence Fix 12/26 array trader_macdfix(array $real [, integer $signalPeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_macdfix(array $real [, integer $signalPeriod = ''])") (purpose . "Moving Average Convergence/Divergence Fix 12/26") (id . "function.trader-macdfix")) "trader_macdext" ((documentation . "MACD with controllable MA type array trader_macdext(array $real [, integer $fastPeriod = '' [, integer $fastMAType = '' [, integer $slowPeriod = '' [, integer $slowMAType = '' [, integer $signalPeriod = '' [, integer $signalMAType = '']]]]]]) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_macdext(array $real [, integer $fastPeriod = '' [, integer $fastMAType = '' [, integer $slowPeriod = '' [, integer $slowMAType = '' [, integer $signalPeriod = '' [, integer $signalMAType = '']]]]]])") (purpose . "MACD with controllable MA type") (id . "function.trader-macdext")) "trader_macd" ((documentation . "Moving Average Convergence/Divergence array trader_macd(array $real [, integer $fastPeriod = '' [, integer $slowPeriod = '' [, integer $signalPeriod = '']]]) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_macd(array $real [, integer $fastPeriod = '' [, integer $slowPeriod = '' [, integer $signalPeriod = '']]])") (purpose . "Moving Average Convergence/Divergence") (id . "function.trader-macd")) "trader_ma" ((documentation . "Moving average array trader_ma(array $real [, integer $timePeriod = '' [, integer $mAType = '']]) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_ma(array $real [, integer $timePeriod = '' [, integer $mAType = '']])") (purpose . "Moving average") (id . "function.trader-ma")) "trader_log10" ((documentation . "Vector Log10 array trader_log10(array $real) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_log10(array $real)") (purpose . "Vector Log10") (id . "function.trader-log10")) "trader_ln" ((documentation . "Vector Log Natural array trader_ln(array $real) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_ln(array $real)") (purpose . "Vector Log Natural") (id . "function.trader-ln")) "trader_linearreg" ((documentation . "Linear Regression array trader_linearreg(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_linearreg(array $real [, integer $timePeriod = ''])") (purpose . "Linear Regression") (id . "function.trader-linearreg")) "trader_linearreg_slope" ((documentation . "Linear Regression Slope array trader_linearreg_slope(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_linearreg_slope(array $real [, integer $timePeriod = ''])") (purpose . "Linear Regression Slope") (id . "function.trader-linearreg-slope")) "trader_linearreg_intercept" ((documentation . "Linear Regression Intercept array trader_linearreg_intercept(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_linearreg_intercept(array $real [, integer $timePeriod = ''])") (purpose . "Linear Regression Intercept") (id . "function.trader-linearreg-intercept")) "trader_linearreg_angle" ((documentation . "Linear Regression Angle array trader_linearreg_angle(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_linearreg_angle(array $real [, integer $timePeriod = ''])") (purpose . "Linear Regression Angle") (id . "function.trader-linearreg-angle")) "trader_kama" ((documentation . "Kaufman Adaptive Moving Average array trader_kama(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_kama(array $real [, integer $timePeriod = ''])") (purpose . "Kaufman Adaptive Moving Average") (id . "function.trader-kama")) "trader_ht_trendmode" ((documentation . "Hilbert Transform - Trend vs Cycle Mode array trader_ht_trendmode(array $real) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_ht_trendmode(array $real)") (purpose . "Hilbert Transform - Trend vs Cycle Mode") (id . "function.trader-ht-trendmode")) "trader_ht_trendline" ((documentation . "Hilbert Transform - Instantaneous Trendline array trader_ht_trendline(array $real) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_ht_trendline(array $real)") (purpose . "Hilbert Transform - Instantaneous Trendline") (id . "function.trader-ht-trendline")) "trader_ht_sine" ((documentation . "Hilbert Transform - SineWave array trader_ht_sine(array $real) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_ht_sine(array $real)") (purpose . "Hilbert Transform - SineWave") (id . "function.trader-ht-sine")) "trader_ht_phasor" ((documentation . "Hilbert Transform - Phasor Components array trader_ht_phasor(array $real) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_ht_phasor(array $real)") (purpose . "Hilbert Transform - Phasor Components") (id . "function.trader-ht-phasor")) "trader_ht_dcphase" ((documentation . "Hilbert Transform - Dominant Cycle Phase array trader_ht_dcphase(array $real) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_ht_dcphase(array $real)") (purpose . "Hilbert Transform - Dominant Cycle Phase") (id . "function.trader-ht-dcphase")) "trader_ht_dcperiod" ((documentation . "Hilbert Transform - Dominant Cycle Period array trader_ht_dcperiod(array $real) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_ht_dcperiod(array $real)") (purpose . "Hilbert Transform - Dominant Cycle Period") (id . "function.trader-ht-dcperiod")) "trader_get_unstable_period" ((documentation . "Get unstable period integer trader_get_unstable_period(integer $functionId) Returns the unstable period factor for the corresponding function. (PECL trader >= 0.2.2)") (versions . "PECL trader >= 0.2.2") (return . "Returns the unstable period factor for the corresponding function.
") (prototype . "integer trader_get_unstable_period(integer $functionId)") (purpose . "Get unstable period") (id . "function.trader-get-unstable-period")) "trader_get_compat" ((documentation . #("Get compatibility mode integer trader_get_compat() Returns the compatibility mode id which can be identified by TRADER_COMPATIBILITY_* series of constants. (PECL trader >= 0.2.2)" 114 136 (shr-url "trader.constants.html"))) (versions . "PECL trader >= 0.2.2") (return . "Returns the compatibility mode id which can be identified by TRADER_COMPATIBILITY_* series of constants.
") (prototype . "integer trader_get_compat()") (purpose . "Get compatibility mode") (id . "function.trader-get-compat")) "trader_floor" ((documentation . "Vector Floor array trader_floor(array $real) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_floor(array $real)") (purpose . "Vector Floor") (id . "function.trader-floor")) "trader_exp" ((documentation . "Vector Arithmetic Exp array trader_exp(array $real) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_exp(array $real)") (purpose . "Vector Arithmetic Exp") (id . "function.trader-exp")) "trader_errno" ((documentation . #("Get error code integer trader_errno() Returns the error code identified by one of the TRADER_ERR_* constants. (PECL trader >= 0.3.0)" 88 100 (shr-url "trader.constants.html"))) (versions . "PECL trader >= 0.3.0") (return . "Returns the error code identified by one of the TRADER_ERR_* constants.
") (prototype . "integer trader_errno()") (purpose . "Get error code") (id . "function.trader-errno")) "trader_ema" ((documentation . "Exponential Moving Average array trader_ema(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_ema(array $real [, integer $timePeriod = ''])") (purpose . "Exponential Moving Average") (id . "function.trader-ema")) "trader_dx" ((documentation . "Directional Movement Index array trader_dx(array $high, array $low, array $close [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_dx(array $high, array $low, array $close [, integer $timePeriod = ''])") (purpose . "Directional Movement Index") (id . "function.trader-dx")) "trader_div" ((documentation . "Vector Arithmetic Div array trader_div(array $real0, array $real1) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_div(array $real0, array $real1)") (purpose . "Vector Arithmetic Div") (id . "function.trader-div")) "trader_dema" ((documentation . "Double Exponential Moving Average array trader_dema(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_dema(array $real [, integer $timePeriod = ''])") (purpose . "Double Exponential Moving Average") (id . "function.trader-dema")) "trader_cosh" ((documentation . "Vector Trigonometric Cosh array trader_cosh(array $real) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cosh(array $real)") (purpose . "Vector Trigonometric Cosh") (id . "function.trader-cosh")) "trader_cos" ((documentation . "Vector Trigonometric Cos array trader_cos(array $real) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cos(array $real)") (purpose . "Vector Trigonometric Cos") (id . "function.trader-cos")) "trader_correl" ((documentation . "Pearson's Correlation Coefficient (r) array trader_correl(array $real0, array $real1 [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_correl(array $real0, array $real1 [, integer $timePeriod = ''])") (purpose . "Pearson's Correlation Coefficient (r)") (id . "function.trader-correl")) "trader_cmo" ((documentation . "Chande Momentum Oscillator array trader_cmo(array $real [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cmo(array $real [, integer $timePeriod = ''])") (purpose . "Chande Momentum Oscillator") (id . "function.trader-cmo")) "trader_ceil" ((documentation . "Vector Ceil array trader_ceil(array $real) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_ceil(array $real)") (purpose . "Vector Ceil") (id . "function.trader-ceil")) "trader_cdlxsidegap3methods" ((documentation . "Upside/Downside Gap Three Methods array trader_cdlxsidegap3methods(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlxsidegap3methods(array $open, array $high, array $low, array $close)") (purpose . "Upside/Downside Gap Three Methods") (id . "function.trader-cdlxsidegap3methods")) "trader_cdlupsidegap2crows" ((documentation . "Upside Gap Two Crows array trader_cdlupsidegap2crows(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlupsidegap2crows(array $open, array $high, array $low, array $close)") (purpose . "Upside Gap Two Crows") (id . "function.trader-cdlupsidegap2crows")) "trader_cdlunique3river" ((documentation . "Unique 3 River array trader_cdlunique3river(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlunique3river(array $open, array $high, array $low, array $close)") (purpose . "Unique 3 River") (id . "function.trader-cdlunique3river")) "trader_cdltristar" ((documentation . "Tristar Pattern array trader_cdltristar(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdltristar(array $open, array $high, array $low, array $close)") (purpose . "Tristar Pattern") (id . "function.trader-cdltristar")) "trader_cdlthrusting" ((documentation . "Thrusting Pattern array trader_cdlthrusting(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlthrusting(array $open, array $high, array $low, array $close)") (purpose . "Thrusting Pattern") (id . "function.trader-cdlthrusting")) "trader_cdltasukigap" ((documentation . "Tasuki Gap array trader_cdltasukigap(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdltasukigap(array $open, array $high, array $low, array $close)") (purpose . "Tasuki Gap") (id . "function.trader-cdltasukigap")) "trader_cdltakuri" ((documentation . "Takuri (Dragonfly Doji with very long lower shadow) array trader_cdltakuri(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdltakuri(array $open, array $high, array $low, array $close)") (purpose . "Takuri (Dragonfly Doji with very long lower shadow)") (id . "function.trader-cdltakuri")) "trader_cdlsticksandwich" ((documentation . "Stick Sandwich array trader_cdlsticksandwich(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlsticksandwich(array $open, array $high, array $low, array $close)") (purpose . "Stick Sandwich") (id . "function.trader-cdlsticksandwich")) "trader_cdlstalledpattern" ((documentation . "Stalled Pattern array trader_cdlstalledpattern(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlstalledpattern(array $open, array $high, array $low, array $close)") (purpose . "Stalled Pattern") (id . "function.trader-cdlstalledpattern")) "trader_cdlspinningtop" ((documentation . "Spinning Top array trader_cdlspinningtop(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlspinningtop(array $open, array $high, array $low, array $close)") (purpose . "Spinning Top") (id . "function.trader-cdlspinningtop")) "trader_cdlshortline" ((documentation . "Short Line Candle array trader_cdlshortline(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlshortline(array $open, array $high, array $low, array $close)") (purpose . "Short Line Candle") (id . "function.trader-cdlshortline")) "trader_cdlshootingstar" ((documentation . "Shooting Star array trader_cdlshootingstar(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlshootingstar(array $open, array $high, array $low, array $close)") (purpose . "Shooting Star") (id . "function.trader-cdlshootingstar")) "trader_cdlseparatinglines" ((documentation . "Separating Lines array trader_cdlseparatinglines(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlseparatinglines(array $open, array $high, array $low, array $close)") (purpose . "Separating Lines") (id . "function.trader-cdlseparatinglines")) "trader_cdlrisefall3methods" ((documentation . "Rising/Falling Three Methods array trader_cdlrisefall3methods(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlrisefall3methods(array $open, array $high, array $low, array $close)") (purpose . "Rising/Falling Three Methods") (id . "function.trader-cdlrisefall3methods")) "trader_cdlrickshawman" ((documentation . "Rickshaw Man array trader_cdlrickshawman(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlrickshawman(array $open, array $high, array $low, array $close)") (purpose . "Rickshaw Man") (id . "function.trader-cdlrickshawman")) "trader_cdlpiercing" ((documentation . "Piercing Pattern array trader_cdlpiercing(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlpiercing(array $open, array $high, array $low, array $close)") (purpose . "Piercing Pattern") (id . "function.trader-cdlpiercing")) "trader_cdlonneck" ((documentation . "On-Neck Pattern array trader_cdlonneck(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlonneck(array $open, array $high, array $low, array $close)") (purpose . "On-Neck Pattern") (id . "function.trader-cdlonneck")) "trader_cdlmorningstar" ((documentation . "Morning Star array trader_cdlmorningstar(array $open, array $high, array $low, array $close [, float $penetration = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlmorningstar(array $open, array $high, array $low, array $close [, float $penetration = ''])") (purpose . "Morning Star") (id . "function.trader-cdlmorningstar")) "trader_cdlmorningdojistar" ((documentation . "Morning Doji Star array trader_cdlmorningdojistar(array $open, array $high, array $low, array $close [, float $penetration = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlmorningdojistar(array $open, array $high, array $low, array $close [, float $penetration = ''])") (purpose . "Morning Doji Star") (id . "function.trader-cdlmorningdojistar")) "trader_cdlmathold" ((documentation . "Mat Hold array trader_cdlmathold(array $open, array $high, array $low, array $close [, float $penetration = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlmathold(array $open, array $high, array $low, array $close [, float $penetration = ''])") (purpose . "Mat Hold") (id . "function.trader-cdlmathold")) "trader_cdlmatchinglow" ((documentation . "Matching Low array trader_cdlmatchinglow(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlmatchinglow(array $open, array $high, array $low, array $close)") (purpose . "Matching Low") (id . "function.trader-cdlmatchinglow")) "trader_cdlmarubozu" ((documentation . "Marubozu array trader_cdlmarubozu(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlmarubozu(array $open, array $high, array $low, array $close)") (purpose . "Marubozu") (id . "function.trader-cdlmarubozu")) "trader_cdllongline" ((documentation . "Long Line Candle array trader_cdllongline(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdllongline(array $open, array $high, array $low, array $close)") (purpose . "Long Line Candle") (id . "function.trader-cdllongline")) "trader_cdllongleggeddoji" ((documentation . "Long Legged Doji array trader_cdllongleggeddoji(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdllongleggeddoji(array $open, array $high, array $low, array $close)") (purpose . "Long Legged Doji") (id . "function.trader-cdllongleggeddoji")) "trader_cdlladderbottom" ((documentation . "Ladder Bottom array trader_cdlladderbottom(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlladderbottom(array $open, array $high, array $low, array $close)") (purpose . "Ladder Bottom") (id . "function.trader-cdlladderbottom")) "trader_cdlkickingbylength" ((documentation . "Kicking - bull/bear determined by the longer marubozu array trader_cdlkickingbylength(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlkickingbylength(array $open, array $high, array $low, array $close)") (purpose . "Kicking - bull/bear determined by the longer marubozu") (id . "function.trader-cdlkickingbylength")) "trader_cdlkicking" ((documentation . "Kicking array trader_cdlkicking(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlkicking(array $open, array $high, array $low, array $close)") (purpose . "Kicking") (id . "function.trader-cdlkicking")) "trader_cdlinvertedhammer" ((documentation . "Inverted Hammer array trader_cdlinvertedhammer(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlinvertedhammer(array $open, array $high, array $low, array $close)") (purpose . "Inverted Hammer") (id . "function.trader-cdlinvertedhammer")) "trader_cdlinneck" ((documentation . "In-Neck Pattern array trader_cdlinneck(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlinneck(array $open, array $high, array $low, array $close)") (purpose . "In-Neck Pattern") (id . "function.trader-cdlinneck")) "trader_cdlidentical3crows" ((documentation . "Identical Three Crows array trader_cdlidentical3crows(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlidentical3crows(array $open, array $high, array $low, array $close)") (purpose . "Identical Three Crows") (id . "function.trader-cdlidentical3crows")) "trader_cdlhomingpigeon" ((documentation . "Homing Pigeon array trader_cdlhomingpigeon(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlhomingpigeon(array $open, array $high, array $low, array $close)") (purpose . "Homing Pigeon") (id . "function.trader-cdlhomingpigeon")) "trader_cdlhikkakemod" ((documentation . "Modified Hikkake Pattern array trader_cdlhikkakemod(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlhikkakemod(array $open, array $high, array $low, array $close)") (purpose . "Modified Hikkake Pattern") (id . "function.trader-cdlhikkakemod")) "trader_cdlhikkake" ((documentation . "Hikkake Pattern array trader_cdlhikkake(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlhikkake(array $open, array $high, array $low, array $close)") (purpose . "Hikkake Pattern") (id . "function.trader-cdlhikkake")) "trader_cdlhighwave" ((documentation . "High-Wave Candle array trader_cdlhighwave(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlhighwave(array $open, array $high, array $low, array $close)") (purpose . "High-Wave Candle") (id . "function.trader-cdlhighwave")) "trader_cdlharamicross" ((documentation . "Harami Cross Pattern array trader_cdlharamicross(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlharamicross(array $open, array $high, array $low, array $close)") (purpose . "Harami Cross Pattern") (id . "function.trader-cdlharamicross")) "trader_cdlharami" ((documentation . "Harami Pattern array trader_cdlharami(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlharami(array $open, array $high, array $low, array $close)") (purpose . "Harami Pattern") (id . "function.trader-cdlharami")) "trader_cdlhangingman" ((documentation . "Hanging Man array trader_cdlhangingman(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlhangingman(array $open, array $high, array $low, array $close)") (purpose . "Hanging Man") (id . "function.trader-cdlhangingman")) "trader_cdlhammer" ((documentation . "Hammer array trader_cdlhammer(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlhammer(array $open, array $high, array $low, array $close)") (purpose . "Hammer") (id . "function.trader-cdlhammer")) "trader_cdlgravestonedoji" ((documentation . "Gravestone Doji array trader_cdlgravestonedoji(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlgravestonedoji(array $open, array $high, array $low, array $close)") (purpose . "Gravestone Doji") (id . "function.trader-cdlgravestonedoji")) "trader_cdlgapsidesidewhite" ((documentation . "Up/Down-gap side-by-side white lines array trader_cdlgapsidesidewhite(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlgapsidesidewhite(array $open, array $high, array $low, array $close)") (purpose . "Up/Down-gap side-by-side white lines") (id . "function.trader-cdlgapsidesidewhite")) "trader_cdleveningstar" ((documentation . "Evening Star array trader_cdleveningstar(array $open, array $high, array $low, array $close [, float $penetration = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdleveningstar(array $open, array $high, array $low, array $close [, float $penetration = ''])") (purpose . "Evening Star") (id . "function.trader-cdleveningstar")) "trader_cdleveningdojistar" ((documentation . "Evening Doji Star array trader_cdleveningdojistar(array $open, array $high, array $low, array $close [, float $penetration = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdleveningdojistar(array $open, array $high, array $low, array $close [, float $penetration = ''])") (purpose . "Evening Doji Star") (id . "function.trader-cdleveningdojistar")) "trader_cdlengulfing" ((documentation . "Engulfing Pattern array trader_cdlengulfing(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlengulfing(array $open, array $high, array $low, array $close)") (purpose . "Engulfing Pattern") (id . "function.trader-cdlengulfing")) "trader_cdldragonflydoji" ((documentation . "Dragonfly Doji array trader_cdldragonflydoji(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdldragonflydoji(array $open, array $high, array $low, array $close)") (purpose . "Dragonfly Doji") (id . "function.trader-cdldragonflydoji")) "trader_cdldojistar" ((documentation . "Doji Star array trader_cdldojistar(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdldojistar(array $open, array $high, array $low, array $close)") (purpose . "Doji Star") (id . "function.trader-cdldojistar")) "trader_cdldoji" ((documentation . "Doji array trader_cdldoji(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdldoji(array $open, array $high, array $low, array $close)") (purpose . "Doji") (id . "function.trader-cdldoji")) "trader_cdldarkcloudcover" ((documentation . "Dark Cloud Cover array trader_cdldarkcloudcover(array $open, array $high, array $low, array $close [, float $penetration = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdldarkcloudcover(array $open, array $high, array $low, array $close [, float $penetration = ''])") (purpose . "Dark Cloud Cover") (id . "function.trader-cdldarkcloudcover")) "trader_cdlcounterattack" ((documentation . "Counterattack array trader_cdlcounterattack(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlcounterattack(array $open, array $high, array $low, array $close)") (purpose . "Counterattack") (id . "function.trader-cdlcounterattack")) "trader_cdlconcealbabyswall" ((documentation . "Concealing Baby Swallow array trader_cdlconcealbabyswall(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlconcealbabyswall(array $open, array $high, array $low, array $close)") (purpose . "Concealing Baby Swallow") (id . "function.trader-cdlconcealbabyswall")) "trader_cdlclosingmarubozu" ((documentation . "Closing Marubozu array trader_cdlclosingmarubozu(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlclosingmarubozu(array $open, array $high, array $low, array $close)") (purpose . "Closing Marubozu") (id . "function.trader-cdlclosingmarubozu")) "trader_cdlbreakaway" ((documentation . "Breakaway array trader_cdlbreakaway(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlbreakaway(array $open, array $high, array $low, array $close)") (purpose . "Breakaway") (id . "function.trader-cdlbreakaway")) "trader_cdlbelthold" ((documentation . "Belt-hold array trader_cdlbelthold(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlbelthold(array $open, array $high, array $low, array $close)") (purpose . "Belt-hold") (id . "function.trader-cdlbelthold")) "trader_cdladvanceblock" ((documentation . "Advance Block array trader_cdladvanceblock(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdladvanceblock(array $open, array $high, array $low, array $close)") (purpose . "Advance Block") (id . "function.trader-cdladvanceblock")) "trader_cdlabandonedbaby" ((documentation . "Abandoned Baby array trader_cdlabandonedbaby(array $open, array $high, array $low, array $close [, float $penetration = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdlabandonedbaby(array $open, array $high, array $low, array $close [, float $penetration = ''])") (purpose . "Abandoned Baby") (id . "function.trader-cdlabandonedbaby")) "trader_cdl3whitesoldiers" ((documentation . "Three Advancing White Soldiers array trader_cdl3whitesoldiers(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdl3whitesoldiers(array $open, array $high, array $low, array $close)") (purpose . "Three Advancing White Soldiers") (id . "function.trader-cdl3whitesoldiers")) "trader_cdl3starsinsouth" ((documentation . "Three Stars In The South array trader_cdl3starsinsouth(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdl3starsinsouth(array $open, array $high, array $low, array $close)") (purpose . "Three Stars In The South") (id . "function.trader-cdl3starsinsouth")) "trader_cdl3outside" ((documentation . "Three Outside Up/Down array trader_cdl3outside(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdl3outside(array $open, array $high, array $low, array $close)") (purpose . "Three Outside Up/Down") (id . "function.trader-cdl3outside")) "trader_cdl3linestrike" ((documentation . "Three-Line Strike array trader_cdl3linestrike(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdl3linestrike(array $open, array $high, array $low, array $close)") (purpose . "Three-Line Strike") (id . "function.trader-cdl3linestrike")) "trader_cdl3inside" ((documentation . "Three Inside Up/Down array trader_cdl3inside(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdl3inside(array $open, array $high, array $low, array $close)") (purpose . "Three Inside Up/Down") (id . "function.trader-cdl3inside")) "trader_cdl3blackcrows" ((documentation . "Three Black Crows array trader_cdl3blackcrows(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdl3blackcrows(array $open, array $high, array $low, array $close)") (purpose . "Three Black Crows") (id . "function.trader-cdl3blackcrows")) "trader_cdl2crows" ((documentation . "Two Crows array trader_cdl2crows(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cdl2crows(array $open, array $high, array $low, array $close)") (purpose . "Two Crows") (id . "function.trader-cdl2crows")) "trader_cci" ((documentation . "Commodity Channel Index array trader_cci(array $high, array $low, array $close [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_cci(array $high, array $low, array $close [, integer $timePeriod = ''])") (purpose . "Commodity Channel Index") (id . "function.trader-cci")) "trader_bop" ((documentation . "Balance Of Power array trader_bop(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_bop(array $open, array $high, array $low, array $close)") (purpose . "Balance Of Power") (id . "function.trader-bop")) "trader_beta" ((documentation . "Beta array trader_beta(array $real0, array $real1 [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_beta(array $real0, array $real1 [, integer $timePeriod = ''])") (purpose . "Beta") (id . "function.trader-beta")) "trader_bbands" ((documentation . "Bollinger Bands array trader_bbands(array $real [, integer $timePeriod = '' [, float $nbDevUp = '' [, float $nbDevDn = '' [, integer $mAType = '']]]]) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_bbands(array $real [, integer $timePeriod = '' [, float $nbDevUp = '' [, float $nbDevDn = '' [, integer $mAType = '']]]])") (purpose . "Bollinger Bands") (id . "function.trader-bbands")) "trader_avgprice" ((documentation . "Average Price array trader_avgprice(array $open, array $high, array $low, array $close) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_avgprice(array $open, array $high, array $low, array $close)") (purpose . "Average Price") (id . "function.trader-avgprice")) "trader_atr" ((documentation . "Average True Range array trader_atr(array $high, array $low, array $close [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_atr(array $high, array $low, array $close [, integer $timePeriod = ''])") (purpose . "Average True Range") (id . "function.trader-atr")) "trader_atan" ((documentation . "Vector Trigonometric ATan array trader_atan(array $real) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_atan(array $real)") (purpose . "Vector Trigonometric ATan") (id . "function.trader-atan")) "trader_asin" ((documentation . "Vector Trigonometric ASin array trader_asin(array $real) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_asin(array $real)") (purpose . "Vector Trigonometric ASin") (id . "function.trader-asin")) "trader_aroonosc" ((documentation . "Aroon Oscillator array trader_aroonosc(array $high, array $low [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_aroonosc(array $high, array $low [, integer $timePeriod = ''])") (purpose . "Aroon Oscillator") (id . "function.trader-aroonosc")) "trader_aroon" ((documentation . "Aroon array trader_aroon(array $high, array $low [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_aroon(array $high, array $low [, integer $timePeriod = ''])") (purpose . "Aroon") (id . "function.trader-aroon")) "trader_apo" ((documentation . "Absolute Price Oscillator array trader_apo(array $real [, integer $fastPeriod = '' [, integer $slowPeriod = '' [, integer $mAType = '']]]) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_apo(array $real [, integer $fastPeriod = '' [, integer $slowPeriod = '' [, integer $mAType = '']]])") (purpose . "Absolute Price Oscillator") (id . "function.trader-apo")) "trader_adxr" ((documentation . "Average Directional Movement Index Rating array trader_adxr(array $high, array $low, array $close [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_adxr(array $high, array $low, array $close [, integer $timePeriod = ''])") (purpose . "Average Directional Movement Index Rating") (id . "function.trader-adxr")) "trader_adx" ((documentation . "Average Directional Movement Index array trader_adx(array $high, array $low, array $close [, integer $timePeriod = '']) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_adx(array $high, array $low, array $close [, integer $timePeriod = ''])") (purpose . "Average Directional Movement Index") (id . "function.trader-adx")) "trader_adosc" ((documentation . "Chaikin A/D Oscillator array trader_adosc(array $high, array $low, array $close, array $volume [, integer $fastPeriod = '' [, integer $slowPeriod = '']]) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_adosc(array $high, array $low, array $close, array $volume [, integer $fastPeriod = '' [, integer $slowPeriod = '']])") (purpose . "Chaikin A/D Oscillator") (id . "function.trader-adosc")) "trader_add" ((documentation . "Vector Arithmetic Add array trader_add(array $real0, array $real1) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_add(array $real0, array $real1)") (purpose . "Vector Arithmetic Add") (id . "function.trader-add")) "trader_ad" ((documentation . "Chaikin A/D Line array trader_ad(array $high, array $low, array $close, array $volume) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_ad(array $high, array $low, array $close, array $volume)") (purpose . "Chaikin A/D Line") (id . "function.trader-ad")) "trader_acos" ((documentation . "Vector Trigonometric ACos array trader_acos(array $real) Returns an array with calculated data or false on failure. (PECL trader >= 0.2.0)") (versions . "PECL trader >= 0.2.0") (return . "Returns an array with calculated data or false on failure.
") (prototype . "array trader_acos(array $real)") (purpose . "Vector Trigonometric ACos") (id . "function.trader-acos")) "stats_variance" ((documentation . "Returns the population variance float stats_variance(array $a [, bool $sample = false]) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "") (prototype . "float stats_variance(array $a [, bool $sample = false])") (purpose . "Returns the population variance") (id . "function.stats-variance")) "stats_stat_powersum" ((documentation . "Not documented float stats_stat_powersum(array $arr, float $power) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_stat_powersum(array $arr, float $power)") (purpose . "Not documented") (id . "function.stats-stat-powersum")) "stats_stat_percentile" ((documentation . "Not documented float stats_stat_percentile(float $df, float $xnonc) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_stat_percentile(float $df, float $xnonc)") (purpose . "Not documented") (id . "function.stats-stat-percentile")) "stats_stat_paired_t" ((documentation . "Not documented float stats_stat_paired_t(array $arr1, array $arr2) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_stat_paired_t(array $arr1, array $arr2)") (purpose . "Not documented") (id . "function.stats-stat-paired-t")) "stats_stat_noncentral_t" ((documentation . "Calculates any one parameter of the noncentral t distribution give values for the others. float stats_stat_noncentral_t(float $par1, float $par2, float $par3, int $which) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_stat_noncentral_t(float $par1, float $par2, float $par3, int $which)") (purpose . "Calculates any one parameter of the noncentral t distribution give values for the others.") (id . "function.stats-stat-noncentral-t")) "stats_stat_innerproduct" ((documentation . " float stats_stat_innerproduct(array $arr1, array $arr2) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_stat_innerproduct(array $arr1, array $arr2)") (purpose . "") (id . "function.stats-stat-innerproduct")) "stats_stat_independent_t" ((documentation . "Not documented float stats_stat_independent_t(array $arr1, array $arr2) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_stat_independent_t(array $arr1, array $arr2)") (purpose . "Not documented") (id . "function.stats-stat-independent-t")) "stats_stat_gennch" ((documentation . "Not documented float stats_stat_gennch(int $n) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_stat_gennch(int $n)") (purpose . "Not documented") (id . "function.stats-stat-gennch")) "stats_stat_correlation" ((documentation . "Not documented float stats_stat_correlation(array $arr1, array $arr2) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_stat_correlation(array $arr1, array $arr2)") (purpose . "Not documented") (id . "function.stats-stat-correlation")) "stats_stat_binomial_coef" ((documentation . "Not documented float stats_stat_binomial_coef(int $x, int $n) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_stat_binomial_coef(int $x, int $n)") (purpose . "Not documented") (id . "function.stats-stat-binomial-coef")) "stats_standard_deviation" ((documentation . "Returns the standard deviation float stats_standard_deviation(array $a [, bool $sample = false]) Returns the standard deviation on success; FALSE on failure. (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
Returns the standard deviation on success; FALSE on failure.
") (prototype . "float stats_skew(array $a)") (purpose . "Computes the skewness of the data in the array") (id . "function.stats-skew")) "stats_rand_setall" ((documentation . "Not documented void stats_rand_setall(int $iseed1, int $iseed2) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "void stats_rand_setall(int $iseed1, int $iseed2)") (purpose . "Not documented") (id . "function.stats-rand-setall")) "stats_rand_ranf" ((documentation . "Returns a random floating point number from a uniform distribution over 0 - 1 (endpoints of this interval are not returned) using the current generator float stats_rand_ranf() (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_rand_ranf()") (purpose . "Returns a random floating point number from a uniform distribution over 0 - 1 (endpoints of this interval are not returned) using the current generator") (id . "function.stats-rand-ranf")) "stats_rand_phrase_to_seeds" ((documentation . "generate two seeds for the RGN random number generator array stats_rand_phrase_to_seeds(string $phrase) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "array stats_rand_phrase_to_seeds(string $phrase)") (purpose . "generate two seeds for the RGN random number generator") (id . "function.stats-rand-phrase-to-seeds")) "stats_rand_get_seeds" ((documentation . "Not documented array stats_rand_get_seeds() (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "array stats_rand_get_seeds()") (purpose . "Not documented") (id . "function.stats-rand-get-seeds")) "stats_rand_gen_t" ((documentation . "Generates a single random deviate from a T distribution float stats_rand_gen_t(float $df) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_rand_gen_t(float $df)") (purpose . "Generates a single random deviate from a T distribution") (id . "function.stats-rand-gen-t")) "stats_rand_gen_normal" ((documentation . "Generates a single random deviate from a normal distribution with mean, av, and standard deviation, sd (sd >= 0). Method : Renames SNORM from TOMS as slightly modified by BWB to use RANF instead of SUNIF. float stats_rand_gen_normal(float $av, float $sd) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_rand_gen_normal(float $av, float $sd)") (purpose . "Generates a single random deviate from a normal distribution with mean, av, and standard deviation, sd (sd >= 0). Method : Renames SNORM from TOMS as slightly modified by BWB to use RANF instead of SUNIF.") (id . "function.stats-rand-gen-normal")) "stats_rand_gen_noncentral_t" ((documentation . "Generates a single random deviate from a noncentral T distribution float stats_rand_gen_noncentral_t(float $df, float $xnonc) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_rand_gen_noncentral_t(float $df, float $xnonc)") (purpose . "Generates a single random deviate from a noncentral T distribution") (id . "function.stats-rand-gen-noncentral-t")) "stats_rand_gen_noncentral_f" ((documentation . "Generates a random deviate from the noncentral F (variance ratio) distribution with \"dfn\" degrees of freedom in the numerator, and \"dfd\" degrees of freedom in the denominator, and noncentrality parameter \"xnonc\". Method : directly generates ratio of noncentral numerator chisquare variate to central denominator chisquare variate. float stats_rand_gen_noncentral_f(float $dfn, float $dfd, float $xnonc) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_rand_gen_noncentral_f(float $dfn, float $dfd, float $xnonc)") (purpose . "Generates a random deviate from the noncentral F (variance ratio) distribution with \"dfn\" degrees of freedom in the numerator, and \"dfd\" degrees of freedom in the denominator, and noncentrality parameter \"xnonc\". Method : directly generates ratio of noncentral numerator chisquare variate to central denominator chisquare variate.") (id . "function.stats-rand-gen-noncentral-f")) "stats_rand_gen_noncenral_chisquare" ((documentation . "Generates random deviate from the distribution of a noncentral chisquare with \"df\" degrees of freedom and noncentrality parameter \"xnonc\". d must be >= 1.0, xnonc must >= 0.0 float stats_rand_gen_noncenral_chisquare(float $df, float $xnonc) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_rand_gen_noncenral_chisquare(float $df, float $xnonc)") (purpose . "Generates random deviate from the distribution of a noncentral chisquare with \"df\" degrees of freedom and noncentrality parameter \"xnonc\". d must be >= 1.0, xnonc must >= 0.0") (id . "function.stats-rand-gen-noncenral-chisquare")) "stats_rand_gen_iuniform" ((documentation . "Generates integer uniformly distributed between LOW (inclusive) and HIGH (inclusive) int stats_rand_gen_iuniform(int $low, int $high) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "int stats_rand_gen_iuniform(int $low, int $high)") (purpose . "Generates integer uniformly distributed between LOW (inclusive) and HIGH (inclusive)") (id . "function.stats-rand-gen-iuniform")) "stats_rand_gen_ipoisson" ((documentation . "Generates a single random deviate from a Poisson distribution with mean \"mu\" (mu >= 0.0). int stats_rand_gen_ipoisson(float $mu) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "int stats_rand_gen_ipoisson(float $mu)") (purpose . "Generates a single random deviate from a Poisson distribution with mean \"mu\" (mu >= 0.0).") (id . "function.stats-rand-gen-ipoisson")) "stats_rand_gen_int" ((documentation . "Generates random integer between 1 and 2147483562 int stats_rand_gen_int() (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "int stats_rand_gen_int()") (purpose . "Generates random integer between 1 and 2147483562") (id . "function.stats-rand-gen-int")) "stats_rand_gen_ibinomial" ((documentation . "Generates a single random deviate from a binomial distribution whose number of trials is \"n\" (n >= 0) and whose probability of an event in each trial is \"pp\" ([0;1]). Method : algorithm BTPE int stats_rand_gen_ibinomial(int $n, float $pp) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "int stats_rand_gen_ibinomial(int $n, float $pp)") (purpose . "Generates a single random deviate from a binomial distribution whose number of trials is \"n\" (n >= 0) and whose probability of an event in each trial is \"pp\" ([0;1]). Method : algorithm BTPE") (id . "function.stats-rand-gen-ibinomial")) "stats_rand_gen_ibinomial_negative" ((documentation . "Generates a single random deviate from a negative binomial distribution. Arguments : n - the number of trials in the negative binomial distribution from which a random deviate is to be generated (n > 0), p - the probability of an event (0 < p < 1)). int stats_rand_gen_ibinomial_negative(int $n, float $p) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "int stats_rand_gen_ibinomial_negative(int $n, float $p)") (purpose . "Generates a single random deviate from a negative binomial distribution. Arguments : n - the number of trials in the negative binomial distribution from which a random deviate is to be generated (n > 0), p - the probability of an event (0 < p < 1)).") (id . "function.stats-rand-gen-ibinomial-negative")) "stats_rand_gen_gamma" ((documentation . "Generates random deviates from a gamma distribution float stats_rand_gen_gamma(float $a, float $r) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_rand_gen_gamma(float $a, float $r)") (purpose . "Generates random deviates from a gamma distribution") (id . "function.stats-rand-gen-gamma")) "stats_rand_gen_funiform" ((documentation . "Generates uniform float between low (exclusive) and high (exclusive) float stats_rand_gen_funiform(float $low, float $high) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_rand_gen_funiform(float $low, float $high)") (purpose . "Generates uniform float between low (exclusive) and high (exclusive)") (id . "function.stats-rand-gen-funiform")) "stats_rand_gen_f" ((documentation . "Generates a random deviate float stats_rand_gen_f(float $dfn, float $dfd) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_rand_gen_f(float $dfn, float $dfd)") (purpose . "Generates a random deviate") (id . "function.stats-rand-gen-f")) "stats_rand_gen_exponential" ((documentation . "Generates a single random deviate from an exponential distribution with mean \"av\" float stats_rand_gen_exponential(float $av) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_rand_gen_exponential(float $av)") (purpose . "Generates a single random deviate from an exponential distribution with mean \"av\"") (id . "function.stats-rand-gen-exponential")) "stats_rand_gen_chisquare" ((documentation . "Generates random deviate from the distribution of a chisquare with \"df\" degrees of freedom random variable. float stats_rand_gen_chisquare(float $df) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_rand_gen_chisquare(float $df)") (purpose . "Generates random deviate from the distribution of a chisquare with \"df\" degrees of freedom random variable.") (id . "function.stats-rand-gen-chisquare")) "stats_rand_gen_beta" ((documentation . "Generates beta random deviate float stats_rand_gen_beta(float $a, float $b) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_rand_gen_beta(float $a, float $b)") (purpose . "Generates beta random deviate") (id . "function.stats-rand-gen-beta")) "stats_kurtosis" ((documentation . "Computes the kurtosis of the data in the array float stats_kurtosis(array $a) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_kurtosis(array $a)") (purpose . "Computes the kurtosis of the data in the array") (id . "function.stats-kurtosis")) "stats_harmonic_mean" ((documentation . "Returns the harmonic mean of an array of values number stats_harmonic_mean(array $a) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "number stats_harmonic_mean(array $a)") (purpose . "Returns the harmonic mean of an array of values") (id . "function.stats-harmonic-mean")) "stats_dens_weibull" ((documentation . "Not documented float stats_dens_weibull(float $x, float $a, float $b) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_dens_weibull(float $x, float $a, float $b)") (purpose . "Not documented") (id . "function.stats-dens-weibull")) "stats_dens_t" ((documentation . "Not documented float stats_dens_t(float $x, float $dfr) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_dens_t(float $x, float $dfr)") (purpose . "Not documented") (id . "function.stats-dens-t")) "stats_dens_pmf_poisson" ((documentation . "Not documented float stats_dens_pmf_poisson(float $x, float $lb) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_dens_pmf_poisson(float $x, float $lb)") (purpose . "Not documented") (id . "function.stats-dens-pmf-poisson")) "stats_dens_pmf_hypergeometric" ((documentation . " float stats_dens_pmf_hypergeometric(float $n1, float $n2, float $N1, float $N2) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_dens_pmf_hypergeometric(float $n1, float $n2, float $N1, float $N2)") (purpose . "") (id . "function.stats-dens-pmf-hypergeometric")) "stats_dens_pmf_binomial" ((documentation . "Not documented float stats_dens_pmf_binomial(float $x, float $n, float $pi) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_dens_pmf_binomial(float $x, float $n, float $pi)") (purpose . "Not documented") (id . "function.stats-dens-pmf-binomial")) "stats_dens_normal" ((documentation . "Not documented float stats_dens_normal(float $x, float $ave, float $stdev) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_dens_normal(float $x, float $ave, float $stdev)") (purpose . "Not documented") (id . "function.stats-dens-normal")) "stats_dens_negative_binomial" ((documentation . "Not documented float stats_dens_negative_binomial(float $x, float $n, float $pi) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_dens_negative_binomial(float $x, float $n, float $pi)") (purpose . "Not documented") (id . "function.stats-dens-negative-binomial")) "stats_dens_logistic" ((documentation . "Not documented float stats_dens_logistic(float $x, float $ave, float $stdev) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_dens_logistic(float $x, float $ave, float $stdev)") (purpose . "Not documented") (id . "function.stats-dens-logistic")) "stats_dens_laplace" ((documentation . "Not documented float stats_dens_laplace(float $x, float $ave, float $stdev) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_dens_laplace(float $x, float $ave, float $stdev)") (purpose . "Not documented") (id . "function.stats-dens-laplace")) "stats_dens_gamma" ((documentation . "Not documented float stats_dens_gamma(float $x, float $shape, float $scale) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_dens_gamma(float $x, float $shape, float $scale)") (purpose . "Not documented") (id . "function.stats-dens-gamma")) "stats_dens_f" ((documentation . " float stats_dens_f(float $x, float $dfr1, float $dfr2) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_dens_f(float $x, float $dfr1, float $dfr2)") (purpose . "") (id . "function.stats-dens-f")) "stats_dens_exponential" ((documentation . "Not documented float stats_dens_exponential(float $x, float $scale) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_dens_exponential(float $x, float $scale)") (purpose . "Not documented") (id . "function.stats-dens-exponential")) "stats_dens_chisquare" ((documentation . "Not documented float stats_dens_chisquare(float $x, float $dfr) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_dens_chisquare(float $x, float $dfr)") (purpose . "Not documented") (id . "function.stats-dens-chisquare")) "stats_dens_cauchy" ((documentation . "Not documented float stats_dens_cauchy(float $x, float $ave, float $stdev) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_dens_cauchy(float $x, float $ave, float $stdev)") (purpose . "Not documented") (id . "function.stats-dens-cauchy")) "stats_dens_beta" ((documentation . "Not documented float stats_dens_beta(float $x, float $a, float $b) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_dens_beta(float $x, float $a, float $b)") (purpose . "Not documented") (id . "function.stats-dens-beta")) "stats_den_uniform" ((documentation . "Not documented float stats_den_uniform(float $x, float $a, float $b) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_den_uniform(float $x, float $a, float $b)") (purpose . "Not documented") (id . "function.stats-den-uniform")) "stats_covariance" ((documentation . "Computes the covariance of two data sets float stats_covariance(array $a, array $b) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_covariance(array $a, array $b)") (purpose . "Computes the covariance of two data sets") (id . "function.stats-covariance")) "stats_cdf_weibull" ((documentation . "Not documented float stats_cdf_weibull(float $par1, float $par2, float $par3, int $which) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_cdf_weibull(float $par1, float $par2, float $par3, int $which)") (purpose . "Not documented") (id . "function.stats-cdf-weibull")) "stats_cdf_uniform" ((documentation . "Not documented float stats_cdf_uniform(float $par1, float $par2, float $par3, int $which) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_cdf_uniform(float $par1, float $par2, float $par3, int $which)") (purpose . "Not documented") (id . "function.stats-cdf-uniform")) "stats_cdf_t" ((documentation . "Calculates any one parameter of the T distribution given values for the others. float stats_cdf_t(float $par1, float $par2, int $which) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_cdf_t(float $par1, float $par2, int $which)") (purpose . "Calculates any one parameter of the T distribution given values for the others.") (id . "function.stats-cdf-t")) "stats_cdf_poisson" ((documentation . "Calculates any one parameter of the Poisson distribution given values for the others. float stats_cdf_poisson(float $par1, float $par2, int $which) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_cdf_poisson(float $par1, float $par2, int $which)") (purpose . "Calculates any one parameter of the Poisson distribution given values for the others.") (id . "function.stats-cdf-poisson")) "stats_cdf_noncentral_f" ((documentation . "Calculates any one parameter of the Non-central F distribution given values for the others. float stats_cdf_noncentral_f(float $par1, float $par2, float $par3, float $par4, int $which) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_cdf_noncentral_f(float $par1, float $par2, float $par3, float $par4, int $which)") (purpose . "Calculates any one parameter of the Non-central F distribution given values for the others.") (id . "function.stats-cdf-noncentral-f")) "stats_cdf_noncentral_chisquare" ((documentation . "Calculates any one parameter of the non-central chi-square distribution given values for the others. float stats_cdf_noncentral_chisquare(float $par1, float $par2, float $par3, int $which) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_cdf_noncentral_chisquare(float $par1, float $par2, float $par3, int $which)") (purpose . "Calculates any one parameter of the non-central chi-square distribution given values for the others.") (id . "function.stats-cdf-noncentral-chisquare")) "stats_cdf_negative_binomial" ((documentation . "Calculates any one parameter of the negative binomial distribution given values for the others. float stats_cdf_negative_binomial(float $par1, float $par2, float $par3, int $which) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_cdf_negative_binomial(float $par1, float $par2, float $par3, int $which)") (purpose . "Calculates any one parameter of the negative binomial distribution given values for the others.") (id . "function.stats-cdf-negative-binomial")) "stats_cdf_logistic" ((documentation . "Not documented float stats_cdf_logistic(float $par1, float $par2, float $par3, int $which) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_cdf_logistic(float $par1, float $par2, float $par3, int $which)") (purpose . "Not documented") (id . "function.stats-cdf-logistic")) "stats_cdf_laplace" ((documentation . "Not documented float stats_cdf_laplace(float $par1, float $par2, float $par3, int $which) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_cdf_laplace(float $par1, float $par2, float $par3, int $which)") (purpose . "Not documented") (id . "function.stats-cdf-laplace")) "stats_cdf_gamma" ((documentation . "Calculates any one parameter of the gamma distribution given values for the others. float stats_cdf_gamma(float $par1, float $par2, float $par3, int $which) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_cdf_gamma(float $par1, float $par2, float $par3, int $which)") (purpose . "Calculates any one parameter of the gamma distribution given values for the others.") (id . "function.stats-cdf-gamma")) "stats_cdf_f" ((documentation . "Calculates any one parameter of the F distribution given values for the others. float stats_cdf_f(float $par1, float $par2, float $par3, int $which) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_cdf_f(float $par1, float $par2, float $par3, int $which)") (purpose . "Calculates any one parameter of the F distribution given values for the others.") (id . "function.stats-cdf-f")) "stats_cdf_exponential" ((documentation . "Not documented float stats_cdf_exponential(float $par1, float $par2, int $which) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_cdf_exponential(float $par1, float $par2, int $which)") (purpose . "Not documented") (id . "function.stats-cdf-exponential")) "stats_cdf_chisquare" ((documentation . "Calculates any one parameter of the chi-square distribution given values for the others. float stats_cdf_chisquare(float $par1, float $par2, int $which) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_cdf_chisquare(float $par1, float $par2, int $which)") (purpose . "Calculates any one parameter of the chi-square distribution given values for the others.") (id . "function.stats-cdf-chisquare")) "stats_cdf_cauchy" ((documentation . "Not documented float stats_cdf_cauchy(float $par1, float $par2, float $par3, int $which) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_cdf_cauchy(float $par1, float $par2, float $par3, int $which)") (purpose . "Not documented") (id . "function.stats-cdf-cauchy")) "stats_cdf_binomial" ((documentation . "Calculates any one parameter of the binomial distribution given values for the others. float stats_cdf_binomial(float $par1, float $par2, float $par3, int $which) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
") (prototype . "float stats_cdf_binomial(float $par1, float $par2, float $par3, int $which)") (purpose . "Calculates any one parameter of the binomial distribution given values for the others.") (id . "function.stats-cdf-binomial")) "stats_cdf_beta" ((documentation . "CDF function for BETA Distribution. Calculates any one parameter of the beta distribution given values for the others. float stats_cdf_beta(float $par1, float $par2, float $par3, int $which) STATUS -- 0 if calculation completed correctly -I if input parameter number I is out of range 1 if answer appears to be lower than lowest search bound 2 if answer appears to be higher than greatest search bound 3 if P + Q .ne. 1 4 if X + Y .ne. 1 (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "
STATUS -- 0 if calculation completed correctly -I if input parameter number I is out of range 1 if answer appears to be lower than lowest search bound 2 if answer appears to be higher than greatest search bound 3 if P + Q .ne. 1 4 if X + Y .ne. 1
") (prototype . "float stats_cdf_beta(float $par1, float $par2, float $par3, int $which)") (purpose . "CDF function for BETA Distribution. Calculates any one parameter of the beta distribution given values for the others.") (id . "function.stats-cdf-beta")) "stats_absolute_deviation" ((documentation . "Returns the absolute deviation of an array of values float stats_absolute_deviation(array $a) (PECL stats >= 1.0.0)") (versions . "PECL stats >= 1.0.0") (return . "") (prototype . "float stats_absolute_deviation(array $a)") (purpose . "Returns the absolute deviation of an array of values") (id . "function.stats-absolute-deviation")) "tanh" ((documentation . "Hyperbolic tangent float tanh(float $arg) The hyperbolic tangent of arg (PHP 4 >= 4.1.0, PHP 5)") (versions . "PHP 4 >= 4.1.0, PHP 5") (return . "
The hyperbolic tangent of arg
The tangent of arg
No value is returned.
") (prototype . "void srand([int $seed = ''])") (purpose . "Seed the random number generator") (id . "function.srand")) "sqrt" ((documentation . "Square root float sqrt(float $arg) The square root of arg or the special value NAN for negative numbers. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " The square root of arg or the special value NAN for negative numbers.
The hyperbolic sine of arg
The sine of arg
The rounded value
") (prototype . "float round(float $val [, int $precision = '' [, int $mode = PHP_ROUND_HALF_UP]])") (purpose . "Rounds a float") (id . "function.round")) "rand" ((documentation . "Generate a random integer int rand(int $min, int $max) A pseudo random value between min (or 0) and max (or getrandmax, inclusive). (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " A pseudo random value between min (or 0) and max (or getrandmax, inclusive).
The equivalent of number in degrees
base raised to the power of exp. If both arguments are non-negative integers and the result can be represented as an integer, the result will be returned with integer type, otherwise it will be returned as a float.
The value of pi as float.
") (prototype . "float pi()") (purpose . "Get value of pi") (id . "function.pi")) "octdec" ((documentation . "Octal to decimal number octdec(string $octal_string) The decimal representation of octal_string (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " The decimal representation of octal_string
No value is returned.
") (prototype . "void mt_srand([int $seed = ''])") (purpose . "Seed the better random number generator") (id . "function.mt-srand")) "mt_rand" ((documentation . "Generate a better random value int mt_rand(int $min, int $max) A random integer value between min (or 0) and max (or mt_getrandmax, inclusive), or FALSE if max is less than min. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " A random integer value between min (or 0) and max (or mt_getrandmax, inclusive), or FALSE if max is less than min.
Returns the maximum random value returned by mt_rand
") (prototype . "int mt_getrandmax()") (purpose . "Show largest possible random value") (id . "function.mt-getrandmax")) "min" ((documentation . "Find lowest value integer min(array $values, mixed $value1, mixed $value2 [, mixed $... = '']) min returns the numerically lowest of the parameter values. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "min returns the numerically lowest of the parameter values.
") (prototype . "integer min(array $values, mixed $value1, mixed $value2 [, mixed $... = ''])") (purpose . "Find lowest value") (id . "function.min")) "max" ((documentation . "Find highest value integer max(array $values, mixed $value1, mixed $value2 [, mixed $... = '']) max returns the numerically highest of the parameter values. If multiple values can be considered of the same size, the one that is listed first will be returned. When max is given multiple arrays, the longest array is returned. If all the arrays have the same length, max will use lexicographic ordering to find the return value. When given a string it will be cast as an integer when comparing. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "max returns the numerically highest of the parameter values. If multiple values can be considered of the same size, the one that is listed first will be returned.
When max is given multiple arrays, the longest array is returned. If all the arrays have the same length, max will use lexicographic ordering to find the return value.
When given a string it will be cast as an integer when comparing.
") (prototype . "integer max(array $values, mixed $value1, mixed $value2 [, mixed $... = ''])") (purpose . "Find highest value") (id . "function.max")) "log" ((documentation . "Natural logarithm float log(float $arg [, float $base = M_E]) The logarithm of arg to base, if given, or the natural logarithm. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " The logarithm of arg to base, if given, or the natural logarithm.
log(1 + number)
The base-10 logarithm of arg
A pseudo random float value in the range of (0, 1)
") (prototype . "float lcg_value()") (purpose . "Combined linear congruential generator") (id . "function.lcg-value")) "is_nan" ((documentation . "Finds whether a value is not a number bool is_nan(float $val) Returns TRUE if val is 'not a number', else FALSE. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . " Returns TRUE if val is 'not a number', else FALSE.
TRUE if val is infinite, else FALSE.
TRUE if val is a legal finite number within the allowed range for a PHP float on this platform, else FALSE.
Calculated length of the hypotenuse
") (prototype . "float hypot(float $x, float $y)") (purpose . "Calculate the length of the hypotenuse of a right-angle triangle") (id . "function.hypot")) "hexdec" ((documentation . "Hexadecimal to decimal number hexdec(string $hex_string) The decimal representation of hex_string (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " The decimal representation of hex_string
The largest possible random value returned by rand
") (prototype . "int getrandmax()") (purpose . "Show largest possible random value") (id . "function.getrandmax")) "fmod" ((documentation . "Returns the floating point remainder (modulo) of the division of the arguments float fmod(float $x, float $y) The floating point remainder of x/y (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . " The floating point remainder of x/y
value rounded to the next lowest integer. The return value of floor is still of type float because the value range of float is usually bigger than that of integer.
'e' to the power of arg minus one
'e' raised to the power of arg
The radian equivalent of number
Octal string representation of number
Hexadecimal string representation of number.
Binary string representation of number
The hyperbolic cosine of arg
The cosine of arg
value rounded up to the next highest integer. The return value of ceil is still of type float as the value range of float is usually bigger than that of integer.
The decimal value of binary_string
number converted to base tobase
Inverse hyperbolic tangent of arg
The arc tangent of arg in radians.
The arc tangent of y/x in radians.
The inverse hyperbolic sine of arg
The arc sine of arg in radians
The inverse hyperbolic cosine of arg
The arc cosine of arg in radians.
The absolute value of number. If the argument number is of type float, the return type is also float, otherwise it is integer (as float usually has a bigger value range than integer).
A GMP number resource.
") (prototype . "resource gmp_xor(resource $a, resource $b)") (purpose . "Bitwise XOR") (id . "function.gmp-xor")) "gmp_testbit" ((documentation . "Tests if a bit is set bool gmp_testbit(resource $a, int $index) Returns TRUE if the bit is set in resource $a, otherwise FALSE. (PHP 5 >= 5.3.0)") (versions . "PHP 5 >= 5.3.0") (return . " Returns TRUE if the bit is set in resource $a, otherwise FALSE.
A GMP number resource.
") (prototype . "resource gmp_sub(resource $a, resource $b)") (purpose . "Subtract numbers") (id . "function.gmp-sub")) "gmp_strval" ((documentation . "Convert GMP number to string string gmp_strval(resource $gmpnumber [, int $base = 10]) The number, as a string. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . "The number, as a string.
") (prototype . "string gmp_strval(resource $gmpnumber [, int $base = 10])") (purpose . "Convert GMP number to string") (id . "function.gmp-strval")) "gmp_sqrtrem" ((documentation . "Square root with remainder array gmp_sqrtrem(resource $a) Returns array where first element is the integer square root of a and the second is the remainder (i.e., the difference between a and the first element squared). (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . " Returns array where first element is the integer square root of a and the second is the remainder (i.e., the difference between a and the first element squared).
The integer portion of the square root, as a GMP number.
") (prototype . "resource gmp_sqrt(resource $a)") (purpose . "Calculate square root") (id . "function.gmp-sqrt")) "gmp_sign" ((documentation . "Sign of number int gmp_sign(resource $a) Returns 1 if a is positive, -1 if a is negative, and 0 if a is zero. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . " Returns 1 if a is positive, -1 if a is negative, and 0 if a is zero.
A GMP number resource.
") (prototype . "void gmp_setbit(resource $a, int $index [, bool $bit_on = true])") (purpose . "Set bit") (id . "function.gmp-setbit")) "gmp_scan1" ((documentation . "Scan for 1 int gmp_scan1(resource $a, int $start) Returns the index of the found bit, as an integer. If no set bit is found, -1 is returned. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . "Returns the index of the found bit, as an integer. If no set bit is found, -1 is returned.
") (prototype . "int gmp_scan1(resource $a, int $start)") (purpose . "Scan for 1") (id . "function.gmp-scan1")) "gmp_scan0" ((documentation . "Scan for 0 int gmp_scan0(resource $a, int $start) Returns the index of the found bit, as an integer. The index starts from 0. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . "Returns the index of the found bit, as an integer. The index starts from 0.
") (prototype . "int gmp_scan0(resource $a, int $start)") (purpose . "Scan for 0") (id . "function.gmp-scan0")) "gmp_random" ((documentation . "Random number resource gmp_random([int $limiter = 20]) A random GMP number. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . "A random GMP number.
") (prototype . "resource gmp_random([int $limiter = 20])") (purpose . "Random number") (id . "function.gmp-random")) "gmp_prob_prime" ((documentation . "Check if number is \"probably prime\" int gmp_prob_prime(resource $a [, int $reps = 10]) If this function returns 0, a is definitely not prime. If it returns 1, then a is \"probably\" prime. If it returns 2, then a is surely prime. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . " If this function returns 0, a is definitely not prime. If it returns 1, then a is "probably" prime. If it returns 2, then a is surely prime.
The new (raised) number, as a GMP number.
") (prototype . "resource gmp_powm(resource $base, resource $exp, resource $mod)") (purpose . "Raise number into power with modulo") (id . "function.gmp-powm")) "gmp_pow" ((documentation . "Raise number into power resource gmp_pow(resource $base, int $exp) The new (raised) number, as a GMP number. The case of 0^0 yields 1. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . "The new (raised) number, as a GMP number. The case of 0^0 yields 1.
") (prototype . "resource gmp_pow(resource $base, int $exp)") (purpose . "Raise number into power") (id . "function.gmp-pow")) "gmp_popcount" ((documentation . "Population count int gmp_popcount(resource $a) The population count of a, as an integer. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . " The population count of a, as an integer.
Returns TRUE if a is a perfect square, FALSE otherwise.
A GMP number resource.
") (prototype . "resource gmp_or(resource $a, resource $b)") (purpose . "Bitwise OR") (id . "function.gmp-or")) "gmp_nextprime" ((documentation . "Find next prime number resource gmp_nextprime(int $a) Return the next prime number greater than a, as a GMP number. (PHP 5 >= 5.2.0)") (versions . "PHP 5 >= 5.2.0") (return . " Return the next prime number greater than a, as a GMP number.
Returns -a, as a GMP number.
A GMP number resource.
") (prototype . "resource gmp_mul(resource $a, resource $b)") (purpose . "Multiply numbers") (id . "function.gmp-mul")) "gmp_mod" ((documentation . "Modulo operation resource gmp_mod(resource $n, resource $d) A GMP number resource. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . "A GMP number resource.
") (prototype . "resource gmp_mod(resource $n, resource $d)") (purpose . "Modulo operation") (id . "function.gmp-mod")) "gmp_legendre" ((documentation . "Legendre symbol int gmp_legendre(resource $a, resource $p) A GMP number resource. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . "A GMP number resource.
") (prototype . "int gmp_legendre(resource $a, resource $p)") (purpose . "Legendre symbol") (id . "function.gmp-legendre")) "gmp_jacobi" ((documentation . "Jacobi symbol int gmp_jacobi(resource $a, resource $p) A GMP number resource. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . "A GMP number resource.
") (prototype . "int gmp_jacobi(resource $a, resource $p)") (purpose . "Jacobi symbol") (id . "function.gmp-jacobi")) "gmp_invert" ((documentation . "Inverse by modulo resource gmp_invert(resource $a, resource $b) A GMP number on success or FALSE if an inverse does not exist. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . " A GMP number on success or FALSE if an inverse does not exist.
An integer value of gmpnumber.
A GMP number resource.
") (prototype . "resource gmp_init(mixed $number [, int $base = ''])") (purpose . "Create GMP number") (id . "function.gmp-init")) "gmp_hamdist" ((documentation . "Hamming distance int gmp_hamdist(resource $a, resource $b) A GMP number resource. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . "A GMP number resource.
") (prototype . "int gmp_hamdist(resource $a, resource $b)") (purpose . "Hamming distance") (id . "function.gmp-hamdist")) "gmp_gcdext" ((documentation . "Calculate GCD and multipliers array gmp_gcdext(resource $a, resource $b) An array of GMP numbers. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . "An array of GMP numbers.
") (prototype . "array gmp_gcdext(resource $a, resource $b)") (purpose . "Calculate GCD and multipliers") (id . "function.gmp-gcdext")) "gmp_gcd" ((documentation . "Calculate GCD resource gmp_gcd(resource $a, resource $b) A positive GMP number that divides into both a and b. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . " A positive GMP number that divides into both a and b.
A GMP number resource.
") (prototype . "resource gmp_fact(mixed $a)") (purpose . "Factorial") (id . "function.gmp-fact")) "gmp_divexact" ((documentation . "Exact division of numbers resource gmp_divexact(resource $n, resource $d) A GMP number resource. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . "A GMP number resource.
") (prototype . "resource gmp_divexact(resource $n, resource $d)") (purpose . "Exact division of numbers") (id . "function.gmp-divexact")) "gmp_div" ((documentation . "Alias of gmp_div_q gmp_div() (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . "") (prototype . " gmp_div()") (purpose . "Alias of gmp_div_q") (id . "function.gmp-div")) "gmp_div_r" ((documentation . "Remainder of the division of numbers resource gmp_div_r(resource $n, resource $d [, int $round = GMP_ROUND_ZERO]) The remainder, as a GMP number. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . "The remainder, as a GMP number.
") (prototype . "resource gmp_div_r(resource $n, resource $d [, int $round = GMP_ROUND_ZERO])") (purpose . "Remainder of the division of numbers") (id . "function.gmp-div-r")) "gmp_div_qr" ((documentation . "Divide numbers and get quotient and remainder array gmp_div_qr(resource $n, resource $d [, int $round = GMP_ROUND_ZERO]) Returns an array, with the first element being [n/d] (the integer result of the division) and the second being (n - [n/d] * d) (the remainder of the division). (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . "Returns an array, with the first element being [n/d] (the integer result of the division) and the second being (n - [n/d] * d) (the remainder of the division).
") (prototype . "array gmp_div_qr(resource $n, resource $d [, int $round = GMP_ROUND_ZERO])") (purpose . "Divide numbers and get quotient and remainder") (id . "function.gmp-div-qr")) "gmp_div_q" ((documentation . "Divide numbers resource gmp_div_q(resource $a, resource $b [, int $round = GMP_ROUND_ZERO]) A GMP number resource. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . "A GMP number resource.
") (prototype . "resource gmp_div_q(resource $a, resource $b [, int $round = GMP_ROUND_ZERO])") (purpose . "Divide numbers") (id . "function.gmp-div-q")) "gmp_com" ((documentation . "Calculates one's complement resource gmp_com(resource $a) Returns the one's complement of a, as a GMP number. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . " Returns the one's complement of a, as a GMP number.
Returns a positive value if a > b, zero if a = b and a negative value if a < b.
") (prototype . "int gmp_cmp(resource $a, resource $b)") (purpose . "Compare numbers") (id . "function.gmp-cmp")) "gmp_clrbit" ((documentation . "Clear bit void gmp_clrbit(resource $a, int $index) A GMP number resource. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . "A GMP number resource.
") (prototype . "void gmp_clrbit(resource $a, int $index)") (purpose . "Clear bit") (id . "function.gmp-clrbit")) "gmp_and" ((documentation . "Bitwise AND resource gmp_and(resource $a, resource $b) A GMP number representing the bitwise AND comparison. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . "A GMP number representing the bitwise AND comparison.
") (prototype . "resource gmp_and(resource $a, resource $b)") (purpose . "Bitwise AND") (id . "function.gmp-and")) "gmp_add" ((documentation . "Add numbers resource gmp_add(resource $a, resource $b) A GMP number representing the sum of the arguments. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . "A GMP number representing the sum of the arguments.
") (prototype . "resource gmp_add(resource $a, resource $b)") (purpose . "Add numbers") (id . "function.gmp-add")) "gmp_abs" ((documentation . "Absolute value resource gmp_abs(resource $a) Returns the absolute value of a, as a GMP number. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . " Returns the absolute value of a, as a GMP number.
The result of the subtraction, as a string.
") (prototype . "string bcsub(string $left_operand, string $right_operand [, int $scale = int])") (purpose . "Subtract one arbitrary precision number from another") (id . "function.bcsub")) "bcsqrt" ((documentation . "Get the square root of an arbitrary precision number string bcsqrt(string $operand [, int $scale = '']) Returns the square root as a string, or NULL if operand is negative. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns the square root as a string, or NULL if operand is negative.
Returns TRUE on success or FALSE on failure.
Returns the result as a string, or NULL if modulus is 0.
Returns the result as a string.
") (prototype . "string bcpow(string $left_operand, string $right_operand [, int $scale = ''])") (purpose . "Raise an arbitrary precision number to another") (id . "function.bcpow")) "bcmul" ((documentation . "Multiply two arbitrary precision numbers string bcmul(string $left_operand, string $right_operand [, int $scale = int]) Returns the result as a string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the result as a string.
") (prototype . "string bcmul(string $left_operand, string $right_operand [, int $scale = int])") (purpose . "Multiply two arbitrary precision numbers") (id . "function.bcmul")) "bcmod" ((documentation . "Get modulus of an arbitrary precision number string bcmod(string $left_operand, string $modulus) Returns the modulus as a string, or NULL if modulus is 0. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns the modulus as a string, or NULL if modulus is 0.
Returns the result of the division as a string, or NULL if right_operand is 0.
Returns 0 if the two operands are equal, 1 if the left_operand is larger than the right_operand, -1 otherwise.
The sum of the two operands, as a string.
") (prototype . "string bcadd(string $left_operand, string $right_operand [, int $scale = ''])") (purpose . "Add two arbitrary precision numbers") (id . "function.bcadd")) "vpopmail_set_user_quota" ((documentation . "Sets a virtual user's quota bool vpopmail_set_user_quota(string $user, string $domain, string $quota) (PHP 4 >= 4.0.5, PECL vpopmail >= 0.2)") (versions . "PHP 4 >= 4.0.5, PECL vpopmail >= 0.2") (return . "") (prototype . "bool vpopmail_set_user_quota(string $user, string $domain, string $quota)") (purpose . "Sets a virtual user's quota") (id . "function.vpopmail-set-user-quota")) "vpopmail_passwd" ((documentation . "Change a virtual user's password bool vpopmail_passwd(string $user, string $domain, string $password [, bool $apop = '']) (PHP 4 >= 4.0.5, PECL vpopmail >= 0.2)") (versions . "PHP 4 >= 4.0.5, PECL vpopmail >= 0.2") (return . "") (prototype . "bool vpopmail_passwd(string $user, string $domain, string $password [, bool $apop = ''])") (purpose . "Change a virtual user's password") (id . "function.vpopmail-passwd")) "vpopmail_error" ((documentation . "Get text message for last vpopmail error string vpopmail_error() (PHP 4 >= 4.0.5, PECL vpopmail >= 0.2)") (versions . "PHP 4 >= 4.0.5, PECL vpopmail >= 0.2") (return . "") (prototype . "string vpopmail_error()") (purpose . "Get text message for last vpopmail error") (id . "function.vpopmail-error")) "vpopmail_del_user" ((documentation . "Delete a user from a virtual domain bool vpopmail_del_user(string $user, string $domain) (PHP 4 >= 4.0.5, PECL vpopmail >= 0.2)") (versions . "PHP 4 >= 4.0.5, PECL vpopmail >= 0.2") (return . "") (prototype . "bool vpopmail_del_user(string $user, string $domain)") (purpose . "Delete a user from a virtual domain") (id . "function.vpopmail-del-user")) "vpopmail_del_domain" ((documentation . "Delete a virtual domain bool vpopmail_del_domain(string $domain) (PHP 4 >= 4.0.5, PECL vpopmail >= 0.2)") (versions . "PHP 4 >= 4.0.5, PECL vpopmail >= 0.2") (return . "") (prototype . "bool vpopmail_del_domain(string $domain)") (purpose . "Delete a virtual domain") (id . "function.vpopmail-del-domain")) "vpopmail_del_domain_ex" ((documentation . "Delete a virtual domain bool vpopmail_del_domain_ex(string $domain) (PHP 4 >= 4.0.5, PECL vpopmail >= 0.2)") (versions . "PHP 4 >= 4.0.5, PECL vpopmail >= 0.2") (return . "") (prototype . "bool vpopmail_del_domain_ex(string $domain)") (purpose . "Delete a virtual domain") (id . "function.vpopmail-del-domain-ex")) "vpopmail_auth_user" ((documentation . "Attempt to validate a username/domain/password bool vpopmail_auth_user(string $user, string $domain, string $password [, string $apop = '']) (PHP 4 >= 4.0.5, PECL vpopmail >= 0.2)") (versions . "PHP 4 >= 4.0.5, PECL vpopmail >= 0.2") (return . "") (prototype . "bool vpopmail_auth_user(string $user, string $domain, string $password [, string $apop = ''])") (purpose . "Attempt to validate a username/domain/password") (id . "function.vpopmail-auth-user")) "vpopmail_alias_get" ((documentation . "Get all lines of an alias for a domain array vpopmail_alias_get(string $alias, string $domain) (PHP 4 >= 4.0.7, PECL vpopmail >= 0.2)") (versions . "PHP 4 >= 4.0.7, PECL vpopmail >= 0.2") (return . "") (prototype . "array vpopmail_alias_get(string $alias, string $domain)") (purpose . "Get all lines of an alias for a domain") (id . "function.vpopmail-alias-get")) "vpopmail_alias_get_all" ((documentation . "Get all lines of an alias for a domain array vpopmail_alias_get_all(string $domain) (PHP 4 >= 4.0.7, PECL vpopmail >= 0.2)") (versions . "PHP 4 >= 4.0.7, PECL vpopmail >= 0.2") (return . "") (prototype . "array vpopmail_alias_get_all(string $domain)") (purpose . "Get all lines of an alias for a domain") (id . "function.vpopmail-alias-get-all")) "vpopmail_alias_del" ((documentation . "Deletes all virtual aliases of a user bool vpopmail_alias_del(string $user, string $domain) (PHP 4 >= 4.0.7, PECL vpopmail >= 0.2)") (versions . "PHP 4 >= 4.0.7, PECL vpopmail >= 0.2") (return . "") (prototype . "bool vpopmail_alias_del(string $user, string $domain)") (purpose . "Deletes all virtual aliases of a user") (id . "function.vpopmail-alias-del")) "vpopmail_alias_del_domain" ((documentation . "Deletes all virtual aliases of a domain bool vpopmail_alias_del_domain(string $domain) (PHP 4 >= 4.0.7, PECL vpopmail >= 0.2)") (versions . "PHP 4 >= 4.0.7, PECL vpopmail >= 0.2") (return . "") (prototype . "bool vpopmail_alias_del_domain(string $domain)") (purpose . "Deletes all virtual aliases of a domain") (id . "function.vpopmail-alias-del-domain")) "vpopmail_alias_add" ((documentation . "Insert a virtual alias bool vpopmail_alias_add(string $user, string $domain, string $alias) (PHP 4 >= 4.0.7, PECL vpopmail >= 0.2)") (versions . "PHP 4 >= 4.0.7, PECL vpopmail >= 0.2") (return . "") (prototype . "bool vpopmail_alias_add(string $user, string $domain, string $alias)") (purpose . "Insert a virtual alias") (id . "function.vpopmail-alias-add")) "vpopmail_add_user" ((documentation . "Add a new user to the specified virtual domain bool vpopmail_add_user(string $user, string $domain, string $password [, string $gecos = '' [, bool $apop = '']]) (PHP 4 >= 4.0.5, PECL vpopmail >= 0.2)") (versions . "PHP 4 >= 4.0.5, PECL vpopmail >= 0.2") (return . "") (prototype . "bool vpopmail_add_user(string $user, string $domain, string $password [, string $gecos = '' [, bool $apop = '']])") (purpose . "Add a new user to the specified virtual domain") (id . "function.vpopmail-add-user")) "vpopmail_add_domain" ((documentation . "Add a new virtual domain bool vpopmail_add_domain(string $domain, string $dir, int $uid, int $gid) (PHP 4 >= 4.0.5, PECL vpopmail >= 0.2)") (versions . "PHP 4 >= 4.0.5, PECL vpopmail >= 0.2") (return . "") (prototype . "bool vpopmail_add_domain(string $domain, string $dir, int $uid, int $gid)") (purpose . "Add a new virtual domain") (id . "function.vpopmail-add-domain")) "vpopmail_add_domain_ex" ((documentation . "Add a new virtual domain bool vpopmail_add_domain_ex(string $domain, string $passwd [, string $quota = '' [, string $bounce = '' [, bool $apop = '']]]) (PHP 4 >= 4.0.5, PECL vpopmail >= 0.2)") (versions . "PHP 4 >= 4.0.5, PECL vpopmail >= 0.2") (return . "") (prototype . "bool vpopmail_add_domain_ex(string $domain, string $passwd [, string $quota = '' [, string $bounce = '' [, bool $apop = '']]])") (purpose . "Add a new virtual domain") (id . "function.vpopmail-add-domain-ex")) "vpopmail_add_alias_domain" ((documentation . "Add an alias for a virtual domain bool vpopmail_add_alias_domain(string $domain, string $aliasdomain) (PHP 4 >= 4.0.5, PECL vpopmail >= 0.2)") (versions . "PHP 4 >= 4.0.5, PECL vpopmail >= 0.2") (return . "") (prototype . "bool vpopmail_add_alias_domain(string $domain, string $aliasdomain)") (purpose . "Add an alias for a virtual domain") (id . "function.vpopmail-add-alias-domain")) "vpopmail_add_alias_domain_ex" ((documentation . "Add alias to an existing virtual domain bool vpopmail_add_alias_domain_ex(string $olddomain, string $newdomain) (PHP 4 >= 4.0.5, PECL vpopmail >= 0.2)") (versions . "PHP 4 >= 4.0.5, PECL vpopmail >= 0.2") (return . "") (prototype . "bool vpopmail_add_alias_domain_ex(string $olddomain, string $newdomain)") (purpose . "Add alias to an existing virtual domain") (id . "function.vpopmail-add-alias-domain-ex")) "mailparse_uudecode_all" ((documentation . "Scans the data from fp and extract each embedded uuencoded file array mailparse_uudecode_all(resource $fp) 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. (PECL mailparse >= 0.9.0)") (versions . "PECL mailparse >= 0.9.0") (return . "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 |
Returns TRUE on success or FALSE on failure.
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. |
Returns TRUE on success or FALSE on failure.
Returns a MIME resource representing the structure, or FALSE on error.
Returns TRUE on success or FALSE on failure.
") (prototype . "string mailparse_msg_extract_whole_part_file(resource $mimemail, string $filename [, callable $callbackfunc = ''])") (purpose . "Extracts a message section including headers without decoding the transfer encoding") (id . "function.mailparse-msg-extract-whole-part-file")) "mailparse_msg_extract_part" ((documentation . "Extracts/decodes a message section void mailparse_msg_extract_part(resource $mimemail, string $msgbody [, callable $callbackfunc = '']) No value is returned. (PECL mailparse >= 0.9.0)") (versions . "PECL mailparse >= 0.9.0") (return . "
No value is returned.
") (prototype . "void mailparse_msg_extract_part(resource $mimemail, string $msgbody [, callable $callbackfunc = ''])") (purpose . "Extracts/decodes a message section") (id . "function.mailparse-msg-extract-part")) "mailparse_msg_extract_part_file" ((documentation . "Extracts/decodes a message section string mailparse_msg_extract_part_file(resource $mimemail, mixed $filename [, callable $callbackfunc = '']) 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. (PECL mailparse >= 0.9.0)") (versions . "PECL mailparse >= 0.9.0") (return . " 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.
Returns a handle that can be used to parse a message.
") (prototype . "resource mailparse_msg_create()") (purpose . "Create a mime mail resource") (id . "function.mailparse-msg-create")) "mailparse_determine_best_xfer_encoding" ((documentation . #("Gets the best way of encoding string mailparse_determine_best_xfer_encoding(resource $fp) Returns one of the character encodings supported by the mbstring module. (PECL mailparse >= 0.9.0)" 148 156 (shr-url "ref.mbstring.html"))) (versions . "PECL mailparse >= 0.9.0") (return . "Returns one of the character encodings supported by the mbstring module.
") (prototype . "string mailparse_determine_best_xfer_encoding(resource $fp)") (purpose . "Gets the best way of encoding") (id . "function.mailparse-determine-best-xfer-encoding")) "mail" ((documentation . "Send mail bool mail(string $to, string $subject, string $message [, string $additional_headers = '' [, string $additional_parameters = '']]) Returns TRUE if the mail was successfully accepted for delivery, FALSE otherwise. It is important to note that just because the mail was accepted for delivery, it does NOT mean the mail will actually reach the intended destination. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE if the mail was successfully accepted for delivery, FALSE otherwise.
It is important to note that just because the mail was accepted for delivery, it does NOT mean the mail will actually reach the intended destination.
") (prototype . "bool mail(string $to, string $subject, string $message [, string $additional_headers = '' [, string $additional_parameters = '']])") (purpose . "Send mail") (id . "function.mail")) "ezmlm_hash" ((documentation . "Calculate the hash value needed by EZMLM int ezmlm_hash(string $addr) The hash value of addr. (PHP 4 >= 4.0.2, PHP 5)") (versions . "PHP 4 >= 4.0.2, PHP 5") (return . " The hash value of addr.
Returns an UTF-8 encoded string.
") (prototype . "string imap_utf8(string $mime_encoded_text)") (purpose . "Converts MIME-encoded text to UTF-8") (id . "function.imap-utf8")) "imap_utf7_encode" ((documentation . #("Converts ISO-8859-1 string to modified UTF-7 text string imap_utf7_encode(string $data) Returns data encoded with the modified UTF-7 encoding as defined in » RFC 2060, section 5.1.3 (original UTF-7 was defined in » RFC1642). (PHP 4, PHP 5)" 158 168 (shr-url "http://www.faqs.org/rfcs/rfc2060") 215 216 (shr-url "http://www.faqs.org/rfcs/rfc1642") 216 217 (shr-url "http://www.faqs.org/rfcs/rfc1642") 217 224 (shr-url "http://www.faqs.org/rfcs/rfc1642"))) (versions . "PHP 4, PHP 5") (return . " Returns data encoded with the modified UTF-7 encoding as defined in » RFC 2060, section 5.1.3 (original UTF-7 was defined in » RFC1642).
Returns a string that is encoded in ISO-8859-1 and consists of the same sequence of characters in text, or FALSE if text contains invalid modified UTF-7 sequence or text contains a character that is not part of ISO-8859-1 character set.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
The UID of the given message.
") (prototype . "int imap_uid(resource $imap_stream, int $msg_number)") (purpose . "This function returns the UID for the given message sequence number") (id . "function.imap-uid")) "imap_timeout" ((documentation . "Set or fetch imap timeout mixed imap_timeout(int $timeout_type [, int $timeout = -1]) If the timeout parameter is set, this function returns TRUE on success and FALSE on failure. If timeout is not provided or evaluates to -1, the current timeout value of timeout_type is returned as an integer. (PHP 4 >= 4.3.3, PHP 5)") (versions . "PHP 4 >= 4.3.3, PHP 5") (return . " If the timeout parameter is set, this function returns TRUE on success and FALSE on failure.
If timeout is not provided or evaluates to -1, the current timeout value of timeout_type is returned as an integer.
imap_thread returns an associative array containing a tree of messages threaded by REFERENCES, or FALSE on error.
Every message in the current mailbox will be represented by three entries in the resulting array:
$thread["XX.num"] - current message number
$thread["XX.next"]
$thread["XX.branch"]
Returns TRUE on success or FALSE on failure.
This function returns an object containing status information. The object has the following properties: messages, recent, unseen, uidnext, and uidvalidity.
flags is also set, which contains a bitmask which can be checked against any of the above constants.
") (prototype . "object imap_status(resource $imap_stream, string $mailbox, int $options)") (purpose . "Returns status information on a mailbox") (id . "function.imap-status")) "imap_sort" ((documentation . "Gets and sort messages array imap_sort(resource $imap_stream, int $criteria, int $reverse [, int $options = '' [, string $search_criteria = '' [, string $charset = NIL]]]) Returns an array of message numbers sorted by the given parameters. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns an array of message numbers sorted by the given parameters.
") (prototype . "array imap_sort(resource $imap_stream, int $criteria, int $reverse [, int $options = '' [, string $search_criteria = '' [, string $charset = NIL]]])") (purpose . "Gets and sort messages") (id . "function.imap-sort")) "imap_setflag_full" ((documentation . "Sets flags on messages bool imap_setflag_full(resource $imap_stream, string $sequence, string $flag [, int $options = NIL]) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns an array of message numbers or UIDs.
Return FALSE if it does not understand the search criteria or no messages have been found.
Returns TRUE on success or FALSE on failure.
Returns a string properly formatted email address as defined in » RFC2822.
") (prototype . "string imap_rfc822_write_address(string $mailbox, string $host, string $personal)") (purpose . "Returns a properly formatted email address given the mailbox, host, and personal info") (id . "function.imap-rfc822-write-address")) "imap_rfc822_parse_headers" ((documentation . "Parse mail headers from a string object imap_rfc822_parse_headers(string $headers [, string $defaulthost = \"UNKNOWN\"]) Returns an object similar to the one returned by imap_header, except for the flags and other properties that come from the IMAP server. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns an object similar to the one returned by imap_header, except for the flags and other properties that come from the IMAP server.
") (prototype . "object imap_rfc822_parse_headers(string $headers [, string $defaulthost = \"UNKNOWN\"])") (purpose . "Parse mail headers from a string") (id . "function.imap-rfc822-parse-headers")) "imap_rfc822_parse_adrlist" ((documentation . "Parses an address string array imap_rfc822_parse_adrlist(string $address, string $default_host) Returns an array of objects. The objects properties are: * mailbox - the mailbox name (username) * host - the host name * personal - the personal name * adl - at domain source route (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns an array of objects. The objects properties are:
Returns TRUE if the stream is reopened, FALSE otherwise.
Returns TRUE on success or FALSE on failure.
Returns an 8 bits string.
") (prototype . "string imap_qprint(string $string)") (purpose . "Convert a quoted-printable string to an 8 bit string") (id . "function.imap-qprint")) "imap_ping" ((documentation . "Check if the IMAP stream is still active bool imap_ping(resource $imap_stream) Returns TRUE if the stream is still alive, FALSE otherwise. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE if the stream is still alive, FALSE otherwise.
Returns an IMAP stream on success or FALSE on error.
Returns the number of recent messages in the current mailbox, as an integer.
") (prototype . "int imap_num_recent(resource $imap_stream)") (purpose . "Gets the number of recent messages in current mailbox") (id . "function.imap-num-recent")) "imap_num_msg" ((documentation . "Gets the number of messages in the current mailbox int imap_num_msg(resource $imap_stream) Return the number of messages in the current mailbox, as an integer. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Return the number of messages in the current mailbox, as an integer.
") (prototype . "int imap_num_msg(resource $imap_stream)") (purpose . "Gets the number of messages in the current mailbox") (id . "function.imap-num-msg")) "imap_msgno" ((documentation . "Gets the message sequence number for the given UID int imap_msgno(resource $imap_stream, int $uid) Returns the message sequence number for the given uid. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns the message sequence number for the given uid.
The decoded elements are returned in an array of objects, where each object has two properties, charset and text.
If the element hasn't been encoded, and in other words is in plain US-ASCII, the charset property of that element is set to default.
") (prototype . "array imap_mime_header_decode(string $text)") (purpose . "Decode MIME header elements") (id . "function.imap-mime-header-decode")) "imap_mailboxmsginfo" ((documentation . "Get information about the current mailbox object imap_mailboxmsginfo(resource $imap_stream) Returns the information in an object with following properties: Mailbox properties Date date of last change (current datetime) Driver driver Mailbox name of the mailbox Nmsgs number of messages Recent number of recent messages Unread number of unread messages Deleted number of deleted messages Size mailbox size Returns FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the information in an object with following properties:
| Date | date of last change (current datetime) |
| Driver | driver |
| Mailbox | name of the mailbox |
| Nmsgs | number of messages |
| Recent | number of recent messages |
| Unread | number of unread messages |
| Deleted | number of deleted messages |
| Size | mailbox size |
Returns FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the MIME message.
") (prototype . "string imap_mail_compose(array $envelope, array $body)") (purpose . "Create a MIME message based on given envelope and body sections") (id . "function.imap-mail-compose")) "imap_lsub" ((documentation . "List all the subscribed mailboxes array imap_lsub(resource $imap_stream, string $ref, string $pattern) Returns an array of all the subscribed mailboxes. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns an array of all the subscribed mailboxes.
") (prototype . "array imap_lsub(resource $imap_stream, string $ref, string $pattern)") (purpose . "List all the subscribed mailboxes") (id . "function.imap-lsub")) "imap_listsubscribed" ((documentation . "Alias of imap_lsub imap_listsubscribed() (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "") (prototype . " imap_listsubscribed()") (purpose . "Alias of imap_lsub") (id . "function.imap-listsubscribed")) "imap_listscan" ((documentation . "Returns the list of mailboxes that matches the given text array imap_listscan(resource $imap_stream, string $ref, string $pattern, string $content) Returns an array containing the names of the mailboxes that have content in the text of the mailbox. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns an array containing the names of the mailboxes that have content in the text of the mailbox.
Returns an array containing the names of the mailboxes.
") (prototype . "array imap_list(resource $imap_stream, string $ref, string $pattern)") (purpose . "Read the list of mailboxes") (id . "function.imap-list")) "imap_last_error" ((documentation . "Gets the last IMAP error that occurred during this page request string imap_last_error() Returns the full text of the last IMAP error message that occurred on the current page. Returns FALSE if no error messages are available. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns the full text of the last IMAP error message that occurred on the current page. Returns FALSE if no error messages are available.
Returns an array of string formatted with header info. One element per mail message.
") (prototype . "array imap_headers(resource $imap_stream)") (purpose . "Returns headers for all messages in a mailbox") (id . "function.imap-headers")) "imap_headerinfo" ((documentation . "Read the header of the message object imap_headerinfo(resource $imap_stream, int $msg_number [, int $fromlength = '' [, int $subjectlength = '' [, string $defaulthost = '']]]) Returns the information in an object with following properties: * toaddress - full to: line, up to 1024 characters * to - an array of objects from the To: line, with the following properties: personal, adl, mailbox, and host * fromaddress - full from: line, up to 1024 characters * from - an array of objects from the From: line, with the following properties: personal, adl, mailbox, and host * ccaddress - full cc: line, up to 1024 characters * cc - an array of objects from the Cc: line, with the following properties: personal, adl, mailbox, and host * bccaddress - full bcc: line, up to 1024 characters * bcc - an array of objects from the Bcc: line, with the following properties: personal, adl, mailbox, and host * reply_toaddress - full Reply-To: line, up to 1024 characters * reply_to - an array of objects from the Reply-To: line, with the following properties: personal, adl, mailbox, and host * senderaddress - full sender: line, up to 1024 characters * sender - an array of objects from the Sender: line, with the following properties: personal, adl, mailbox, and host * return_pathaddress - full Return-Path: line, up to 1024 characters * return_path - an array of objects from the Return-Path: line, with the following properties: personal, adl, mailbox, and host * remail - * date - The message date as found in its headers * Date - Same as date * subject - The message subject * Subject - Same as subject * in_reply_to - * message_id - * newsgroups - * followup_to - * references - * Recent - R if recent and seen, N if recent and not seen, ' ' if not recent. * Unseen - U if not seen AND not recent, ' ' if seen OR not seen and recent * Flagged - F if flagged, ' ' if not flagged * Answered - A if answered, ' ' if unanswered * Deleted - D if deleted, ' ' if not deleted * Draft - X if draft, ' ' if not draft * Msgno - The message number * MailDate - * Size - The message size * udate - mail message date in Unix time * fetchfrom - from line formatted to fit fromlength characters * fetchsubject - subject line formatted to fit subjectlength characters (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the information in an object with following properties:
fromlength characters subjectlength characters Returns an array of objects containing mailbox information. Each object has the attributes name, specifying the full name of the mailbox; delimiter, which is the hierarchy delimiter for the part of the hierarchy this mailbox is in; and attributes. Attributes is a bitmask that can be tested against:
LATT_NOINFERIORS - This mailbox has no "children" (there are no mailboxes below this one). LATT_NOSELECT - This is only a container, not a mailbox - you cannot open it. LATT_MARKED - This mailbox is marked. Only used by UW-IMAPD. LATT_UNMARKED - This mailbox is not marked. Only used by UW-IMAPD. Returns an array of objects containing mailbox information. Each object has the attributes name, specifying the full name of the mailbox; delimiter, which is the hierarchy delimiter for the part of the hierarchy this mailbox is in; and attributes. Attributes is a bitmask that can be tested against:
LATT_NOINFERIORS - This mailbox contains, and may not contain any "children" (there are no mailboxes below this one). Calling imap_createmailbox will not work on this mailbox.
LATT_NOSELECT - This is only a container, not a mailbox - you cannot open it.
LATT_MARKED - This mailbox is marked. This means that it may contain new messages since the last time it was checked. Not provided by all IMAP servers.
LATT_UNMARKED - This mailbox is not marked, does not contain new messages. If either MARKED or UNMARKED is provided, you can assume the IMAP server supports this feature for this mailbox.
Returns an associative array of "folder" => "acl" pairs.
") (prototype . "array imap_getacl(resource $imap_stream, string $mailbox)") (purpose . "Gets the ACL for a given mailbox") (id . "function.imap-getacl")) "imap_get_quotaroot" ((documentation . "Retrieve the quota settings per user array imap_get_quotaroot(resource $imap_stream, string $quota_root) Returns an array of integer values pertaining to the specified user mailbox. All values contain a key based upon the resource name, and a corresponding array with the usage and limit values within. This function will return FALSE in the case of call failure, and an array of information about the connection upon an un-parsable response from the server. (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . "Returns an array of integer values pertaining to the specified user mailbox. All values contain a key based upon the resource name, and a corresponding array with the usage and limit values within.
This function will return FALSE in the case of call failure, and an array of information about the connection upon an un-parsable response from the server.
Returns an array with integer values limit and usage for the given mailbox. The value of limit represents the total amount of space allowed for this mailbox. The usage value represents the mailboxes current level of capacity. Will return FALSE in the case of failure.
As of PHP 4.3, the function more properly reflects the functionality as dictated by the » RFC2087. The array return value has changed to support an unlimited number of returned resources (i.e. messages, or sub-folders) with each named resource receiving an individual array key. Each key value then contains an another array with the usage and limit values within it.
For backwards compatibility reasons, the original access methods are still available for use, although it is suggested to update.
") (prototype . "array imap_get_quota(resource $imap_stream, string $quota_root)") (purpose . "Retrieve the quota level settings, and usage statics per mailbox") (id . "function.imap-get-quota")) "imap_gc" ((documentation . "Clears IMAP cache bool imap_gc(resource $imap_stream, int $caches) Returns TRUE on success or FALSE on failure. (PHP 5 >= 5.3.0)") (versions . "PHP 5 >= 5.3.0") (return . " Returns TRUE on success or FALSE on failure.
Returns an object includes the envelope, internal date, size, flags and body structure along with a similar object for each mime attachment. The structure of the returned objects is as follows:
| type | Primary body type |
| encoding | Body transfer encoding |
| ifsubtype | TRUE if there is a subtype string |
| subtype | MIME subtype |
| ifdescription | TRUE if there is a description string |
| description | Content description string |
| ifid | TRUE if there is an identification string |
| id | Identification string |
| lines | Number of lines |
| bytes | Number of bytes |
| ifdisposition | TRUE if there is a disposition string |
| disposition | Disposition string |
| ifdparameters | TRUE if the dparameters array exists |
| dparameters | An array of objects where each object has an "attribute" and a "value" property corresponding to the parameters on the Content-disposition MIME header. |
| ifparameters | TRUE if the parameters array exists |
| parameters | An array of objects where each object has an "attribute" and a "value" property. |
| parts | An array of objects identical in structure to the top-level object, each of which corresponds to a MIME body part. |
| 0 | text |
| 1 | multipart |
| 2 | message |
| 3 | application |
| 4 | audio |
| 5 | image |
| 6 | video |
| 7 | other |
| 0 | 7BIT |
| 1 | 8BIT |
| 2 | BINARY |
| 3 | BASE64 |
| 4 | QUOTED-PRINTABLE |
| 5 | OTHER |
Returns the MIME headers of a particular section of the body of the specified messages as a text string.
") (prototype . "string imap_fetchmime(resource $imap_stream, int $msg_number, string $section [, int $options = ''])") (purpose . "Fetch MIME headers for a particular section of the message") (id . "function.imap-fetchmime")) "imap_fetchheader" ((documentation . "Returns header for a message string imap_fetchheader(resource $imap_stream, int $msg_number [, int $options = '']) Returns the header of the specified message as a text string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the header of the specified message as a text string.
") (prototype . "string imap_fetchheader(resource $imap_stream, int $msg_number [, int $options = ''])") (purpose . "Returns header for a message") (id . "function.imap-fetchheader")) "imap_fetchbody" ((documentation . "Fetch a particular section of the body of the message string imap_fetchbody(resource $imap_stream, int $msg_number, string $section [, int $options = '']) Returns a particular section of the body of the specified messages as a text string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns a particular section of the body of the specified messages as a text string.
") (prototype . "string imap_fetchbody(resource $imap_stream, int $msg_number, string $section [, int $options = ''])") (purpose . "Fetch a particular section of the body of the message") (id . "function.imap-fetchbody")) "imap_fetch_overview" ((documentation . "Read an overview of the information in the headers of the given message array imap_fetch_overview(resource $imap_stream, string $sequence [, int $options = '']) Returns an array of objects describing one message header each. The object will only define a property if it exists. The possible properties are: * subject - the messages subject * from - who sent it * to - recipient * date - when was it sent * message_id - Message-ID * references - is a reference to this message id * in_reply_to - is a reply to this message id * size - size in bytes * uid - UID the message has in the mailbox * msgno - message sequence number in the mailbox * recent - this message is flagged as recent * flagged - this message is flagged * answered - this message is flagged as answered * deleted - this message is flagged for deletion * seen - this message is flagged as already read * draft - this message is flagged as being a draft (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns an array of objects describing one message header each. The object will only define a property if it exists. The possible properties are:
Returns TRUE.
This function returns an array of all of the IMAP error messages generated since the last imap_errors call, or the beginning of the page. Returns FALSE if no error messages are available.
Returns TRUE on success or FALSE on failure.
Returns TRUE.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the information in an object with following properties:
Date - current system time formatted according to » RFC2822 Driver - protocol used to access this mailbox: POP3, IMAP, NNTP Mailbox - the mailbox name Nmsgs - number of messages in the mailbox Recent - number of recent messages in the mailbox Returns FALSE on failure.
Returns the information in an object, for a detailed description of the object structure and properties see imap_fetchstructure.
") (prototype . "object imap_bodystruct(resource $imap_stream, int $msg_number, string $section)") (purpose . "Read the structure of a specified body section of a specific message") (id . "function.imap-bodystruct")) "imap_body" ((documentation . "Read the message body string imap_body(resource $imap_stream, int $msg_number [, int $options = '']) Returns the body of the specified message, as a string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the body of the specified message, as a string.
") (prototype . "string imap_body(resource $imap_stream, int $msg_number [, int $options = ''])") (purpose . "Read the message body") (id . "function.imap-body")) "imap_binary" ((documentation . "Convert an 8bit string to a base64 string string imap_binary(string $string) Returns a base64 encoded string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns a base64 encoded string.
") (prototype . "string imap_binary(string $string)") (purpose . "Convert an 8bit string to a base64 string") (id . "function.imap-binary")) "imap_base64" ((documentation . "Decode BASE64 encoded text string imap_base64(string $text) Returns the decoded message as a string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the decoded message as a string.
") (prototype . "string imap_base64(string $text)") (purpose . "Decode BASE64 encoded text") (id . "function.imap-base64")) "imap_append" ((documentation . "Append a string message to a specified mailbox bool imap_append(resource $imap_stream, string $mailbox, string $message [, string $options = '' [, string $internal_date = '']]) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns an array of all of the IMAP alert messages generated or FALSE if no alert messages are available.
Returns a quoted-printable string.
") (prototype . "string imap_8bit(string $string)") (purpose . "Convert an 8bit string to a quoted-printable string") (id . "function.imap-8bit")) "cyrus_unbind" ((documentation . "Unbind ... bool cyrus_unbind(resource $connection, string $trigger_name) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.1.0, PECL cyrus 1.0)") (versions . "PHP 4 >= 4.1.0, PECL cyrus 1.0") (return . " Returns TRUE on success or FALSE on failure.
Returns an associative array with the following keys: text, msgno, and keyword.
") (prototype . "array cyrus_query(resource $connection, string $query)") (purpose . "Send a query to a Cyrus IMAP server") (id . "function.cyrus-query")) "cyrus_connect" ((documentation . "Connect to a Cyrus IMAP server resource cyrus_connect([string $host = '' [, string $port = '' [, int $flags = '']]]) Returns a connection handler on success or FALSE on failure. (PHP 4 >= 4.1.0, PECL cyrus 1.0)") (versions . "PHP 4 >= 4.1.0, PECL cyrus 1.0") (return . " Returns a connection handler on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void cyrus_authenticate(resource $connection [, string $mechlist = '' [, string $service = '' [, string $user = '' [, int $minssf = '' [, int $maxssf = '' [, string $authname = '' [, string $password = '']]]]]]])") (purpose . "Authenticate against a Cyrus IMAP server") (id . "function.cyrus-authenticate")) "png2wbmp" ((documentation . "Convert PNG image file to WBMP image file bool png2wbmp(string $pngname, string $wbmpname, int $dest_height, int $dest_width, int $threshold) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.5, PHP 5)") (versions . "PHP 4 >= 4.0.5, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns an array using the tagmarker as an index and the value as the value. It returns FALSE on error or if no IPTC data was found.
If success and spool flag is lower than 2 then the JPEG will not be returned as a string, FALSE on errors.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns a bit-field corresponding to the image formats supported by the version of GD linked into PHP. The following bits are returned, IMG_GIF | IMG_JPG | IMG_PNG | IMG_WBMP | IMG_XPM.
Returns an array with 8 elements representing four points making the bounding box of the text. The order of the points is lower left, lower right, upper right, upper left. The points are relative to the text regardless of the angle, so "upper left" means in the top left-hand corner when you see the text horizontally. Returns FALSE on error.
imagettfbbox returns an array with 8 elements representing four points making the bounding box of the text on success and FALSE on error.
| key | contents |
|---|---|
| 0 | lower left corner, X position |
| 1 | lower left corner, Y position |
| 2 | lower right corner, X position |
| 3 | lower right corner, Y position |
| 4 | upper right corner, X position |
| 5 | upper right corner, Y position |
| 6 | upper left corner, X position |
| 7 | upper left corner, Y position |
The points are relative to the text regardless of the angle, so "upper left" means in the top left-hand corner seeing the text horizontally.
Returns TRUE on success or FALSE on failure.
Return the height of the image or FALSE on errors.
Return the width of the image or FALSE on errors.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Return scaled image resource on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns an image resource for the rotated image, or FALSE on failure.
Returns TRUE on success or FALSE on failure.
This function returns an array containing the following elements:
| 0 | lower left x-coordinate |
| 1 | lower left y-coordinate |
| 2 | upper right x-coordinate |
| 3 | upper right y-coordinate |
Returns TRUE on success or FALSE on failure.
In the case everything went right, a valid font index will be returned and can be used for further purposes. Otherwise the function returns FALSE.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns an array containing the following elements:
| 0 | left x-coordinate |
| 1 | upper y-coordinate |
| 2 | right x-coordinate |
| 3 | lower y-coordinate |
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE if the convertion was complete, or if the source image already is a true color image, otherwise FALSE is returned.
No value is returned.
") (prototype . "void imagepalettecopy(resource $destination, resource $source)") (purpose . "Copy the palette from one image to another") (id . "function.imagepalettecopy")) "imageloadfont" ((documentation . "Load a new font int imageloadfont(string $file) The font identifier which is always bigger than 5 to avoid conflicts with built-in fonts or FALSE on errors. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " The font identifier which is always bigger than 5 to avoid conflicts with built-in fonts or FALSE on errors.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE if the image is truecolor, FALSE otherwise.
Returns 1 if the interlace bit is set for the image, 0 otherwise.
") (prototype . "int imageinterlace(resource $image [, int $interlace = ''])") (purpose . "Enable or disable interlace") (id . "function.imageinterlace")) "imagegrabwindow" ((documentation . "Captures a window resource imagegrabwindow(int $window_handle [, int $client_area = '']) Returns an image resource identifier on success, FALSE on failure. (PHP 5 >= 5.2.2)") (versions . "PHP 5 >= 5.2.2") (return . " Returns an image resource identifier on success, FALSE on failure.
Returns an image resource identifier on success, FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
This function returns an array defining the four points of the box, starting in the lower left and moving counter-clockwise:
| 0 | lower left x-coordinate |
| 1 | lower left y-coordinate |
| 2 | lower right x-coordinate |
| 3 | lower right y-coordinate |
| 4 | upper right x-coordinate |
| 5 | upper right y-coordinate |
| 6 | upper left x-coordinate |
| 7 | upper left y-coordinate |
imageftbbox returns an array with 8 elements representing four points making the bounding box of the text:
| 0 | lower left corner, X position |
| 1 | lower left corner, Y position |
| 2 | lower right corner, X position |
| 3 | lower right corner, Y position |
| 4 | upper right corner, X position |
| 5 | upper right corner, Y position |
| 6 | upper left corner, X position |
| 7 | upper left corner, Y position |
The points are relative to the text regardless of the angle, so "upper left" means in the top left-hand corner seeing the text horizontally.
Returns the pixel width of the font.
") (prototype . "int imagefontwidth(int $font)") (purpose . "Get font width") (id . "function.imagefontwidth")) "imagefontheight" ((documentation . "Get font height int imagefontheight(int $font) Returns the pixel height of the font. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the pixel height of the font.
") (prototype . "int imagefontheight(int $font)") (purpose . "Get font height") (id . "function.imagefontheight")) "imageflip" ((documentation . "Flips an image using a given mode bool imageflip(resource $image, int $mode) Returns TRUE on success or FALSE on failure. (PHP 5 >= 5.5.0)") (versions . "PHP 5 >= 5.5.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Always returns true
") (prototype . "bool imagedashedline(resource $image, int $x1, int $y1, int $x2, int $y2, int $color)") (purpose . "Draw a dashed line") (id . "function.imagedashedline")) "imagecropauto" ((documentation . "Crop an image automatically using one of the available modes resource imagecropauto(resource $image [, int $mode = -1 [, float $threshold = .5 [, int $color = -1]]]) Return cropped image resource on success or FALSE on failure. (PHP 5 >= 5.5.0)") (versions . "PHP 5 >= 5.5.0") (return . " Return cropped image resource on success or FALSE on failure.
Return cropped image resource on success or FALSE on failure.
Returns an image resource identifier on success, FALSE on errors.
Returns an image resource identifier on success, FALSE on errors.
Returns an image resource identifier on success, FALSE on errors.
Returns an image resource identifier on success, FALSE on errors.
Returns an image resource identifier on success, FALSE on errors.
An image resource will be returned on success. FALSE is returned if the image type is unsupported, the data is not in a recognised format, or the image is corrupt and cannot be loaded.
Returns an image resource identifier on success, FALSE on errors.
Returns an image resource identifier on success, FALSE on errors.
Returns an image resource identifier on success, FALSE on errors.
Returns an image resource identifier on success, FALSE on errors.
Returns an image resource identifier on success, FALSE on errors.
Returns an image resource identifier on success, FALSE on errors.
Returns an image resource identifier on success, FALSE on errors.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
The identifier of the new (or current, if none is specified) transparent color is returned. If color is not specified, and the image has no transparent color, the returned identifier will be -1.
Returns the number of colors in the specified image's palette or 0 for truecolor images.
") (prototype . "int imagecolorstotal(resource $image)") (purpose . "Find out the number of colors in an image's palette") (id . "function.imagecolorstotal")) "imagecolorsforindex" ((documentation . "Get the colors for an index array imagecolorsforindex(resource $image, int $index) Returns an associative array with red, green, blue and alpha keys that contain the appropriate values for the specified color index. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns an associative array with red, green, blue and alpha keys that contain the appropriate values for the specified color index.
") (prototype . "array imagecolorsforindex(resource $image, int $index)") (purpose . "Get the colors for an index") (id . "function.imagecolorsforindex")) "imagecolorset" ((documentation . "Set the color for the specified palette index void imagecolorset(resource $image, int $index, int $red, int $green, int $blue [, int $alpha = '']) No value is returned. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "No value is returned.
") (prototype . "void imagecolorset(resource $image, int $index, int $red, int $green, int $blue [, int $alpha = ''])") (purpose . "Set the color for the specified palette index") (id . "function.imagecolorset")) "imagecolorresolvealpha" ((documentation . "Get the index of the specified color + alpha or its closest possible alternative int imagecolorresolvealpha(resource $image, int $red, int $green, int $blue, int $alpha) Returns a color index. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . "Returns a color index.
") (prototype . "int imagecolorresolvealpha(resource $image, int $red, int $green, int $blue, int $alpha)") (purpose . "Get the index of the specified color + alpha or its closest possible alternative") (id . "function.imagecolorresolvealpha")) "imagecolorresolve" ((documentation . "Get the index of the specified color or its closest possible alternative int imagecolorresolve(resource $image, int $red, int $green, int $blue) Returns a color index. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns a color index.
") (prototype . "int imagecolorresolve(resource $image, int $red, int $green, int $blue)") (purpose . "Get the index of the specified color or its closest possible alternative") (id . "function.imagecolorresolve")) "imagecolormatch" ((documentation . "Makes the colors of the palette version of an image more closely match the true color version bool imagecolormatch(resource $image1, resource $image2) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns the index of the specified color+alpha in the palette of the image, or -1 if the color does not exist in the image's palette.
") (prototype . "int imagecolorexactalpha(resource $image, int $red, int $green, int $blue, int $alpha)") (purpose . "Get the index of the specified color + alpha") (id . "function.imagecolorexactalpha")) "imagecolorexact" ((documentation . "Get the index of the specified color int imagecolorexact(resource $image, int $red, int $green, int $blue) Returns the index of the specified color in the palette, or -1 if the color does not exist. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the index of the specified color in the palette, or -1 if the color does not exist.
") (prototype . "int imagecolorexact(resource $image, int $red, int $green, int $blue)") (purpose . "Get the index of the specified color") (id . "function.imagecolorexact")) "imagecolordeallocate" ((documentation . "De-allocate a color for an image bool imagecolordeallocate(resource $image, int $color) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns an integer with the index of the color which has the hue, white and blackness nearest the given color.
") (prototype . "int imagecolorclosesthwb(resource $image, int $red, int $green, int $blue)") (purpose . "Get the index of the color which has the hue, white and blackness") (id . "function.imagecolorclosesthwb")) "imagecolorclosestalpha" ((documentation . "Get the index of the closest color to the specified color + alpha int imagecolorclosestalpha(resource $image, int $red, int $green, int $blue, int $alpha) Returns the index of the closest color in the palette. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . "Returns the index of the closest color in the palette.
") (prototype . "int imagecolorclosestalpha(resource $image, int $red, int $green, int $blue, int $alpha)") (purpose . "Get the index of the closest color to the specified color + alpha") (id . "function.imagecolorclosestalpha")) "imagecolorclosest" ((documentation . "Get the index of the closest color to the specified color int imagecolorclosest(resource $image, int $red, int $green, int $blue) Returns the index of the closest color, in the palette of the image, to the specified one (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the index of the closest color, in the palette of the image, to the specified one
") (prototype . "int imagecolorclosest(resource $image, int $red, int $green, int $blue)") (purpose . "Get the index of the closest color to the specified color") (id . "function.imagecolorclosest")) "imagecolorat" ((documentation . "Get the index of the color of a pixel int imagecolorat(resource $image, int $x, int $y) Returns the index of the color. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the index of the color.
") (prototype . "int imagecolorat(resource $image, int $x, int $y)") (purpose . "Get the index of the color of a pixel") (id . "function.imagecolorat")) "imagecolorallocatealpha" ((documentation . #("Allocate a color for an image int imagecolorallocatealpha(resource $image, int $red, int $green, int $blue, int $alpha) A color identifier or FALSE if the allocation failed. Warning This function mayreturn Boolean FALSE, but may also return a non-Boolean value whichevaluates to FALSE. Please read the section on Booleans for moreinformation. Use the ===operator for testing the return value of thisfunction. (PHP 4 >= 4.3.2, PHP 5)" 317 325 (shr-url "language.types.boolean.html") 351 354 (shr-url "language.operators.comparison.html") 354 355 (shr-url "language.operators.comparison.html") 355 366 (shr-url "language.operators.comparison.html"))) (versions . "PHP 4 >= 4.3.2, PHP 5") (return . " A color identifier or FALSE if the allocation failed.
This function mayreturn Boolean FALSE, but may also return a non-Boolean value whichevaluates to FALSE. Please read the section on Booleans for moreinformation. Use the ===operator for testing the return value of thisfunction.
A color identifier or FALSE if the allocation failed.
This function mayreturn Boolean FALSE, but may also return a non-Boolean value whichevaluates to FALSE. Please read the section on Booleans for moreinformation. Use the ===operator for testing the return value of thisfunction.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Array with keys 0 to 5 and float values or FALSE on failure.
Array with keys 0 to 5 and float values or FALSE on failure.
Return affined image resource on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
The returned values are as follows
imagetype | Returned value |
|---|---|
IMAGETYPE_GIF | image/gif |
IMAGETYPE_JPEG | image/jpeg |
IMAGETYPE_PNG | image/png |
IMAGETYPE_SWF | application/x-shockwave-flash |
IMAGETYPE_PSD | image/psd |
IMAGETYPE_BMP | image/bmp |
IMAGETYPE_TIFF_II (intel byte order) | image/tiff |
IMAGETYPE_TIFF_MM (motorola byte order) | image/tiff |
IMAGETYPE_JPC | application/octet-stream |
IMAGETYPE_JP2 | image/jp2 |
IMAGETYPE_JPX | application/octet-stream |
IMAGETYPE_JB2 | application/octet-stream |
IMAGETYPE_SWC | application/x-shockwave-flash |
IMAGETYPE_IFF | image/iff |
IMAGETYPE_WBMP | image/vnd.wap.wbmp |
IMAGETYPE_XBM | image/xbm |
IMAGETYPE_ICO | image/vnd.microsoft.icon |
A string with the extension corresponding to the given image type.
") (prototype . "string image_type_to_extension(int $imagetype [, bool $include_dot = ''])") (purpose . "Get file extension for image type") (id . "function.image-type-to-extension")) "getimagesizefromstring" ((documentation . "Get the size of an image from a string array getimagesizefromstring(string $imagedata [, array $imageinfo = '']) See getimagesize. (PHP 5 >= 5.4.0)") (versions . "PHP 5 >= 5.4.0") (return . "See getimagesize.
") (prototype . "array getimagesizefromstring(string $imagedata [, array $imageinfo = ''])") (purpose . "Get the size of an image from a string") (id . "function.getimagesizefromstring")) "getimagesize" ((documentation . #("Get the size of an image array getimagesize(string $filename [, array $imageinfo = '']) Returns an array with up to 7 elements. Not all image types will include the channels and bits elements. Index 0 and 1 contains respectively the width and the height of the image. Note: Some formats may contain no image or may contain multiple images. In these cases, getimagesize might not be able to properly determine the image size. getimagesize will return zero for width and height in these cases. Index 2 is one of the IMAGETYPE_XXX constants indicating the type of the image. Index 3 is a text string with the correct height=\"yyy\" width=\"xxx\" string that can be used directly in an IMG tag. mime is the correspondant MIME type of the image. This information can be used to deliver images with the correct HTTP Content-type header: Example # getimagesize and MIME types channels will be 3 for RGB pictures and 4 for CMYK pictures. bits is the number of bits for each color. For some image types, the presence of channels and bits values can be a bit confusing. As an example, GIF always uses 3 channels per pixel, but the number of bits per pixel cannot be calculated for an animated GIF with a global color table. On failure, FALSE is returned. (PHP 4, PHP 5)" 540 563 (shr-url "image.constants.html") 895 900 (face (:foreground "#0000BB")) 901 906 (face (:foreground "#0000BB")) 906 907 (face (:foreground "#0000BB")) 907 908 (face (:foreground "#007700")) 908 909 (face (:foreground "#007700")) 909 921 (face (:foreground "#0000BB")) 921 922 (face (:foreground "#007700")) 922 931 (face (:foreground "#0000BB")) 931 933 (face (:foreground "#007700")) 934 937 (face (:foreground "#0000BB")) 937 938 (face (:foreground "#0000BB")) 938 939 (face (:foreground "#007700")) 939 940 (face (:foreground "#007700")) 940 945 (face (:foreground "#0000BB")) 945 946 (face (:foreground "#007700")) 946 955 (face (:foreground "#0000BB")) 955 956 (face (:foreground "#007700")) 956 957 (face (:foreground "#007700")) 957 961 (face (:foreground "#DD0000")) 961 963 (face (:foreground "#007700")) 964 966 (face (:foreground "#007700")) 966 967 (face (:foreground "#007700")) 967 968 (face (:foreground "#007700")) 968 973 (face (:foreground "#0000BB")) 973 974 (face (:foreground "#0000BB")) 974 976 (face (:foreground "#007700")) 976 977 (face (:foreground "#007700")) 977 980 (face (:foreground "#0000BB")) 980 981 (face (:foreground "#007700")) 981 982 (face (:foreground "#007700")) 982 983 (face (:foreground "#007700")) 984 990 (face (:foreground "#0000BB")) 990 991 (face (:foreground "#007700")) 991 1005 (face (:foreground "#DD0000")) 1005 1006 (face (:foreground "#DD0000")) 1006 1007 (face (:foreground "#007700")) 1007 1012 (face (:foreground "#0000BB")) 1012 1013 (face (:foreground "#007700")) 1013 1019 (face (:foreground "#DD0000")) 1019 1021 (face (:foreground "#007700")) 1021 1022 (face (:foreground "#DD0000")) 1022 1024 (face (:foreground "#007700")) 1025 1034 (face (:foreground "#0000BB")) 1034 1035 (face (:foreground "#007700")) 1035 1038 (face (:foreground "#0000BB")) 1038 1040 (face (:foreground "#007700")) 1041 1046 (face (:foreground "#007700")) 1047 1048 (face (:foreground "#007700")) 1048 1049 (face (:foreground "#007700")) 1049 1053 (face (:foreground "#007700")) 1053 1054 (face (:foreground "#007700")) 1054 1055 (face (:foreground "#007700")) 1056 1058 (face (:foreground "#FF8000")) 1058 1059 (face (:foreground "#FF8000")) 1059 1064 (face (:foreground "#FF8000")) 1065 1066 (face (:foreground "#007700")) 1067 1069 (face (:foreground "#0000BB")))) (versions . "PHP 4, PHP 5") (return . "Returns an array with up to 7 elements. Not all image types will include the channels and bits elements.
Index 0 and 1 contains respectively the width and the height of the image.
Note:
Some formats may contain no image or may contain multiple images. In these cases, getimagesize might not be able to properly determine the image size. getimagesize will return zero for width and height in these cases.
Index 2 is one of the IMAGETYPE_XXX constants indicating the type of the image.
Index 3 is a text string with the correct height="yyy" width="xxx" string that can be used directly in an IMG tag.
mime is the correspondant MIME type of the image. This information can be used to deliver images with the correct HTTP Content-type header:
Example # getimagesize and MIME types
<?php
$size = getimagesize($filename);
$fp = fopen($filename, \"rb\");
if ($size && $fp) {
header(\"Content-type: {$size['mime']}\");
fpassthru($fp);
exit;
} else {
// error
}
?>channels will be 3 for RGB pictures and 4 for CMYK pictures.
bits is the number of bits for each color.
For some image types, the presence of channels and bits values can be a bit confusing. As an example, GIF always uses 3 channels per pixel, but the number of bits per pixel cannot be calculated for an animated GIF with a global color table.
On failure, FALSE is returned.
Returns an associative array.
| Attribute | Meaning |
|---|---|
| GD Version | string value describing the installed libgd version. |
| FreeType Support | boolean value. TRUE if FreeType Support is installed. |
| FreeType Linkage | string value describing the way in which FreeType was linked. Expected values are: 'with freetype', 'with TTF library', and 'with unknown library'. This element will only be defined if FreeType Support evaluated to TRUE. |
| T1Lib Support | boolean value. TRUE if T1Lib support is included. |
| GIF Read Support | boolean value. TRUE if support for reading GIF images is included. |
| GIF Create Support | boolean value. TRUE if support for creating GIF images is included. |
| JPEG Support | boolean value. TRUE if JPEG support is included. |
| PNG Support | boolean value. TRUE if PNG support is included. |
| WBMP Support | boolean value. TRUE if WBMP support is included. |
| XBM Support | boolean value. TRUE if XBM support is included. |
| WebP Support | boolean value. TRUE if WebP support is included. |
") (prototype . "array gd_info()") (purpose . "Retrieve information about the currently installed GD library") (id . "function.gd-info")) "read_exif_data" ((documentation . "Alias of exif_read_data read_exif_data() (PHP 4 >= 4.0.1, PHP 5)") (versions . "PHP 4 >= 4.0.1, PHP 5") (return . "") (prototype . " read_exif_data()") (purpose . "Alias of exif_read_data") (id . "function.read-exif-data")) "exif_thumbnail" ((documentation . "Retrieve the embedded thumbnail of a TIFF or JPEG image string exif_thumbnail(string $filename [, int $width = '' [, int $height = '' [, int $imagetype = '']]]) Returns the embedded thumbnail, or FALSE if the image contains no thumbnail. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . "Note:
Previous to PHP 5.3.0, the JPEG Support attribute was named JPG Support.
Returns the embedded thumbnail, or FALSE if the image contains no thumbnail.
Returns the header name, or FALSE if index is not a defined EXIF tag id.
It returns an associative array where the array indexes are the header names and the array values are the values associated with those headers. If no data can be returned, exif_read_data will return FALSE.
When a correct signature is found, the appropriate constant value will be returned otherwise the return value is FALSE. The return value is the same value that getimagesize returns in index 2 but exif_imagetype is much faster.
") (prototype . "int exif_imagetype(string $filename)") (purpose . "Determine the type of an image") (id . "function.exif-imagetype")) "cairo_matrix_scale" ((documentation . "Applies scaling to a matrix void cairo_matrix_scale(float $sx, float $sy, CairoContext $context) (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "") (prototype . "void cairo_matrix_scale(float $sx, float $sy, CairoContext $context)") (purpose . "Applies scaling to a matrix") (id . "cairomatrix.scale")) "cairo_matrix_init_translate" ((documentation . "Creates a new translation matrix object cairo_matrix_init_translate(float $tx, float $ty) Returns a new CairoMatrix object that can be used with surfaces, contexts, and patterns. (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Note:
exif_imagetype will emit an
E_NOTICEand returnFALSEif it is unable to read enough bytes from the file to determine the image type.
Returns a new CairoMatrix object that can be used with surfaces, contexts, and patterns.
") (prototype . "object cairo_matrix_init_translate(float $tx, float $ty)") (purpose . "Creates a new translation matrix") (id . "cairomatrix.inittranslate")) "cairo_matrix_init_scale" ((documentation . "Creates a new scaling matrix object cairo_matrix_init_scale(float $sx, float $sy) Returns a new CairoMatrix object that can be used with surfaces, contexts, and patterns. (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Returns a new CairoMatrix object that can be used with surfaces, contexts, and patterns.
") (prototype . "object cairo_matrix_init_scale(float $sx, float $sy)") (purpose . "Creates a new scaling matrix") (id . "cairomatrix.initscale")) "cairo_matrix_init_rotate" ((documentation . "Creates a new rotated matrix object cairo_matrix_init_rotate(float $radians) Returns a new CairoMatrix object that can be used with surfaces, contexts, and patterns. (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Returns a new CairoMatrix object that can be used with surfaces, contexts, and patterns.
") (prototype . "object cairo_matrix_init_rotate(float $radians)") (purpose . "Creates a new rotated matrix") (id . "cairomatrix.initrotate")) "cairo_matrix_init_identity" ((documentation . "Creates a new identity matrix object cairo_matrix_init_identity() Returns a new CairoMatrix object that can be used with surfaces, contexts, and patterns. (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Returns a new CairoMatrix object that can be used with surfaces, contexts, and patterns.
") (prototype . "object cairo_matrix_init_identity()") (purpose . "Creates a new identity matrix") (id . "cairomatrix.initidentity")) "cairo_matrix_init" ((documentation . "Creates a new CairoMatrix object object cairo_matrix_init([float $xx = 1.0 [, float $yx = 0.0 [, float $xy = 0.0 [, float $yy = 1.0 [, float $x0 = 0.0 [, float $y0 = 0.0]]]]]]) Returns a new CairoMatrix object that can be used with surfaces, contexts, and patterns. (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Returns a new CairoMatrix object that can be used with surfaces, contexts, and patterns.
") (prototype . "object cairo_matrix_init([float $xx = 1.0 [, float $yx = 0.0 [, float $xy = 0.0 [, float $yy = 1.0 [, float $x0 = 0.0 [, float $y0 = 0.0]]]]]])") (purpose . "Creates a new CairoMatrix object") (id . "cairomatrix.construct")) "cairo_svg_surface_get_versions" ((documentation . "Used to retrieve a list of supported SVG versions array cairo_svg_surface_get_versions() Returns a numerically indexed array of integer values. (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Returns a numerically indexed array of integer values.
") (prototype . "array cairo_svg_surface_get_versions()") (purpose . "Used to retrieve a list of supported SVG versions") (id . "cairosvgsurface.getversions")) "cairo_user_to_device_distance" ((documentation . "The userToDeviceDistance purpose array cairo_user_to_device_distance(string $x, string $y, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "array cairo_user_to_device_distance(string $x, string $y, CairoContext $context)") (purpose . "The userToDeviceDistance purpose") (id . "cairocontext.usertodevicedistance")) "cairo_user_to_device" ((documentation . "The userToDevice purpose array cairo_user_to_device(string $x, string $y, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "array cairo_user_to_device(string $x, string $y, CairoContext $context)") (purpose . "The userToDevice purpose") (id . "cairocontext.usertodevice")) "cairo_translate" ((documentation . "The translate purpose void cairo_translate(string $tx, string $ty, CairoContext $context, string $x, string $y) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_translate(string $tx, string $ty, CairoContext $context, string $x, string $y)") (purpose . "The translate purpose") (id . "cairomatrix.translate")) "cairo_transform" ((documentation . "The transform purpose void cairo_transform(CairoMatrix $matrix, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_transform(CairoMatrix $matrix, CairoContext $context)") (purpose . "The transform purpose") (id . "cairocontext.transform")) "cairo_text_path" ((documentation . "The textPath purpose void cairo_text_path(string $string, CairoContext $context, string $text) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_text_path(string $string, CairoContext $context, string $text)") (purpose . "The textPath purpose") (id . "cairocontext.textpath")) "cairo_text_extents" ((documentation . "The textExtents purpose array cairo_text_extents(string $text, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "array cairo_text_extents(string $text, CairoContext $context)") (purpose . "The textExtents purpose") (id . "cairoscaledfont.textextents")) "cairo_stroke_preserve" ((documentation . "The strokePreserve purpose void cairo_stroke_preserve(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_stroke_preserve(CairoContext $context)") (purpose . "The strokePreserve purpose") (id . "cairocontext.strokepreserve")) "cairo_stroke_extents" ((documentation . "The strokeExtents purpose array cairo_stroke_extents(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "array cairo_stroke_extents(CairoContext $context)") (purpose . "The strokeExtents purpose") (id . "cairocontext.strokeextents")) "cairo_stroke" ((documentation . "The stroke purpose void cairo_stroke(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_stroke(CairoContext $context)") (purpose . "The stroke purpose") (id . "cairocontext.stroke")) "cairo_status" ((documentation . "The status purpose int cairo_status(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "int cairo_status(CairoContext $context)") (purpose . "The status purpose") (id . "cairopattern.status")) "cairo_show_text" ((documentation . "The showText purpose void cairo_show_text(string $text, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_show_text(string $text, CairoContext $context)") (purpose . "The showText purpose") (id . "cairocontext.showtext")) "cairo_show_page" ((documentation . "The showPage purpose void cairo_show_page(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_show_page(CairoContext $context)") (purpose . "The showPage purpose") (id . "cairosurface.showpage")) "cairo_set_tolerance" ((documentation . "The setTolerance purpose void cairo_set_tolerance(string $tolerance, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_set_tolerance(string $tolerance, CairoContext $context)") (purpose . "The setTolerance purpose") (id . "cairocontext.settolerance")) "cairo_set_source_surface" ((documentation . "The setSourceSurface purpose void cairo_set_source_surface(CairoSurface $surface [, string $x = '' [, string $y = '', CairoContext $context]]) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_set_source_surface(CairoSurface $surface [, string $x = '' [, string $y = '', CairoContext $context]])") (purpose . "The setSourceSurface purpose") (id . "cairocontext.setsourcesurface")) "cairo_set_source" ((documentation . "The setSourceRGBA purpose void cairo_set_source(string $red, string $green, string $blue, string $alpha, CairoContext $context, CairoPattern $pattern) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_set_source(string $red, string $green, string $blue, string $alpha, CairoContext $context, CairoPattern $pattern)") (purpose . "The setSourceRGBA purpose") (id . "cairocontext.setsourcergba")) "cairo_set_scaled_font" ((documentation . "The setScaledFont purpose void cairo_set_scaled_font(CairoScaledFont $scaledfont, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_set_scaled_font(CairoScaledFont $scaledfont, CairoContext $context)") (purpose . "The setScaledFont purpose") (id . "cairocontext.setscaledfont")) "cairo_set_operator" ((documentation . "The setOperator purpose void cairo_set_operator(string $setting, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_set_operator(string $setting, CairoContext $context)") (purpose . "The setOperator purpose") (id . "cairocontext.setoperator")) "cairo_set_miter_limit" ((documentation . "The setMiterLimit purpose void cairo_set_miter_limit(string $limit, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_set_miter_limit(string $limit, CairoContext $context)") (purpose . "The setMiterLimit purpose") (id . "cairocontext.setmiterlimit")) "cairo_set_matrix" ((documentation . "The setMatrix purpose void cairo_set_matrix(CairoMatrix $matrix, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_set_matrix(CairoMatrix $matrix, CairoContext $context)") (purpose . "The setMatrix purpose") (id . "cairopattern.setmatrix")) "cairo_set_line_width" ((documentation . "The setLineWidth purpose void cairo_set_line_width(string $width, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_set_line_width(string $width, CairoContext $context)") (purpose . "The setLineWidth purpose") (id . "cairocontext.setlinewidth")) "cairo_set_line_join" ((documentation . "The setLineJoin purpose void cairo_set_line_join(string $setting, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_set_line_join(string $setting, CairoContext $context)") (purpose . "The setLineJoin purpose") (id . "cairocontext.setlinejoin")) "cairo_set_line_cap" ((documentation . "The setLineCap purpose void cairo_set_line_cap(string $setting, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_set_line_cap(string $setting, CairoContext $context)") (purpose . "The setLineCap purpose") (id . "cairocontext.setlinecap")) "cairo_set_font_size" ((documentation . "The setFontSize purpose void cairo_set_font_size(string $size, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_set_font_size(string $size, CairoContext $context)") (purpose . "The setFontSize purpose") (id . "cairocontext.setfontsize")) "cairo_set_font_options" ((documentation . "The setFontOptions purpose void cairo_set_font_options(CairoFontOptions $fontoptions, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_set_font_options(CairoFontOptions $fontoptions, CairoContext $context)") (purpose . "The setFontOptions purpose") (id . "cairocontext.setfontoptions")) "cairo_set_font_matrix" ((documentation . "The setFontMatrix purpose void cairo_set_font_matrix(CairoMatrix $matrix, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_set_font_matrix(CairoMatrix $matrix, CairoContext $context)") (purpose . "The setFontMatrix purpose") (id . "cairocontext.setfontmatrix")) "cairo_set_font_face" ((documentation . "The setFontFace purpose void cairo_set_font_face(CairoFontFace $fontface, CairoContext $context) No value is returned (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "No value is returned
") (prototype . "void cairo_set_font_face(CairoFontFace $fontface, CairoContext $context)") (purpose . "The setFontFace purpose") (id . "cairocontext.setfontface")) "cairo_set_fill_rule" ((documentation . "The setFillRule purpose void cairo_set_fill_rule(string $setting, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_set_fill_rule(string $setting, CairoContext $context)") (purpose . "The setFillRule purpose") (id . "cairocontext.setfillrule")) "cairo_set_dash" ((documentation . "The setDash purpose void cairo_set_dash(array $dashes [, string $offset = '', CairoContext $context]) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_set_dash(array $dashes [, string $offset = '', CairoContext $context])") (purpose . "The setDash purpose") (id . "cairocontext.setdash")) "cairo_set_antialias" ((documentation . "The setAntialias purpose void cairo_set_antialias([string $antialias = '', CairoContext $context]) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_set_antialias([string $antialias = '', CairoContext $context])") (purpose . "The setAntialias purpose") (id . "cairofontoptions.setantialias")) "cairo_select_font_face" ((documentation . "The selectFontFace purpose void cairo_select_font_face(string $family [, string $slant = '' [, string $weight = '', CairoContext $context]]) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_select_font_face(string $family [, string $slant = '' [, string $weight = '', CairoContext $context]])") (purpose . "The selectFontFace purpose") (id . "cairocontext.selectfontface")) "cairo_scale" ((documentation . "The scale purpose void cairo_scale(string $x, string $y, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_scale(string $x, string $y, CairoContext $context)") (purpose . "The scale purpose") (id . "cairocontext.scale")) "cairo_save" ((documentation . "The save purpose void cairo_save(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_save(CairoContext $context)") (purpose . "The save purpose") (id . "cairocontext.save")) "cairo_rotate" ((documentation . "The rotate purpose void cairo_rotate(string $sx, string $sy, CairoContext $context, string $angle) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_rotate(string $sx, string $sy, CairoContext $context, string $angle)") (purpose . "The rotate purpose") (id . "cairomatrix.rotate")) "cairo_restore" ((documentation . "The restore purpose void cairo_restore(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_restore(CairoContext $context)") (purpose . "The restore purpose") (id . "cairocontext.restore")) "cairo_reset_clip" ((documentation . "The resetClip purpose void cairo_reset_clip(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_reset_clip(CairoContext $context)") (purpose . "The resetClip purpose") (id . "cairocontext.resetclip")) "cairo_rel_move_to" ((documentation . "The relMoveTo purpose void cairo_rel_move_to(string $x, string $y, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_rel_move_to(string $x, string $y, CairoContext $context)") (purpose . "The relMoveTo purpose") (id . "cairocontext.relmoveto")) "cairo_rel_line_to" ((documentation . "The relLineTo purpose void cairo_rel_line_to(string $x, string $y, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_rel_line_to(string $x, string $y, CairoContext $context)") (purpose . "The relLineTo purpose") (id . "cairocontext.rellineto")) "cairo_rel_curve_to" ((documentation . "The relCurveTo purpose void cairo_rel_curve_to(string $x1, string $y1, string $x2, string $y2, string $x3, string $y3, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_rel_curve_to(string $x1, string $y1, string $x2, string $y2, string $x3, string $y3, CairoContext $context)") (purpose . "The relCurveTo purpose") (id . "cairocontext.relcurveto")) "cairo_rectangle" ((documentation . "The rectangle purpose void cairo_rectangle(string $x, string $y, string $width, string $height, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_rectangle(string $x, string $y, string $width, string $height, CairoContext $context)") (purpose . "The rectangle purpose") (id . "cairocontext.rectangle")) "cairo_push_group_with_content" ((documentation . "The pushGroupWithContent purpose void cairo_push_group_with_content(string $content, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_push_group_with_content(string $content, CairoContext $context)") (purpose . "The pushGroupWithContent purpose") (id . "cairocontext.pushgroupwithcontent")) "cairo_push_group" ((documentation . "The pushGroup purpose void cairo_push_group(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_push_group(CairoContext $context)") (purpose . "The pushGroup purpose") (id . "cairocontext.pushgroup")) "cairo_pop_group_to_source" ((documentation . "The popGroupToSource purpose void cairo_pop_group_to_source(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_pop_group_to_source(CairoContext $context)") (purpose . "The popGroupToSource purpose") (id . "cairocontext.popgrouptosource")) "cairo_pop_group" ((documentation . "The popGroup purpose void cairo_pop_group(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_pop_group(CairoContext $context)") (purpose . "The popGroup purpose") (id . "cairocontext.popgroup")) "cairo_path_extents" ((documentation . "The pathExtents purpose array cairo_path_extents(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "array cairo_path_extents(CairoContext $context)") (purpose . "The pathExtents purpose") (id . "cairocontext.pathextents")) "cairo_paint_with_alpha" ((documentation . "The paintWithAlpha purpose void cairo_paint_with_alpha(string $alpha, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_paint_with_alpha(string $alpha, CairoContext $context)") (purpose . "The paintWithAlpha purpose") (id . "cairocontext.paintwithalpha")) "cairo_paint" ((documentation . "The paint purpose void cairo_paint(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_paint(CairoContext $context)") (purpose . "The paint purpose") (id . "cairocontext.paint")) "cairo_new_sub_path" ((documentation . "The newSubPath purpose void cairo_new_sub_path(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_new_sub_path(CairoContext $context)") (purpose . "The newSubPath purpose") (id . "cairocontext.newsubpath")) "cairo_new_path" ((documentation . "The newPath purpose void cairo_new_path(CairoContext $context) No value is returned. (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "No value is returned.
") (prototype . "void cairo_new_path(CairoContext $context)") (purpose . "The newPath purpose") (id . "cairocontext.newpath")) "cairo_move_to" ((documentation . "The moveTo purpose void cairo_move_to(string $x, string $y, CairoContext $context) No value is returned. (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "No value is returned.
") (prototype . "void cairo_move_to(string $x, string $y, CairoContext $context)") (purpose . "The moveTo purpose") (id . "cairocontext.moveto")) "cairo_mask_surface" ((documentation . "The maskSurface purpose void cairo_mask_surface(CairoSurface $surface [, string $x = '' [, string $y = '', CairoContext $context]]) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_mask_surface(CairoSurface $surface [, string $x = '' [, string $y = '', CairoContext $context]])") (purpose . "The maskSurface purpose") (id . "cairocontext.masksurface")) "cairo_mask" ((documentation . "The mask purpose void cairo_mask(CairoPattern $pattern, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_mask(CairoPattern $pattern, CairoContext $context)") (purpose . "The mask purpose") (id . "cairocontext.mask")) "cairo_line_to" ((documentation . "The lineTo purpose void cairo_line_to(string $x, string $y, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_line_to(string $x, string $y, CairoContext $context)") (purpose . "The lineTo purpose") (id . "cairocontext.lineto")) "cairo_in_stroke" ((documentation . "The inStroke purpose bool cairo_in_stroke(string $x, string $y, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "bool cairo_in_stroke(string $x, string $y, CairoContext $context)") (purpose . "The inStroke purpose") (id . "cairocontext.instroke")) "cairo_in_fill" ((documentation . "The inFill purpose bool cairo_in_fill(string $x, string $y, CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "bool cairo_in_fill(string $x, string $y, CairoContext $context)") (purpose . "The inFill purpose") (id . "cairocontext.infill")) "cairo_identity_matrix" ((documentation . "The identityMatrix purpose void cairo_identity_matrix(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_identity_matrix(CairoContext $context)") (purpose . "The identityMatrix purpose") (id . "cairocontext.identitymatrix")) "cairo_has_current_point" ((documentation . "The hasCurrentPoint purpose bool cairo_has_current_point(CairoContext $context) Whether a current point is defined (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Whether a current point is defined
") (prototype . "bool cairo_has_current_point(CairoContext $context)") (purpose . "The hasCurrentPoint purpose") (id . "cairocontext.hascurrentpoint")) "cairo_glyph_path" ((documentation . "The glyphPath purpose void cairo_glyph_path(array $glyphs, CairoContext $context) No value is returned. (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "No value is returned.
") (prototype . "void cairo_glyph_path(array $glyphs, CairoContext $context)") (purpose . "The glyphPath purpose") (id . "cairocontext.glyphpath")) "cairo_get_tolerance" ((documentation . "The getTolerance purpose float cairo_get_tolerance(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "float cairo_get_tolerance(CairoContext $context)") (purpose . "The getTolerance purpose") (id . "cairocontext.gettolerance")) "cairo_get_target" ((documentation . "The getTarget purpose void cairo_get_target(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_get_target(CairoContext $context)") (purpose . "The getTarget purpose") (id . "cairocontext.gettarget")) "cairo_get_source" ((documentation . "The getSource purpose void cairo_get_source(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_get_source(CairoContext $context)") (purpose . "The getSource purpose") (id . "cairocontext.getsource")) "cairo_get_scaled_font" ((documentation . "The getScaledFont purpose void cairo_get_scaled_font(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_get_scaled_font(CairoContext $context)") (purpose . "The getScaledFont purpose") (id . "cairocontext.getscaledfont")) "cairo_get_operator" ((documentation . "The getOperator purpose int cairo_get_operator(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "int cairo_get_operator(CairoContext $context)") (purpose . "The getOperator purpose") (id . "cairocontext.getoperator")) "cairo_get_miter_limit" ((documentation . "The getMiterLimit purpose float cairo_get_miter_limit(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "float cairo_get_miter_limit(CairoContext $context)") (purpose . "The getMiterLimit purpose") (id . "cairocontext.getmiterlimit")) "cairo_get_matrix" ((documentation . "The getMatrix purpose void cairo_get_matrix(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_get_matrix(CairoContext $context)") (purpose . "The getMatrix purpose") (id . "cairopattern.getmatrix")) "cairo_get_line_width" ((documentation . "The getLineWidth purpose float cairo_get_line_width(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "float cairo_get_line_width(CairoContext $context)") (purpose . "The getLineWidth purpose") (id . "cairocontext.getlinewidth")) "cairo_get_line_join" ((documentation . "The getLineJoin purpose int cairo_get_line_join(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "int cairo_get_line_join(CairoContext $context)") (purpose . "The getLineJoin purpose") (id . "cairocontext.getlinejoin")) "cairo_get_line_cap" ((documentation . "The getLineCap purpose int cairo_get_line_cap(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "int cairo_get_line_cap(CairoContext $context)") (purpose . "The getLineCap purpose") (id . "cairocontext.getlinecap")) "cairo_get_group_target" ((documentation . "The getGroupTarget purpose void cairo_get_group_target(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_get_group_target(CairoContext $context)") (purpose . "The getGroupTarget purpose") (id . "cairocontext.getgrouptarget")) "cairo_get_font_options" ((documentation . "The getFontOptions purpose void cairo_get_font_options(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_get_font_options(CairoContext $context)") (purpose . "The getFontOptions purpose") (id . "cairoscaledfont.getfontoptions")) "cairo_get_font_matrix" ((documentation . "The getFontMatrix purpose void cairo_get_font_matrix(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_get_font_matrix(CairoContext $context)") (purpose . "The getFontMatrix purpose") (id . "cairoscaledfont.getfontmatrix")) "cairo_get_font_face" ((documentation . "The getFontFace purpose void cairo_get_font_face(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_get_font_face(CairoContext $context)") (purpose . "The getFontFace purpose") (id . "cairoscaledfont.getfontface")) "cairo_get_fill_rule" ((documentation . "The getFillRule purpose int cairo_get_fill_rule(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "int cairo_get_fill_rule(CairoContext $context)") (purpose . "The getFillRule purpose") (id . "cairocontext.getfillrule")) "cairo_get_dash_count" ((documentation . "The getDashCount purpose int cairo_get_dash_count(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "int cairo_get_dash_count(CairoContext $context)") (purpose . "The getDashCount purpose") (id . "cairocontext.getdashcount")) "cairo_get_dash" ((documentation . "The getDash purpose array cairo_get_dash(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "array cairo_get_dash(CairoContext $context)") (purpose . "The getDash purpose") (id . "cairocontext.getdash")) "cairo_get_current_point" ((documentation . "The getCurrentPoint purpose array cairo_get_current_point(CairoContext $context) An array containing the x (index 0) and y (index 1) coordinates of the current point. (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "An array containing the x (index 0) and y (index 1) coordinates of the current point.
") (prototype . "array cairo_get_current_point(CairoContext $context)") (purpose . "The getCurrentPoint purpose") (id . "cairocontext.getcurrentpoint")) "cairo_get_antialias" ((documentation . "The getAntialias purpose int cairo_get_antialias(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "int cairo_get_antialias(CairoContext $context)") (purpose . "The getAntialias purpose") (id . "cairofontoptions.getantialias")) "cairo_font_extents" ((documentation . "Get the font extents array cairo_font_extents(CairoContext $context) An array containing the font extents for the current font. (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "An array containing the font extents for the current font.
") (prototype . "array cairo_font_extents(CairoContext $context)") (purpose . "Get the font extents") (id . "cairocontext.fontextents")) "cairo_fill_preserve" ((documentation . "Fills and preserve the current path void cairo_fill_preserve(CairoContext $context) No value is returned. (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "No value is returned.
") (prototype . "void cairo_fill_preserve(CairoContext $context)") (purpose . "Fills and preserve the current path") (id . "cairocontext.fillpreserve")) "cairo_fill_extents" ((documentation . "Computes the filled area array cairo_fill_extents(CairoContext $context) An array with the coordinates of the afected area (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "An array with the coordinates of the afected area
") (prototype . "array cairo_fill_extents(CairoContext $context)") (purpose . "Computes the filled area") (id . "cairocontext.fillextents")) "cairo_fill" ((documentation . "Fills the current path void cairo_fill(CairoContext $context) No value is returned. (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "No value is returned.
") (prototype . "void cairo_fill(CairoContext $context)") (purpose . "Fills the current path") (id . "cairocontext.fill")) "cairo_device_to_user_distance" ((documentation . "Transform a distance array cairo_device_to_user_distance(float $x, float $y, CairoContext $context) Returns an array with the x and y values of a distance vector in the user-space (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Returns an array with the x and y values of a distance vector in the user-space
") (prototype . "array cairo_device_to_user_distance(float $x, float $y, CairoContext $context)") (purpose . "Transform a distance") (id . "cairocontext.devicetouserdistance")) "cairo_device_to_user" ((documentation . "Transform a coordinate array cairo_device_to_user(float $x, float $y, CairoContext $context) An array containing the x and y coordinates in the user-space (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "An array containing the x and y coordinates in the user-space
") (prototype . "array cairo_device_to_user(float $x, float $y, CairoContext $context)") (purpose . "Transform a coordinate") (id . "cairocontext.devicetouser")) "cairo_curve_to" ((documentation . "Adds a curve void cairo_curve_to(float $x1, float $y1, float $x2, float $y2, float $x3, float $y3, CairoContext $context) No value is returned. (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "No value is returned.
") (prototype . "void cairo_curve_to(float $x1, float $y1, float $x2, float $y2, float $x3, float $y3, CairoContext $context)") (purpose . "Adds a curve") (id . "cairocontext.curveto")) "cairo_copy_path_flat" ((documentation . "Gets a flattened copy of the current path CairoPath cairo_copy_path_flat(CairoContext $context) A copy of the current path (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "A copy of the current path
") (prototype . "CairoPath cairo_copy_path_flat(CairoContext $context)") (purpose . "Gets a flattened copy of the current path") (id . "cairocontext.copypathflat")) "cairo_copy_path" ((documentation . "Creates a copy of the current path CairoPath cairo_copy_path(CairoContext $context) A copy of the current CairoPath in the context (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "A copy of the current CairoPath in the context
") (prototype . "CairoPath cairo_copy_path(CairoContext $context)") (purpose . "Creates a copy of the current path") (id . "cairocontext.copypath")) "cairo_copy_page" ((documentation . "The copyPage purpose void cairo_copy_page(CairoContext $context) Description... (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Description...
") (prototype . "void cairo_copy_page(CairoContext $context)") (purpose . "The copyPage purpose") (id . "cairosurface.copypage")) "cairo_close_path" ((documentation . "Closes the current path void cairo_close_path(CairoContext $context) No value is returned. (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "No value is returned.
") (prototype . "void cairo_close_path(CairoContext $context)") (purpose . "Closes the current path") (id . "cairocontext.closepath")) "cairo_clip_rectangle_list" ((documentation . "Retrieves the current clip as a list of rectangles array cairo_clip_rectangle_list(CairoContext $context) An array of user-space represented rectangles for the current clip (The status in the list may be CAIRO_STATUS_CLIP_NOT_REPRESENTABLE to indicate that the clip region cannot be represented as a list of user-space rectangles. The status may have other values to indicate other errors.) (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "An array of user-space represented rectangles for the current clip
(The status in the list may be CAIRO_STATUS_CLIP_NOT_REPRESENTABLE to indicate that the clip region cannot be represented as a list of user-space rectangles. The status may have other values to indicate other errors.)
") (prototype . "array cairo_clip_rectangle_list(CairoContext $context)") (purpose . "Retrieves the current clip as a list of rectangles") (id . "cairocontext.cliprectanglelist")) "cairo_clip_preserve" ((documentation . "Establishes a new clip region from the current clip void cairo_clip_preserve(CairoContext $context) No value is returned. (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "No value is returned.
") (prototype . "void cairo_clip_preserve(CairoContext $context)") (purpose . "Establishes a new clip region from the current clip") (id . "cairocontext.clippreserve")) "cairo_clip_extents" ((documentation . "Computes the area inside the current clip array cairo_clip_extents(CairoContext $context) An array containing the (float)x1, (float)y1, (float)x2, (float)y2, coordinates covering the area inside the current clip (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "An array containing the (float)x1, (float)y1, (float)x2, (float)y2, coordinates covering the area inside the current clip
") (prototype . "array cairo_clip_extents(CairoContext $context)") (purpose . "Computes the area inside the current clip") (id . "cairocontext.clipextents")) "cairo_clip" ((documentation . "Establishes a new clip region void cairo_clip(CairoContext $context) No value is returned. (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "No value is returned.
") (prototype . "void cairo_clip(CairoContext $context)") (purpose . "Establishes a new clip region") (id . "cairocontext.clip")) "cairo_arc_negative" ((documentation . "Adds a negative arc void cairo_arc_negative(float $x, float $y, float $radius, float $angle1, float $angle2, CairoContext $context) No value is returned. (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "No value is returned.
") (prototype . "void cairo_arc_negative(float $x, float $y, float $radius, float $angle1, float $angle2, CairoContext $context)") (purpose . "Adds a negative arc") (id . "cairocontext.arcnegative")) "cairo_arc" ((documentation . "Adds a circular arc void cairo_arc(float $x, float $y, float $radius, float $angle1, float $angle2, CairoContext $context) No value is returned. (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "No value is returned.
") (prototype . "void cairo_arc(float $x, float $y, float $radius, float $angle1, float $angle2, CairoContext $context)") (purpose . "Adds a circular arc") (id . "cairocontext.arc")) "cairo_append_path" ((documentation . "Appends a path to current path void cairo_append_path(CairoPath $path, CairoContext $context) No value is returned. (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "No value is returned.
") (prototype . "void cairo_append_path(CairoPath $path, CairoContext $context)") (purpose . "Appends a path to current path") (id . "cairocontext.appendpath")) "cairo_version_string" ((documentation . "Retrieves cairo version as string string cairo_version_string() Current Cairo library version string (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Current Cairo library version string
") (prototype . "string cairo_version_string()") (purpose . "Retrieves cairo version as string") (id . "cairo.versionstring")) "cairo_version" ((documentation . "Retrives cairo's library version int cairo_version() Current Cairo library version integer (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Current Cairo library version integer
") (prototype . "int cairo_version()") (purpose . "Retrives cairo's library version") (id . "cairo.version")) "cairo_status_to_string" ((documentation . "Retrieves the current status as string string cairo_status_to_string(int $status) A string containing the current status of a CairoContext object (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "A string containing the current status of a CairoContext object
") (prototype . "string cairo_status_to_string(int $status)") (purpose . "Retrieves the current status as string") (id . "cairo.statustostring")) "cairo_available_surfaces" ((documentation . "Retrieves all available surfaces array cairo_available_surfaces() A list-type array with all available surface backends. (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "A list-type array with all available surface backends.
") (prototype . "array cairo_available_surfaces()") (purpose . "Retrieves all available surfaces") (id . "cairo.availablesurfaces")) "cairo_available_fonts" ((documentation . "Retrieves the availables font types array cairo_available_fonts() A list-type array with all available font backends. (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "A list-type array with all available font backends.
") (prototype . "array cairo_available_fonts()") (purpose . "Retrieves the availables font types") (id . "cairo.availablefonts")) "cairo_svg_version_to_string" ((documentation . "Description string cairo_svg_version_to_string(int $version) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "string cairo_svg_version_to_string(int $version)") (purpose . "Description") (id . "function.cairo-svg-version-to-string")) "cairo_svg_surface_restrict_to_version" ((documentation . "Description void cairo_svg_surface_restrict_to_version(CairoSvgSurface $surface, int $version) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_svg_surface_restrict_to_version(CairoSvgSurface $surface, int $version)") (purpose . "Description") (id . "function.cairo-svg-surface-restrict-to-version")) "cairo_svg_surface_create" ((documentation . "Description CairoSvgSurface cairo_svg_surface_create(string $file, float $width, float $height) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "CairoSvgSurface cairo_svg_surface_create(string $file, float $width, float $height)") (purpose . "Description") (id . "function.cairo-svg-surface-create")) "cairo_surface_write_to_png" ((documentation . "Description void cairo_surface_write_to_png(CairoSurface $surface, resource $stream) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_surface_write_to_png(CairoSurface $surface, resource $stream)") (purpose . "Description") (id . "function.cairo-surface-write-to-png")) "cairo_surface_status" ((documentation . "Description int cairo_surface_status(CairoSurface $surface) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "int cairo_surface_status(CairoSurface $surface)") (purpose . "Description") (id . "function.cairo-surface-status")) "cairo_surface_show_page" ((documentation . "Description void cairo_surface_show_page(CairoSurface $surface) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_surface_show_page(CairoSurface $surface)") (purpose . "Description") (id . "function.cairo-surface-show-page")) "cairo_surface_set_fallback_resolution" ((documentation . "Description void cairo_surface_set_fallback_resolution(CairoSurface $surface, float $x, float $y) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_surface_set_fallback_resolution(CairoSurface $surface, float $x, float $y)") (purpose . "Description") (id . "function.cairo-surface-set-fallback-resolution")) "cairo_surface_set_device_offset" ((documentation . "Description void cairo_surface_set_device_offset(CairoSurface $surface, float $x, float $y) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_surface_set_device_offset(CairoSurface $surface, float $x, float $y)") (purpose . "Description") (id . "function.cairo-surface-set-device-offset")) "cairo_surface_mark_dirty" ((documentation . "Description void cairo_surface_mark_dirty(CairoSurface $surface) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_surface_mark_dirty(CairoSurface $surface)") (purpose . "Description") (id . "function.cairo-surface-mark-dirty")) "cairo_surface_mark_dirty_rectangle" ((documentation . "Description void cairo_surface_mark_dirty_rectangle(CairoSurface $surface, float $x, float $y, float $width, float $height) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_surface_mark_dirty_rectangle(CairoSurface $surface, float $x, float $y, float $width, float $height)") (purpose . "Description") (id . "function.cairo-surface-mark-dirty-rectangle")) "cairo_surface_get_type" ((documentation . "Description int cairo_surface_get_type(CairoSurface $surface) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "int cairo_surface_get_type(CairoSurface $surface)") (purpose . "Description") (id . "function.cairo-surface-get-type")) "cairo_surface_get_font_options" ((documentation . "Description CairoFontOptions cairo_surface_get_font_options(CairoSurface $surface) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "CairoFontOptions cairo_surface_get_font_options(CairoSurface $surface)") (purpose . "Description") (id . "function.cairo-surface-get-font-options")) "cairo_surface_get_device_offset" ((documentation . "Description array cairo_surface_get_device_offset(CairoSurface $surface) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "array cairo_surface_get_device_offset(CairoSurface $surface)") (purpose . "Description") (id . "function.cairo-surface-get-device-offset")) "cairo_surface_get_content" ((documentation . "Description int cairo_surface_get_content(CairoSurface $surface) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "int cairo_surface_get_content(CairoSurface $surface)") (purpose . "Description") (id . "function.cairo-surface-get-content")) "cairo_surface_flush" ((documentation . "Description void cairo_surface_flush(CairoSurface $surface) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_surface_flush(CairoSurface $surface)") (purpose . "Description") (id . "function.cairo-surface-flush")) "cairo_surface_finish" ((documentation . "Description void cairo_surface_finish(CairoSurface $surface) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_surface_finish(CairoSurface $surface)") (purpose . "Description") (id . "function.cairo-surface-finish")) "cairo_surface_create_similar" ((documentation . "Description CairoSurface cairo_surface_create_similar(CairoSurface $surface, int $content, float $width, float $height) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "CairoSurface cairo_surface_create_similar(CairoSurface $surface, int $content, float $width, float $height)") (purpose . "Description") (id . "function.cairo-surface-create-similar")) "cairo_surface_copy_page" ((documentation . "Description void cairo_surface_copy_page(CairoSurface $surface) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_surface_copy_page(CairoSurface $surface)") (purpose . "Description") (id . "function.cairo-surface-copy-page")) "cairo_scaled_font_text_extents" ((documentation . "Description array cairo_scaled_font_text_extents(CairoScaledFont $scaledfont, string $text) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "array cairo_scaled_font_text_extents(CairoScaledFont $scaledfont, string $text)") (purpose . "Description") (id . "function.cairo-scaled-font-text-extents")) "cairo_scaled_font_status" ((documentation . "Description int cairo_scaled_font_status(CairoScaledFont $scaledfont) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "int cairo_scaled_font_status(CairoScaledFont $scaledfont)") (purpose . "Description") (id . "function.cairo-scaled-font-status")) "cairo_scaled_font_glyph_extents" ((documentation . "Description array cairo_scaled_font_glyph_extents(CairoScaledFont $scaledfont, array $glyphs) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "array cairo_scaled_font_glyph_extents(CairoScaledFont $scaledfont, array $glyphs)") (purpose . "Description") (id . "function.cairo-scaled-font-glyph-extents")) "cairo_scaled_font_get_type" ((documentation . "Description int cairo_scaled_font_get_type(CairoScaledFont $scaledfont) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "int cairo_scaled_font_get_type(CairoScaledFont $scaledfont)") (purpose . "Description") (id . "function.cairo-scaled-font-get-type")) "cairo_scaled_font_get_scale_matrix" ((documentation . "Description CairoMatrix cairo_scaled_font_get_scale_matrix(CairoScaledFont $scaledfont) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "CairoMatrix cairo_scaled_font_get_scale_matrix(CairoScaledFont $scaledfont)") (purpose . "Description") (id . "function.cairo-scaled-font-get-scale-matrix")) "cairo_scaled_font_get_font_options" ((documentation . "Description CairoFontOptions cairo_scaled_font_get_font_options(CairoScaledFont $scaledfont) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "CairoFontOptions cairo_scaled_font_get_font_options(CairoScaledFont $scaledfont)") (purpose . "Description") (id . "function.cairo-scaled-font-get-font-options")) "cairo_scaled_font_get_font_matrix" ((documentation . "Description CairoFontOptions cairo_scaled_font_get_font_matrix(CairoScaledFont $scaledfont) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "CairoFontOptions cairo_scaled_font_get_font_matrix(CairoScaledFont $scaledfont)") (purpose . "Description") (id . "function.cairo-scaled-font-get-font-matrix")) "cairo_scaled_font_get_font_face" ((documentation . "Description CairoFontFace cairo_scaled_font_get_font_face(CairoScaledFont $scaledfont) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "CairoFontFace cairo_scaled_font_get_font_face(CairoScaledFont $scaledfont)") (purpose . "Description") (id . "function.cairo-scaled-font-get-font-face")) "cairo_scaled_font_get_ctm" ((documentation . "Description CairoMatrix cairo_scaled_font_get_ctm(CairoScaledFont $scaledfont) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "CairoMatrix cairo_scaled_font_get_ctm(CairoScaledFont $scaledfont)") (purpose . "Description") (id . "function.cairo-scaled-font-get-ctm")) "cairo_scaled_font_extents" ((documentation . "Description array cairo_scaled_font_extents(CairoScaledFont $scaledfont) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "array cairo_scaled_font_extents(CairoScaledFont $scaledfont)") (purpose . "Description") (id . "function.cairo-scaled-font-extents")) "cairo_scaled_font_create" ((documentation . "Description CairoScaledFont cairo_scaled_font_create(CairoFontFace $fontface, CairoMatrix $matrix, CairoMatrix $ctm, CairoFontOptions $fontoptions) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "CairoScaledFont cairo_scaled_font_create(CairoFontFace $fontface, CairoMatrix $matrix, CairoMatrix $ctm, CairoFontOptions $fontoptions)") (purpose . "Description") (id . "function.cairo-scaled-font-create")) "cairo_ps_surface_set_size" ((documentation . "Description void cairo_ps_surface_set_size(CairoPsSurface $surface, float $width, float $height) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_ps_surface_set_size(CairoPsSurface $surface, float $width, float $height)") (purpose . "Description") (id . "function.cairo-ps-surface-set-size")) "cairo_ps_surface_set_eps" ((documentation . "Description void cairo_ps_surface_set_eps(CairoPsSurface $surface, bool $level) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_ps_surface_set_eps(CairoPsSurface $surface, bool $level)") (purpose . "Description") (id . "function.cairo-ps-surface-set-eps")) "cairo_ps_surface_restrict_to_level" ((documentation . "Description void cairo_ps_surface_restrict_to_level(CairoPsSurface $surface, int $level) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_ps_surface_restrict_to_level(CairoPsSurface $surface, int $level)") (purpose . "Description") (id . "function.cairo-ps-surface-restrict-to-level")) "cairo_ps_surface_get_eps" ((documentation . "Description bool cairo_ps_surface_get_eps(CairoPsSurface $surface) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "bool cairo_ps_surface_get_eps(CairoPsSurface $surface)") (purpose . "Description") (id . "function.cairo-ps-surface-get-eps")) "cairo_ps_surface_dsc_comment" ((documentation . "Description void cairo_ps_surface_dsc_comment(CairoPsSurface $surface, string $comment) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_ps_surface_dsc_comment(CairoPsSurface $surface, string $comment)") (purpose . "Description") (id . "function.cairo-ps-surface-dsc-comment")) "cairo_ps_surface_dsc_begin_setup" ((documentation . "Description void cairo_ps_surface_dsc_begin_setup(CairoPsSurface $surface) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_ps_surface_dsc_begin_setup(CairoPsSurface $surface)") (purpose . "Description") (id . "function.cairo-ps-surface-dsc-begin-setup")) "cairo_ps_surface_dsc_begin_page_setup" ((documentation . "Description void cairo_ps_surface_dsc_begin_page_setup(CairoPsSurface $surface) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_ps_surface_dsc_begin_page_setup(CairoPsSurface $surface)") (purpose . "Description") (id . "function.cairo-ps-surface-dsc-begin-page-setup")) "cairo_ps_surface_create" ((documentation . "Description CairoPsSurface cairo_ps_surface_create(string $file, float $width, float $height) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "CairoPsSurface cairo_ps_surface_create(string $file, float $width, float $height)") (purpose . "Description") (id . "function.cairo-ps-surface-create")) "cairo_ps_level_to_string" ((documentation . "Description string cairo_ps_level_to_string(int $level) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "string cairo_ps_level_to_string(int $level)") (purpose . "Description") (id . "function.cairo-ps-level-to-string")) "cairo_ps_get_levels" ((documentation . "Description array cairo_ps_get_levels() What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "array cairo_ps_get_levels()") (purpose . "Description") (id . "function.cairo-ps-get-levels")) "cairo_pdf_surface_set_size" ((documentation . "Description void cairo_pdf_surface_set_size(CairoPdfSurface $surface, float $width, float $height) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_pdf_surface_set_size(CairoPdfSurface $surface, float $width, float $height)") (purpose . "Description") (id . "function.cairo-pdf-surface-set-size")) "cairo_pdf_surface_create" ((documentation . "Description CairoPdfSurface cairo_pdf_surface_create(string $file, float $width, float $height) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "CairoPdfSurface cairo_pdf_surface_create(string $file, float $width, float $height)") (purpose . "Description") (id . "function.cairo-pdf-surface-create")) "cairo_pattern_status" ((documentation . "Description int cairo_pattern_status(CairoPattern $pattern) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "int cairo_pattern_status(CairoPattern $pattern)") (purpose . "Description") (id . "function.cairo-pattern-status")) "cairo_pattern_set_matrix" ((documentation . "Description void cairo_pattern_set_matrix(CairoPattern $pattern, CairoMatrix $matrix) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_pattern_set_matrix(CairoPattern $pattern, CairoMatrix $matrix)") (purpose . "Description") (id . "function.cairo-pattern-set-matrix")) "cairo_pattern_set_filter" ((documentation . "Description void cairo_pattern_set_filter(CairoSurfacePattern $pattern, int $filter) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_pattern_set_filter(CairoSurfacePattern $pattern, int $filter)") (purpose . "Description") (id . "function.cairo-pattern-set-filter")) "cairo_pattern_set_extend" ((documentation . "Description void cairo_pattern_set_extend(string $pattern, string $extend) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_pattern_set_extend(string $pattern, string $extend)") (purpose . "Description") (id . "function.cairo-pattern-set-extend")) "cairo_pattern_get_type" ((documentation . "Description int cairo_pattern_get_type(CairoPattern $pattern) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "int cairo_pattern_get_type(CairoPattern $pattern)") (purpose . "Description") (id . "function.cairo-pattern-get-type")) "cairo_pattern_get_surface" ((documentation . "Description CairoSurface cairo_pattern_get_surface(CairoSurfacePattern $pattern) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "CairoSurface cairo_pattern_get_surface(CairoSurfacePattern $pattern)") (purpose . "Description") (id . "function.cairo-pattern-get-surface")) "cairo_pattern_get_rgba" ((documentation . "Description array cairo_pattern_get_rgba(CairoSolidPattern $pattern) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "array cairo_pattern_get_rgba(CairoSolidPattern $pattern)") (purpose . "Description") (id . "function.cairo-pattern-get-rgba")) "cairo_pattern_get_radial_circles" ((documentation . "Description array cairo_pattern_get_radial_circles(CairoRadialGradient $pattern) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "array cairo_pattern_get_radial_circles(CairoRadialGradient $pattern)") (purpose . "Description") (id . "function.cairo-pattern-get-radial-circles")) "cairo_pattern_get_matrix" ((documentation . "Description CairoMatrix cairo_pattern_get_matrix(CairoPattern $pattern) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "CairoMatrix cairo_pattern_get_matrix(CairoPattern $pattern)") (purpose . "Description") (id . "function.cairo-pattern-get-matrix")) "cairo_pattern_get_linear_points" ((documentation . "Description array cairo_pattern_get_linear_points(CairoLinearGradient $pattern) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "array cairo_pattern_get_linear_points(CairoLinearGradient $pattern)") (purpose . "Description") (id . "function.cairo-pattern-get-linear-points")) "cairo_pattern_get_filter" ((documentation . "Description int cairo_pattern_get_filter(CairoSurfacePattern $pattern) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "int cairo_pattern_get_filter(CairoSurfacePattern $pattern)") (purpose . "Description") (id . "function.cairo-pattern-get-filter")) "cairo_pattern_get_extend" ((documentation . "Description int cairo_pattern_get_extend(string $pattern) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "int cairo_pattern_get_extend(string $pattern)") (purpose . "Description") (id . "function.cairo-pattern-get-extend")) "cairo_pattern_get_color_stop_rgba" ((documentation . "Description array cairo_pattern_get_color_stop_rgba(CairoGradientPattern $pattern, int $index) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "array cairo_pattern_get_color_stop_rgba(CairoGradientPattern $pattern, int $index)") (purpose . "Description") (id . "function.cairo-pattern-get-color-stop-rgba")) "cairo_pattern_get_color_stop_count" ((documentation . "Description int cairo_pattern_get_color_stop_count(CairoGradientPattern $pattern) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "int cairo_pattern_get_color_stop_count(CairoGradientPattern $pattern)") (purpose . "Description") (id . "function.cairo-pattern-get-color-stop-count")) "cairo_pattern_create_rgba" ((documentation . "Description CairoPattern cairo_pattern_create_rgba(float $red, float $green, float $blue, float $alpha) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "CairoPattern cairo_pattern_create_rgba(float $red, float $green, float $blue, float $alpha)") (purpose . "Description") (id . "function.cairo-pattern-create-rgba")) "cairo_pattern_create_rgb" ((documentation . "Description CairoPattern cairo_pattern_create_rgb(float $red, float $green, float $blue) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "CairoPattern cairo_pattern_create_rgb(float $red, float $green, float $blue)") (purpose . "Description") (id . "function.cairo-pattern-create-rgb")) "cairo_pattern_create_radial" ((documentation . "Description CairoPattern cairo_pattern_create_radial(float $x0, float $y0, float $r0, float $x1, float $y1, float $r1) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "CairoPattern cairo_pattern_create_radial(float $x0, float $y0, float $r0, float $x1, float $y1, float $r1)") (purpose . "Description") (id . "function.cairo-pattern-create-radial")) "cairo_pattern_create_linear" ((documentation . "Description CairoPattern cairo_pattern_create_linear(float $x0, float $y0, float $x1, float $y1) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "CairoPattern cairo_pattern_create_linear(float $x0, float $y0, float $x1, float $y1)") (purpose . "Description") (id . "function.cairo-pattern-create-linear")) "cairo_pattern_create_for_surface" ((documentation . "Description CairoPattern cairo_pattern_create_for_surface(CairoSurface $surface) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "CairoPattern cairo_pattern_create_for_surface(CairoSurface $surface)") (purpose . "Description") (id . "function.cairo-pattern-create-for-surface")) "cairo_pattern_add_color_stop_rgba" ((documentation . "Description void cairo_pattern_add_color_stop_rgba(CairoGradientPattern $pattern, float $offset, float $red, float $green, float $blue, float $alpha) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_pattern_add_color_stop_rgba(CairoGradientPattern $pattern, float $offset, float $red, float $green, float $blue, float $alpha)") (purpose . "Description") (id . "function.cairo-pattern-add-color-stop-rgba")) "cairo_pattern_add_color_stop_rgb" ((documentation . "Description void cairo_pattern_add_color_stop_rgb(CairoGradientPattern $pattern, float $offset, float $red, float $green, float $blue) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_pattern_add_color_stop_rgb(CairoGradientPattern $pattern, float $offset, float $red, float $green, float $blue)") (purpose . "Description") (id . "function.cairo-pattern-add-color-stop-rgb")) "cairo_matrix_translate" ((documentation . "Description void cairo_matrix_translate(CairoMatrix $matrix, float $tx, float $ty) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_matrix_translate(CairoMatrix $matrix, float $tx, float $ty)") (purpose . "Description") (id . "function.cairo-matrix-translate")) "cairo_matrix_transform_point" ((documentation . "Description array cairo_matrix_transform_point(CairoMatrix $matrix, float $dx, float $dy) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "array cairo_matrix_transform_point(CairoMatrix $matrix, float $dx, float $dy)") (purpose . "Description") (id . "function.cairo-matrix-transform-point")) "cairo_matrix_transform_distance" ((documentation . "Description array cairo_matrix_transform_distance(CairoMatrix $matrix, float $dx, float $dy) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "array cairo_matrix_transform_distance(CairoMatrix $matrix, float $dx, float $dy)") (purpose . "Description") (id . "function.cairo-matrix-transform-distance")) "cairo_matrix_rotate" ((documentation . "Description void cairo_matrix_rotate(CairoMatrix $matrix, float $radians) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_matrix_rotate(CairoMatrix $matrix, float $radians)") (purpose . "Description") (id . "function.cairo-matrix-rotate")) "cairo_matrix_multiply" ((documentation . "Description CairoMatrix cairo_matrix_multiply(CairoMatrix $matrix1, CairoMatrix $matrix2) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "CairoMatrix cairo_matrix_multiply(CairoMatrix $matrix1, CairoMatrix $matrix2)") (purpose . "Description") (id . "function.cairo-matrix-multiply")) "cairo_matrix_invert" ((documentation . "Description void cairo_matrix_invert(CairoMatrix $matrix) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_matrix_invert(CairoMatrix $matrix)") (purpose . "Description") (id . "function.cairo-matrix-invert")) "cairo_matrix_create_translate" ((documentation . "Alias of CairoMatrix::initTranslate cairo_matrix_create_translate() (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "") (prototype . " cairo_matrix_create_translate()") (purpose . "Alias of CairoMatrix::initTranslate") (id . "function.cairo-matrix-create-translate")) "cairo_matrix_create_scale" ((documentation . "Creates a new scaling matrix object cairo_matrix_create_scale(float $sx, float $sy) Returns a new CairoMatrix object that can be used with surfaces, contexts, and patterns. (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "Returns a new CairoMatrix object that can be used with surfaces, contexts, and patterns.
") (prototype . "object cairo_matrix_create_scale(float $sx, float $sy)") (purpose . "Creates a new scaling matrix") (id . "cairomatrix.initscale")) "cairo_image_surface_get_width" ((documentation . "Description int cairo_image_surface_get_width(CairoImageSurface $surface) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "int cairo_image_surface_get_width(CairoImageSurface $surface)") (purpose . "Description") (id . "function.cairo-image-surface-get-width")) "cairo_image_surface_get_stride" ((documentation . "Description int cairo_image_surface_get_stride(CairoImageSurface $surface) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "int cairo_image_surface_get_stride(CairoImageSurface $surface)") (purpose . "Description") (id . "function.cairo-image-surface-get-stride")) "cairo_image_surface_get_height" ((documentation . "Description int cairo_image_surface_get_height(CairoImageSurface $surface) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "int cairo_image_surface_get_height(CairoImageSurface $surface)") (purpose . "Description") (id . "function.cairo-image-surface-get-height")) "cairo_image_surface_get_format" ((documentation . "Description int cairo_image_surface_get_format(CairoImageSurface $surface) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "int cairo_image_surface_get_format(CairoImageSurface $surface)") (purpose . "Description") (id . "function.cairo-image-surface-get-format")) "cairo_image_surface_get_data" ((documentation . "Description string cairo_image_surface_get_data(CairoImageSurface $surface) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "string cairo_image_surface_get_data(CairoImageSurface $surface)") (purpose . "Description") (id . "function.cairo-image-surface-get-data")) "cairo_image_surface_create" ((documentation . "Description CairoImageSurface cairo_image_surface_create(int $format, int $width, int $height) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "CairoImageSurface cairo_image_surface_create(int $format, int $width, int $height)") (purpose . "Description") (id . "function.cairo-image-surface-create")) "cairo_image_surface_create_from_png" ((documentation . "Description CairoImageSurface cairo_image_surface_create_from_png(string $file) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "CairoImageSurface cairo_image_surface_create_from_png(string $file)") (purpose . "Description") (id . "function.cairo-image-surface-create-from-png")) "cairo_image_surface_create_for_data" ((documentation . "Description CairoImageSurface cairo_image_surface_create_for_data(string $data, int $format, int $width, int $height [, int $stride = -1]) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "CairoImageSurface cairo_image_surface_create_for_data(string $data, int $format, int $width, int $height [, int $stride = -1])") (purpose . "Description") (id . "function.cairo-image-surface-create-for-data")) "cairo_format_stride_for_width" ((documentation . "Description int cairo_format_stride_for_width(int $format, int $width) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "int cairo_format_stride_for_width(int $format, int $width)") (purpose . "Description") (id . "function.cairo-format-stride-for-width")) "cairo_font_options_status" ((documentation . "Description int cairo_font_options_status(CairoFontOptions $options) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "int cairo_font_options_status(CairoFontOptions $options)") (purpose . "Description") (id . "function.cairo-font-options-status")) "cairo_font_options_set_subpixel_order" ((documentation . "Description void cairo_font_options_set_subpixel_order(CairoFontOptions $options, int $subpixel_order) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_font_options_set_subpixel_order(CairoFontOptions $options, int $subpixel_order)") (purpose . "Description") (id . "function.cairo-font-options-set-subpixel-order")) "cairo_font_options_set_hint_style" ((documentation . "Description void cairo_font_options_set_hint_style(CairoFontOptions $options, int $hint_style) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_font_options_set_hint_style(CairoFontOptions $options, int $hint_style)") (purpose . "Description") (id . "function.cairo-font-options-set-hint-style")) "cairo_font_options_set_hint_metrics" ((documentation . "Description void cairo_font_options_set_hint_metrics(CairoFontOptions $options, int $hint_metrics) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_font_options_set_hint_metrics(CairoFontOptions $options, int $hint_metrics)") (purpose . "Description") (id . "function.cairo-font-options-set-hint-metrics")) "cairo_font_options_set_antialias" ((documentation . "Description void cairo_font_options_set_antialias(CairoFontOptions $options, int $antialias) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_font_options_set_antialias(CairoFontOptions $options, int $antialias)") (purpose . "Description") (id . "function.cairo-font-options-set-antialias")) "cairo_font_options_merge" ((documentation . "Description void cairo_font_options_merge(CairoFontOptions $options, CairoFontOptions $other) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "void cairo_font_options_merge(CairoFontOptions $options, CairoFontOptions $other)") (purpose . "Description") (id . "function.cairo-font-options-merge")) "cairo_font_options_hash" ((documentation . "Description int cairo_font_options_hash(CairoFontOptions $options) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "int cairo_font_options_hash(CairoFontOptions $options)") (purpose . "Description") (id . "function.cairo-font-options-hash")) "cairo_font_options_get_subpixel_order" ((documentation . "Description int cairo_font_options_get_subpixel_order(CairoFontOptions $options) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "int cairo_font_options_get_subpixel_order(CairoFontOptions $options)") (purpose . "Description") (id . "function.cairo-font-options-get-subpixel-order")) "cairo_font_options_get_hint_style" ((documentation . "Description int cairo_font_options_get_hint_style(CairoFontOptions $options) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "int cairo_font_options_get_hint_style(CairoFontOptions $options)") (purpose . "Description") (id . "function.cairo-font-options-get-hint-style")) "cairo_font_options_get_hint_metrics" ((documentation . "Description int cairo_font_options_get_hint_metrics(CairoFontOptions $options) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "int cairo_font_options_get_hint_metrics(CairoFontOptions $options)") (purpose . "Description") (id . "function.cairo-font-options-get-hint-metrics")) "cairo_font_options_get_antialias" ((documentation . "Description int cairo_font_options_get_antialias(CairoFontOptions $options) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "int cairo_font_options_get_antialias(CairoFontOptions $options)") (purpose . "Description") (id . "function.cairo-font-options-get-antialias")) "cairo_font_options_equal" ((documentation . "Description bool cairo_font_options_equal(CairoFontOptions $options, CairoFontOptions $other) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "bool cairo_font_options_equal(CairoFontOptions $options, CairoFontOptions $other)") (purpose . "Description") (id . "function.cairo-font-options-equal")) "cairo_font_options_create" ((documentation . "Description CairoFontOptions cairo_font_options_create() What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "CairoFontOptions cairo_font_options_create()") (purpose . "Description") (id . "function.cairo-font-options-create")) "cairo_font_face_status" ((documentation . "Check for CairoFontFace errors int cairo_font_face_status(CairoFontFace $fontface) CAIRO_STATUS_SUCCESS or another error such as CAIRO_STATUS_NO_MEMORY. (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "CAIRO_STATUS_SUCCESS or another error such as CAIRO_STATUS_NO_MEMORY.
") (prototype . "int cairo_font_face_status(CairoFontFace $fontface)") (purpose . "Check for CairoFontFace errors") (id . "cairofontface.status")) "cairo_font_face_get_type" ((documentation . "Description int cairo_font_face_get_type(CairoFontFace $fontface) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "int cairo_font_face_get_type(CairoFontFace $fontface)") (purpose . "Description") (id . "function.cairo-font-face-get-type")) "cairo_create" ((documentation . "Returns a new CairoContext object on the requested surface. CairoContext cairo_create(CairoSurface $surface) What is returned on success and failure (PECL cairo >= 0.1.0)") (versions . "PECL cairo >= 0.1.0") (return . "What is returned on success and failure
") (prototype . "CairoContext cairo_create(CairoSurface $surface)") (purpose . "Returns a new CairoContext object on the requested surface.") (id . "function.cairo-create")) "recode" ((documentation . "Alias of recode_string recode() (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "") (prototype . " recode()") (purpose . "Alias of recode_string") (id . "function.recode")) "recode_string" ((documentation . "Recode a string according to a recode request string recode_string(string $request, string $string) Returns the recoded string or FALSE, if unable to perform the recode request. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns the recoded string or FALSE, if unable to perform the recode request.
Returns FALSE, if unable to comply, TRUE otherwise.
Returns an array of possible spellings.
") (prototype . "array pspell_suggest(int $dictionary_link, string $word)") (purpose . "Suggest spellings of a word") (id . "function.pspell-suggest")) "pspell_store_replacement" ((documentation . "Store a replacement pair for a word bool pspell_store_replacement(int $dictionary_link, string $misspelled, string $correct) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.2, PHP 5)") (versions . "PHP 4 >= 4.0.2, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the dictionary link identifier on success or FALSE on failure.
Returns the dictionary link identifier for use in other pspell functions.
") (prototype . "int pspell_new_personal(string $personal, string $language [, string $spelling = '' [, string $jargon = '' [, string $encoding = '' [, int $mode = '']]]])") (purpose . "Load a new dictionary with personal wordlist") (id . "function.pspell-new-personal")) "pspell_new_config" ((documentation . "Load a new dictionary with settings based on a given config int pspell_new_config(int $config) Returns a dictionary link identifier on success. (PHP 4 >= 4.0.2, PHP 5)") (versions . "PHP 4 >= 4.0.2, PHP 5") (return . "Returns a dictionary link identifier on success.
") (prototype . "int pspell_new_config(int $config)") (purpose . "Load a new dictionary with settings based on a given config") (id . "function.pspell-new-config")) "pspell_config_save_repl" ((documentation . "Determine whether to save a replacement pairs list along with the wordlist bool pspell_config_save_repl(int $dictionary_link, bool $flag) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.2, PHP 5)") (versions . "PHP 4 >= 4.0.2, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Retuns a pspell config identifier, or FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns TRUE if the spelling is correct, FALSE if not.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
mb_substr returns the portion of str specified by the start and length parameters.
The number of times the needle substring occurs in the haystack string.
If substchar is set, it returns TRUE for success, otherwise returns FALSE. If substchar is not set, it returns the current setting.
The width of string str.
str with all alphabetic characters converted to uppercase.
str with all alphabetic characters converted to lowercase.
Returns the portion of haystack, or FALSE if needle is not found.
Returns the numeric position of the last occurrence of needle in the haystack string. If needle is not found, it returns FALSE.
Return the numeric position of the last occurrence of needle in the haystack string, or FALSE if needle is not found.
Returns the portion of haystack. or FALSE if needle is not found.
Returns the portion of haystack. or FALSE if needle is not found.
Returns the numeric position of the first occurrence of needle in the haystack string. If needle is not found, it returns FALSE.
Returns the number of characters in string str having character encoding encoding. A multi-byte character is counted as 1.
Returns FALSE if the given encoding is invalid.
This function mayreturn Boolean FALSE, but may also return a non-Boolean value whichevaluates to FALSE. Please read the section on Booleans for moreinformation. Use the ===operator for testing the return value of thisfunction.
Returns the portion of haystack, or FALSE if needle is not found.
Return the numeric position of the first occurrence of needle in the haystack string, or FALSE if needle is not found.
The truncated string. If trimmarker is set, trimmarker is appended to the return value.
mb_strcut returns the portion of str specified by the start and length parameters.
The result as an array.
") (prototype . "array mb_split(string $pattern, string $string [, int $limit = -1])") (purpose . "Split multibyte string using regular expression") (id . "function.mb-split")) "mb_send_mail" ((documentation . "Send encoded mail bool mb_send_mail(string $to, string $subject, string $message [, string $additional_headers = '' [, string $additional_parameter = '']]) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
The previous options. If options is omitted, it returns the string that describes the current options.
If encoding is set, then Returns TRUE on success or FALSE on failure. In this case, the internal character encoding is NOT changed. If encoding is omitted, then the current character encoding name for a multibyte regex is returned.
The MIME charset string for character encoding encoding.
Returns TRUE on success or FALSE on failure.
The converted string.
") (prototype . "string mb_output_handler(string $contents, int $status)") (purpose . "Callback function converts character encoding in output buffer") (id . "function.mb-output-handler")) "mb_list_encodings" ((documentation . "Returns an array of all supported encodings array mb_list_encodings() Returns a numerically indexed array. (PHP 5)") (versions . "PHP 5") (return . "Returns a numerically indexed array.
") (prototype . "array mb_list_encodings()") (purpose . "Returns an array of all supported encodings") (id . "function.mb-list-encodings")) "mb_language" ((documentation . "Set/Get current language mixed mb_language([string $language = mb_language()]) If language is set and language is valid, it returns TRUE. Otherwise, it returns FALSE. When language is omitted, it returns the language name as a string. If no language is set previously, it then returns FALSE. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . " If language is set and language is valid, it returns TRUE. Otherwise, it returns FALSE. When language is omitted, it returns the language name as a string. If no language is set previously, it then returns FALSE.
If encoding is set, then Returns TRUE on success or FALSE on failure. In this case, the character encoding for multibyte regex is NOT changed. If encoding is omitted, then the current character encoding name is returned.
If encoding is omitted, mb_http_output returns the current HTTP output character encoding. Otherwise, Returns TRUE on success or FALSE on failure.
The character encoding name, as per the type. If mb_http_input does not process specified HTTP input, it returns FALSE.
An array of type information if type is not specified, otherwise a specific type.
Executes the regular expression match with multibyte support, and returns 1 if matches are found. If the optional regs parameter was specified, the function returns the byte length of matched part, and the array regs will contain the substring of matched string. The function returns 1 if it matches with the empty string. If no matches are found or an error happens, FALSE will be returned.
The resultant string or FALSE on error.
Executes the regular expression match with multibyte support, and returns 1 if matches are found. If the optional regs parameter was specified, the function returns the byte length of matched part, and the array regs will contain the substring of matched string. The function returns 1 if it matches with the empty string. If no matches are found or an error happens, FALSE will be returned.
mb_ereg_search returns TRUE if the multibyte string matches with the regular expression, or FALSE otherwise. The string for matching is set by mb_ereg_search_init. If pattern is not specified, the previous one is used.
Returns TRUE on success or FALSE on failure.
mb_ereg_search_regs executes the multibyte regular expression match, and if there are some matched part, it returns an array including substring of matched part as first element, the first grouped part with brackets as second element, the second grouped part as third element, and so on. It returns FALSE on error.
An array containing two elements. The first element is the offset, in bytes, where the match begins relative to the start of the search string, and the second element is the length in bytes of the match.
If an error occurs, FALSE is returned.
Returns TRUE on success or FALSE on failure.
An array including the sub-string of matched part by last mb_ereg_search, mb_ereg_search_pos, mb_ereg_search_regs. If there are some matches, the first element will have the matched sub-string, the second element will have the first part grouped with brackets, the third element will have the second part grouped with brackets, and so on. It returns FALSE on error;
mb_ereg_search_getpos returns the point to start regular expression match for mb_ereg_search, mb_ereg_search_pos, mb_ereg_search_regs. The position is represented by bytes from the head of string.
") (prototype . "int mb_ereg_search_getpos()") (purpose . "Returns start point for next regular expression match") (id . "function.mb-ereg-search-getpos")) "mb_ereg_replace" ((documentation . "Replace regular expression with multibyte support string mb_ereg_replace(string $pattern, string $replacement, string $string [, string $option = \"msr\"]) The resultant string on success, or FALSE on error. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . " The resultant string on success, or FALSE on error.
The resultant string on success, or FALSE on error.
Returns TRUE if string matches the regular expression pattern, FALSE if not.
Returns a numerically indexed array of encoding aliases on success, or FALSE on failure
The converted string.
") (prototype . "string mb_encode_numericentity(string $str, array $convmap [, string $encoding = mb_internal_encoding() [, bool $is_hex = FALSE]])") (purpose . "Encode character to HTML numeric string reference") (id . "function.mb-encode-numericentity")) "mb_encode_mimeheader" ((documentation . "Encode string for MIME header string mb_encode_mimeheader(string $str [, string $charset = mb_internal_encoding() [, string $transfer_encoding = \"B\" [, string $linefeed = \"\\r\\n\" [, int $indent = '']]]]) A converted version of the string represented in ASCII. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . "A converted version of the string represented in ASCII.
") (prototype . "string mb_encode_mimeheader(string $str [, string $charset = mb_internal_encoding() [, string $transfer_encoding = \"B\" [, string $linefeed = \"\\r\\n\" [, int $indent = '']]]])") (purpose . "Encode string for MIME header") (id . "function.mb-encode-mimeheader")) "mb_detect_order" ((documentation . "Set/Get character encoding detection order mixed mb_detect_order([mixed $encoding_list = mb_detect_order()]) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
The detected character encoding or FALSE if the encoding cannot be detected from the given string.
The converted string.
") (prototype . "string mb_decode_numericentity(string $str, array $convmap [, string $encoding = mb_internal_encoding()])") (purpose . "Decode HTML numeric string reference to character") (id . "function.mb-decode-numericentity")) "mb_decode_mimeheader" ((documentation . "Decode string in MIME header field string mb_decode_mimeheader(string $str) The decoded string in internal character encoding. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . "The decoded string in internal character encoding.
") (prototype . "string mb_decode_mimeheader(string $str)") (purpose . "Decode string in MIME header field") (id . "function.mb-decode-mimeheader")) "mb_convert_variables" ((documentation . "Convert character code in variable(s) string mb_convert_variables(string $to_encoding, mixed $from_encoding, mixed $vars [, mixed $... = '']) The character encoding before conversion for success, or FALSE for failure. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . " The character encoding before conversion for success, or FALSE for failure.
The converted string.
") (prototype . "string mb_convert_kana(string $str [, string $option = \"KV\" [, string $encoding = mb_internal_encoding()]])") (purpose . "Convert \"kana\" one from another (\"zen-kaku\", \"han-kaku\" and more)") (id . "function.mb-convert-kana")) "mb_convert_encoding" ((documentation . "Convert character encoding string mb_convert_encoding(string $str, string $to_encoding [, mixed $from_encoding = mb_internal_encoding()]) The encoded string. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . "The encoded string.
") (prototype . "string mb_convert_encoding(string $str, string $to_encoding [, mixed $from_encoding = mb_internal_encoding()])") (purpose . "Convert character encoding") (id . "function.mb-convert-encoding")) "mb_convert_case" ((documentation . "Perform case folding on a string string mb_convert_case(string $str, int $mode [, string $encoding = mb_internal_encoding()]) A case folded version of string converted in the way specified by mode. (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . " A case folded version of string converted in the way specified by mode.
Returns TRUE on success or FALSE on failure.
TRUE if it the code indicates some failure, and FALSE in case of success or a warning.
The returned string will be the same as the name of the error code constant.
") (prototype . "string intl_error_name(int $error_code)") (purpose . "Get symbolic name for a given error code") (id . "function.intl-error-name")) "idn_to_utf8" ((documentation . "Convert domain name from IDNA ASCII to Unicode. string idn_to_utf8(string $domain [, int $options = '' [, int $variant = INTL_IDNA_VARIANT_2003 [, array $idna_info = '']]]) Domain name in Unicode, encoded in UTF-8. or FALSE on failure (PHP 5 >= 5.3.0, PECL intl >= 1.0.2, PECL idn >= 0.1)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.2, PECL idn >= 0.1") (return . " Domain name in Unicode, encoded in UTF-8. or FALSE on failure
Domain name encoded in ASCII-compatible form. or FALSE on failure
Returns the extracted part of $string.
") (prototype . "int grapheme_substr(string $string, int $start [, int $length = ''])") (purpose . "Return part of a string") (id . "function.grapheme-substr")) "grapheme_strstr" ((documentation . "Returns part of haystack string from the first occurrence of needle to the end of haystack. string grapheme_strstr(string $haystack, string $needle [, bool $before_needle = false]) Returns the portion of string, or FALSE if needle is not found. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "Returns the portion of string, or FALSE if needle is not found.
") (prototype . "string grapheme_strstr(string $haystack, string $needle [, bool $before_needle = false])") (purpose . "Returns part of haystack string from the first occurrence of needle to the end of haystack.") (id . "function.grapheme-strstr")) "grapheme_strrpos" ((documentation . "Find position (in grapheme units) of last occurrence of a string int grapheme_strrpos(string $haystack, string $needle [, int $offset = '']) Returns the position as an integer. If needle is not found, grapheme_strrpos() will return boolean FALSE. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "Returns the position as an integer. If needle is not found, grapheme_strrpos() will return boolean FALSE.
") (prototype . "int grapheme_strrpos(string $haystack, string $needle [, int $offset = ''])") (purpose . "Find position (in grapheme units) of last occurrence of a string") (id . "function.grapheme-strrpos")) "grapheme_strripos" ((documentation . "Find position (in grapheme units) of last occurrence of a case-insensitive string int grapheme_strripos(string $haystack, string $needle [, int $offset = '']) Returns the position as an integer. If needle is not found, grapheme_strripos() will return boolean FALSE. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "Returns the position as an integer. If needle is not found, grapheme_strripos() will return boolean FALSE.
") (prototype . "int grapheme_strripos(string $haystack, string $needle [, int $offset = ''])") (purpose . "Find position (in grapheme units) of last occurrence of a case-insensitive string") (id . "function.grapheme-strripos")) "grapheme_strpos" ((documentation . "Find position (in grapheme units) of first occurrence of a string int grapheme_strpos(string $haystack, string $needle [, int $offset = '']) Returns the position as an integer. If needle is not found, strpos() will return boolean FALSE. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "Returns the position as an integer. If needle is not found, strpos() will return boolean FALSE.
") (prototype . "int grapheme_strpos(string $haystack, string $needle [, int $offset = ''])") (purpose . "Find position (in grapheme units) of first occurrence of a string") (id . "function.grapheme-strpos")) "grapheme_strlen" ((documentation . "Get string length in grapheme units int grapheme_strlen(string $input) The length of the string on success, and 0 if the string is empty. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "The length of the string on success, and 0 if the string is empty.
") (prototype . "int grapheme_strlen(string $input)") (purpose . "Get string length in grapheme units") (id . "function.grapheme-strlen")) "grapheme_stristr" ((documentation . "Returns part of haystack string from the first occurrence of case-insensitive needle to the end of haystack. string grapheme_stristr(string $haystack, string $needle [, bool $before_needle = false]) Returns the portion of $haystack, or FALSE if $needle is not found. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "Returns the portion of $haystack, or FALSE if $needle is not found.
") (prototype . "string grapheme_stristr(string $haystack, string $needle [, bool $before_needle = false])") (purpose . "Returns part of haystack string from the first occurrence of case-insensitive needle to the end of haystack.") (id . "function.grapheme-stristr")) "grapheme_stripos" ((documentation . "Find position (in grapheme units) of first occurrence of a case-insensitive string int grapheme_stripos(string $haystack, string $needle [, int $offset = '']) Returns the position as an integer. If needle is not found, grapheme_stripos() will return boolean FALSE. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "Returns the position as an integer. If needle is not found, grapheme_stripos() will return boolean FALSE.
") (prototype . "int grapheme_stripos(string $haystack, string $needle [, int $offset = ''])") (purpose . "Find position (in grapheme units) of first occurrence of a case-insensitive string") (id . "function.grapheme-stripos")) "grapheme_extract" ((documentation . "Function to extract a sequence of default grapheme clusters from a text buffer, which must be encoded in UTF-8. string grapheme_extract(string $haystack, int $size [, int $extract_type = '' [, int $start = '' [, int $next = '']]]) A string starting at offset $start and ending on a default grapheme cluster boundary that conforms to the $size and $extract_type specified. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "A string starting at offset $start and ending on a default grapheme cluster boundary that conforms to the $size and $extract_type specified.
") (prototype . "string grapheme_extract(string $haystack, int $size [, int $extract_type = '' [, int $start = '' [, int $next = '']]])") (purpose . "Function to extract a sequence of default grapheme clusters from a text buffer, which must be encoded in UTF-8.") (id . "function.grapheme-extract")) "intl_get_error_message" ((documentation . "Get description of the last error string intl_get_error_message() Description of an error occurred in the last API function call. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "Description of an error occurred in the last API function call.
") (prototype . "string intl_get_error_message()") (purpose . "Get description of the last error") (id . "function.intl-get-error-message")) "intl_get_error_code" ((documentation . "Get the last error code int intl_get_error_code() Error code returned by the last API function call. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "Error code returned by the last API function call.
") (prototype . "int intl_get_error_code()") (purpose . "Get the last error code") (id . "function.intl-get-error-code")) "transliterator_transliterate" ((documentation . "Transliterate a string string transliterator_transliterate(string $subject [, int $start = '' [, int $end = '', mixed $transliterator]]) The transfomed string on success, or FALSE on failure. (PHP >= 5.4.0, PECL intl >= 2.0.0)") (versions . "PHP >= 5.4.0, PECL intl >= 2.0.0") (return . " The transfomed string on success, or FALSE on failure.
An array of registered transliterator IDs on success, or FALSE on failure.
The error code on success, or FALSE if none exists, or on failure.
The error code on success, or FALSE if none exists, or on failure.
Returns a Transliterator object on success, or NULL on failure
Returns a Transliterator object on success, or NULL on failure.
Returns a Transliterator object on success, or NULL on failure.
Returns the list of locales supported by the bundle.
") (prototype . "array resourcebundle_locales(string $bundlename)") (purpose . "Get supported locales") (id . "resourcebundle.locales")) "resourcebundle_get" ((documentation . "Get data from the bundle mixed resourcebundle_get(string|int $index, ResourceBundle $r) Returns the data located at the index or NULL on error. Strings, integers and binary data strings are returned as corresponding PHP types, integer array is returned as PHP array. Complex types are returned as ResourceBundle object. (PHP >= 5.3.2, PECL intl >= 2.0.0)") (versions . "PHP >= 5.3.2, PECL intl >= 2.0.0") (return . " Returns the data located at the index or NULL on error. Strings, integers and binary data strings are returned as corresponding PHP types, integer array is returned as PHP array. Complex types are returned as ResourceBundle object.
Returns error message from last bundle object's call.
") (prototype . "string resourcebundle_get_error_message(ResourceBundle $r)") (purpose . "Get bundle's last error message.") (id . "resourcebundle.geterrormessage")) "resourcebundle_get_error_code" ((documentation . "Get bundle's last error code. int resourcebundle_get_error_code(ResourceBundle $r) Returns error code from last bundle object call. (PHP >= 5.3.2, PECL intl >= 2.0.0)") (versions . "PHP >= 5.3.2, PECL intl >= 2.0.0") (return . "Returns error code from last bundle object call.
") (prototype . "int resourcebundle_get_error_code(ResourceBundle $r)") (purpose . "Get bundle's last error code.") (id . "resourcebundle.geterrorcode")) "resourcebundle_create" ((documentation . "Create a resource bundle ResourceBundle resourcebundle_create(string $locale, string $bundlename [, bool $fallback = '']) Returns ResourceBundle object or FALSE on error. (PHP >= 5.3.2, PECL intl >= 2.0.0)") (versions . "PHP >= 5.3.2, PECL intl >= 2.0.0") (return . " Returns ResourceBundle object or FALSE on error.
Returns number of elements in the bundle.
") (prototype . "int resourcebundle_count(ResourceBundle $r)") (purpose . "Get number of elements in the bundle") (id . "resourcebundle.count")) "datefmt_set_timezone" ((documentation . "Sets formatterʼs timezone boolean datefmt_set_timezone(mixed $zone) Returns TRUE on success and FALSE on failure. (PHP 5 >= 5.5.0, PECL intl >= 3.0.0)") (versions . "PHP 5 >= 5.5.0, PECL intl >= 3.0.0") (return . " Returns TRUE on success and FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure. Bad formatstrings are usually the cause of the failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
timestamp parsed value, or FALSE if value can't be parsed.
Localtime compatible array of integers : contains 24 hour clock value in tm_hour field
") (prototype . "array datefmt_localtime(string $value [, int $position = '', IntlDateFormatter $fmt])") (purpose . "Parse string to a field-based time value") (id . "intldateformatter.localtime")) "datefmt_is_lenient" ((documentation . "Get the lenient used for the IntlDateFormatter bool datefmt_is_lenient(IntlDateFormatter $fmt) TRUE if parser is lenient, FALSE if parser is strict. By default the parser is lenient. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . " TRUE if parser is lenient, FALSE if parser is strict. By default the parser is lenient.
The associated IntlTimeZone object or FALSE on failure.
A copy of the internal calendar object used by this formatter.
") (prototype . "IntlCalendar datefmt_get_calendar_object()") (purpose . "Get copy of formatterʼs calendar object") (id . "intldateformatter.getcalendarobject")) "datefmt_get_timezone_id" ((documentation . "Get the timezone-id used for the IntlDateFormatter string datefmt_get_timezone_id(IntlDateFormatter $fmt) ID string for the time zone used by this formatter. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "ID string for the time zone used by this formatter.
") (prototype . "string datefmt_get_timezone_id(IntlDateFormatter $fmt)") (purpose . "Get the timezone-id used for the IntlDateFormatter") (id . "intldateformatter.gettimezoneid")) "datefmt_get_timetype" ((documentation . #("Get the timetype used for the IntlDateFormatter int datefmt_get_timetype(IntlDateFormatter $fmt) The current date type value of the formatter. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)" 111 120 (shr-url "class.intldateformatter.html#intl.intldateformatter-constants"))) (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "The current date type value of the formatter.
") (prototype . "int datefmt_get_timetype(IntlDateFormatter $fmt)") (purpose . "Get the timetype used for the IntlDateFormatter") (id . "intldateformatter.gettimetype")) "datefmt_get_pattern" ((documentation . "Get the pattern used for the IntlDateFormatter string datefmt_get_pattern(IntlDateFormatter $fmt) The pattern string being used to format/parse. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "The pattern string being used to format/parse.
") (prototype . "string datefmt_get_pattern(IntlDateFormatter $fmt)") (purpose . "Get the pattern used for the IntlDateFormatter") (id . "intldateformatter.getpattern")) "datefmt_get_locale" ((documentation . "Get the locale used by formatter string datefmt_get_locale([int $which = '', IntlDateFormatter $fmt]) the locale of this formatter or 'false' if error (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "the locale of this formatter or 'false' if error
") (prototype . "string datefmt_get_locale([int $which = '', IntlDateFormatter $fmt])") (purpose . "Get the locale used by formatter") (id . "intldateformatter.getlocale")) "datefmt_get_error_message" ((documentation . "Get the error text from the last operation. string datefmt_get_error_message(IntlDateFormatter $fmt) Description of the last error. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "Description of the last error.
") (prototype . "string datefmt_get_error_message(IntlDateFormatter $fmt)") (purpose . "Get the error text from the last operation.") (id . "intldateformatter.geterrormessage")) "datefmt_get_error_code" ((documentation . "Get the error code from last operation int datefmt_get_error_code(IntlDateFormatter $fmt) The error code, one of UErrorCode values. Initial value is U_ZERO_ERROR. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "The error code, one of UErrorCode values. Initial value is U_ZERO_ERROR.
") (prototype . "int datefmt_get_error_code(IntlDateFormatter $fmt)") (purpose . "Get the error code from last operation") (id . "intldateformatter.geterrorcode")) "datefmt_get_datetype" ((documentation . #("Get the datetype used for the IntlDateFormatter int datefmt_get_datetype(IntlDateFormatter $fmt) The current date type value of the formatter. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)" 111 120 (shr-url "class.intldateformatter.html#intl.intldateformatter-constants"))) (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "The current date type value of the formatter.
") (prototype . "int datefmt_get_datetype(IntlDateFormatter $fmt)") (purpose . "Get the datetype used for the IntlDateFormatter") (id . "intldateformatter.getdatetype")) "datefmt_get_calendar" ((documentation . #("Get the calendar type used for the IntlDateFormatter int datefmt_get_calendar(IntlDateFormatter $fmt) The calendar type being used by the formatter. Either IntlDateFormatter::TRADITIONAL or IntlDateFormatter::GREGORIAN. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)" 108 121 (shr-url "class.intldateformatter.html#intl.intldateformatter-constants.calendartypes"))) (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . " The calendar type being used by the formatter. Either IntlDateFormatter::TRADITIONAL or IntlDateFormatter::GREGORIAN.
A string with result or FALSE on failure.
The formatted string or, if an error occurred, FALSE.
The created IntlDateFormatter or FALSE in case of failure.
") (prototype . "string intltz_get_error_message()") (purpose . "Get last error message on the object") (id . "intltimezone.geterrormessage")) "intltz_get_error_code" ((documentation . "Get last error code on the object integer intltz_get_error_code() (PHP 5.5.0, PECL >= 3.0.0a1)") (versions . "PHP 5.5.0, PECL >= 3.0.0a1") (return . "
") (prototype . "integer intltz_get_error_code()") (purpose . "Get last error code on the object") (id . "intltimezone.geterrorcode")) "intlcal_get_error_message" ((documentation . "Get last error message on the object string intlcal_get_error_message(IntlCalendar $calendar) The error message associated with last error that occurred in a function call on this object, or a string indicating the non-existance of an error. (PHP 5.5.0, PECL >= 3.0.0a1)") (versions . "PHP 5.5.0, PECL >= 3.0.0a1") (return . "
The error message associated with last error that occurred in a function call on this object, or a string indicating the non-existance of an error.
") (prototype . "string intlcal_get_error_message(IntlCalendar $calendar)") (purpose . "Get last error message on the object") (id . "intlcalendar.geterrormessage")) "intlcal_get_error_code" ((documentation . "Get last error code on the object int intlcal_get_error_code(IntlCalendar $calendar) An ICU error code indicating either success, failure or a warning. (PHP 5.5.0, PECL >= 3.0.0a1)") (versions . "PHP 5.5.0, PECL >= 3.0.0a1") (return . "An ICU error code indicating either success, failure or a warning.
") (prototype . "int intlcal_get_error_code(IntlCalendar $calendar)") (purpose . "Get last error code on the object") (id . "intlcalendar.geterrorcode")) "msgfmt_set_pattern" ((documentation . "Set the pattern used by the formatter bool msgfmt_set_pattern(string $pattern, MessageFormatter $fmt) Returns TRUE on success or FALSE on failure. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . " Returns TRUE on success or FALSE on failure.
An array containing the items extracted, or FALSE on error
An array containing items extracted, or FALSE on error
The pattern string for this message formatter
") (prototype . "string msgfmt_get_pattern(MessageFormatter $fmt)") (purpose . "Get the pattern used by the formatter") (id . "messageformatter.getpattern")) "msgfmt_get_locale" ((documentation . "Get the locale for which the formatter was created. string msgfmt_get_locale(NumberFormatter $formatter) The locale name (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "The locale name
") (prototype . "string msgfmt_get_locale(NumberFormatter $formatter)") (purpose . "Get the locale for which the formatter was created.") (id . "messageformatter.getlocale")) "msgfmt_get_error_message" ((documentation . "Get the error text from the last operation string msgfmt_get_error_message(MessageFormatter $fmt) Description of the last error. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "Description of the last error.
") (prototype . "string msgfmt_get_error_message(MessageFormatter $fmt)") (purpose . "Get the error text from the last operation") (id . "messageformatter.geterrormessage")) "msgfmt_get_error_code" ((documentation . "Get the error code from last operation int msgfmt_get_error_code(MessageFormatter $fmt) The error code, one of UErrorCode values. Initial value is U_ZERO_ERROR. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "The error code, one of UErrorCode values. Initial value is U_ZERO_ERROR.
") (prototype . "int msgfmt_get_error_code(MessageFormatter $fmt)") (purpose . "Get the error code from last operation") (id . "messageformatter.geterrorcode")) "msgfmt_format" ((documentation . "Format the message string msgfmt_format(array $args, MessageFormatter $fmt) The formatted string, or FALSE if an error occurred (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . " The formatted string, or FALSE if an error occurred
The formatted pattern string or FALSE if an error occurred
The formatter object
") (prototype . "MessageFormatter msgfmt_create(string $locale, string $pattern)") (purpose . "Constructs a new Message Formatter") (id . "messageformatter.create")) "normalizer_normalize" ((documentation . "Normalizes the input provided and returns the normalized string string normalizer_normalize(string $input [, string $form = Normalizer::FORM_C]) The normalized string or NULL if an error occurred. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "The normalized string or NULL if an error occurred.
TRUE if normalized, FALSE otherwise or if there an error
Returns TRUE on success or FALSE on failure.
Returns an array containing a list of key-value pairs, where the keys identify the particular locale ID subtags, and the values are the associated subtag values. The array will be ordered as the locale id subtags e.g. in the locale id if variants are '-varX-varY-varZ' then the returned array will have variant0=>varX , variant1=>varY , variant2=>varZ
") (prototype . "array locale_parse(string $locale)") (purpose . "Returns a key-value array of locale ID subtag elements.") (id . "locale.parselocale")) "locale_lookup" ((documentation . "Searches the language tag list for the best match to the language string locale_lookup(array $langtag, string $locale [, bool $canonicalize = false [, string $default = '']]) The closest matching language tag or default value. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "The closest matching language tag or default value.
") (prototype . "string locale_lookup(array $langtag, string $locale [, bool $canonicalize = false [, string $default = '']])") (purpose . "Searches the language tag list for the best match to the language") (id . "locale.lookup")) "locale_get_script" ((documentation . "Gets the script for the input locale string locale_get_script(string $locale) The script subtag for the locale or NULL if not present (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . " The script subtag for the locale or NULL if not present
The region subtag for the locale or NULL if not present
The language code associated with the language or NULL in case of error.
Associative array containing the keyword-value pairs for this locale
") (prototype . "array locale_get_keywords(string $locale)") (purpose . "Gets the keywords for the input locale") (id . "locale.getkeywords")) "locale_get_display_variant" ((documentation . "Returns an appropriately localized display name for variants of the input locale string locale_get_display_variant(string $locale [, string $in_locale = '']) Display name of the variant for the $locale in the format appropriate for $in_locale. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "Display name of the variant for the $locale in the format appropriate for $in_locale.
") (prototype . "string locale_get_display_variant(string $locale [, string $in_locale = ''])") (purpose . "Returns an appropriately localized display name for variants of the input locale") (id . "locale.getdisplayvariant")) "locale_get_display_script" ((documentation . "Returns an appropriately localized display name for script of the input locale string locale_get_display_script(string $locale [, string $in_locale = '']) Display name of the script for the $locale in the format appropriate for $in_locale. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "Display name of the script for the $locale in the format appropriate for $in_locale.
") (prototype . "string locale_get_display_script(string $locale [, string $in_locale = ''])") (purpose . "Returns an appropriately localized display name for script of the input locale") (id . "locale.getdisplayscript")) "locale_get_display_region" ((documentation . "Returns an appropriately localized display name for region of the input locale string locale_get_display_region(string $locale [, string $in_locale = '']) display name of the region for the $locale in the format appropriate for $in_locale. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "display name of the region for the $locale in the format appropriate for $in_locale.
") (prototype . "string locale_get_display_region(string $locale [, string $in_locale = ''])") (purpose . "Returns an appropriately localized display name for region of the input locale") (id . "locale.getdisplayregion")) "locale_get_display_name" ((documentation . "Returns an appropriately localized display name for the input locale string locale_get_display_name(string $locale [, string $in_locale = '']) Display name of the locale in the format appropriate for $in_locale. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "Display name of the locale in the format appropriate for $in_locale.
") (prototype . "string locale_get_display_name(string $locale [, string $in_locale = ''])") (purpose . "Returns an appropriately localized display name for the input locale") (id . "locale.getdisplayname")) "locale_get_display_language" ((documentation . "Returns an appropriately localized display name for language of the inputlocale string locale_get_display_language(string $locale [, string $in_locale = '']) display name of the language for the $locale in the format appropriate for $in_locale. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "display name of the language for the $locale in the format appropriate for $in_locale.
") (prototype . "string locale_get_display_language(string $locale [, string $in_locale = ''])") (purpose . "Returns an appropriately localized display name for language of the inputlocale") (id . "locale.getdisplaylanguage")) "locale_get_default" ((documentation . "Gets the default locale value from the INTL global 'default_locale' string locale_get_default() The current runtime locale (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "The current runtime locale
") (prototype . "string locale_get_default()") (purpose . "Gets the default locale value from the INTL global 'default_locale'") (id . "locale.getdefault")) "locale_get_all_variants" ((documentation . "Gets the variants for the input locale array locale_get_all_variants(string $locale) The array containing the list of all variants subtag for the locale or NULL if not present (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . " The array containing the list of all variants subtag for the locale or NULL if not present
TRUE if $locale matches $langtag FALSE otherwise.
The corresponding locale identifier.
") (prototype . "string locale_compose(array $subtags)") (purpose . "Returns a correctly ordered and delimited locale ID") (id . "locale.composelocale")) "locale_canonicalize" ((documentation . "Canonicalize the locale string string locale_canonicalize(string $locale) (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "") (prototype . "string locale_canonicalize(string $locale)") (purpose . "Canonicalize the locale string") (id . "locale.canonicalize")) "locale_accept_from_http" ((documentation . "Tries to find out best available locale based on HTTP \"Accept-Language\" header string locale_accept_from_http(string $header) The corresponding locale identifier. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "
The corresponding locale identifier.
") (prototype . "string locale_accept_from_http(string $header)") (purpose . "Tries to find out best available locale based on HTTP \"Accept-Language\" header") (id . "locale.acceptfromhttp")) "numfmt_set_text_attribute" ((documentation . "Set a text attribute bool numfmt_set_text_attribute(int $attr, string $value, NumberFormatter $fmt) Returns TRUE on success or FALSE on failure. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
The value of the parsed number or FALSE on error.
The parsed numeric value or FALSE on error.
Return attribute value on success, or FALSE on error.
The symbol string or FALSE on error.
Pattern string that is used by the formatter, or FALSE if an error happens.
The locale name used to create the formatter.
") (prototype . "string numfmt_get_locale([int $type = '', NumberFormatter $fmt])") (purpose . "Get formatter locale") (id . "numberformatter.getlocale")) "numfmt_get_error_message" ((documentation . "Get formatter's last error message. string numfmt_get_error_message(NumberFormatter $fmt) Returns error message from last formatter call. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "Returns error message from last formatter call.
") (prototype . "string numfmt_get_error_message(NumberFormatter $fmt)") (purpose . "Get formatter's last error message.") (id . "numberformatter.geterrormessage")) "numfmt_get_error_code" ((documentation . "Get formatter's last error code. int numfmt_get_error_code(NumberFormatter $fmt) Returns error code from last formatter call. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "Returns error code from last formatter call.
") (prototype . "int numfmt_get_error_code(NumberFormatter $fmt)") (purpose . "Get formatter's last error code.") (id . "numberformatter.geterrorcode")) "numfmt_get_attribute" ((documentation . "Get an attribute int numfmt_get_attribute(int $attr, NumberFormatter $fmt) Return attribute value on success, or FALSE on error. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . " Return attribute value on success, or FALSE on error.
Returns the string containing formatted value, or FALSE on error.
String representing the formatted currency value.
") (prototype . "string numfmt_format_currency(float $value, string $currency, NumberFormatter $fmt)") (purpose . "Format a currency value") (id . "numberformatter.formatcurrency")) "numfmt_create" ((documentation . "Create a number formatter NumberFormatter numfmt_create(string $locale, int $style [, string $pattern = '']) Returns NumberFormatter object or FALSE on error. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . " Returns NumberFormatter object or FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns current collation strength, or boolean FALSE on error.
Returns the collation key for the string. Collation keys can be compared directly instead of strings.
This function mayreturn Boolean FALSE, but may also return a non-Boolean value whichevaluates to FALSE. Please read the section on Booleans for moreinformation. Use the ===operator for testing the return value of thisfunction.
Real locale name from which the collation data comes. If the collator was instantiated from rules or an error occurred, returns boolean FALSE.
Description of an error occurred in the last Collator API function call.
") (prototype . "string collator_get_error_message(Collator $coll)") (purpose . "Get text for collator's last error code") (id . "collator.geterrormessage")) "collator_get_error_code" ((documentation . "Get collator's last error code int collator_get_error_code(Collator $coll) Error code returned by the last Collator API function call. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . "Error code returned by the last Collator API function call.
") (prototype . "int collator_get_error_code(Collator $coll)") (purpose . "Get collator's last error code") (id . "collator.geterrorcode")) "collator_get_attribute" ((documentation . "Get collation attribute value int collator_get_attribute(int $attr, Collator $coll) Attribute value, or boolean FALSE on error. (PHP 5 >= 5.3.0, PECL intl >= 1.0.0)") (versions . "PHP 5 >= 5.3.0, PECL intl >= 1.0.0") (return . " Attribute value, or boolean FALSE on error.
Return new instance of Collator object, or NULL on error.
Return comparison result:
1 if str1 is greater than str2 ;
0 if str1 is equal to str2;
-1 if str1 is less than str2 .
FALSE is returned. This function mayreturn Boolean FALSE, but may also return a non-Boolean value whichevaluates to FALSE. Please read the section on Booleans for moreinformation. Use the ===operator for testing the return value of thisfunction.
Returns TRUE on success or FALSE on failure.
See ob_start for information about this handler return values.
") (prototype . "string ob_iconv_handler(string $contents, int $status)") (purpose . "Convert character encoding as output buffer handler") (id . "function.ob-iconv-handler")) "iconv" ((documentation . "Convert string to requested character encoding string iconv(string $in_charset, string $out_charset, string $str) Returns the converted string or FALSE on failure. (PHP 4 >= 4.0.5, PHP 5)") (versions . "PHP 4 >= 4.0.5, PHP 5") (return . " Returns the converted string or FALSE on failure.
Returns the portion of str specified by the offset and length parameters.
If str is shorter than offset characters long, FALSE will be returned.
Returns the numeric position of the last occurrence of needle in haystack.
If needle is not found, iconv_strrpos will return FALSE.
This function mayreturn Boolean FALSE, but may also return a non-Boolean value whichevaluates to FALSE. Please read the section on Booleans for moreinformation. Use the ===operator for testing the return value of thisfunction.
Returns the numeric position of the first occurrence of needle in haystack.
If needle is not found, iconv_strpos will return FALSE.
This function mayreturn Boolean FALSE, but may also return a non-Boolean value whichevaluates to FALSE. Please read the section on Booleans for moreinformation. Use the ===operator for testing the return value of thisfunction.
Returns the character count of str, as an integer.
Returns TRUE on success or FALSE on failure.
Returns an encoded MIME field on success, or FALSE if an error occurs during the encoding.
Returns a decoded MIME field on success, or FALSE if an error occurs during the decoding.
Returns an associative array that holds a whole set of MIME header fields specified by encoded_headers on success, or FALSE if an error occurs during the decoding.
Each key of the return value represents an individual field name and the corresponding element represents a field value. If more than one field of the same name are present, iconv_mime_decode_headers automatically incorporates them into a numerically indexed array in the order of occurrence.
") (prototype . "array iconv_mime_decode_headers(string $encoded_headers [, int $mode = '' [, string $charset = ini_get(\"iconv.internal_encoding\")]])") (purpose . "Decodes multiple MIME header fields at once") (id . "function.iconv-mime-decode-headers")) "iconv_get_encoding" ((documentation . "Retrieve internal configuration variables of iconv extension mixed iconv_get_encoding([string $type = \"all\"]) Returns the current value of the internal configuration variable if successful or FALSE on failure. If type is omitted or set to \"all\", iconv_get_encoding returns an array that stores all these variables. (PHP 4 >= 4.0.5, PHP 5)") (versions . "PHP 4 >= 4.0.5, PHP 5") (return . " Returns the current value of the internal configuration variable if successful or FALSE on failure.
If type is omitted or set to "all", iconv_get_encoding returns an array that stores all these variables.
If successful, this function returns the current message domain, after possibly changing it.
") (prototype . "string textdomain(string $text_domain)") (purpose . "Sets the default domain") (id . "function.textdomain")) "ngettext" ((documentation . "Plural version of gettext string ngettext(string $msgid1, string $msgid2, int $n) Returns correct plural form of message identified by msgid1 and msgid2 for count n. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . " Returns correct plural form of message identified by msgid1 and msgid2 for count n.
Returns a translated string if one is found in the translation table, or the submitted message if not found.
") (prototype . "string gettext(string $message)") (purpose . "Lookup a message in the current domain") (id . "function.gettext")) "dngettext" ((documentation . "Plural version of dgettext string dngettext(string $domain, string $msgid1, string $msgid2, int $n) A string on success. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . "A string on success.
") (prototype . "string dngettext(string $domain, string $msgid1, string $msgid2, int $n)") (purpose . "Plural version of dgettext") (id . "function.dngettext")) "dgettext" ((documentation . "Override the current domain string dgettext(string $domain, string $message) A string on success. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "A string on success.
") (prototype . "string dgettext(string $domain, string $message)") (purpose . "Override the current domain") (id . "function.dgettext")) "dcngettext" ((documentation . "Plural version of dcgettext string dcngettext(string $domain, string $msgid1, string $msgid2, int $n, int $category) A string on success. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . "A string on success.
") (prototype . "string dcngettext(string $domain, string $msgid1, string $msgid2, int $n, int $category)") (purpose . "Plural version of dcgettext") (id . "function.dcngettext")) "dcgettext" ((documentation . "Overrides the domain for a single lookup string dcgettext(string $domain, string $message, int $category) A string on success. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "A string on success.
") (prototype . "string dcgettext(string $domain, string $message, int $category)") (purpose . "Overrides the domain for a single lookup") (id . "function.dcgettext")) "bindtextdomain" ((documentation . "Sets the path for a domain string bindtextdomain(string $domain, string $directory) The full pathname for the domain currently being set. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " The full pathname for the domain currently being set.
A string on success.
") (prototype . "string bind_textdomain_codeset(string $domain, string $codeset)") (purpose . "Specify the character encoding in which the messages from the DOMAIN message catalog will be returned") (id . "function.bind-textdomain-codeset")) "fribidi_log2vis" ((documentation . "Convert a logical string to a visual one string fribidi_log2vis(string $str, string $direction, int $charset) Returns the visual string on success or FALSE on failure. (PHP 4 >= 4.0.4 and PHP 4 <= 4.1.0, PECL fribidi >= 1.0)") (versions . "PHP 4 >= 4.0.4 and PHP 4 <= 4.1.0, PECL fribidi >= 1.0") (return . " Returns the visual string on success or FALSE on failure.
Will returns an array of suggestions if the word is bad spelled.
") (prototype . "array enchant_dict_suggest(resource $dict, string $word)") (purpose . "Will return a list of values if any of those pre-conditions are not met") (id . "function.enchant-dict-suggest")) "enchant_dict_store_replacement" ((documentation . "Add a correction for a word void enchant_dict_store_replacement(resource $dict, string $mis, string $cor) Returns TRUE on success or FALSE on failure. (PHP 5 >= 5.3.0, PECL enchant >= 0.1.0 )") (versions . "PHP 5 >= 5.3.0, PECL enchant >= 0.1.0 ") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE if the word is correctly spelled or FALSE
Returns TRUE if the word exists or FALSE
Returns the error message as string or FALSE if no error occurred.
Returns TRUE on success or FALSE on failure.
Returns TRUE if the word is spelled correctly, FALSE if not.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns a dictionary resource on success or FALSE on failure.
Returns a dictionary resource on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns a broker resource on success or FALSE.
Return the msg string if an error was found or FALSE
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE when the tag exist or FALSE when not.
Returns TRUE on success or FALSE on failure.
Returns string with binary diff containing differences between "old" and "new" data or FALSE if an internal error occurred.
Returns the patched string, or FALSE on error.
Returns the patched string, or FALSE on error.
Returns the merged string, FALSE if an internal error happened, or TRUE if merged string is empty.
Returns string with resulting diff or FALSE if an internal error happened.
Returns string with result or FALSE if an internal error happened.
Returns the patched string, or FALSE on error.
Returns string with binary diff containing differences between "old" and "new" data or FALSE if an internal error occurred.
Returns the size of file that would be created.
") (prototype . "int xdiff_string_bdiff_size(string $patch)") (purpose . "Read a size of file created by applying a binary diff") (id . "function.xdiff-string-bdiff-size")) "xdiff_file_rabdiff" ((documentation . "Make binary diff of two files using the Rabin's polynomial fingerprinting algorithm bool xdiff_file_rabdiff(string $old_file, string $new_file, string $dest) Returns TRUE on success or FALSE on failure. (PECL xdiff >= 1.5.0)") (versions . "PECL xdiff >= 1.5.0") (return . " Returns TRUE on success or FALSE on failure.
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.
Returns TRUE on success or FALSE on failure.
Returns TRUE if merge was successful, string with rejected chunks if it was not or FALSE if an internal error happened.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the size of file that would be created.
") (prototype . "int xdiff_file_bdiff_size(string $file)") (purpose . "Read a size of file created by applying a binary diff") (id . "function.xdiff-file-bdiff-size")) "xattr_supported" ((documentation . "Check if filesystem supports extended attributes bool xattr_supported(string $filename [, int $flags = '']) 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). (PECL xattr >= 1.0.0)") (versions . "PECL xattr >= 1.0.0") (return . " 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).
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
This function returns an array with names of extended attributes.
") (prototype . "array xattr_list(string $filename [, int $flags = ''])") (purpose . "Get a list of extended attributes") (id . "function.xattr-list")) "xattr_get" ((documentation . "Get an extended attribute string xattr_get(string $filename, string $name [, int $flags = '']) Returns a string containing the value or FALSE if the attribute doesn't exist. (PECL xattr >= 0.9.0)") (versions . "PECL xattr >= 0.9.0") (return . " Returns a string containing the value or FALSE if the attribute doesn't exist.
Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void setproctitle(string $title)") (purpose . "Set the process title") (id . "function.setproctitle")) "inotify_rm_watch" ((documentation . "Remove an existing watch from an inotify instance bool inotify_rm_watch(resource $inotify_instance, int $watch_descriptor) Returns TRUE on success or FALSE on failure. (PECL inotify >= 0.1.2)") (versions . "PECL inotify >= 0.1.2") (return . " Returns TRUE on success or FALSE on failure.
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:
IN_MOVE_FROM and IN_MOVE_TO)Returns a number upper than zero if there are pending events.
") (prototype . "int inotify_queue_len(resource $inotify_instance)") (purpose . "Return a number upper than zero if there are pending events") (id . "function.inotify-queue-len")) "inotify_init" ((documentation . "Initialize an inotify instance resource inotify_init() A stream resource or FALSE on error. (PECL inotify >= 0.1.2)") (versions . "PECL inotify >= 0.1.2") (return . " A stream resource or FALSE on error.
The return value is a unique (inotify instance wide) watch descriptor.
") (prototype . "int inotify_add_watch(resource $inotify_instance, string $pathname, int $mask)") (purpose . "Add a watch to an initialized inotify instance") (id . "function.inotify-add-watch")) "unlink" ((documentation . "Deletes a file bool unlink(string $filename [, resource $context = '']) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
umask without arguments simply returns the current umask otherwise the old umask is returned.
") (prototype . "int umask([int $mask = ''])") (purpose . "Changes the current umask") (id . "function.umask")) "touch" ((documentation . "Sets access and modification time of file bool touch(string $filename [, int $time = time() [, int $atime = '']]) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns a file handle, similar to the one returned by fopen, for the new file or FALSE on failure.
Returns the new temporary filename (with path), or FALSE on failure.
Returns TRUE on success or FALSE on failure.
| Numeric | Associative (since PHP 4.0.6) | Description |
|---|---|---|
| 0 | dev | device number |
| 1 | ino | inode number * |
| 2 | mode | inode protection mode |
| 3 | nlink | number of links |
| 4 | uid | userid of owner * |
| 5 | gid | groupid of owner * |
| 6 | rdev | device type, if inode device |
| 7 | size | size in bytes |
| 8 | atime | time of last access (Unix timestamp) |
| 9 | mtime | time of last modification (Unix timestamp) |
| 10 | ctime | time of last inode change (Unix timestamp) |
| 11 | blksize | blocksize of filesystem IO ** |
| 12 | blocks | number of 512-byte blocks allocated ** |
** Only valid on systems supporting the st_blksize type - other systems (e.g. Windows) return -1.
In case of error, stat returns FALSE.
") (prototype . "array stat(string $filename)") (purpose . "Gives information about a file") (id . "function.stat")) "set_file_buffer" ((documentation . "Alias of stream_set_write_buffer set_file_buffer() (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "") (prototype . " set_file_buffer()") (purpose . "Alias of stream_set_write_buffer") (id . "function.set-file-buffer")) "rmdir" ((documentation . "Removes directory bool rmdir(string $dirname [, resource $context = '']) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Note: 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.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the canonicalized absolute pathname on success. The resulting path will have no symbolic link, '/./' or '/../' components.
realpath returns FALSE on failure, e.g. if the file does not exist.
Note:
The running script must have executable permissions on all directories in the hierarchy, otherwise realpath will return
FALSE.
") (prototype . "string realpath(string $path)") (purpose . "Returns canonicalized absolute pathname") (id . "function.realpath")) "realpath_cache_size" ((documentation . "Get realpath cache size int realpath_cache_size() Returns how much memory realpath cache is using. (PHP 5 >= 5.3.2)") (versions . "PHP 5 >= 5.3.2") (return . "Note: 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.
Returns how much memory realpath cache is using.
") (prototype . "int realpath_cache_size()") (purpose . "Get realpath cache size") (id . "function.realpath-cache-size")) "realpath_cache_get" ((documentation . "Get realpath cache entries array realpath_cache_get() Returns an array of realpath cache entries. The keys are original path entries, and the values are arrays of data items, containing the resolved path, expiration date, and other options kept in the cache. (PHP 5 >= 5.3.2)") (versions . "PHP 5 >= 5.3.2") (return . "Returns an array of realpath cache entries. The keys are original path entries, and the values are arrays of data items, containing the resolved path, expiration date, and other options kept in the cache.
") (prototype . "array realpath_cache_get()") (purpose . "Get realpath cache entries") (id . "function.realpath-cache-get")) "readlink" ((documentation . "Returns the target of a symbolic link string readlink(string $path) Returns the contents of the symbolic link path or FALSE on error. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns the contents of the symbolic link path or FALSE on error.
Returns the number of bytes read from the file. If an error occurs, FALSE is returned and unless the function was called as @readfile, an error message is printed.
Returns a file pointer identical to that returned by fopen, except that it is unidirectional (may only be used for reading or writing) and must be closed with pclose. This pointer may be used with fgets, fgetss, and fwrite. When the mode is 'r', the returned file pointer equals to the STDOUT of the command, when the mode is 'w', the returned file pointer equals to the STDIN of the command.
If an error occurs, returns FALSE.
Returns the termination status of the process that was run. In case of an error then -1 is returned.
") (prototype . "int pclose(resource $handle)") (purpose . "Closes process file pointer") (id . "function.pclose")) "pathinfo" ((documentation . "Returns information about a file path mixed pathinfo(string $path [, int $options = PATHINFO_DIRNAME | PATHINFO_BASENAME | PATHINFO_EXTENSION | PATHINFO_FILENAME]) If the options parameter is not passed, an associative array containing the following elements is returned: dirname, basename, extension (if any), and filename. Note: If the path has more than one extension, PATHINFO_EXTENSION returns only the last one and PATHINFO_FILENAME only strips the last one. (see first example below). Note: If the path does not have an extension, no extension element will be returned (see second example below). If options is present, returns a string containing the requested element. (PHP 4 >= 4.0.3, PHP 5)") (versions . "PHP 4 >= 4.0.3, PHP 5") (return . " If the options parameter is not passed, an associative array containing the following elements is returned: dirname, basename, extension (if any), and filename.
Note:
If the
pathhas more than one extension,PATHINFO_EXTENSIONreturns only the last one andPATHINFO_FILENAMEonly strips the last one. (see first example below).
Note:
If the
pathdoes not have an extension, no extension element will be returned (see second example below).
If options is present, returns a string containing the requested element.
The settings are returned as an associative array on success, and FALSE on failure.
The settings are returned as an associative array on success, and FALSE on failure.
Returns TRUE on success.
If filename is not a valid upload file, then no action will occur, and move_uploaded_file will return FALSE.
If filename is a valid upload file, but cannot be moved for some reason, no action will occur, and move_uploaded_file will return FALSE. Additionally, a warning will be issued.
Returns TRUE on success or FALSE on failure.
See the manual page for stat for information on the structure of the array that lstat returns. This function is identical to the stat function except that if the filename parameter is a symbolic link, the status of the symbolic link is returned, not the status of the file pointed to by the symbolic link.
linkinfo returns the st_dev field of the Unix C stat structure returned by the lstat system call. Returns 0 or FALSE in case of error.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE if the filename exists and is writable.
Returns TRUE on success or FALSE on failure.
Returns TRUE if the file or directory specified by filename exists and is readable, FALSE otherwise.
Returns TRUE if the filename exists and is a symbolic link, FALSE otherwise.
Returns TRUE if the filename exists and is a regular file, FALSE otherwise.
") (prototype . "bool is_file(string $filename)") (purpose . "Tells whether the filename is a regular file") (id . "function.is-file")) "is_executable" ((documentation . "Tells whether the filename is executable bool is_executable(string $filename) Returns TRUE if the filename exists and is executable, or FALSE on error. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Note: 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.
Returns TRUE if the filename exists and is executable, or FALSE on error.
Returns TRUE if the filename exists and is a directory, FALSE otherwise.
Returns an array containing the matched files/directories, an empty array if no file matched or FALSE on error.
") (prototype . "array glob(string $pattern [, int $flags = ''])") (purpose . "Find pathnames matching a pattern") (id . "function.glob")) "fwrite" ((documentation . "Binary-safe file write int fwrite(resource $handle, string $string [, int $length = '']) fwrite returns the number of bytes written, or FALSE on error. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Note:
On some systems it is impossible to distinguish between empty match and an error.
fwrite returns the number of bytes written, or FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns the position of the file pointer referenced by handle as an integer; i.e., its offset into the file stream.
If an error occurs, returns FALSE.
") (prototype . "int ftell(resource $handle)") (purpose . "Returns the current position of the file read/write pointer") (id . "function.ftell")) "fstat" ((documentation . "Gets information about a file using an open file pointer array fstat(resource $handle) Returns an array with the statistics of the file; the format of the array is described in detail on the stat manual page. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Note: 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.
Returns an array with the statistics of the file; the format of the array is described in detail on the stat manual page.
") (prototype . "array fstat(resource $handle)") (purpose . "Gets information about a file using an open file pointer") (id . "function.fstat")) "fseek" ((documentation . "Seeks on a file pointer int fseek(resource $handle, int $offset [, int $whence = SEEK_SET]) Upon success, returns 0; otherwise, returns -1. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Upon success, returns 0; otherwise, returns -1.
") (prototype . "int fseek(resource $handle, int $offset [, int $whence = SEEK_SET])") (purpose . "Seeks on a file pointer") (id . "function.fseek")) "fscanf" ((documentation . "Parses input from a file according to a format mixed fscanf(resource $handle, string $format [, mixed $... = '']) If only two parameters were passed to this function, the values parsed will be returned as an array. Otherwise, if optional parameters are passed, the function will return the number of assigned values. The optional parameters must be passed by reference. (PHP 4 >= 4.0.1, PHP 5)") (versions . "PHP 4 >= 4.0.1, PHP 5") (return . "If only two parameters were passed to this function, the values parsed will be returned as an array. Otherwise, if optional parameters are passed, the function will return the number of assigned values. The optional parameters must be passed by reference.
") (prototype . "mixed fscanf(resource $handle, string $format [, mixed $... = ''])") (purpose . "Parses input from a file according to a format") (id . "function.fscanf")) "fread" ((documentation . "Binary-safe file read string fread(resource $handle, int $length) Returns the read string or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns the read string or FALSE on failure.
Returns the length of the written string or FALSE on failure.
If an error occurs, fpassthru returns FALSE. Otherwise, fpassthru returns the number of characters read from handle and passed through to the output.
Returns a file pointer resource on success, or FALSE on error.
Returns TRUE if there is a match, FALSE otherwise.
Returns TRUE on success or FALSE on failure.
Returns the type of the file. Possible values are fifo, char, dir, block, link, file, socket and unknown.
Returns FALSE if an error occurs. filetype will also produce an E_NOTICE message if the stat call fails or if the file type is unknown.
Returns the size of the file in bytes, or FALSE (and generates an error of level E_WARNING) in case of an error.
") (prototype . "int filesize(string $filename)") (purpose . "Gets file size") (id . "function.filesize")) "fileperms" ((documentation . "Gets file permissions int fileperms(string $filename) Returns the file's permissions as a numeric mode. Lower bits of this mode are the same as the permissions expected by chmod, however on most platforms the return value will also include information on the type of file given as filename. The examples below demonstrate how to test the return value for specific permissions and file types on POSIX systems, including Linux and Mac OS X. For local files, the specific return value is that of the st_mode member of the structure returned by the C library's stat function. Exactly which bits are set can vary from platform to platform, and looking up your specific platform's documentation is recommended if parsing the non-permission bits of the return value is required. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Note: 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.
Returns the file's permissions as a numeric mode. Lower bits of this mode are the same as the permissions expected by chmod, however on most platforms the return value will also include information on the type of file given as filename. The examples below demonstrate how to test the return value for specific permissions and file types on POSIX systems, including Linux and Mac OS X.
For local files, the specific return value is that of the st_mode member of the structure returned by the C library's stat function. Exactly which bits are set can vary from platform to platform, and looking up your specific platform's documentation is recommended if parsing the non-permission bits of the return value is required.
") (prototype . "int fileperms(string $filename)") (purpose . "Gets file permissions") (id . "function.fileperms")) "fileowner" ((documentation . "Gets file owner int fileowner(string $filename) Returns the user ID of the owner of the file, or FALSE on failure. The user ID is returned in numerical format, use posix_getpwuid to resolve it to a username. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns the user ID of the owner of the file, or FALSE on failure. The user ID is returned in numerical format, use posix_getpwuid to resolve it to a username.
Returns the time the file was last modified, or FALSE on failure. The time is returned as a Unix timestamp, which is suitable for the date function.
Returns the inode number of the file, or FALSE on failure.
Returns the group ID of the file, or FALSE if an error occurs. The group ID is returned in numerical format, use posix_getgrgid to resolve it to a group name. Upon failure, FALSE is returned.
Returns the time the file was last changed, or FALSE on failure. The time is returned as a Unix timestamp.
Returns the time the file was last accessed, or FALSE on failure. The time is returned as a Unix timestamp.
Returns the file in an array. Each element of the array corresponds to a line in the file, with the newline still attached. Upon failure, file returns FALSE.
Note:
Each line in the resulting array will include the line ending, unless
FILE_IGNORE_NEW_LINESis used, so you still need to use rtrim if you do not want the line ending present.
") (prototype . "array file(string $filename [, int $flags = '' [, resource $context = '']])") (purpose . "Reads entire file into an array") (id . "function.file")) "file_put_contents" ((documentation . #("Write a string to a file int file_put_contents(string $filename, mixed $data [, int $flags = '' [, resource $context = '']]) This function returns the number of bytes that were written to the file, or FALSE on failure. Warning This function mayreturn Boolean FALSE, but may also return a non-Boolean value whichevaluates to FALSE. Please read the section on Booleans for moreinformation. Use the ===operator for testing the return value of thisfunction. (PHP 5)" 362 370 (shr-url "language.types.boolean.html") 396 399 (shr-url "language.operators.comparison.html") 399 400 (shr-url "language.operators.comparison.html") 400 411 (shr-url "language.operators.comparison.html"))) (versions . "PHP 5") (return . "Note: If PHP is not properly recognizingthe line endings when reading files either on or created by a Macintoshcomputer, enabling theauto_detect_line_endingsrun-time configuration option may help resolve the problem.
This function returns the number of bytes that were written to the file, or FALSE on failure.
This function mayreturn Boolean FALSE, but may also return a non-Boolean value whichevaluates to FALSE. Please read the section on Booleans for moreinformation. Use the ===operator for testing the return value of thisfunction.
The function returns the read data or FALSE on failure.
This function mayreturn Boolean FALSE, but may also return a non-Boolean value whichevaluates to FALSE. Please read the section on Booleans for moreinformation. Use the ===operator for testing the return value of thisfunction.
Returns TRUE if the file or directory specified by filename exists; FALSE otherwise.
Note:
This function will return
FALSEfor symlinks pointing to non-existing files.
This function returns FALSE for files inaccessible due to safe mode restrictions. However these files still can be included if they are located in safe_mode_include_dir.
Note:
The check is done using the real UID/GID instead of the effective one.
") (prototype . "bool file_exists(string $filename)") (purpose . "Checks whether a file or directory exists") (id . "function.file-exists")) "fgetss" ((documentation . "Gets line from file pointer and strip HTML tags string fgetss(resource $handle [, int $length = '' [, string $allowable_tags = '']]) Returns a string of up to length - 1 bytes read from the file pointed to by handle, with all HTML and PHP code stripped. If an error occurs, returns FALSE. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Note: 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.
Returns a string of up to length - 1 bytes read from the file pointed to by handle, with all HTML and PHP code stripped.
If an error occurs, returns FALSE.
Returns a string of up to length - 1 bytes read from the file pointed to by handle. If there is no more data to read in the file pointer, then FALSE is returned.
If an error occurs, FALSE is returned.
Returns an indexed array containing the fields read.
Note:
A blank line in a CSV file will be returned as an array comprising a single null field, and will not be treated as an error.
Note: If PHP is not properly recognizingthe line endings when reading files either on or created by a Macintoshcomputer, enabling theauto_detect_line_endingsrun-time configuration option may help resolve the problem.
fgetcsv returns NULL if an invalid handle is supplied or FALSE on other errors, including end of file.
Returns a string containing a single character read from the file pointed to by handle. Returns FALSE on EOF.
This function mayreturn Boolean FALSE, but may also return a non-Boolean value whichevaluates to FALSE. Please read the section on Booleans for moreinformation. Use the ===operator for testing the return value of thisfunction.
Returns TRUE on success or FALSE on failure.
Returns TRUE if the file pointer is at EOF or an error occurs (including socket timeout); otherwise returns FALSE.
Returns TRUE on success or FALSE on failure.
Returns the total number of bytes as a float or FALSE on failure.
Returns the number of available bytes as a float or FALSE on failure.
Returns the path of the parent directory. If there are no slashes in path, a dot ('.') is returned, indicating the current directory. Otherwise, the returned string is path with any trailing /component removed.
No value is returned.
") (prototype . " delete()") (purpose . "See unlink or unset") (id . "function.delete")) "copy" ((documentation . "Copies file bool copy(string $source, string $dest [, resource $context = '']) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void clearstatcache([bool $clear_realpath_cache = false [, string $filename = '']])") (purpose . "Clears file status cache") (id . "function.clearstatcache")) "chown" ((documentation . "Changes file owner bool chown(string $filename, mixed $user) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the base name of the given path.
Returns the content type in MIME format, like text/plain or application/octet-stream.
") (prototype . "string mime_content_type(string $filename)") (purpose . "Detect MIME Content-type for a file (deprecated)") (id . "function.mime-content-type")) "finfo_set_flags" ((documentation . "Set libmagic configuration options bool finfo_set_flags(resource $finfo, int $options) Returns TRUE on success or FALSE on failure. (PHP >= 5.3.0, PECL fileinfo >= 0.1.0)") (versions . "PHP >= 5.3.0, PECL fileinfo >= 0.1.0") (return . " Returns TRUE on success or FALSE on failure.
(Procedural style only) Returns a magic database resource on success or FALSE on failure.
Returns a textual description of the contents of the filename argument, or FALSE if an error occurred.
Returns TRUE on success or FALSE on failure.
Returns a textual description of the string argument, or FALSE if an error occurred.
Returns an array of filenames on success, or FALSE on failure. If directory is not a directory, then boolean FALSE is returned, and an error of level E_WARNING is generated.
Returns the entry name on success or FALSE on failure.
This function mayreturn Boolean FALSE, but may also return a non-Boolean value whichevaluates to FALSE. Please read the section on Booleans for moreinformation. Use the ===operator for testing the return value of thisfunction.
Returns a directory handle resource on success, or FALSE on failure.
If path is not a valid directory or the directory can not be opened due to permission restrictions or filesystem errors, opendir returns FALSE and generates a PHP error of level E_WARNING. You can suppress the error output of opendir by prepending '@' to the front of the function name.
Returns the current working directory on success, or FALSE on failure.
On some Unix variants, getcwd will return FALSE if any one of the parent directories does not have the readable or search mode set, even if the current directory does. See chmod for more information on modes and permissions.
Returns an instance of Directory, or NULL with wrong parameters, or FALSE in case of another error.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the number of bytes written to fd.
Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "bool dio_tcsetattr(resource $fd, array $options)") (purpose . "Sets terminal attributes and baud rate for a serial port") (id . "function.dio-tcsetattr")) "dio_stat" ((documentation . "Gets stat information about the file descriptor fd array dio_stat(resource $fd) 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. (PHP 4 >= 4.2.0, PHP 5 <= 5.0.5)") (versions . "PHP 4 >= 4.2.0, PHP 5 <= 5.0.5") (return . "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
NULL. ") (prototype . "array dio_stat(resource $fd)") (purpose . "Gets stat information about the file descriptor fd") (id . "function.dio-stat")) "dio_seek" ((documentation . "Seeks to pos on fd from whence
int dio_seek(resource $fd, int $pos [, int $whence = SEEK_SET])
(PHP 4 >= 4.2.0, PHP 5 <= 5.0.5)") (versions . "PHP 4 >= 4.2.0, PHP 5 <= 5.0.5") (return . "") (prototype . "int dio_seek(resource $fd, int $pos [, int $whence = SEEK_SET])") (purpose . "Seeks to pos on fd from whence") (id . "function.dio-seek")) "dio_read" ((documentation . "Reads bytes from a file descriptor string dio_read(resource $fd [, int $len = 1024]) The bytes read from fd. (PHP 4 >= 4.2.0, PHP 5 <= 5.0.5)") (versions . "PHP 4 >= 4.2.0, PHP 5 <= 5.0.5") (return . "
The bytes read from fd.
A file descriptor or FALSE on error.
Returns the result of the C call.
") (prototype . "mixed dio_fcntl(resource $fd, int $cmd [, mixed $args = ''])") (purpose . "Performs a c library fcntl on fd") (id . "function.dio-fcntl")) "dio_close" ((documentation . "Closes the file descriptor given by fd void dio_close(resource $fd) No value is returned. (PHP 4 >= 4.2.0, PHP 5 <= 5.0.5)") (versions . "PHP 4 >= 4.2.0, PHP 5 <= 5.0.5") (return . "No value is returned.
") (prototype . "void dio_close(resource $fd)") (purpose . "Closes the file descriptor given by fd") (id . "function.dio-close")) "timezone_version_get" ((documentation . "Gets the version of the timezonedb string timezone_version_get() Returns a string. (PHP 5 >= 5.3.0)") (versions . "PHP 5 >= 5.3.0") (return . "Returns a string.
") (prototype . "string timezone_version_get()") (purpose . "Gets the version of the timezonedb") (id . "function.timezone-version-get")) "timezone_name_from_abbr" ((documentation . "Returns the timezone name from abbreviation string timezone_name_from_abbr(string $abbr [, int $gmtOffset = -1 [, int $isdst = -1]]) Returns time zone name on success or FALSE on failure. (PHP 5 >= 5.1.3)") (versions . "PHP 5 >= 5.1.3") (return . " Returns time zone name on success or FALSE on failure.
Returns a timestamp on success, FALSE otherwise. Previous to PHP 5.1.0, this function would return -1 on failure.
Returns an array or FALSE on failure.
| parameters | Description |
|---|---|
| "tm_sec" | Seconds after the minute (0-61) |
| "tm_min" | Minutes after the hour (0-59) |
| "tm_hour" | Hour since midnight (0-23) |
| "tm_mday" | Day of the month (1-31) |
| "tm_mon" | Months since January (0-11) |
| "tm_year" | Years since 1900 |
| "tm_wday" | Days since Sunday (0-6) |
| "tm_yday" | Days since January 1 (0-365) |
| "unparsed" | the date part which was not recognized using the specified format |
Returns a string formatted according format using the given timestamp or the current local time if no timestamp is given. Month and weekday names and other language-dependent strings respect the current locale set with setlocale.
mktime returns the Unix timestamp of the arguments given. If the arguments are invalid, the function returns FALSE (before PHP 5.1 it returned -1).
By default, microtime returns a string in the form "msec sec", where sec is the number of seconds since the Unix epoch (0:00:00 January 1,1970 GMT), and msec measures microseconds that have elapsed since sec and is also expressed in seconds.
If get_as_float is set to TRUE, then microtime returns a float, which represents the current time in seconds since the Unix epoch accurate to the nearest microsecond.
Returns an integer.
As idate always returns an integer and as they can't start with a "0", idate may return fewer digits than you would expect. See the example below.
") (prototype . "int idate(string $format [, int $timestamp = time()])") (purpose . "Format a local time/date as integer") (id . "function.idate")) "gmstrftime" ((documentation . "Format a GMT/UTC time/date according to locale settings string gmstrftime(string $format [, int $timestamp = time()]) Returns a string formatted according to the given format string using the given timestamp or the current local time if no timestamp is given. Month and weekday names and other language dependent strings respect the current locale set with setlocale. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns a string formatted according to the given format string using the given timestamp or the current local time if no timestamp is given. Month and weekday names and other language dependent strings respect the current locale set with setlocale.
Returns a integer Unix timestamp.
") (prototype . "int gmmktime([int $hour = gmdate(\"H\") [, int $minute = gmdate(\"i\") [, int $second = gmdate(\"s\") [, int $month = gmdate(\"n\") [, int $day = gmdate(\"j\") [, int $year = gmdate(\"Y\") [, int $is_dst = -1]]]]]]])") (purpose . "Get Unix timestamp for a GMT date") (id . "function.gmmktime")) "gmdate" ((documentation . "Format a GMT/UTC date/time string gmdate(string $format [, int $timestamp = time()]) Returns a formatted date string. If a non-numeric value is used for timestamp, FALSE is returned and an E_WARNING level error is emitted. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns a formatted date string. If a non-numeric value is used for timestamp, FALSE is returned and an E_WARNING level error is emitted.
By default an array is returned. If return_float is set, then a float is returned.
Array keys:
Returns an associative array of information related to the timestamp. Elements from the returned associative array are as follows:
| Key | Description | Example returned values |
|---|---|---|
| "seconds" | Numeric representation of seconds | 0 to 59 |
| "minutes" | Numeric representation of minutes | 0 to 59 |
| "hours" | Numeric representation of hours | 0 to 23 |
| "mday" | Numeric representation of the day of the month | 1 to 31 |
| "wday" | Numeric representation of the day of the week | 0 (for Sunday) through 6 (for Saturday) |
| "mon" | Numeric representation of a month | 1 through 12 |
| "year" | A full numeric representation of a year, 4 digits | Examples: 1999 or 2003 |
| "yday" | Numeric representation of the day of the year | 0 through 365 |
| "weekday" | A full textual representation of the day of the week | Sunday through Saturday |
| "month" | A full textual representation of a month, such as January or March | January through December |
| 0 | Seconds since the Unix Epoch, similar to the values returned by time and used by date. | System Dependent, typically -2147483648 through 2147483647. |
Returns a formatted date string. If a non-numeric value is used for timestamp, FALSE is returned and an E_WARNING level error is emitted.
Returns the sunset time in a specified format on success or FALSE on failure.
Returns the sunrise time in a specified format on success or FALSE on failure.
Returns array on success or FALSE on failure.
Returns array with information about the parsed date on success or FALSE on failure.
Returns associative array with detailed info about given date.
") (prototype . "array date_parse_from_format(string $format, string $date)") (purpose . "Get info about given date formatted according to the specified format") (id . "function.date-parse-from-format")) "date_interval_format" ((documentation . "Alias of DateInterval::format date_interval_format() (PHP 5 >= 5.3.0)") (versions . "PHP 5 >= 5.3.0") (return . "") (prototype . " date_interval_format()") (purpose . "Alias of DateInterval::format") (id . "function.date-interval-format")) "date_interval_create_from_date_string" ((documentation . "Alias of DateInterval::createFromDateString date_interval_create_from_date_string() (PHP 5 >= 5.3.0)") (versions . "PHP 5 >= 5.3.0") (return . "") (prototype . " date_interval_create_from_date_string()") (purpose . "Alias of DateInterval::createFromDateString") (id . "function.date-interval-create-from-date-string")) "date_default_timezone_set" ((documentation . "Sets the default timezone used by all date/time functions in a script bool date_default_timezone_set(string $timezone_identifier) This function returns FALSE if the timezone_identifier isn't valid, or TRUE otherwise. (PHP 5 >= 5.1.0)") (versions . "PHP 5 >= 5.1.0") (return . " This function returns FALSE if the timezone_identifier isn't valid, or TRUE otherwise.
Returns a string.
") (prototype . "string date_default_timezone_get()") (purpose . "Gets the default timezone used by all date/time functions in a script") (id . "function.date-default-timezone-get")) "checkdate" ((documentation . "Validate a Gregorian date bool checkdate(int $month, int $day, int $year) Returns TRUE if the date given is valid; otherwise returns FALSE. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE if the date given is valid; otherwise returns FALSE.
A julian day number as integer.
") (prototype . "int unixtojd([int $timestamp = time()])") (purpose . "Convert Unix timestamp to Julian Day") (id . "function.unixtojd")) "JulianToJD" ((documentation . "Converts a Julian Calendar date to Julian Day Count int JulianToJD(int $month, int $day, int $year) The julian day for the given julian date as an integer. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "The julian day for the given julian date as an integer.
") (prototype . "int JulianToJD(int $month, int $day, int $year)") (purpose . "Converts a Julian Calendar date to Julian Day Count") (id . "function.juliantojd")) "JewishToJD" ((documentation . "Converts a date in the Jewish Calendar to Julian Day Count int JewishToJD(int $month, int $day, int $year) The julian day for the given jewish date as an integer. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "The julian day for the given jewish date as an integer.
") (prototype . "int JewishToJD(int $month, int $day, int $year)") (purpose . "Converts a date in the Jewish Calendar to Julian Day Count") (id . "function.jewishtojd")) "jdtounix" ((documentation . "Convert Julian Day to Unix timestamp int jdtounix(int $jday) The unix timestamp for the start of the given julian day. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "The unix timestamp for the start of the given julian day.
") (prototype . "int jdtounix(int $jday)") (purpose . "Convert Julian Day to Unix timestamp") (id . "function.jdtounix")) "JDToJulian" ((documentation . "Converts a Julian Day Count to a Julian Calendar Date string JDToJulian(int $julianday) The julian date as a string in the form \"month/day/year\" (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "The julian date as a string in the form "month/day/year"
") (prototype . "string JDToJulian(int $julianday)") (purpose . "Converts a Julian Day Count to a Julian Calendar Date") (id . "function.jdtojulian")) "jdtojewish" ((documentation . "Converts a Julian day count to a Jewish calendar date string jdtojewish(int $juliandaycount [, bool $hebrew = false [, int $fl = '']]) The jewish date as a string in the form \"month/day/year\" (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "The jewish date as a string in the form "month/day/year"
") (prototype . "string jdtojewish(int $juliandaycount [, bool $hebrew = false [, int $fl = '']])") (purpose . "Converts a Julian day count to a Jewish calendar date") (id . "function.jdtojewish")) "JDToGregorian" ((documentation . "Converts Julian Day Count to Gregorian date string JDToGregorian(int $julianday) The gregorian date as a string in the form \"month/day/year\" (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "The gregorian date as a string in the form "month/day/year"
") (prototype . "string JDToGregorian(int $julianday)") (purpose . "Converts Julian Day Count to Gregorian date") (id . "function.jdtogregorian")) "JDToFrench" ((documentation . "Converts a Julian Day Count to the French Republican Calendar string JDToFrench(int $juliandaycount) The french revolution date as a string in the form \"month/day/year\" (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "The french revolution date as a string in the form "month/day/year"
") (prototype . "string JDToFrench(int $juliandaycount)") (purpose . "Converts a Julian Day Count to the French Republican Calendar") (id . "function.jdtofrench")) "JDMonthName" ((documentation . "Returns a month name string JDMonthName(int $julianday, int $mode) The month name for the given Julian Day and calendar. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " The month name for the given Julian Day and calendar.
The gregorian weekday as either an integer or string.
") (prototype . "mixed JDDayOfWeek(int $julianday [, int $mode = CAL_DOW_DAYNO])") (purpose . "Returns the day of the week") (id . "function.jddayofweek")) "GregorianToJD" ((documentation . "Converts a Gregorian date to Julian Day Count int GregorianToJD(int $month, int $day, int $year) The julian day for the given gregorian date as an integer. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "The julian day for the given gregorian date as an integer.
") (prototype . "int GregorianToJD(int $month, int $day, int $year)") (purpose . "Converts a Gregorian date to Julian Day Count") (id . "function.gregoriantojd")) "FrenchToJD" ((documentation . "Converts a date from the French Republican Calendar to a Julian Day Count int FrenchToJD(int $month, int $day, int $year) The julian day for the given french revolution date as an integer. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "The julian day for the given french revolution date as an integer.
") (prototype . "int FrenchToJD(int $month, int $day, int $year)") (purpose . "Converts a date from the French Republican Calendar to a Julian Day Count") (id . "function.frenchtojd")) "easter_days" ((documentation . "Get number of days after March 21 on which Easter falls for a given year int easter_days([int $year = '' [, int $method = CAL_EASTER_DEFAULT]]) The number of days after March 21st that the Easter Sunday is in the given year. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " The number of days after March 21st that the Easter Sunday is in the given year.
The easter date as a unix timestamp.
") (prototype . "int easter_date([int $year = ''])") (purpose . "Get Unix timestamp for midnight on Easter of a given year") (id . "function.easter-date")) "cal_to_jd" ((documentation . "Converts from a supported calendar to Julian Day Count int cal_to_jd(int $calendar, int $month, int $day, int $year) A Julian Day number. (PHP 4 >= 4.1.0, PHP 5)") (versions . "PHP 4 >= 4.1.0, PHP 5") (return . "A Julian Day number.
") (prototype . "int cal_to_jd(int $calendar, int $month, int $day, int $year)") (purpose . "Converts from a supported calendar to Julian Day Count") (id . "function.cal-to-jd")) "cal_info" ((documentation . "Returns information about a particular calendar array cal_info([int $calendar = -1]) (PHP 4 >= 4.1.0, PHP 5)") (versions . "PHP 4 >= 4.1.0, PHP 5") (return . "") (prototype . "array cal_info([int $calendar = -1])") (purpose . "Returns information about a particular calendar") (id . "function.cal-info")) "cal_from_jd" ((documentation . "Converts from Julian Day Count to a supported calendar array cal_from_jd(int $jd, int $calendar) Returns an array containing calendar information like month, day, year, day of week, abbreviated and full names of weekday and month and the date in string form \"month/day/year\". (PHP 4 >= 4.1.0, PHP 5)") (versions . "PHP 4 >= 4.1.0, PHP 5") (return . "
Returns an array containing calendar information like month, day, year, day of week, abbreviated and full names of weekday and month and the date in string form "month/day/year".
") (prototype . "array cal_from_jd(int $jd, int $calendar)") (purpose . "Converts from Julian Day Count to a supported calendar") (id . "function.cal-from-jd")) "cal_days_in_month" ((documentation . "Return the number of days in a month for a given year and calendar int cal_days_in_month(int $calendar, int $month, int $year) The length in days of the selected month in the given calendar (PHP 4 >= 4.1.0, PHP 5)") (versions . "PHP 4 >= 4.1.0, PHP 5") (return . "The length in days of the selected month in the given calendar
") (prototype . "int cal_days_in_month(int $calendar, int $month, int $year)") (purpose . "Return the number of days in a month for a given year and calendar") (id . "function.cal-days-in-month")) "sybase_unbuffered_query" ((documentation . "Send a Sybase query and do not block resource sybase_unbuffered_query(string $query, resource $link_identifier [, bool $store_result = '']) Returns a positive Sybase result identifier on success, or FALSE on error. (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . " Returns a positive Sybase result identifier on success, or FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
sybase_result returns the contents of one cell from a Sybase result set.
") (prototype . "string sybase_result(resource $result, int $row, mixed $field)") (purpose . "Get result data") (id . "function.sybase-result")) "sybase_query" ((documentation . "Sends a Sybase query mixed sybase_query(string $query [, resource $link_identifier = '']) Returns a positive Sybase result identifier on success, FALSE on error, or TRUE if the query was successful but didn't return any columns. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns a positive Sybase result identifier on success, FALSE on error, or TRUE if the query was successful but didn't return any columns.
Returns a positive Sybase persistent link identifier on success, or FALSE on error.
Returns the number of rows as an integer.
") (prototype . "int sybase_num_rows(resource $result)") (purpose . "Get number of rows in a result set") (id . "function.sybase-num-rows")) "sybase_num_fields" ((documentation . "Gets the number of fields in a result set int sybase_num_fields(resource $result) Returns the number of fields as an integer. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the number of fields as an integer.
") (prototype . "int sybase_num_fields(resource $result)") (purpose . "Gets the number of fields in a result set") (id . "function.sybase-num-fields")) "sybase_min_server_severity" ((documentation . "Sets minimum server severity void sybase_min_server_severity(int $severity) No value is returned. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "No value is returned.
") (prototype . "void sybase_min_server_severity(int $severity)") (purpose . "Sets minimum server severity") (id . "function.sybase-min-server-severity")) "sybase_min_message_severity" ((documentation . "Sets minimum message severity void sybase_min_message_severity(int $severity) No value is returned. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "No value is returned.
") (prototype . "void sybase_min_message_severity(int $severity)") (purpose . "Sets minimum message severity") (id . "function.sybase-min-message-severity")) "sybase_min_error_severity" ((documentation . "Sets minimum error severity void sybase_min_error_severity(int $severity) No value is returned. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "No value is returned.
") (prototype . "void sybase_min_error_severity(int $severity)") (purpose . "Sets minimum error severity") (id . "function.sybase-min-error-severity")) "sybase_min_client_severity" ((documentation . "Sets minimum client severity void sybase_min_client_severity(int $severity) No value is returned. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "No value is returned.
") (prototype . "void sybase_min_client_severity(int $severity)") (purpose . "Sets minimum client severity") (id . "function.sybase-min-client-severity")) "sybase_get_last_message" ((documentation . "Returns the last message from the server string sybase_get_last_message() Returns the message as a string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the message as a string.
") (prototype . "string sybase_get_last_message()") (purpose . "Returns the last message from the server") (id . "function.sybase-get-last-message")) "sybase_free_result" ((documentation . "Frees result memory bool sybase_free_result(resource $result) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
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.
| PHP | Sybase |
|---|---|
| string | VARCHAR, TEXT, CHAR, IMAGE, BINARY, VARBINARY, DATETIME |
| int | NUMERIC (w/o precision), DECIMAL (w/o precision), INT, BIT, TINYINT, SMALLINT |
| float | NUMERIC (w/ precision), DECIMAL (w/ precision), REAL, FLOAT, MONEY |
NULL | NULL |
Returns an object with properties that correspond to the fetched row, or FALSE if there are no more rows.
Returns an object containing field information.
The properties of the object are:
Returns an array that corresponds to the fetched row, or FALSE if there are no more rows.
Returns an array that corresponds to the fetched row, or FALSE if there are no more rows.
") (prototype . "array sybase_fetch_array(resource $result)") (purpose . "Fetch row as array") (id . "function.sybase-fetch-array")) "sybase_deadlock_retry_count" ((documentation . "Sets the deadlock retry count void sybase_deadlock_retry_count(int $retry_count) No value is returned. (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . "Note:
When selecting fields with identical names (for instance, in a join), the associative indices will have a sequential number prepended. See the example for details.
No value is returned.
") (prototype . "void sybase_deadlock_retry_count(int $retry_count)") (purpose . "Sets the deadlock retry count") (id . "function.sybase-deadlock-retry-count")) "sybase_data_seek" ((documentation . "Moves internal row pointer bool sybase_data_seek(resource $result_identifier, int $row_number) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns a positive Sybase link identifier on success, or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the number of affected rows, as an integer.
") (prototype . "int sybase_affected_rows([resource $link_identifier = ''])") (purpose . "Gets number of affected rows in last query") (id . "function.sybase-affected-rows")) "sqlsrv_server_info" ((documentation . "Returns information about the server array sqlsrv_server_info(resource $conn) 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. ()") (versions . "") (return . "Returns an array as described in the following table:
| CurrentDatabase | The connected-to database. |
|---|---|
| SQLServerVersion | The SQL Server version. |
| SQLServerName | The name of the server. |
Returns TRUE if there is more data to send and FALSE if there is not.
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.
Returns TRUE on success or FALSE on failure.
Returns a statement resource on success and FALSE if an error occurred.
Returns a statement resource on success and FALSE if an error occurred.
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.
Returns the number of fields on success. Returns FALSE otherwise.
Returns TRUE if the next result was successfully retrieved, FALSE if an error occurred, and NULL if there are no more results to retrieve.
Returns TRUE if the specified statement has rows and FALSE if the statement does not have rows or if an error occurred.
Returns data from the specified field on success. Returns FALSE otherwise.
Returns the value of the specified setting. If an invalid setting is specified, FALSE is returned.
Returns TRUE on success or FALSE on failure.
Returns an array of arrays is returned on success. Otherwise, FALSE is returned. Each returned array is described by the following table:
| 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. |
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.
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.
Returns an array on success, NULL if there are no more rows to return, and FALSE if an error occurs.
Returns TRUE on success or FALSE on failure.
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:
| 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. |
A connection resource. If a connection cannot be successfully opened, FALSE is returned.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns an associative array with keys described in the table below. Returns FALSE otherwise.
| 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) |
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE if there are more rows available from the result handle, or FALSE otherwise.
Returns a result handle or FALSE on failure.
sqlite_unbuffered_query returns a sequential forward-only result set that can only be used to read each row, one after the other.
") (prototype . "SQLiteUnbuffered sqlite_unbuffered_query(resource $dbhandle, string $query [, int $result_type = SQLITE_BOTH [, string $error_msg = '']])") (purpose . "Execute a query that does not prefetch and buffer all data") (id . "function.sqlite-unbuffered-query")) "sqlite_udf_encode_binary" ((documentation . "Encode binary data before returning it from an UDF string sqlite_udf_encode_binary(string $data) The encoded string. (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0)") (versions . "PHP 5 < 5.4.0, PECL sqlite >= 1.0.0") (return . "The encoded string.
") (prototype . "string sqlite_udf_encode_binary(string $data)") (purpose . "Encode binary data before returning it from an UDF") (id . "function.sqlite-udf-encode-binary")) "sqlite_udf_decode_binary" ((documentation . "Decode binary data passed as parameters to an UDF string sqlite_udf_decode_binary(string $data) The decoded string. (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0)") (versions . "PHP 5 < 5.4.0, PECL sqlite >= 1.0.0") (return . "The decoded string.
") (prototype . "string sqlite_udf_decode_binary(string $data)") (purpose . "Decode binary data passed as parameters to an UDF") (id . "function.sqlite-udf-decode-binary")) "sqlite_single_query" ((documentation . "Executes a query and returns either an array for one single column or the value of the first row array sqlite_single_query(resource $db, string $query [, bool $first_row_only = '' [, bool $decode_binary = '']]) (PHP 5 < 5.4.0, PECL sqlite >= 1.0.1)") (versions . "PHP 5 < 5.4.0, PECL sqlite >= 1.0.1") (return . "") (prototype . "array sqlite_single_query(resource $db, string $query [, bool $first_row_only = '' [, bool $decode_binary = '']])") (purpose . "Executes a query and returns either an array for one single column or the value of the first row") (id . "function.sqlite-single-query")) "sqlite_seek" ((documentation . "Seek to a particular row number of a buffered result set bool sqlite_seek(resource $result, int $rownum) Returns FALSE if the row does not exist, TRUE otherwise. (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0)") (versions . "PHP 5 < 5.4.0, PECL sqlite >= 1.0.0") (return . " Returns FALSE if the row does not exist, TRUE otherwise.
Returns FALSE if there are no rows in the result set, TRUE otherwise.
This function will return a result handle or FALSE on failure. For queries that return rows, the result handle can then be used with functions such as sqlite_fetch_array and sqlite_seek.
Regardless of the query type, this function will return FALSE if the query failed.
sqlite_query returns a buffered, seekable result handle. This is useful for reasonably small queries where you need to be able to randomly access the rows. Buffered result handles will allocate memory to hold the entire result and will not return until it has been fetched. If you only need sequential access to the data, it is recommended that you use the much higher performance sqlite_unbuffered_query instead.
") (prototype . "SQLiteResult sqlite_query(resource $dbhandle, string $query [, int $result_type = SQLITE_BOTH [, string $error_msg = '']])") (purpose . "Executes a query against a given database and returns a result handle") (id . "function.sqlite-query")) "sqlite_prev" ((documentation . "Seek to the previous row number of a result set bool sqlite_prev(resource $result) Returns TRUE on success, or FALSE if there are no more previous rows. (PHP 5 < 5.4.0)") (versions . "PHP 5 < 5.4.0") (return . " Returns TRUE on success, or FALSE if there are no more previous rows.
Returns a resource (database handle) on success, FALSE on error.
Returns a resource (database handle) on success, FALSE on error.
Returns the number of rows, as an integer.
") (prototype . "int sqlite_num_rows(resource $result)") (purpose . "Returns the number of rows in a buffered result set") (id . "function.sqlite-num-rows")) "sqlite_num_fields" ((documentation . "Returns the number of fields in a result set int sqlite_num_fields(resource $result) Returns the number of fields, as an integer. (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0)") (versions . "PHP 5 < 5.4.0, PECL sqlite >= 1.0.0") (return . "Returns the number of fields, as an integer.
") (prototype . "int sqlite_num_fields(resource $result)") (purpose . "Returns the number of fields in a result set") (id . "function.sqlite-num-fields")) "sqlite_next" ((documentation . "Seek to the next row number bool sqlite_next(resource $result) Returns TRUE on success, or FALSE if there are no more rows. (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0)") (versions . "PHP 5 < 5.4.0, PECL sqlite >= 1.0.0") (return . " Returns TRUE on success, or FALSE if there are no more rows.
Returns the library version, as a string.
") (prototype . "string sqlite_libversion()") (purpose . "Returns the version of the linked SQLite library") (id . "function.sqlite-libversion")) "sqlite_libencoding" ((documentation . "Returns the encoding of the linked SQLite library string sqlite_libencoding() Returns the library encoding. (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0)") (versions . "PHP 5 < 5.4.0, PECL sqlite >= 1.0.0") (return . "Returns the library encoding.
") (prototype . "string sqlite_libencoding()") (purpose . "Returns the encoding of the linked SQLite library") (id . "function.sqlite-libencoding")) "sqlite_last_insert_rowid" ((documentation . "Returns the rowid of the most recently inserted row int sqlite_last_insert_rowid(resource $dbhandle) Returns the row id, as an integer. (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0)") (versions . "PHP 5 < 5.4.0, PECL sqlite >= 1.0.0") (return . "Returns the row id, as an integer.
") (prototype . "int sqlite_last_insert_rowid(resource $dbhandle)") (purpose . "Returns the rowid of the most recently inserted row") (id . "function.sqlite-last-insert-rowid")) "sqlite_last_error" ((documentation . "Returns the error code of the last error for a database int sqlite_last_error(resource $dbhandle) Returns an error code, or 0 if no error occurred. (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0)") (versions . "PHP 5 < 5.4.0, PECL sqlite >= 1.0.0") (return . "Returns an error code, or 0 if no error occurred.
") (prototype . "int sqlite_last_error(resource $dbhandle)") (purpose . "Returns the error code of the last error for a database") (id . "function.sqlite-last-error")) "sqlite_key" ((documentation . "Returns the current row index int sqlite_key() Returns the current row index of the buffered result set result. (PHP 5 >= 5.1.0 and < 5.4.0)") (versions . "PHP 5 >= 5.1.0 and < 5.4.0") (return . " Returns the current row index of the buffered result set result.
Returns TRUE if there are more previous rows available from the result handle, or FALSE otherwise.
Returns TRUE if there are more rows available from the result handle, or FALSE otherwise.
Returns the name of a field in an SQLite result set, given the ordinal column number; FALSE on error.
The column names returned bySQLITE_ASSOC and SQLITE_BOTH will becase-folded according to the value of thesqlite.assoc_case configurationoption.
Returns the first column value, as a string.
") (prototype . "string sqlite_fetch_single(resource $result [, bool $decode_binary = true])") (purpose . "Fetches the first column of a result set as a string") (id . "function.sqlite-fetch-single")) "sqlite_fetch_object" ((documentation . "Fetches the next row from a result set as an object object sqlite_fetch_object(resource $result [, string $class_name = '' [, array $ctor_params = '' [, bool $decode_binary = true]]]) (PHP 5 < 5.4.0)") (versions . "PHP 5 < 5.4.0") (return . "") (prototype . "object sqlite_fetch_object(resource $result [, string $class_name = '' [, array $ctor_params = '' [, bool $decode_binary = true]]])") (purpose . "Fetches the next row from a result set as an object") (id . "function.sqlite-fetch-object")) "sqlite_fetch_column_types" ((documentation . #("Return an array of column types from a particular table array sqlite_fetch_column_types(string $table_name, resource $dbhandle [, int $result_type = SQLITE_ASSOC]) Returns an array of column data types; FALSE on error. The column names returned bySQLITE_ASSOC and SQLITE_BOTH will becase-folded according to the value of thesqlite.assoc_case configurationoption. (PHP 5 < 5.4.0)" 327 344 (shr-url "sqlite.configuration.html#ini.sqlite.assoc-case"))) (versions . "PHP 5 < 5.4.0") (return . " Returns an array of column data types; FALSE on error.
The column names returned bySQLITE_ASSOC and SQLITE_BOTH will becase-folded according to the value of thesqlite.assoc_case configurationoption.
Returns an array of the next row from a result set; FALSE if the next position is beyond the final row.
The column names returned bySQLITE_ASSOC and SQLITE_BOTH will becase-folded according to the value of thesqlite.assoc_case configurationoption.
Returns an array of the remaining rows in a result set. If called right after sqlite_query, it returns all rows. If called after sqlite_fetch_array, it returns the rest. If there are no rows in a result set, it returns an empty array.
The column names returned bySQLITE_ASSOC and SQLITE_BOTH will becase-folded according to the value of thesqlite.assoc_case configurationoption.
Returns an SQLiteDatabase object on success, NULL on error.
This function will return a boolean result; TRUE for success or FALSE for failure. If you need to run a query that returns rows, see sqlite_query.
The column names returned bySQLITE_ASSOC and SQLITE_BOTH will becase-folded according to the value of thesqlite.assoc_case configurationoption.
Returns an escaped string for use in an SQLite SQL statement.
") (prototype . "string sqlite_escape_string(string $item)") (purpose . "Escapes a string for use as a query parameter") (id . "function.sqlite-escape-string")) "sqlite_error_string" ((documentation . "Returns the textual description of an error code string sqlite_error_string(int $error_code) Returns a human readable description of the error_code, as a string. (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0)") (versions . "PHP 5 < 5.4.0, PECL sqlite >= 1.0.0") (return . " Returns a human readable description of the error_code, as a string.
Returns an array of the current row from a result set; FALSE if the current position is beyond the final row.
The column names returned bySQLITE_ASSOC and SQLITE_BOTH will becase-folded according to the value of thesqlite.assoc_case configurationoption.
No value is returned.
") (prototype . "void sqlite_create_function(resource $dbhandle, string $function_name, callable $callback [, int $num_args = -1])") (purpose . "Registers a \"regular\" User Defined Function for use in SQL statements") (id . "function.sqlite-create-function")) "sqlite_create_aggregate" ((documentation . "Register an aggregating UDF for use in SQL statements void sqlite_create_aggregate(resource $dbhandle, string $function_name, callable $step_func, callable $finalize_func [, int $num_args = -1]) No value is returned. (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0)") (versions . "PHP 5 < 5.4.0, PECL sqlite >= 1.0.0") (return . "No value is returned.
") (prototype . "void sqlite_create_aggregate(resource $dbhandle, string $function_name, callable $step_func, callable $finalize_func [, int $num_args = -1])") (purpose . "Register an aggregating UDF for use in SQL statements") (id . "function.sqlite-create-aggregate")) "sqlite_column" ((documentation . "Fetches a column from the current row of a result set mixed sqlite_column(resource $result, mixed $index_or_name [, bool $decode_binary = true]) Returns the column value. (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0)") (versions . "PHP 5 < 5.4.0, PECL sqlite >= 1.0.0") (return . "Returns the column value.
") (prototype . "mixed sqlite_column(resource $result, mixed $index_or_name [, bool $decode_binary = true])") (purpose . "Fetches a column from the current row of a result set") (id . "function.sqlite-column")) "sqlite_close" ((documentation . "Closes an open SQLite database void sqlite_close(resource $dbhandle) No value is returned. (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0)") (versions . "PHP 5 < 5.4.0, PECL sqlite >= 1.0.0") (return . "No value is returned.
") (prototype . "void sqlite_close(resource $dbhandle)") (purpose . "Closes an open SQLite database") (id . "function.sqlite-close")) "sqlite_changes" ((documentation . "Returns the number of rows that were changed by the most recent SQL statement int sqlite_changes(resource $dbhandle) Returns the number of changed rows. (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0)") (versions . "PHP 5 < 5.4.0, PECL sqlite >= 1.0.0") (return . "Returns the number of changed rows.
") (prototype . "int sqlite_changes(resource $dbhandle)") (purpose . "Returns the number of rows that were changed by the most recent SQL statement") (id . "function.sqlite-changes")) "sqlite_busy_timeout" ((documentation . "Set busy timeout duration, or disable busy handlers void sqlite_busy_timeout(resource $dbhandle, int $milliseconds) No value is returned. (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0)") (versions . "PHP 5 < 5.4.0, PECL sqlite >= 1.0.0") (return . "No value is returned.
") (prototype . "void sqlite_busy_timeout(resource $dbhandle, int $milliseconds)") (purpose . "Set busy timeout duration, or disable busy handlers") (id . "function.sqlite-busy-timeout")) "sqlite_array_query" ((documentation . #("Execute a query against a given database and returns an array array sqlite_array_query(resource $dbhandle, string $query [, int $result_type = SQLITE_BOTH [, bool $decode_binary = true]]) Returns an array of the entire result set; FALSE otherwise. The column names returned bySQLITE_ASSOC and SQLITE_BOTH will becase-folded according to the value of thesqlite.assoc_case configurationoption. (PHP 5 < 5.4.0, PECL sqlite >= 1.0.0)" 356 373 (shr-url "sqlite.configuration.html#ini.sqlite.assoc-case"))) (versions . "PHP 5 < 5.4.0, PECL sqlite >= 1.0.0") (return . " Returns an array of the entire result set; FALSE otherwise.
The column names returned bySQLITE_ASSOC and SQLITE_BOTH will becase-folded according to the value of thesqlite.assoc_case configurationoption.
Returns an array with client, protocol and server keys and values (if available). Returns FALSE on error or invalid connection.
Returns TRUE on success or FALSE on failure. Returns string if PGSQL_DML_STRING is passed via options.
Always returns TRUE.
A string containing the unescaped data.
") (prototype . "string pg_unescape_bytea(string $data)") (purpose . "Unescape binary for bytea type") (id . "function.pg-unescape-bytea")) "pg_tty" ((documentation . "Return the TTY name associated with the connection string pg_tty([resource $connection = '']) A string containing the debug TTY of the connection, or FALSE on error. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " A string containing the debug TTY of the connection, or FALSE on error.
The status can be PGSQL_TRANSACTION_IDLE (currently idle), PGSQL_TRANSACTION_ACTIVE (a command is in progress), PGSQL_TRANSACTION_INTRANS (idle, in a valid transaction block), or PGSQL_TRANSACTION_INERROR (idle, in a failed transaction block). PGSQL_TRANSACTION_UNKNOWN is reported if the connection is bad. PGSQL_TRANSACTION_ACTIVE is reported only when a query has been sent to the server and not yet completed.
Returns TRUE on success or FALSE on failure.
The previous verbosity level: PGSQL_ERRORS_TERSE, PGSQL_ERRORS_DEFAULT or PGSQL_ERRORS_VERBOSE.
Returns 0 on success or -1 on error.
") (prototype . "int pg_set_client_encoding([resource $connection = '', string $encoding])") (purpose . "Set the client encoding") (id . "function.pg-set-client-encoding")) "pg_send_query" ((documentation . "Sends asynchronous query bool pg_send_query(resource $connection, string $query) Returns TRUE on success or FALSE on failure. Use pg_get_result to determine the query result. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . "Returns TRUE on success or FALSE on failure.
Use pg_get_result to determine the query result.
") (prototype . "bool pg_send_query(resource $connection, string $query)") (purpose . "Sends asynchronous query") (id . "function.pg-send-query")) "pg_send_query_params" ((documentation . "Submits a command and separate parameters to the server without waiting for the result(s). bool pg_send_query_params(resource $connection, string $query, array $params) Returns TRUE on success or FALSE on failure. Use pg_get_result to determine the query result. (PHP 5 >= 5.1.0)") (versions . "PHP 5 >= 5.1.0") (return . "Returns TRUE on success or FALSE on failure.
Use pg_get_result to determine the query result.
") (prototype . "bool pg_send_query_params(resource $connection, string $query, array $params)") (purpose . "Submits a command and separate parameters to the server without waiting for the result(s).") (id . "function.pg-send-query-params")) "pg_send_prepare" ((documentation . "Sends a request to create a prepared statement with the given parameters, without waiting for completion. bool pg_send_prepare(resource $connection, string $stmtname, string $query) Returns TRUE on success, FALSE on failure. Use pg_get_result to determine the query result. (PHP 5 >= 5.1.0)") (versions . "PHP 5 >= 5.1.0") (return . "Returns TRUE on success, FALSE on failure. Use pg_get_result to determine the query result.
Returns TRUE on success, FALSE on failure. Use pg_get_result to determine the query result.
Returns TRUE on success or FALSE on failure. Returns string if PGSQL_DML_STRING is passed via options.
Possible return values are PGSQL_EMPTY_QUERY, PGSQL_COMMAND_OK, PGSQL_TUPLES_OK, PGSQL_COPY_OUT, PGSQL_COPY_IN, PGSQL_BAD_RESPONSE, PGSQL_NONFATAL_ERROR and PGSQL_FATAL_ERROR if PGSQL_STATUS_LONG is specified. Otherwise, a string containing the PostgreSQL command tag is returned.
Returns TRUE on success or FALSE on failure.
Returns a string if there is an error associated with the result parameter, FALSE otherwise.
A string containing the contents of the error field, NULL if the field does not exist or FALSE on failure.
A query result resource on success or FALSE on failure.
A query result resource on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
A query result resource on success or FALSE on failure.
An int containing the port number of the database server the connection is to, or FALSE on error.
Returns TRUE on success or FALSE on failure.
PostgreSQL connection resource on success, FALSE on failure.
A string containing the value of the parameter, FALSE on failure or invalid param_name.
A string containing the connection options, or FALSE on error.
The number of rows in the result. On error, -1 is returned.
") (prototype . "int pg_num_rows(resource $result)") (purpose . "Returns the number of rows in a result") (id . "function.pg-num-rows")) "pg_num_fields" ((documentation . "Returns the number of fields in a result int pg_num_fields(resource $result) The number of fields (columns) in the result. On error, -1 is returned. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . "The number of fields (columns) in the result. On error, -1 is returned.
") (prototype . "int pg_num_fields(resource $result)") (purpose . "Returns the number of fields in a result") (id . "function.pg-num-fields")) "pg_meta_data" ((documentation . "Get meta data for table array pg_meta_data(resource $connection, string $table_name [, bool $extended = '']) An array of the table definition, or FALSE on error. (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . " An array of the table definition, or FALSE on error.
The number of bytes written to the large object, or FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
The current seek offset (in number of bytes) from the beginning of the large object. If there is an error, the return value is negative.
") (prototype . "int pg_lo_tell(resource $large_object)") (purpose . "Returns current seek position a of large object") (id . "function.pg-lo-tell")) "pg_lo_seek" ((documentation . "Seeks position within a large object bool pg_lo_seek(resource $large_object, int $offset [, int $whence = PGSQL_SEEK_CUR]) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
A string containing len bytes from the large object, or FALSE on error.
Number of bytes read or FALSE on error.
A large object resource or FALSE on error.
The OID of the newly created large object, or FALSE on failure.
Returns TRUE on success or FALSE on failure.
A large object OID or FALSE on error.
Returns TRUE on success or FALSE on failure.
A string containing the OID assigned to the most recently inserted row in the specified connection, or FALSE on error or no available OID.
A string containing the last notice on the given connection, or FALSE on error.
A string containing the last error message on the given connection, or FALSE on error.
Returns TRUE on success or FALSE on failure. Returns string if PGSQL_DML_STRING is passed via options.
A string containing the name of the host the connection is to, or FALSE on error.
The result resource, or FALSE if no more results are available.
The backend database process ID.
") (prototype . "int pg_get_pid(resource $connection)") (purpose . "Gets the backend's process ID") (id . "function.pg-get-pid")) "pg_get_notify" ((documentation . "Gets SQL NOTIFY message array pg_get_notify(resource $connection [, int $result_type = '']) An array containing the NOTIFY message name and backend PID. Otherwise if no NOTIFY is waiting, then FALSE is returned. (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . " An array containing the NOTIFY message name and backend PID. Otherwise if no NOTIFY is waiting, then FALSE is returned.
Returns TRUE on success or FALSE on failure.
A string containing the base name of the field's type, or FALSE on error.
The OID of the field's base type. FALSE is returned on error.
On success either the fields table name or oid. Or, FALSE on failure.
The internal field storage size (in bytes). -1 indicates a variable length field. FALSE is returned on error.
The field printed length, or FALSE on error.
The field number (numbered from 0), or -1 on error.
") (prototype . "int pg_field_num(resource $result, string $field_name)") (purpose . "Returns the field number of the named field") (id . "function.pg-field-num")) "pg_field_name" ((documentation . "Returns the name of a field string pg_field_name(resource $result, int $field_number) The field name, or FALSE on error. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . " The field name, or FALSE on error.
Returns 1 if the field in the given row is SQL NULL, 0 if not. FALSE is returned if the row is out of range, or upon any other error.
An array, indexed from 0 upwards, with each value represented as a string. Database NULL values are returned as NULL.
FALSE is returned if row exceeds the number of rows in the set, there are no more rows, or on any other error.
Boolean is returned as "t" or "f". All other types, including arrays are returned as strings formatted in the same default PostgreSQL manner that you would see in the psql program. Database NULL values are returned as NULL.
FALSE is returned if row exceeds the number of rows in the set, or on any other error.
An object with one attribute for each field name in the result. Database NULL values are returned as NULL.
FALSE is returned if row exceeds the number of rows in the set, there are no more rows, or on any other error.
An array indexed associatively (by field name). Each value in the array is represented as a string. Database NULL values are returned as NULL.
FALSE is returned if row exceeds the number of rows in the set, there are no more rows, or on any other error.
An array indexed numerically (beginning with 0) or associatively (indexed by field name), or both. Each value in the array is represented as a string. Database NULL values are returned as NULL.
FALSE is returned if row exceeds the number of rows in the set, there are no more rows, or on any other error.
An array with all rows in the result. Each row is an array of field values indexed by field name.
FALSE is returned if there are no rows in the result, or on any other error.
An array with all values in the result column.
FALSE is returned if column is larger than the number of columns in the result, or on any other error.
A query result resource on success or FALSE on failure.
A string containing the escaped data.
") (prototype . "string pg_escape_string([resource $connection = '', string $data])") (purpose . "Escape a string for query") (id . "function.pg-escape-string")) "pg_escape_literal" ((documentation . "Escape a literal for insertion into a text field string pg_escape_literal([resource $connection = '', string $data]) A string containing the escaped data. (PHP 5 >= 5.4.4)") (versions . "PHP 5 >= 5.4.4") (return . "A string containing the escaped data.
") (prototype . "string pg_escape_literal([resource $connection = '', string $data])") (purpose . "Escape a literal for insertion into a text field") (id . "function.pg-escape-literal")) "pg_escape_identifier" ((documentation . "Escape a identifier for insertion into a text field string pg_escape_identifier([resource $connection = '', string $data]) A string containing the escaped data. (PHP 5 >= 5.4.4)") (versions . "PHP 5 >= 5.4.4") (return . "A string containing the escaped data.
") (prototype . "string pg_escape_identifier([resource $connection = '', string $data])") (purpose . "Escape a identifier for insertion into a text field") (id . "function.pg-escape-identifier")) "pg_escape_bytea" ((documentation . "Escape a string for insertion into a bytea field string pg_escape_bytea([resource $connection = '', string $data]) A string containing the escaped data. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . "A string containing the escaped data.
") (prototype . "string pg_escape_bytea([resource $connection = '', string $data])") (purpose . "Escape a string for insertion into a bytea field") (id . "function.pg-escape-bytea")) "pg_end_copy" ((documentation . "Sync with PostgreSQL backend bool pg_end_copy([resource $connection = '']) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.3, PHP 5)") (versions . "PHP 4 >= 4.0.3, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure. Returns string if PGSQL_DML_STRING is passed via options.
A string containing the name of the database the connection is to, or FALSE on error.
An array with one element for each line of COPY data. It returns FALSE on failure.
Returns TRUE on success or FALSE on failure.
An array of converted values, or FALSE on error.
PGSQL_CONNECTION_OK or PGSQL_CONNECTION_BAD.
Returns TRUE on success or FALSE on failure.
Returns TRUE if the connection is busy, FALSE otherwise.
PostgreSQL connection resource on success, FALSE on failure.
Returns TRUE on success or FALSE on failure.
The client encoding, or FALSE on error.
Returns TRUE on success or FALSE on failure.
The number of rows affected by the query. If no tuple is affected, it will return 0.
") (prototype . "int pg_affected_rows(resource $result)") (purpose . "Returns number of affected records (tuples)") (id . "function.pg-affected-rows")) "px_update_record" ((documentation . "Updates record in paradox database bool px_update_record(resource $pxdoc, array $data, int $num) Returns TRUE on success or FALSE on failure. (PECL paradox >= 1.4.0)") (versions . "PECL paradox >= 1.4.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns FALSE if the encoding could not be set, e.g. the encoding is unknown, or pxlib does not support recoding at all. In the second case a warning will be issued.
Returns NULL on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the num'th record from the paradox database. The record is returned as an associated array with its keys being the field names.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the number of records in a database file. The return value of this function is identical to the element numrecords in the array returned by px_get_info.
") (prototype . "int px_numrecords(resource $pxdoc)") (purpose . "Returns number of records in a database") (id . "function.px-numrecords")) "px_numfields" ((documentation . "Returns number of fields in a database int px_numfields(resource $pxdoc) Returns the number of fields in a database file. The return value of this function is identical to the element numfields in the array returned by px_get_info. (PECL paradox >= 1.0.0)") (versions . "PECL paradox >= 1.0.0") (return . "Returns the number of fields in a database file. The return value of this function is identical to the element numfields in the array returned by px_get_info.
") (prototype . "int px_numfields(resource $pxdoc)") (purpose . "Returns number of fields in a database") (id . "function.px-numfields")) "px_new" ((documentation . "Create a new paradox object resource px_new() Returns FALSE on failure. (PECL paradox >= 1.0.0)") (versions . "PECL paradox >= 1.0.0") (return . " Returns FALSE on failure.
Returns FALSE on failure or the record number in case of success.
Returns the value of the parameter or FALSE on failure.
Returns the schema of a database file as an associated array. The key name is equal to the field name. Each array element is itself an associated array containing the two fields type and size. type is one of the constants in table Constants for field types. size is the number of bytes this field consumes in the record. The total of all field sizes is equal to the record size as it can be retrieved with px-get-info.
") (prototype . "array px_get_schema(resource $pxdoc [, int $mode = ''])") (purpose . "Returns the database schema") (id . "function.px-get-schema")) "px_get_record" ((documentation . "Returns record of paradox database array px_get_record(resource $pxdoc, int $num [, int $mode = '']) Returns the num'th record from the paradox database. The record is returned as an associated array with its keys being the field names. (PECL paradox >= 1.0.0)") (versions . "PECL paradox >= 1.0.0") (return . " Returns the num'th record from the paradox database. The record is returned as an associated array with its keys being the field names.
Returns the value of the parameter or FALSE on failure.
Returns an associated array with lots of information about a paradox file. This array is likely to be extended in the future.
Version of file multiplied by 10, e.g. 70.
Name of table as stored in the file. If the database was created by pxlib, then this will be the name of the file without the extension.
Number of records in this table.
Number of fields in this table.
Number of bytes used for the header. This is usually 0x800.
Number of bytes used for each record. This is the sum of all field sizes (available since version 1.4.2).
This value multiplied by 0x400 is the size of a data block in bytes. The maximum number of records in a datablock is the integer part of (maxtablesize * 0x400 - 8) / recordsize.
The number of data blocks in the file. Each data block contains a certain number of records which depends on the record size and the data block size (maxtablesize). Data blocks may not necessarily be completely filled.
Number of fields used for the primary index. The fields do always start with field number 1.
The DOS codepage which was used for encoding fields with character data. If the target encoding is not set with px_set_targetencoding this will be the encoding for character fields when records are being accessed with px_get_record or px_retrieve_record.
Returns the specification of the fieldno'th database field as an associated array. The array contains three fields named name, type, and size.
") (prototype . "array px_get_field(resource $pxdoc, int $fieldno)") (purpose . "Returns the specification of a single field") (id . "function.px-get-field")) "px_delete" ((documentation . "Deletes resource of paradox database bool px_delete(resource $pxdoc) Returns TRUE on success or FALSE on failure. (PECL paradox >= 1.0.0)") (versions . "PECL paradox >= 1.0.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the column as a string, FALSE on failure.
Returns the number of rows in the generated table.
") (prototype . "int ovrimos_result_all(int $result_id [, string $format = ''])") (purpose . "Prints the whole result set as an HTML table") (id . "function.ovrimos-result-all")) "ovrimos_prepare" ((documentation . "Prepares an SQL statement int ovrimos_prepare(int $connection_id, string $query) Returns a result identifier on success, or FALSE on error. (PHP 4 >= 4.0.3, PHP 5 <= 5.0.5)") (versions . "PHP 4 >= 4.0.3, PHP 5 <= 5.0.5") (return . " Returns a result identifier on success, or FALSE on error.
Returns the number of rows as an integer, or FALSE on error.
Returns the number of columns as an integer, or FALSE on error.
Returns TRUE.
Returns TRUE.
Returns the field type as an integer, or FALSE on error.
Returns the index, starting at 1, or FALSE on error.
Returns the field name as a string, or FALSE on error.
Returns the length as an integer, or FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the result identifier as an integer, or FALSE on error.
Returns the name as a string, or FALSE on error.
Returns a connection identifier (greater than 0) on success, or 0 on failure.
") (prototype . "int ovrimos_connect(string $host, string $dborport, string $user, string $password)") (purpose . "Connect to the specified database") (id . "function.ovrimos-connect")) "ovrimos_commit" ((documentation . "Commits the transaction bool ovrimos_commit(int $connection_id) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.3, PHP 5 <= 5.0.5)") (versions . "PHP 4 >= 4.0.3, PHP 5 <= 5.0.5") (return . " Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void ovrimos_close(int $connection)") (purpose . "Closes the connection to ovrimos") (id . "function.ovrimos-close")) "ociwritetemporarylob" ((documentation . "Alias of OCI-Lob::writeTemporary ociwritetemporarylob() (PHP 4 >= 4.0.6, PECL OCI8 1.0)") (versions . "PHP 4 >= 4.0.6, PECL OCI8 1.0") (return . "") (prototype . " ociwritetemporarylob()") (purpose . "Alias of OCI-Lob::writeTemporary") (id . "function.ociwritetemporarylob")) "ociwritelobtofile" ((documentation . "Alias of OCI-Lob::export ociwritelobtofile() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ociwritelobtofile()") (purpose . "Alias of OCI-Lob::export") (id . "function.ociwritelobtofile")) "ocistatementtype" ((documentation . "Alias of oci_statement_type ocistatementtype() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocistatementtype()") (purpose . "Alias of oci_statement_type") (id . "function.ocistatementtype")) "ocisetprefetch" ((documentation . "Alias of oci_set_prefetch ocisetprefetch() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocisetprefetch()") (purpose . "Alias of oci_set_prefetch") (id . "function.ocisetprefetch")) "ociserverversion" ((documentation . "Alias of oci_server_version ociserverversion() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ociserverversion()") (purpose . "Alias of oci_server_version") (id . "function.ociserverversion")) "ocisavelobfile" ((documentation . "Alias of OCI-Lob::import ocisavelobfile() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocisavelobfile()") (purpose . "Alias of OCI-Lob::import") (id . "function.ocisavelobfile")) "ocisavelob" ((documentation . "Alias of OCI-Lob::save ocisavelob() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocisavelob()") (purpose . "Alias of OCI-Lob::save") (id . "function.ocisavelob")) "ocirowcount" ((documentation . "Alias of oci_num_rows ocirowcount() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocirowcount()") (purpose . "Alias of oci_num_rows") (id . "function.ocirowcount")) "ocirollback" ((documentation . "Alias of oci_rollback ocirollback() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocirollback()") (purpose . "Alias of oci_rollback") (id . "function.ocirollback")) "ociresult" ((documentation . "Alias of oci_result ociresult() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ociresult()") (purpose . "Alias of oci_result") (id . "function.ociresult")) "ociplogon" ((documentation . "Alias of oci_pconnect ociplogon() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ociplogon()") (purpose . "Alias of oci_pconnect") (id . "function.ociplogon")) "ociparse" ((documentation . "Alias of oci_parse ociparse() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ociparse()") (purpose . "Alias of oci_parse") (id . "function.ociparse")) "ocinumcols" ((documentation . "Alias of oci_num_fields ocinumcols() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocinumcols()") (purpose . "Alias of oci_num_fields") (id . "function.ocinumcols")) "ocinlogon" ((documentation . "Alias of oci_new_connect ocinlogon() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocinlogon()") (purpose . "Alias of oci_new_connect") (id . "function.ocinlogon")) "ocinewdescriptor" ((documentation . "Alias of oci_new_descriptor ocinewdescriptor() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocinewdescriptor()") (purpose . "Alias of oci_new_descriptor") (id . "function.ocinewdescriptor")) "ocinewcursor" ((documentation . "Alias of oci_new_cursor ocinewcursor() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocinewcursor()") (purpose . "Alias of oci_new_cursor") (id . "function.ocinewcursor")) "ocinewcollection" ((documentation . "Alias of oci_new_collection ocinewcollection() (PHP 4 >= 4.0.6, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4 >= 4.0.6, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocinewcollection()") (purpose . "Alias of oci_new_collection") (id . "function.ocinewcollection")) "ocilogon" ((documentation . "Alias of oci_connect ocilogon() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocilogon()") (purpose . "Alias of oci_connect") (id . "function.ocilogon")) "ocilogoff" ((documentation . "Alias of oci_close ocilogoff() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocilogoff()") (purpose . "Alias of oci_close") (id . "function.ocilogoff")) "ociloadlob" ((documentation . "Alias of OCI-Lob::load ociloadlob() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ociloadlob()") (purpose . "Alias of OCI-Lob::load") (id . "function.ociloadlob")) "ociinternaldebug" ((documentation . "Alias of oci_internal_debug ociinternaldebug() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ociinternaldebug()") (purpose . "Alias of oci_internal_debug") (id . "function.ociinternaldebug")) "ocifreestatement" ((documentation . "Alias of oci_free_statement ocifreestatement() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocifreestatement()") (purpose . "Alias of oci_free_statement") (id . "function.ocifreestatement")) "ocifreedesc" ((documentation . "Alias of OCI-Lob::free ocifreedesc() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocifreedesc()") (purpose . "Alias of OCI-Lob::free") (id . "function.ocifreedesc")) "ocifreecursor" ((documentation . "Alias of oci_free_statement ocifreecursor() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocifreecursor()") (purpose . "Alias of oci_free_statement") (id . "function.ocifreecursor")) "ocifreecollection" ((documentation . "Alias of OCI-Collection::free ocifreecollection() (PHP 4 >= 4.0.7, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocifreecollection()") (purpose . "Alias of OCI-Collection::free") (id . "function.ocifreecollection")) "ocifetchstatement" ((documentation . "Alias of oci_fetch_all ocifetchstatement() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocifetchstatement()") (purpose . "Alias of oci_fetch_all") (id . "function.ocifetchstatement")) "ocifetchinto" ((documentation . "Obsolete variant of oci_fetch_array, oci_fetch_object, oci_fetch_assoc and oci_fetch_row ocifetchinto() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocifetchinto()") (purpose . "Obsolete variant of oci_fetch_array, oci_fetch_object, oci_fetch_assoc and oci_fetch_row") (id . "function.ocifetchinto")) "ocifetch" ((documentation . "Alias of oci_fetch ocifetch() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocifetch()") (purpose . "Alias of oci_fetch") (id . "function.ocifetch")) "ociexecute" ((documentation . "Alias of oci_execute ociexecute() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ociexecute()") (purpose . "Alias of oci_execute") (id . "function.ociexecute")) "ocierror" ((documentation . "Alias of oci_error ocierror() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocierror()") (purpose . "Alias of oci_error") (id . "function.ocierror")) "ocidefinebyname" ((documentation . "Alias of oci_define_by_name ocidefinebyname() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocidefinebyname()") (purpose . "Alias of oci_define_by_name") (id . "function.ocidefinebyname")) "ocicommit" ((documentation . "Alias of oci_commit ocicommit() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocicommit()") (purpose . "Alias of oci_commit") (id . "function.ocicommit")) "ocicolumntyperaw" ((documentation . "Alias of oci_field_type_raw ocicolumntyperaw() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocicolumntyperaw()") (purpose . "Alias of oci_field_type_raw") (id . "function.ocicolumntyperaw")) "ocicolumntype" ((documentation . "Alias of oci_field_type ocicolumntype() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocicolumntype()") (purpose . "Alias of oci_field_type") (id . "function.ocicolumntype")) "ocicolumnsize" ((documentation . "Alias of oci_field_size ocicolumnsize() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocicolumnsize()") (purpose . "Alias of oci_field_size") (id . "function.ocicolumnsize")) "ocicolumnscale" ((documentation . "Alias of oci_field_scale ocicolumnscale() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocicolumnscale()") (purpose . "Alias of oci_field_scale") (id . "function.ocicolumnscale")) "ocicolumnprecision" ((documentation . "Alias of oci_field_precision ocicolumnprecision() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocicolumnprecision()") (purpose . "Alias of oci_field_precision") (id . "function.ocicolumnprecision")) "ocicolumnname" ((documentation . "Alias of oci_field_name ocicolumnname() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocicolumnname()") (purpose . "Alias of oci_field_name") (id . "function.ocicolumnname")) "ocicolumnisnull" ((documentation . "Alias of oci_field_is_null ocicolumnisnull() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocicolumnisnull()") (purpose . "Alias of oci_field_is_null") (id . "function.ocicolumnisnull")) "ocicolltrim" ((documentation . "Alias of OCI-Collection::trim ocicolltrim() (PHP 4 >= 4.0.6, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4 >= 4.0.6, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocicolltrim()") (purpose . "Alias of OCI-Collection::trim") (id . "function.ocicolltrim")) "ocicollsize" ((documentation . "Alias of OCI-Collection::size ocicollsize() (PHP 4 >= 4.0.6, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4 >= 4.0.6, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocicollsize()") (purpose . "Alias of OCI-Collection::size") (id . "function.ocicollsize")) "ocicollmax" ((documentation . "Alias of OCI-Collection::max ocicollmax() (PHP 4 >= 4.0.6, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4 >= 4.0.6, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocicollmax()") (purpose . "Alias of OCI-Collection::max") (id . "function.ocicollmax")) "ocicollgetelem" ((documentation . "Alias of OCI-Collection::getElem ocicollgetelem() (PHP 4 >= 4.0.6, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4 >= 4.0.6, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocicollgetelem()") (purpose . "Alias of OCI-Collection::getElem") (id . "function.ocicollgetelem")) "ocicollassignelem" ((documentation . "Alias of OCI-Collection::assignElem ocicollassignelem() (PHP 4 >= 4.0.6, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4 >= 4.0.6, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocicollassignelem()") (purpose . "Alias of OCI-Collection::assignElem") (id . "function.ocicollassignelem")) "ocicollassign" ((documentation . "Alias of OCI-Collection::assign ocicollassign() (PHP 4 >= 4.0.6, PECL OCI8 1.0)") (versions . "PHP 4 >= 4.0.6, PECL OCI8 1.0") (return . "") (prototype . " ocicollassign()") (purpose . "Alias of OCI-Collection::assign") (id . "function.ocicollassign")) "ocicollappend" ((documentation . "Alias of OCI-Collection::append ocicollappend() (PHP 4 >= 4.0.6, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4 >= 4.0.6, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocicollappend()") (purpose . "Alias of OCI-Collection::append") (id . "function.ocicollappend")) "ocicloselob" ((documentation . "Alias of OCI-Lob::close ocicloselob() (PHP 4 >= 4.0.6, PECL OCI8 1.0)") (versions . "PHP 4 >= 4.0.6, PECL OCI8 1.0") (return . "") (prototype . " ocicloselob()") (purpose . "Alias of OCI-Lob::close") (id . "function.ocicloselob")) "ocicancel" ((documentation . "Alias of oci_cancel ocicancel() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocicancel()") (purpose . "Alias of oci_cancel") (id . "function.ocicancel")) "ocibindbyname" ((documentation . "Alias of oci_bind_by_name ocibindbyname() (PHP 4, PHP 5, PECL OCI8 >= 1.0.0)") (versions . "PHP 4, PHP 5, PECL OCI8 >= 1.0.0") (return . "") (prototype . " ocibindbyname()") (purpose . "Alias of oci_bind_by_name") (id . "function.ocibindbyname")) "oci_statement_type" ((documentation . "Returns the type of a statement string oci_statement_type(resource $statement) Returns the type of statement as one of the following strings. Statement type Return String Notes ALTER BEGIN CALL Introduced in PHP 5.2.1 (PECL OCI8 1.2.3) CREATE DECLARE DELETE DROP INSERT SELECT UPDATE UNKNOWN Returns FALSE on error. (PHP 5, PECL OCI8 >= 1.1.0)") (versions . "PHP 5, PECL OCI8 >= 1.1.0") (return . " Returns the type of statement as one of the following strings.
| Return String | Notes |
|---|---|
| ALTER | |
| BEGIN | |
| CALL | Introduced in PHP 5.2.1 (PECL OCI8 1.2.3) |
| CREATE | |
| DECLARE | |
| DELETE | |
| DROP | |
| INSERT | |
| SELECT | |
| UPDATE | |
| UNKNOWN |
Returns FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the version information as a string or FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns everything as strings except for abstract types (ROWIDs, LOBs and FILEs). Returns FALSE on error.
Returns a connection identifier or FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns a statement handle on success, or FALSE on error.
Returns the number of rows affected as an integer, or FALSE on errors.
Returns the number of columns as an integer, or FALSE on errors.
Returns a new LOB or FILE descriptor on success, FALSE on error.
Returns a new statement handle, or FALSE on error.
Returns a connection identifier or FALSE on error.
Returns a new OCICollection object or FALSE on error.
Returns TRUE if these objects are equal, FALSE otherwise.
Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void oci_internal_debug(bool $onoff)") (purpose . "Enables or disables internal debug output") (id . "function.oci-internal-debug")) "oci_get_implicit_resultset" ((documentation . "Returns the next child statement resource from a parent statement resource that has Oracle Database 12c Implicit Result Sets resource oci_get_implicit_resultset(resource $statement) Returns a statement handle for the next child statement available on statement. Returns FALSE when child statements do not exist, or all child statements have been returned by previous calls to oci_get_implicit_resultset. (PECL OCI8 >= 2.0.0)") (versions . "PECL OCI8 >= 2.0.0") (return . " Returns a statement handle for the next child statement available on statement. Returns FALSE when child statements do not exist, or all child statements have been returned by previous calls to oci_get_implicit_resultset.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the field data type as a string, or FALSE on errors.
Returns Oracle's raw data type as a number, or FALSE on errors.
Returns the size of a field in bytes, or FALSE on errors.
Returns the scale as an integer, or FALSE on errors.
Returns the precision as an integer, or FALSE on errors.
Returns the name as a string, or FALSE on errors.
Returns TRUE if field is NULL, FALSE otherwise.
Returns TRUE on success or FALSE if there are no more rows in the statement.
Returns a numerically indexed array. If there are no more rows in the statement then FALSE is returned.
Returns an object. Each attribute of the object corresponds to a column of the row. If there are no more rows in the statement then FALSE is returned.
Any LOB columns are returned as LOB descriptors.
DATE columns are returned as strings formatted to the current date format. The default format can be changed with Oracle environment variables such as NLS_LANG or by a previously executed ALTER SESSION SET NLS_DATE_FORMAT command.
Oracle's default, non-case sensitive column names will have uppercase attribute names. Case-sensitive column names will have attribute names using the exact column case. Use var_dump on the result object to verify the appropriate case for attribute access.
Attribute values will be NULL for any NULL data fields.
Returns an associative array. If there are no more rows in the statement then FALSE is returned.
Returns an array with associative and/or numeric indices. If there are no more rows in the statement then FALSE is returned.
By default, LOB columns are returned as LOB descriptors.
DATE columns are returned as strings formatted to the current date format. The default format can be changed with Oracle environment variables such as NLS_LANG or by a previously executed ALTER SESSION SET NLS_DATE_FORMAT command.
Oracle's default, non-case sensitive column names will have uppercase associative indices in the result array. Case-sensitive column names will have array indices using the exact column case. Use var_dump on the result array to verify the appropriate case to use for each query.
The table name is not included in the array index. If your query contains two different columns with the same name, use OCI_NUM or add a column alias to the query to ensure name uniqueness, see example #7. Otherwise only one column will be returned via PHP.
Returns the number of rows in output, which may be 0 or more, or FALSE on failure.
Returns TRUE on success or FALSE on failure.
If no error is found, oci_error returns FALSE. Otherwise, oci_error returns the error information as an associative array.
| Array key | Type | Description |
|---|---|---|
| code | integer | The Oracle error number. |
| message | string | The Oracle error text. |
| offset | integer | The byte position of an error in the SQL statement. If there was no statement, this is 0 |
| sqltext | string | The SQL statement text. If there was no statement, this is an empty string. |
Returns TRUE on success or FALSE on failure.
Returns a connection identifier or FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the version number as a string.
") (prototype . "string oci_client_version()") (purpose . "Returns the Oracle client library version") (id . "function.oci-client-version")) "oci_cancel" ((documentation . "Cancels reading from cursor bool oci_cancel(resource $statement) Returns TRUE on success or FALSE on failure. (PHP 5, PECL OCI8 >= 1.1.0)") (versions . "PHP 5, PECL OCI8 >= 1.1.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
TRUE if the association or disassociation is successful, otherwise FALSE if there is an error.
An array of mysqlnd_memcache configuration information on success, otherwise FALSE.
The returned array has these elements:
| Array Key | Description |
|---|---|
| memcached | Instance of Memcached associated to this MySQL connection by mysqlnd_memcache_set. You can use this to change settings of the memcache connection, or directly by querying the server on this connection. |
| pattern | The PCRE regular expression used to match the SQL query sent to the server. Queries matching this pattern will be further analyzed to decide whether the query can be intercepted and sent via the memcache interface or whether the query is sent using the general MySQL protocol to the server. The pattern is either the default pattern (MYSQLND_MEMCACHE_DEFAULT_REGEXP) or it is set via mysqlnd_memcache_set. |
| mappings | An associative array with a list of all configured containers as they were discovered by this plugin. The key for these elements is the name of the container in the MySQL configuration. The value is described below. The contents of this field is created by querying the MySQL Server during association to MySQL and a memcache connection using mysqlnd_memcache_set. |
| mapping_query | An SQL query used during mysqlnd_memcache_set to identify the available containers and mappings. The result of that query is provided in the mappings element. |
| Array Key | Description |
|---|---|
| prefix | A prefix used while accessing data via memcache. With the MySQL InnoDB Memcache Deamon plugin, this usually begins with @@ and ends with a configurable separator. This prefix is placed in front of the key value while using the memcache protocol. |
| schema_name | Name of the schema (database) which contains the table being accessed. |
| table_name | Name of the table which contains the data accessible via memcache protocol. |
| id_field_name | Name of the database field (column) with the id used as key when accessing the table via memcache. Often this is the database field having a primary key. |
| separator | The separator used to split the different field values. This is needed as memcache only provides access to a single value while MySQL can map multiple columns to this value.
|
| fields | An array with the name of all fields available for this mapping. |
Returns TRUE on success. Otherwise, returns FALSE
Returns TRUE on success. Otherwise, returns FALSE
A mysqlnd connection handle.
") (prototype . "resource mysqlnd_uh_convert_to_mysqlnd(mysqli $mysql_connection)") (purpose . "Converts a MySQL connection handle into a mysqlnd connection handle") (id . "function.mysqlnd-uh-convert-to-mysqlnd")) "mysqlnd_qc_set_user_handlers" ((documentation . "Sets the callback functions for a user-defined procedural storage handler bool mysqlnd_qc_set_user_handlers(string $get_hash, string $find_query_in_cache, string $return_to_cache, string $add_query_to_cache_if_not_exists, string $query_is_select, string $update_query_run_time_stats, string $get_stats, string $clear_cache) Returns TRUE on success or FALSE on FAILURE. (PECL mysqlnd_qc >= 1.0.0)") (versions . "PECL mysqlnd_qc >= 1.0.0") (return . "Returns TRUE on success or FALSE on FAILURE.
") (prototype . "bool mysqlnd_qc_set_user_handlers(string $get_hash, string $find_query_in_cache, string $return_to_cache, string $add_query_to_cache_if_not_exists, string $query_is_select, string $update_query_run_time_stats, string $get_stats, string $clear_cache)") (purpose . "Sets the callback functions for a user-defined procedural storage handler") (id . "function.mysqlnd-qc-set-user-handlers")) "mysqlnd_qc_set_storage_handler" ((documentation . "Change current storage handler bool mysqlnd_qc_set_storage_handler(string $handler) Returns TRUE on success or FALSE on failure. If changing the storage handler fails a catchable fatal error will be thrown. The query cache cannot operate if the previous storage handler has been shutdown but no new storage handler has been installed. (PECL mysqlnd_qc >= 1.0.0)") (versions . "PECL mysqlnd_qc >= 1.0.0") (return . " Returns TRUE on success or FALSE on failure.
If changing the storage handler fails a catchable fatal error will be thrown. The query cache cannot operate if the previous storage handler has been shutdown but no new storage handler has been installed.
") (prototype . "bool mysqlnd_qc_set_storage_handler(string $handler)") (purpose . "Change current storage handler") (id . "function.mysqlnd-qc-set-storage-handler")) "mysqlnd_qc_set_is_select" ((documentation . "Installs a callback which decides whether a statement is cached mixed mysqlnd_qc_set_is_select(string $callback) Returns TRUE on success or FALSE on failure. (PECL mysqlnd_qc >= 1.0.0)") (versions . "PECL mysqlnd_qc >= 1.0.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on FAILURE.
") (prototype . "bool mysqlnd_qc_set_cache_condition(int $condition_type, mixed $condition, mixed $condition_option)") (purpose . "Set conditions for automatic caching") (id . "function.mysqlnd-qc-set-cache-condition")) "mysqlnd_qc_get_query_trace_log" ((documentation . "Returns a backtrace for each query inspected by the query cache array mysqlnd_qc_get_query_trace_log() An array of query backtrace. Every list entry contains the query string, a backtrace and further detail information. Key Description query Query string. origin Code backtrace. run_time Query run time in milliseconds. The collection of all times and the necessary gettimeofday system calls can be disabled by setting the PHP configuration directive mysqlnd_qc.time_statistics to 0 store_time Query result set store time in milliseconds. The collection of all times and the necessary gettimeofday system calls can be disabled by setting the PHP configuration directive mysqlnd_qc.time_statistics to 0 eligible_for_caching TRUE if query is cacheable otherwise FALSE. no_table TRUE if the query has generated a result set and at least one column from the result set has no table name set in its metadata. This is usually the case with queries which one probably do not want to cache such as SELECT SLEEP(1). By default any such query will not be added to the cache. See also PHP configuration directive mysqlnd_qc.cache_no_table. was_added TRUE if the query result has been put into the cache, otherwise FALSE. was_already_in_cache TRUE if the query result would have been added to the cache if it was not already in the cache (cache hit). Otherwise FALSE. (PECL mysqlnd_qc >= 1.0.0)") (versions . "PECL mysqlnd_qc >= 1.0.0") (return . "An array of query backtrace. Every list entry contains the query string, a backtrace and further detail information.
| Key | Description |
|---|---|
| query | Query string. |
| origin | Code backtrace. |
| run_time | Query run time in milliseconds. The collection of all times and the necessary gettimeofday system calls can be disabled by setting the PHP configuration directive mysqlnd_qc.time_statistics to 0 |
| store_time | Query result set store time in milliseconds. The collection of all times and the necessary gettimeofday system calls can be disabled by setting the PHP configuration directive mysqlnd_qc.time_statistics to 0 |
| eligible_for_caching | TRUE if query is cacheable otherwise FALSE. |
| no_table | TRUE if the query has generated a result set and at least one column from the result set has no table name set in its metadata. This is usually the case with queries which one probably do not want to cache such as SELECT SLEEP(1). By default any such query will not be added to the cache. See also PHP configuration directive mysqlnd_qc.cache_no_table. |
| was_added | TRUE if the query result has been put into the cache, otherwise FALSE. |
| was_already_in_cache | TRUE if the query result would have been added to the cache if it was not already in the cache (cache hit). Otherwise FALSE. |
An array of query log. Every list entry contains the normalized query stringand further detail information.
| Key | Description |
|---|---|
| query | Normalized statement string. |
| occurences | How many statements have matched the normalized statement string in addition to the one which has created the log entry. The value is zero if a statement has been normalized, its normalized representation has been added to the log but no further queries inspected by PECL/mysqlnd_qc have the same normalized statement string. |
| eligible_for_caching | Whether the statement could be cached. An statement eligible for caching has not necessarily been cached. It not possible to tell for sure if or how many cached statement have contributed to the aggregated normalized statement log entry. However, comparing the minimum and average run time one can make an educated guess. |
| avg_run_time | The average run time of all queries contributing to the query log entry. The run time is the time between sending the query statement to MySQL and receiving an answer from MySQL. |
| avg_store_time | The average store time of all queries contributing to the query log entry. The store time is the time needed to fetch a statements result set from the server to the client and, storing it on the client. |
| min_run_time | The minimum run time of all queries contributing to the query log entry. |
| min_store_time | The minimum store time of all queries contributing to the query log entry. |
| max_run_time | The maximum run time of all queries contributing to the query log entry. |
| max_store_time | The maximum store time of all queries contributing to the query log entry. |
Array of core statistics
| Statistic | Description | Version |
|---|---|---|
| cache_hit | Statement is considered cacheable and cached data has been reused. Statement is considered cacheable and a cache miss happened but the statement got cached by someone else while we process it and thus we can fetch the result from the refreshed cache. | Since 1.0.0. |
| cache_miss | Statement is considered cacheable...
| Since 1.0.0. |
| cache_put | Statement is considered cacheable and has been added to the cache. Take care when calculating derived statistics. Storage handler with a storage life time beyond process scope may report cache_put = 0 together with cache_hit > 0, if another process has filled the cache. You may want to use num_entries from mysqlnd_qc_get_cache_info if the handler supports it ( default, APC). | Since 1.0.0. |
| query_should_cache | Statement is considered cacheable based on query string analysis. The statement may or may not be added to the cache. See also cache_put. | Since 1.0.0. |
| query_should_not_cache | Statement is considered not cacheable based on query string analysis. | Since 1.0.0. |
| query_not_cached | Statement is considered not cacheable or it is considered cachable but the storage handler has not returned a hash key for it. | Since 1.0.0. |
| query_could_cache | Statement is considered cacheable...
| Since 1.0.0. |
| query_found_in_cache | Statement is considered cacheable and we have found it in the cache but we have not replayed the cached data yet and we have not send the result set to the client yet. This is not considered a cache hit because the client might not fetch the result or the cached data may be faulty. | Since 1.0.0. |
| query_uncached_other | Statement is considered cacheable and it may or may not be in the cache already but either replaying cached data has failed, no result set is available or some other error has happened. | |
| query_uncached_no_table | Statement has not been cached because the result set has at least one column which has no table name in its meta data. An example of such a query is SELECT SLEEP(1). To cache those statements you have to change default value of the PHP configuration directive mysqlnd_qc.cache_no_table and set mysqlnd_qc.cache_no_table = 1. Often, it is not desired to cache such statements. | Since 1.0.0. |
| query_uncached_use_result | Statement would have been cached if a buffered result set had been used. The situation is also considered as a cache miss and cache_miss will be incremented as well. | Since 1.0.0. |
| query_aggr_run_time_cache_hit | Aggregated run time (ms) of all cached queries. Cached queries are those which have incremented cache_hit. | Since 1.0.0. |
| query_aggr_run_time_cache_put | Aggregated run time (ms) of all uncached queries that have been put into the cache. See also cache_put. | Since 1.0.0. |
| query_aggr_run_time_total | Aggregated run time (ms) of all uncached and cached queries that have been inspected and executed by the query cache. | Since 1.0.0. |
| query_aggr_store_time_cache_hit | Aggregated store time (ms) of all cached queries. Cached queries are those which have incremented cache_hit. | Since 1.0.0. |
| query_aggr_store_time_cache_put | Aggregated store time ( ms) of all uncached queries that have been put into the cache. See also cache_put. | Since 1.0.0. |
| query_aggr_store_time_total | Aggregated store time (ms) of all uncached and cached queries that have been inspected and executed by the query cache. | Since 1.0.0. |
| receive_bytes_recorded | Recorded incoming network traffic ( bytes) send from MySQL to PHP. The traffic may or may not have been added to the cache. The traffic is the total for all queries regardless if cached or not. | Since 1.0.0. |
| receive_bytes_replayed | Network traffic replayed during cache. This is the total amount of incoming traffic saved because of the usage of the query cache plugin. | Since 1.0.0. |
| send_bytes_recorded | Recorded outgoing network traffic ( bytes) send from MySQL to PHP. The traffic may or may not have been added to the cache. The traffic is the total for all queries regardless if cached or not. | Since 1.0.0. |
| send_bytes_replayed | Network traffic replayed during cache. This is the total amount of outgoing traffic saved because of the usage of the query cache plugin. | Since 1.0.0. |
| slam_stale_refresh | Number of cache misses which triggered serving stale data until the client causing the cache miss has refreshed the cache entry. | Since 1.0.0. |
| slam_stale_hit | Number of cache hits while a stale cache entry gets refreshed. | Since 1.0.0. |
Returns information on the current handler, the number of cache entries and cache entries, if available. If and what data will be returned for the cache entries is subject to the active storage handler. Storage handler are free to return any data. Storage handler are recommended to return at least the data provided by the default handler, if technically possible.
The scope of the information is the PHP process. Depending on the PHP deployment model a process may serve one or more web requests.
Values are aggregated for all cache activities on a per storage handler basis. It is not possible to tell how much queries originating from mysqli, PDO_MySQL or mysql.API calls have contributed to the aggregated data values. Use mysqlnd_qc_get_core_stats to get timing data aggregated for all storage handlers.
Array of cache information
handler string The active storage handler.
All storage handler. Since 1.0.0.
handler_version string The version of the active storage handler.
All storage handler. Since 1.0.0.
num_entries int The number of cache entries. The value depends on the storage handler in use.
The default, APC and SQLite storage handler provide the actual number of cache entries.
The MEMCACHE storage handler always returns 0. MEMCACHE does not support counting the number of cache entries.
If a user defined handler is used, the number of entries of the data property is reported.
Since 1.0.0.
data array The version of the active storage handler.
Additional storage handler dependent data on the cache entries. Storage handler are requested to provide similar and comparable information. A user defined storage handler is free to return any data.
Since 1.0.0.
The following information is provided by the default storage handler for the data property.
The data property holds a hash. The hash is indexed by the internal cache entry identifier of the storage handler. The cache entry identifier is human-readable and contains the query string leading to the cache entry. Please, see also the example below. The following data is given for every cache entry.
statistics array Statistics of the cache entry.
Since 1.0.0.
| Property | Description | Version |
|---|---|---|
| rows | Number of rows of the cached result set. | Since 1.0.0. |
| stored_size | The size of the cached result set in bytes. This is the size of the payload. The value is not suited for calculating the total memory consumption of all cache entries including the administrative overhead of the cache entries. | Since 1.0.0. |
| cache_hits | How often the cached entry has been returned. | Since 1.0.0. |
| run_time | Run time of the statement to which the cache entry belongs. This is the run time of the uncached statement. It is the time between sending the statement to MySQL receiving a reply from MySQL. Run time saved by using the query cache plugin can be calculated like this: cache_hits * ((run_time - avg_run_time) + (store_time - avg_store_time)). | Since 1.0.0. |
| store_time | Store time of the statements result set to which the cache entry belongs. This is the time it took to fetch and store the results of the uncached statement. | Since 1.0.0. |
| min_run_time | Minimum run time of the cached statement. How long it took to find the statement in the cache. | Since 1.0.0. |
| min_store_time | Minimum store time of the cached statement. The time taken for fetching the cached result set from the storage medium and decoding | Since 1.0.0. |
| avg_run_time | Average run time of the cached statement. | Since 1.0.0. |
| avg_store_time | Average store time of the cached statement. | Since 1.0.0. |
| max_run_time | Average run time of the cached statement. | Since 1.0.0. |
| max_store_time | Average store time of the cached statement. | Since 1.0.0. |
| valid_until | Timestamp when the cache entry expires. | Since 1.1.0. |
metadata array Metadata of the cache entry. This is the metadata provided by MySQL together with the result set of the statement in question. Different versions of the MySQL server may return different metadata. Unlike with some of the PHP MySQL extensions no attempt is made to hide MySQL server version dependencies and version details from the caller. Please, refer to the MySQL C API documentation that belongs to the MySQL server in use for further details.
The metadata list contains one entry for every column.
Since 1.0.0.
| Property | Description | Version |
|---|---|---|
| name | The field name. Depending on the MySQL version this may be the fields alias name. | Since 1.0.0. |
| org_name | The field name. | Since 1.0.0. |
| table | The table name. If an alias name was used for the table, this usually holds the alias name. | Since 1.0.0. |
| org_table | The table name. | Since 1.0.0. |
| db | The database/schema name. | Since 1.0.0. |
| max_length | The maximum width of the field. Details may vary by MySQL server version. | Since 1.0.0. |
| length | The width of the field. Details may vary by MySQL server version. | Since 1.0.0. |
| type | The data type of the field. Details may vary by the MySQL server in use. This is the MySQL C API type constants value. It is recommended to use type constants provided by the mysqli extension to test for its meaning. You should not test for certain type values by comparing with certain numbers. | Since 1.0.0. |
The APC storage handler returns the same information for the data property but no metadata. The metadata of a cache entry is set to NULL.
The MEMCACHE storage handler does not fill the data property. Statistics are not available on a per cache entry basis with the MEMCACHE storage handler.
A user defined storage handler is free to provide any data.
Returns an array of available built-in storage handler. For each storage handler the version number and version string is given.
") (prototype . "array mysqlnd_qc_get_available_handlers()") (purpose . "Returns a list of available storage handler") (id . "function.mysqlnd-qc-get-available-handlers")) "mysqlnd_qc_clear_cache" ((documentation . "Flush all cache contents bool mysqlnd_qc_clear_cache() Returns TRUE on success or FALSE on failure. A return value of FALSE indicates that flushing all cache contents has failed or the operation is not supported by the active storage handler. Applications must not expect that calling the function will always flush the cache. (PECL mysqlnd_qc >= 1.0.0)") (versions . "PECL mysqlnd_qc >= 1.0.0") (return . " Returns TRUE on success or FALSE on failure.
A return value of FALSE indicates that flushing all cache contents has failed or the operation is not supported by the active storage handler. Applications must not expect that calling the function will always flush the cache.
Host to run the query on. The host URI is to be taken from the master and slave connection lists passed to the callback function. If callback returns a value neither found in the master nor in the slave connection lists the plugin will fallback to the second pick method configured via the pick[] setting in the plugin configuration file. If not second pick method is given, the plugin falls back to the build-in default pick method for server selection.
") (prototype . "bool mysqlnd_ms_set_user_pick_server(string $function)") (purpose . "Sets a callback for user-defined read/write splitting") (id . "function.mysqlnd-ms-set-user-pick-server")) "mysqlnd_ms_set_qos" ((documentation . "Sets the quality of service needed from the cluster bool mysqlnd_ms_set_qos(mixed $connection, int $service_level [, int $service_level_option = '' [, mixed $option_value = '']]) Returns TRUE if the connections service level has been switched to the requested. Otherwise, returns FALSE (PECL mysqlnd_ms < 1.2.0)") (versions . "PECL mysqlnd_ms < 1.2.0") (return . " Returns TRUE if the connections service level has been switched to the requested. Otherwise, returns FALSE
A return value of MYSQLND_MS_QUERY_USE_MASTER indicates that the query should be send to the MySQL replication master server. The function returns a value of MYSQLND_MS_QUERY_USE_SLAVE if the query can be run on a slave because it is considered read-only. A value of MYSQLND_MS_QUERY_USE_LAST_USED is returned to recommend running the query on the last used server. This can either be a MySQL replication master server or a MySQL replication slave server.
If read write splitting has been disabled by setting mysqlnd_ms.disable_rw_split, the function will always return MYSQLND_MS_QUERY_USE_MASTER or MYSQLND_MS_QUERY_USE_LAST_USED.
Returns TRUE table_name is matched by wildcard. Otherwise, returns FALSE
Returns NULL if the PHP configuration directive mysqlnd_ms.enable has disabled the plugin. Otherwise, returns array of statistics.
Array of statistics
| Statistic | Description | Version |
|---|---|---|
| use_slave | The semantics of this statistic has changed between 1.0.1 - 1.1.0. The meaning for version 1.0.1 is as follows. Number of statements considered as read-only by the built-in query analyzer. Neither statements which begin with a SQL hint to force use of slave nor statements directed to a slave by an user-defined callback are included. The total number of statements sent to the slaves is use_slave + use_slave_sql_hint + use_slave_callback. PECL/mysqlnd_ms 1.1.0 introduces a new concept of chained filters. The statistics is now set by the internal load balancing filter. With version 1.1.0 the load balancing filter is always the last in the filter chain, if used. In future versions a load balancing filter may be followed by other filters causing another change in the meaning of the statistic. If, in the future, a load balancing filter is followed by another filter it is no longer guaranteed that the statement, which increments use_slave, will be executed on the slaves. The meaning for version 1.1.0 is as follows. Number of statements sent to the slaves. Statements directed to a slave by the user filter (an user-defined callback) are not included. The latter are counted by use_slave_callback. | Since 1.0.0. |
| use_master | The semantics of this statistic has changed between 1.0.1 - 1.1.0. The meaning for version 1.0.1 is as follows. Number of statements not considered as read-only by the built-in query analyzer. Neither statements which begin with a SQL hint to force use of master nor statements directed to a master by an user-defined callback are included. The total number of statements sent to the master is use_master + use_master_sql_hint + use_master_callback. PECL/mysqlnd_ms 1.1.0 introduces a new concept of chained filters. The statictics is now set by the internal load balancing filter. With version 1.1.0 the load balancing filter is always the last in the filter chain, if used. In future versions a load balancing filter may be followed by other filters causing another change in the meaning of the statistic. If, in the future, a load balancing filter is followed by another filter it is no longer guaranteed that the statement, which increments use_master, will be executed on the slaves. The meaning for version 1.1.0 is as follows. Number of statements sent to the masters. Statements directed to a master by the user filter (an user-defined callback) are not included. The latter are counted by use_master_callback. | Since 1.0.0. |
| use_slave_guess | Number of statements the built-in query analyzer recommends sending to a slave because they contain no SQL hint to force use of a certain server. The recommendation may be overruled in the following. It is not guaranteed whether the statement will be executed on a slave or not. This is how often the internal is_select function has guessed that a slave shall be used. Please, see also the user space function mysqlnd_ms_query_is_select. | Since 1.1.0. |
| use_master_guess | Number of statements the built-in query analyzer recommends sending to a master because they contain no SQL hint to force use of a certain server. The recommendation may be overruled in the following. It is not guaranteed whether the statement will be executed on a slave or not. This is how often the internal is_select function has guessed that a master shall be used. Please, see also the user space function mysqlnd_ms_query_is_select. | Since 1.1.0. |
| use_slave_sql_hint | Number of statements sent to a slave because statement begins with the SQL hint to force use of slave. | Since 1.0.0. |
| use_master_sql_hint | Number of statements sent to a master because statement begins with the SQL hint to force use of master. | Since 1.0.0. |
| use_last_used_sql_hint | Number of statements sent to server which has run the previous statement, because statement begins with the SQL hint to force use of previously used server. | Since 1.0.0. |
| use_slave_callback | Number of statements sent to a slave because an user-defined callback has chosen a slave server for statement execution. | Since 1.0.0. |
| use_master_callback | Number of statements sent to a master because an user-defined callback has chosen a master server for statement execution. | Since 1.0.0. |
| non_lazy_connections_slave_success | Number of successfully opened slave connections from configurations not using lazy connections. The total number of successfully opened slave connections is non_lazy_connections_slave_success + lazy_connections_slave_success | Since 1.0.0. |
| non_lazy_connections_slave_failure | Number of failed slave connection attempts from configurations not using lazy connections. The total number of failed slave connection attempts is non_lazy_connections_slave_failure + lazy_connections_slave_failure | Since 1.0.0. |
| non_lazy_connections_master_success | Number of successfully opened master connections from configurations not using lazy connections. The total number of successfully opened master connections is non_lazy_connections_master_success + lazy_connections_master_success | Since 1.0.0. |
| non_lazy_connections_master_failure | Number of failed master connection attempts from configurations not using lazy connections. The total number of failed master connection attempts is non_lazy_connections_master_failure + lazy_connections_master_failure | Since 1.0.0. |
| lazy_connections_slave_success | Number of successfully opened slave connections from configurations using lazy connections. | Since 1.0.0. |
| lazy_connections_slave_failure | Number of failed slave connection attempts from configurations using lazy connections. | Since 1.0.0. |
| lazy_connections_master_success | Number of successfully opened master connections from configurations using lazy connections. | Since 1.0.0. |
| lazy_connections_master_failure | Number of failed master connection attempts from configurations using lazy connections. | Since 1.0.0. |
| trx_autocommit_on | Number of autocommit mode activations via API calls. This figure may be used to monitor activity related to the plugin configuration setting trx_stickiness. If, for example, you want to know if a certain API call invokes the mysqlnd library function trx_autocommit(), which is a requirement for trx_stickiness, you may call the user API function in question and check if the statistic has changed. The statistic is modified only by the plugins internal subclassed trx_autocommit() method. | Since 1.0.0. |
| trx_autocommit_off | Number of autocommit mode deactivations via API calls. | Since 1.0.0. |
| trx_master_forced | Number of statements redirected to the master while trx_stickiness=master and autocommit mode is disabled. | Since 1.0.0. |
| gtid_autocommit_injections_success | Number of successful SQL injections in autocommit mode as part of the plugins client-side global transaction id emulation. | Since 1.2.0. |
| gtid_autocommit_injections_failure | Number of failed SQL injections in autocommit mode as part of the plugins client-side global transaction id emulation. | Since 1.2.0. |
| gtid_commit_injections_success | Number of successful SQL injections in commit mode as part of the plugins client-side global transaction id emulation. | Since 1.2.0. |
| gtid_commit_injections_failure | Number of failed SQL injections in commit mode as part of the plugins client-side global transaction id emulation. | Since 1.2.0. |
| gtid_implicit_commit_injections_success | Number of successful SQL injections when implicit commit is detected as part of the plugins client-side global transaction id emulation. Implicit commit happens, for example, when autocommit has been turned off, a query is executed and autocommit is enabled again. In that case, the statement will be committed by the server and SQL to maintain is injected before the autocommit is re-enabled. Another sequence causing an an implicit commit is begin(), query(), begin(). The second call to begin() will implicitly commit the transaction started by the first call to begin(). begin() refers to internal library calls not actual PHP user API calls. | Since 1.2.0. |
| gtid_implicit_commit_injections_failure | Number of failed SQL injections when implicit commit is detected as part of the plugins client-side global transaction id emulation. Implicit commit happens, for example, when autocommit has been turned off, a query is executed and autocommit is enabled again. In that case, the statement will be committed by the server and SQL to maintain is injected before the autocommit is re-enabled. | Since 1.2.0. |
| transient_error_retries | How often an operation has been retried when a transient error was detected. See also, transient_error plugin configuration file setting. | Since 1.6.0. |
| fabric_sharding_lookup_servers_success | Number of successful sharding.lookup_servers remote procedure calls to MySQL Fabric. A call is considered successful if the plugin could reach MySQL Fabric and got any reply. The reply itself may or may not be understood by the plugin. Success refers to the network transport only. If the reply was not understood or indicates a valid error condition, fabric_sharding_lookup_servers_xml_failure gets incremented. | Since 1.6.0. |
| fabric_sharding_lookup_servers_failure | Number of failed sharding.lookup_servers remote procedure calls to MySQL Fabric. A remote procedure call is considered failed if there was a network error in connecting to, writing to or reading from MySQL Fabric. | Since 1.6.0. |
| fabric_sharding_lookup_servers_time_total | Time spent connecting to,writing to and reading from MySQL Fabrich during the sharding.lookup_servers remote procedure call. The value is aggregated for all calls. Time is measured in microseconds. | Since 1.6.0. |
| fabric_sharding_lookup_servers_bytes_total | Total number of bytes received from MySQL Fabric in reply to sharding.lookup_servers calls. | Since 1.6.0. |
| fabric_sharding_lookup_servers_xml_failure | How often a reply from MySQL Fabric to sharding.lookup_servers calls was not understood. Please note, the current experimental implementation does not distinguish between valid errors returned and malformed replies. | Since 1.6.0. |
FALSE on error. Otherwise, an array which describes the connection used to execute the last statement on.
Array which describes the connection.
| Property | Description | Version |
|---|---|---|
| scheme | Connection scheme. Either tcp://host:port or unix://host:socket. If you want to distinguish connections from each other use a combination of scheme and thread_id as a unique key. Neither scheme nor thread_id alone are sufficient to distinguish two connections from each other. Two servers may assign the same thread_id to two different connections. Thus, connections in the pool may have the same thread_id. Also, do not rely on uniqueness of scheme in a pool. Your QA engineers may use the same MySQL server instance for two distinct logical roles and add it multiple times to the pool. This hack is used, for example, in the test suite. | Since 1.1.0. |
| host | Database server host used with the connection. The host is only set with TCP/IP connections. It is empty with Unix domain or Windows named pipe connections, | Since 1.1.0. |
| host_info | A character string representing the server hostname and the connection type. | Since 1.1.2. |
| port | Database server port used with the connection. | Since 1.1.0. |
| socket_or_pipe | Unix domain socket or Windows named pipe used with the connection. The value is empty for TCP/IP connections. | Since 1.1.2. |
| thread_id | Connection thread id. | Since 1.1.0. |
| last_message | Info message obtained from the MySQL C API function mysql_info(). Please, see mysqli_info for a description. | Since 1.1.0. |
| errno | Error code. | Since 1.1.0. |
| error | Error message. | Since 1.1.0. |
| sqlstate | Error SQLstate code. | Since 1.1.0. |
Returns a global transaction ID (GTID) on success. Otherwise, returns FALSE.
The function mysqlnd_ms_get_last_gtid returns the GTID obtained when executing the SQL statement from the fetch_last_gtid entry of the global_transaction_id_injection section from the plugins configuration file.
The function may be called after the GTID has been incremented.
") (prototype . "string mysqlnd_ms_get_last_gtid(mixed $connection)") (purpose . "Returns the latest global transaction ID") (id . "function.mysqlnd-ms-get-last-gtid")) "mysqlnd_ms_fabric_select_shard" ((documentation . "Switch to shard array mysqlnd_ms_fabric_select_shard(mixed $connection, mixed $table_name, mixed $shard_key) FALSE on error. Otherwise, TRUE ()") (versions . "") (return . " FALSE on error. Otherwise, TRUE
FALSE on error. Otherwise, TRUE
FALSE on error. Otherwise, returns an array with two entries masters and slaves each of which contains an array listing all corresponding servers.
The function can be used to check and debug the list of servers currently used by the plugin. It is mostly useful when the list of servers changes at runtime, for example, when using MySQL Fabric.
masters and slaves server entries
| Key | Description | Version |
|---|---|---|
| name_from_config | Server entry name from config, if appliciable. NULL if no configuration name is available. | Since 1.6.0. |
| hostname | Host name of the server. | Since 1.6.0. |
| user | Database user used to authenticate against the server. | Since 1.6.0. |
| port | TCP/IP port of the server. | Since 1.6.0. |
| socket | Unix domain socket of the server. | Since 1.6.0. |
Returns an array with client Zval cache stats if success, FALSE otherwise.
Returns number of rows in the result set.
") (prototype . "int mysqli_result.$num_rows(mysqli_result $result)") (purpose . "Gets the number of rows in a result") (id . "mysqli-result.num-rows")) "mysqli_fetch_lengths" ((documentation . "Returns the lengths of the columns of the current row in the result set array mysqli_result.$lengths(mysqli_result $result) An array of integers representing the size of each column (not including any terminating null characters). FALSE if an error occurred. mysqli_fetch_lengths is valid only for the current row of the result set. It returns FALSE if you call it before calling mysqli_fetch_row/array/object or after retrieving all rows in the result. (PHP 5)") (versions . "PHP 5") (return . "Note:
If the number of rows is greater than
PHP_INT_MAX, the number will be returned as a string.
An array of integers representing the size of each column (not including any terminating null characters). FALSE if an error occurred.
mysqli_fetch_lengths is valid only for the current row of the result set. It returns FALSE if you call it before calling mysqli_fetch_row/array/object or after retrieving all rows in the result.
No value is returned.
") (prototype . "void mysqli_free_result(mysqli_result $result)") (purpose . "Frees the memory associated with a result") (id . "mysqli-result.free")) "mysqli_field_seek" ((documentation . "Set result pointer to a specified field offset bool mysqli_field_seek(int $fieldnr, mysqli_result $result) Returns TRUE on success or FALSE on failure. (PHP 5)") (versions . "PHP 5") (return . " Returns TRUE on success or FALSE on failure.
The number of fields from a result set.
") (prototype . "int mysqli_result.$field_count(mysqli_result $result)") (purpose . "Get the number of fields in a result") (id . "mysqli-result.field-count")) "mysqli_fetch_row" ((documentation . "Get a result row as an enumerated array mixed mysqli_fetch_row(mysqli_result $result) mysqli_fetch_row returns an array of strings that corresponds to the fetched row or NULL if there are no more rows in result set. Note: This function sets NULL fields tothe PHP NULL value. (PHP 5)") (versions . "PHP 5") (return . " mysqli_fetch_row returns an array of strings that corresponds to the fetched row or NULL if there are no more rows in result set.
") (prototype . "mixed mysqli_fetch_row(mysqli_result $result)") (purpose . "Get a result row as an enumerated array") (id . "mysqli-result.fetch-row")) "mysqli_fetch_object" ((documentation . "Returns the current row of a result set as an object object mysqli_fetch_object([string $class_name = '' [, array $params = '', mysqli_result $result]]) Returns an object with string properties that corresponds to the fetched row or NULL if there are no more rows in resultset. Note: Field names returned by this functionare case-sensitive. Note: This function sets NULL fields tothe PHP NULL value. (PHP 5)") (versions . "PHP 5") (return . "Note: This function sets NULL fields tothe PHP
NULLvalue.
Returns an object with string properties that corresponds to the fetched row or NULL if there are no more rows in resultset.
Note: Field names returned by this functionare case-sensitive.
") (prototype . "object mysqli_fetch_object([string $class_name = '' [, array $params = '', mysqli_result $result]])") (purpose . "Returns the current row of a result set as an object") (id . "mysqli-result.fetch-object")) "mysqli_fetch_fields" ((documentation . "Returns an array of objects representing the fields in a result set array mysqli_fetch_fields(mysqli_result $result) Returns an array of objects which contains field definition information or FALSE if no field information is available. Object properties Property Description name The name of the column orgname Original column name if an alias was specified table The name of the table this field belongs to (if not calculated) orgtable Original table name if an alias was specified max_length The maximum width of the field for the result set. length The width of the field, as specified in the table definition. charsetnr The character set number for the field. flags An integer representing the bit-flags for the field. type The data type used for this field decimals The number of decimals used (for integer fields) (PHP 5)") (versions . "PHP 5") (return . "Note: This function sets NULL fields tothe PHP
NULLvalue.
Returns an array of objects which contains field definition information or FALSE if no field information is available.
| Property | Description |
|---|---|
| name | The name of the column |
| orgname | Original column name if an alias was specified |
| table | The name of the table this field belongs to (if not calculated) |
| orgtable | Original table name if an alias was specified |
| max_length | The maximum width of the field for the result set. |
| length | The width of the field, as specified in the table definition. |
| charsetnr | The character set number for the field. |
| flags | An integer representing the bit-flags for the field. |
| type | The data type used for this field |
| decimals | The number of decimals used (for integer fields) |
Returns an object which contains field definition information or FALSE if no field information is available.
| Property | Description |
|---|---|
| name | The name of the column |
| orgname | Original column name if an alias was specified |
| table | The name of the table this field belongs to (if not calculated) |
| orgtable | Original table name if an alias was specified |
| def | Reserved for default value, currently always "" |
| db | Database (since PHP 5.3.6) |
| catalog | The catalog name, always "def" (since PHP 5.3.6) |
| max_length | The maximum width of the field for the result set. |
| length | The width of the field, as specified in the table definition. |
| charsetnr | The character set number for the field. |
| flags | An integer representing the bit-flags for the field. |
| type | The data type used for this field |
| decimals | The number of decimals used (for integer fields) |
Returns an object which contains field definition information or FALSE if no field information for specified fieldnr is available.
| Attribute | Description |
|---|---|
| name | The name of the column |
| orgname | Original column name if an alias was specified |
| table | The name of the table this field belongs to (if not calculated) |
| orgtable | Original table name if an alias was specified |
| def | The default value for this field, represented as a string |
| max_length | The maximum width of the field for the result set. |
| length | The width of the field, as specified in the table definition. |
| charsetnr | The character set number for the field. |
| flags | An integer representing the bit-flags for the field. |
| type | The data type used for this field |
| decimals | The number of decimals used (for integer fields) |
Returns an associative array of strings representing the fetched row in the result set, where each key in the array represents the name of one of the result set's columns or NULL if there are no more rows in resultset.
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 mysqli_fetch_row or add alias names.
") (prototype . "array mysqli_fetch_assoc(mysqli_result $result)") (purpose . "Fetch a result row as an associative array") (id . "mysqli-result.fetch-assoc")) "mysqli_fetch_array" ((documentation . "Fetch a result row as an associative, a numeric array, or both mixed mysqli_fetch_array([int $resulttype = MYSQLI_BOTH, mysqli_result $result]) Returns an array of strings that corresponds to the fetched row or NULL if there are no more rows in resultset. (PHP 5)") (versions . "PHP 5") (return . " Returns an array of strings that corresponds to the fetched row or NULL if there are no more rows in resultset.
Returns an array of associative or numeric arrays holding result rows.
") (prototype . "mixed mysqli_fetch_all([int $resulttype = MYSQLI_NUM, mysqli_result $result])") (purpose . "Fetches all result rows as an associative array, a numeric array, or both") (id . "mysqli-result.fetch-all")) "mysqli_data_seek" ((documentation . "Adjusts the result pointer to an arbitrary row in the result bool mysqli_data_seek(int $offset, mysqli_result $result) Returns TRUE on success or FALSE on failure. (PHP 5)") (versions . "PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns current offset of field cursor.
") (prototype . "int mysqli_result.$current_field(mysqli_result $result)") (purpose . "Get current field offset of a result pointer") (id . "mysqli-result.current-field")) "mysqli_stmt_store_result" ((documentation . "Transfers a result set from a prepared statement bool mysqli_stmt_store_result(mysqli_stmt $stmt) Returns TRUE on success or FALSE on failure. (PHP 5)") (versions . "PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns a string containing the SQLSTATE error code for the last error. The error code consists of five characters. '00000' means no error.
") (prototype . "string mysqli_stmt.$sqlstate(mysqli_stmt $stmt)") (purpose . "Returns SQLSTATE error from previous statement operation") (id . "mysqli-stmt.sqlstate")) "mysqli_stmt_send_long_data" ((documentation . "Send data in blocks bool mysqli_stmt_send_long_data(int $param_nr, string $data, mysqli_stmt $stmt) Returns TRUE on success or FALSE on failure. (PHP 5)") (versions . "PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns a result object or FALSE if an error occurred.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns an integer representing the number of parameters.
") (prototype . "int mysqli_stmt.$param_count(mysqli_stmt $stmt)") (purpose . "Returns the number of parameter for the given statement") (id . "mysqli-stmt.param-count")) "mysqli_stmt_num_rows" ((documentation . "Return the number of rows in statements result set int mysqli_stmt.$num_rows(mysqli_stmt $stmt) An integer representing the number of rows in result set. (PHP 5)") (versions . "PHP 5") (return . "An integer representing the number of rows in result set.
") (prototype . "int mysqli_stmt.$num_rows(mysqli_stmt $stmt)") (purpose . "Return the number of rows in statements result set") (id . "mysqli-stmt.num-rows")) "mysqli_stmt_next_result" ((documentation . "Reads the next result from a multiple query bool mysqli_stmt_next_result(mysql_stmt $stmt) Returns TRUE on success or FALSE on failure. (PHP 5)") (versions . "PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE if more results exist, otherwise FALSE.
Returns a resultset or FALSE on failure.
No value is returned.
") (prototype . "void mysqli_stmt_free_result(mysqli_stmt $stmt)") (purpose . "Frees stored result memory for the given statement handle") (id . "mysqli-stmt.free-result")) "mysqli_stmt_field_count" ((documentation . "Returns the number of field in the given statement int mysqli_stmt.$field_count(mysqli_stmt $stmt) (PHP 5)") (versions . "PHP 5") (return . "") (prototype . "int mysqli_stmt.$field_count(mysqli_stmt $stmt)") (purpose . "Returns the number of field in the given statement") (id . "mysqli-stmt.field-count")) "mysqli_stmt_fetch" ((documentation . "Fetch results from a prepared statement into the bound variables bool mysqli_stmt_fetch(mysqli_stmt $stmt) Return Values Value Description TRUE Success. Data has been fetched FALSE Error occurred NULL No more rows/data exists or data truncation occurred (PHP 5)") (versions . "PHP 5") (return . "| Value | Description |
|---|---|
TRUE | Success. Data has been fetched |
FALSE | Error occurred |
NULL | No more rows/data exists or data truncation occurred |
Returns TRUE on success or FALSE on failure.
A string that describes the error. An empty string if no error occurred.
") (prototype . "string mysqli_stmt.$error(mysqli_stmt $stmt)") (purpose . "Returns a string description for last statement error") (id . "mysqli-stmt.error")) "mysqli_stmt_error_list" ((documentation . "Returns a list of errors from the last statement executed array mysqli_stmt.$error_list(mysqli_stmt $stmt) A list of errors, each as an associative array containing the errno, error, and sqlstate. (PHP 5 >= 5.4.0)") (versions . "PHP 5 >= 5.4.0") (return . "A list of errors, each as an associative array containing the errno, error, and sqlstate.
") (prototype . "array mysqli_stmt.$error_list(mysqli_stmt $stmt)") (purpose . "Returns a list of errors from the last statement executed") (id . "mysqli-stmt.error-list")) "mysqli_stmt_errno" ((documentation . "Returns the error code for the most recent statement call int mysqli_stmt.$errno(mysqli_stmt $stmt) An error code value. Zero means no error occurred. (PHP 5)") (versions . "PHP 5") (return . "An error code value. Zero means no error occurred.
") (prototype . "int mysqli_stmt.$errno(mysqli_stmt $stmt)") (purpose . "Returns the error code for the most recent statement call") (id . "mysqli-stmt.errno")) "mysqli_stmt_data_seek" ((documentation . "Seeks to an arbitrary row in statement result set void mysqli_stmt_data_seek(int $offset, mysqli_stmt $stmt) No value is returned. (PHP 5)") (versions . "PHP 5") (return . "No value is returned.
") (prototype . "void mysqli_stmt_data_seek(int $offset, mysqli_stmt $stmt)") (purpose . "Seeks to an arbitrary row in statement result set") (id . "mysqli-stmt.data-seek")) "mysqli_stmt_close" ((documentation . "Closes a prepared statement bool mysqli_stmt_close(mysqli_stmt $stmt) Returns TRUE on success or FALSE on failure. (PHP 5)") (versions . "PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns FALSE if the attribute is not found, otherwise returns the value of the attribute.
An integer greater than zero indicates the number of rows affected or retrieved. Zero indicates that no records where updated for an UPDATE/DELETE statement, no rows matched the WHERE clause in the query or that no query has yet been executed. -1 indicates that the query has returned an error. NULL indicates an invalid argument was supplied to the function.
") (prototype . "int mysqli_stmt.$affected_rows(mysqli_stmt $stmt)") (purpose . "Returns the total number of rows changed, deleted, or inserted by the last executed statement") (id . "mysqli-stmt.affected-rows")) "mysqli_warning_count" ((documentation . "Returns the number of warnings from the last query for the given link int mysqli.$warning_count(mysqli $link) Number of warnings or zero if there are no warnings. (PHP 5)") (versions . "PHP 5") (return . "Note:
If the number of affected rows is greater than maximal PHP int value, the number of affected rows will be returned as a string value.
Number of warnings or zero if there are no warnings.
") (prototype . "int mysqli.$warning_count(mysqli $link)") (purpose . "Returns the number of warnings from the last query for the given link") (id . "mysqli.warning-count")) "mysqli_use_result" ((documentation . "Initiate a result set retrieval mysqli_result mysqli_use_result(mysqli $link) Returns an unbuffered result object or FALSE if an error occurred. (PHP 5)") (versions . "PHP 5") (return . " Returns an unbuffered result object or FALSE if an error occurred.
TRUE if the client library is thread-safe, otherwise FALSE.
Returns the Thread ID for the current connection.
") (prototype . "int mysqli.$thread_id(mysqli $link)") (purpose . "Returns the thread ID for the current connection") (id . "mysqli.thread-id")) "mysqli_store_result" ((documentation . "Transfers a result set from the last query mysqli_result mysqli_store_result(mysqli $link) Returns a buffered result object or FALSE if an error occurred. Note: mysqli_store_result returns FALSE in case the query didn't return a result set (if the query was, for example an INSERT statement). This function also returns FALSE if the reading of the result set failed. You can check if you have got an error by checking if mysqli_error doesn't return an empty string, if mysqli_errno returns a non zero value, or if mysqli_field_count returns a non zero value. Also possible reason for this function returning FALSE after successful call to mysqli_query can be too large result set (memory for it cannot be allocated). If mysqli_field_count returns a non-zero value, the statement should have produced a non-empty result set. (PHP 5)") (versions . "PHP 5") (return . " Returns a buffered result object or FALSE if an error occurred.
") (prototype . "mysqli_result mysqli_store_result(mysqli $link)") (purpose . "Transfers a result set from the last query") (id . "mysqli.store-result")) "mysqli_stmt_init" ((documentation . "Initializes a statement and returns an object for use with mysqli_stmt_prepare mysqli_stmt mysqli_stmt_init(mysqli $link) Returns an object. (PHP 5)") (versions . "PHP 5") (return . "Note:
mysqli_store_result returns
FALSEin case the query didn't return a result set (if the query was, for example an INSERT statement). This function also returnsFALSEif the reading of the result set failed. You can check if you have got an error by checking if mysqli_error doesn't return an empty string, if mysqli_errno returns a non zero value, or if mysqli_field_count returns a non zero value. Also possible reason for this function returningFALSEafter successful call to mysqli_query can be too large result set (memory for it cannot be allocated). If mysqli_field_count returns a non-zero value, the statement should have produced a non-empty result set.
Returns an object.
") (prototype . "mysqli_stmt mysqli_stmt_init(mysqli $link)") (purpose . "Initializes a statement and returns an object for use with mysqli_stmt_prepare") (id . "mysqli.stmt-init")) "mysqli_stat" ((documentation . "Gets the current system status string mysqli_stat(mysqli $link) A string describing the server status. FALSE if an error occurred. (PHP 5)") (versions . "PHP 5") (return . " A string describing the server status. FALSE if an error occurred.
This function always returns TRUE value. If SSL setup is incorrect mysqli_real_connect will return an error when you attempt to connect.
Returns a string containing the SQLSTATE error code for the last error. The error code consists of five characters. '00000' means no error.
") (prototype . "string mysqli.$sqlstate(mysqli $link)") (purpose . "Returns the SQLSTATE error from previous MySQL operation") (id . "mysqli.sqlstate")) "mysqli_set_local_infile_handler" ((documentation . "Set callback function for LOAD DATA LOCAL INFILE command bool mysqli_set_local_infile_handler(mysqli $link, callable $read_func) Returns TRUE on success or FALSE on failure. (PHP 5)") (versions . "PHP 5") (return . " Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void mysqli_set_local_infile_default(mysqli $link)") (purpose . "Unsets user defined handler for load local infile command") (id . "mysqli.set-local-infile-default")) "mysqli_set_charset" ((documentation . "Sets the default client character set bool mysqli_set_charset(string $charset, mysqli $link) Returns TRUE on success or FALSE on failure. (PHP 5 >= 5.0.5)") (versions . "PHP 5 >= 5.0.5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
TRUE if the refresh was a success, otherwise FALSE
Returns mysqli_result in success, FALSE otherwise.
Returns TRUE on success or FALSE on failure.
Returns an escaped string.
") (prototype . "string mysqli_real_escape_string(string $escapestr, mysqli $link)") (purpose . "Escapes special characters in a string for use in an SQL statement, taking into account the current charset of the connection") (id . "mysqli.real-escape-string")) "mysqli_real_connect" ((documentation . "Opens a connection to a mysql server bool mysqli_real_connect([string $host = '' [, string $username = '' [, string $passwd = '' [, string $dbname = '' [, int $port = '' [, string $socket = '' [, int $flags = '', mysqli $link]]]]]]]) Returns TRUE on success or FALSE on failure. (PHP 5)") (versions . "PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns FALSE on failure. For successful SELECT, SHOW, DESCRIBE or EXPLAIN queries mysqli_query will return a mysqli_result object. For other successful queries mysqli_query will return TRUE.
mysqli_prepare returns a statement object or FALSE if an error occurred.
Returns number of ready connections upon success, FALSE otherwise.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns FALSE if the first statement failed. To retrieve subsequent errors from other statements you have to call mysqli_next_result first.
Returns TRUE if one or more result sets are available from a previous call to mysqli_multi_query, otherwise FALSE.
Returns TRUE on success or FALSE on failure.
The value of the AUTO_INCREMENT field that was updated by the previous query. Returns zero if there was no previous query on the connection or if the query did not update an AUTO_INCREMENT value.
") (prototype . "mixed mysqli.$insert_id(mysqli $link)") (purpose . "Returns the auto generated id used in the last query") (id . "mysqli.insert-id")) "mysqli_init" ((documentation . "Initializes MySQLi and returns a resource for use with mysqli_real_connect() mysqli mysqli_init() Returns an object. (PHP 5)") (versions . "PHP 5") (return . "Note:
If the number is greater than maximal int value, mysqli_insert_id will return a string.
Returns an object.
") (prototype . "mysqli mysqli_init()") (purpose . "Initializes MySQLi and returns a resource for use with mysqli_real_connect()") (id . "mysqli.init")) "mysqli_info" ((documentation . "Retrieves information about the most recently executed query string mysqli.$info(mysqli $link) A character string representing additional information about the most recently executed query. (PHP 5)") (versions . "PHP 5") (return . "A character string representing additional information about the most recently executed query.
") (prototype . "string mysqli.$info(mysqli $link)") (purpose . "Retrieves information about the most recently executed query") (id . "mysqli.info")) "mysqli_get_warnings" ((documentation . "Get result of SHOW WARNINGS mysqli_warning mysqli_get_warnings(mysqli $link) (PHP 5 >= 5.1.0)") (versions . "PHP 5 >= 5.1.0") (return . "") (prototype . "mysqli_warning mysqli_get_warnings(mysqli $link)") (purpose . "Get result of SHOW WARNINGS") (id . "mysqli.get-warnings")) "mysqli_get_server_version" ((documentation . "Returns the version of the MySQL server as an integer int mysqli.$server_version(mysqli $link) An integer representing the server version. The form of this version number is main_version * 10000 + minor_version * 100 + sub_version (i.e. version 4.1.0 is 40100). (PHP 5)") (versions . "PHP 5") (return . "An integer representing the server version.
The form of this version number is main_version * 10000 + minor_version * 100 + sub_version (i.e. version 4.1.0 is 40100).
") (prototype . "int mysqli.$server_version(mysqli $link)") (purpose . "Returns the version of the MySQL server as an integer") (id . "mysqli.get-server-version")) "mysqli_get_server_info" ((documentation . "Returns the version of the MySQL server string mysqli.$server_info(mysqli $link) A character string representing the server version. (PHP 5)") (versions . "PHP 5") (return . "A character string representing the server version.
") (prototype . "string mysqli.$server_info(mysqli $link)") (purpose . "Returns the version of the MySQL server") (id . "mysqli.get-server-info")) "mysqli_get_proto_info" ((documentation . "Returns the version of the MySQL protocol used int mysqli.$protocol_version(mysqli $link) Returns an integer representing the protocol version. (PHP 5)") (versions . "PHP 5") (return . "Returns an integer representing the protocol version.
") (prototype . "int mysqli.$protocol_version(mysqli $link)") (purpose . "Returns the version of the MySQL protocol used") (id . "mysqli.get-proto-info")) "mysqli_get_host_info" ((documentation . "Returns a string representing the type of connection used string mysqli.$host_info(mysqli $link) A character string representing the server hostname and the connection type. (PHP 5)") (versions . "PHP 5") (return . "A character string representing the server hostname and the connection type.
") (prototype . "string mysqli.$host_info(mysqli $link)") (purpose . "Returns a string representing the type of connection used") (id . "mysqli.get-host-info")) "mysqli_get_connection_stats" ((documentation . "Returns statistics about the client connection array mysqli_get_connection_stats(mysqli $link) Returns an array with connection stats if success, FALSE otherwise. (PHP 5 >= 5.3.0)") (versions . "PHP 5 >= 5.3.0") (return . " Returns an array with connection stats if success, FALSE otherwise.
Returns an array with client stats if success, FALSE otherwise.
The function returns a character set object with the following properties:
charsetCharacter set name
collationCollation name
dirDirectory the charset description was fetched from (?) or "" for built-in character sets
min_lengthMinimum character length in bytes
max_lengthMaximum character length in bytes
numberInternal character set number
stateCharacter set status (?)
An integer representing the number of fields in a result set.
") (prototype . "int mysqli.$field_count(mysqli $link)") (purpose . "Returns the number of columns for the most recent query") (id . "mysqli.field-count")) "mysqli_error" ((documentation . "Returns a string description of the last error string mysqli.$error(mysqli $link) A string that describes the error. An empty string if no error occurred. (PHP 5)") (versions . "PHP 5") (return . "A string that describes the error. An empty string if no error occurred.
") (prototype . "string mysqli.$error(mysqli $link)") (purpose . "Returns a string description of the last error") (id . "mysqli.error")) "mysqli_error_list" ((documentation . "Returns a list of errors from the last command executed array mysqli.$error_list(mysqli $link) A list of errors, each as an associative array containing the errno, error, and sqlstate. (PHP 5 >= 5.4.0)") (versions . "PHP 5 >= 5.4.0") (return . "A list of errors, each as an associative array containing the errno, error, and sqlstate.
") (prototype . "array mysqli.$error_list(mysqli $link)") (purpose . "Returns a list of errors from the last command executed") (id . "mysqli.error-list")) "mysqli_errno" ((documentation . "Returns the error code for the most recent function call int mysqli.$errno(mysqli $link) An error code value for the last call, if it failed. zero means no error occurred. (PHP 5)") (versions . "PHP 5") (return . "An error code value for the last call, if it failed. zero means no error occurred.
") (prototype . "int mysqli.$errno(mysqli $link)") (purpose . "Returns the error code for the most recent function call") (id . "mysqli.errno")) "mysqli_dump_debug_info" ((documentation . "Dump debugging information into the log bool mysqli_dump_debug_info(mysqli $link) Returns TRUE on success or FALSE on failure. (PHP 5)") (versions . "PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE.
A string that describes the error. NULL is returned if no error occurred.
An error code value for the last call to mysqli_connect, if it failed. zero means no error occurred.
") (prototype . "int mysqli.$connect_errno()") (purpose . "Returns the error code from last connect call") (id . "mysqli.connect-errno")) "mysqli_commit" ((documentation . "Commits the current transaction bool mysqli_commit([int $flags = '' [, string $name = '', mysqli $link]]) Returns TRUE on success or FALSE on failure. (PHP 5)") (versions . "PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
A number that represents the MySQL client library version in format: main_version*10000 + minor_version *100 + sub_version. For example, 4.1.0 is returned as 40100.
This is useful to quickly determine the version of the client library to know if some capability exits.
") (prototype . "int mysqli_get_client_version(mysqli $link)") (purpose . "Returns the MySQL client version as an integer") (id . "mysqli.get-client-version")) "mysqli_get_client_info" ((documentation . "Get MySQL client info string mysqli_get_client_info(mysqli $link) A string that represents the MySQL client library version (PHP 5)") (versions . "PHP 5") (return . "A string that represents the MySQL client library version
") (prototype . "string mysqli_get_client_info(mysqli $link)") (purpose . "Get MySQL client info") (id . "mysqli.get-client-info")) "mysqli_character_set_name" ((documentation . "Returns the default character set for the database connection string mysqli_character_set_name(mysqli $link) The default character set for the current connection (PHP 5)") (versions . "PHP 5") (return . "The default character set for the current connection
") (prototype . "string mysqli_character_set_name(mysqli $link)") (purpose . "Returns the default character set for the database connection") (id . "mysqli.character-set-name")) "mysqli_change_user" ((documentation . "Changes the user of the specified database connection bool mysqli_change_user(string $user, string $password, string $database, mysqli $link) Returns TRUE on success or FALSE on failure. (PHP 5)") (versions . "PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
An integer greater than zero indicates the number of rows affected or retrieved. Zero indicates that no records were updated for an UPDATE statement, no rows matched the WHERE clause in the query or that no query has yet been executed. -1 indicates that the query returned an error.
") (prototype . "int mysqli.$affected_rows(mysqli $link)") (purpose . "Gets the number of affected rows in a previous MySQL operation") (id . "mysqli.affected-rows")) "mysql_unbuffered_query" ((documentation . "Send an SQL query to MySQL without fetching and buffering the result rows. resource mysql_unbuffered_query(string $query [, resource $link_identifier = null]) 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. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . "Note:
If the number of affected rows is greater than the maximum integer value(
PHP_INT_MAX), the number of affected rows will be returned as a string.
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.
The thread ID on success or FALSE on failure.
The name of the table 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.
") (prototype . "string mysql_tablename(resource $result, int $i)") (purpose . "Get table name of field") (id . "function.mysql-tablename")) "mysql_stat" ((documentation . "Get current system status string mysql_stat([resource $link_identifier = null]) 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. (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . " 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.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
The contents of one cell from a MySQL result set on success, or FALSE on failure.
Returns the escaped string, or FALSE on error.
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.
Returns TRUE if the connection to the server MySQL server is working, otherwise FALSE.
Returns a MySQL persistent link identifier on success, or FALSE on failure.
The number of rows in a result set on success or FALSE on failure.
Returns the number of fields in the result set resource on success or FALSE on failure.
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.
") (prototype . "resource mysql_list_tables(string $database [, resource $link_identifier = null])") (purpose . "List tables in a MySQL database") (id . "function.mysql-list-tables")) "mysql_list_processes" ((documentation . "List MySQL processes resource mysql_list_processes([resource $link_identifier = null]) A result pointer resource on success or FALSE on failure. (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . " A result pointer resource on success or FALSE on failure.
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 and mysql_field_type.
") (prototype . "resource mysql_list_fields(string $database_name, string $table_name [, resource $link_identifier = null])") (purpose . "List MySQL table fields") (id . "function.mysql-list-fields")) "mysql_list_dbs" ((documentation . "List databases available on a MySQL server resource mysql_list_dbs([resource $link_identifier = null]) 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. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " 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.
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.
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.
Returns the MySQL server version on success or FALSE on failure.
Returns the MySQL protocol on success or FALSE on failure.
Returns a string describing the type of MySQL connection in use for the connection or FALSE on failure.
The MySQL client version.
") (prototype . "string mysql_get_client_info()") (purpose . "Get MySQL client info") (id . "function.mysql-get-client-info")) "mysql_free_result" ((documentation . "Free result memory bool mysql_free_result(resource $result) Returns TRUE on success or FALSE on failure. 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. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
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.
The returned field type will be one of "int", "real", "string", "blob", and others as detailed in the » MySQL documentation.
") (prototype . "string mysql_field_type(resource $result, int $field_offset)") (purpose . "Get the type of the specified field in a result") (id . "function.mysql-field-type")) "mysql_field_table" ((documentation . "Get name of the table the specified field is in string mysql_field_table(resource $result, int $field_offset) The name of the table on success. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "The name of the table on success.
") (prototype . "string mysql_field_table(resource $result, int $field_offset)") (purpose . "Get name of the table the specified field is in") (id . "function.mysql-field-table")) "mysql_field_seek" ((documentation . "Set result pointer to a specified field offset bool mysql_field_seek(resource $result, int $field_offset) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
The name of the specified field index on success or FALSE on failure.
The length of the specified field index on success or FALSE on failure.
Returns a string of flags associated with the result or FALSE on failure.
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".
") (prototype . "string mysql_field_flags(resource $result, int $field_offset)") (purpose . "Get the flags associated with the specified field in a result") (id . "function.mysql-field-flags")) "mysql_fetch_row" ((documentation . "Get a result row as an enumerated array array mysql_fetch_row(resource $result) 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. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " 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.
") (prototype . "array mysql_fetch_row(resource $result)") (purpose . "Get a result row as an enumerated array") (id . "function.mysql-fetch-row")) "mysql_fetch_object" ((documentation . "Fetch a result row as an object object mysql_fetch_object(resource $result [, string $class_name = '' [, array $params = '']]) Returns an object with string properties that correspond to the fetched row, or FALSE if there are no more rows. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns an object with string properties that correspond to the fetched row, or FALSE if there are no more rows.
An array of lengths on success or FALSE on failure.
Returns an object containing field information. The properties of the object are:
NULL 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.
") (prototype . "array mysql_fetch_assoc(resource $result)") (purpose . "Fetch a result row as an associative array") (id . "function.mysql-fetch-assoc")) "mysql_fetch_array" ((documentation . "Fetch a result row as an associative array, a numeric array, or both array mysql_fetch_array(resource $result [, int $result_type = MYSQL_BOTH]) 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. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " 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.
") (prototype . "array mysql_fetch_array(resource $result [, int $result_type = MYSQL_BOTH])") (purpose . "Fetch a result row as an associative array, a numeric array, or both") (id . "function.mysql-fetch-array")) "mysql_escape_string" ((documentation . "Escapes a string for use in a mysql_query string mysql_escape_string(string $unescaped_string) Returns the escaped string. (PHP 4 >= 4.0.3, PHP 5)") (versions . "PHP 4 >= 4.0.3, PHP 5") (return . "Returns the escaped string.
") (prototype . "string mysql_escape_string(string $unescaped_string)") (purpose . "Escapes a string for use in a mysql_query") (id . "function.mysql-escape-string")) "mysql_error" ((documentation . "Returns the text of the error message from previous MySQL operation string mysql_error([resource $link_identifier = null]) Returns the error text from the last MySQL function, or '' (empty string) if no error occurred. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the error text from the last MySQL function, or '' (empty string) if no error occurred.
") (prototype . "string mysql_error([resource $link_identifier = null])") (purpose . "Returns the text of the error message from previous MySQL operation") (id . "function.mysql-error")) "mysql_errno" ((documentation . "Returns the numerical value of the error message from previous MySQL operation int mysql_errno([resource $link_identifier = null]) Returns the error number from the last MySQL function, or 0 (zero) if no error occurred. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the error number from the last MySQL function, or 0 (zero) if no error occurred.
") (prototype . "int mysql_errno([resource $link_identifier = null])") (purpose . "Returns the numerical value of the error message from previous MySQL operation") (id . "function.mysql-errno")) "mysql_drop_db" ((documentation . "Drop (delete) a MySQL database bool mysql_drop_db(string $database_name [, resource $link_identifier = null]) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
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.
Returns the database name on success, and FALSE on failure. If FALSE is returned, use mysql_error to determine the nature of the error.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns a MySQL link identifier on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the default character set name for the current connection.
") (prototype . "string mysql_client_encoding([resource $link_identifier = null])") (purpose . "Returns the name of the character set") (id . "function.mysql-client-encoding")) "mysql_affected_rows" ((documentation . "Get number of affected rows in previous MySQL operation int mysql_affected_rows([resource $link_identifier = null]) 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. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "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.
") (prototype . "int mysql_affected_rows([resource $link_identifier = null])") (purpose . "Get number of affected rows in previous MySQL operation") (id . "function.mysql-affected-rows")) "mssql_select_db" ((documentation . "Select MS SQL database bool mssql_select_db(string $database_name [, resource $link_identifier = '']) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5, PECL odbtp >= 1.1.1)") (versions . "PHP 4, PHP 5, PECL odbtp >= 1.1.1") (return . " Returns TRUE on success or FALSE on failure.
Returns the number of records affected by last operation.
") (prototype . "int mssql_rows_affected(resource $link_identifier)") (purpose . "Returns the number of records affected by the query") (id . "function.mssql-rows-affected")) "mssql_result" ((documentation . "Get result data string mssql_result(resource $result, int $row, mixed $field) Returns the contents of the specified cell. (PHP 4, PHP 5, PECL odbtp >= 1.1.1)") (versions . "PHP 4, PHP 5, PECL odbtp >= 1.1.1") (return . "Returns the contents of the specified cell.
") (prototype . "string mssql_result(resource $result, int $row, mixed $field)") (purpose . "Get result data") (id . "function.mssql-result")) "mssql_query" ((documentation . "Send MS SQL query mixed mssql_query(string $query [, resource $link_identifier = '' [, int $batch_size = '']]) Returns a MS SQL result resource on success, TRUE if no rows were returned, or FALSE on error. (PHP 4, PHP 5, PECL odbtp >= 1.1.1)") (versions . "PHP 4, PHP 5, PECL odbtp >= 1.1.1") (return . " Returns a MS SQL result resource on success, TRUE if no rows were returned, or FALSE on error.
Returns a positive MS SQL persistent link identifier on success, or FALSE on error.
Returns the number of rows, as an integer.
") (prototype . "int mssql_num_rows(resource $result)") (purpose . "Gets the number of rows in result") (id . "function.mssql-num-rows")) "mssql_num_fields" ((documentation . "Gets the number of fields in result int mssql_num_fields(resource $result) Returns the number of fields, as an integer. (PHP 4, PHP 5, PECL odbtp >= 1.1.1)") (versions . "PHP 4, PHP 5, PECL odbtp >= 1.1.1") (return . "Returns the number of fields, as an integer.
") (prototype . "int mssql_num_fields(resource $result)") (purpose . "Gets the number of fields in result") (id . "function.mssql-num-fields")) "mssql_next_result" ((documentation . "Move the internal result pointer to the next result bool mssql_next_result(resource $result_id) Returns TRUE if an additional result set was available or FALSE otherwise. (PHP 4 >= 4.0.5, PHP 5, PECL odbtp >= 1.1.1)") (versions . "PHP 4 >= 4.0.5, PHP 5, PECL odbtp >= 1.1.1") (return . " Returns TRUE if an additional result set was available or FALSE otherwise.
No value is returned.
") (prototype . "void mssql_min_message_severity(int $severity)") (purpose . "Sets the minimum message severity") (id . "function.mssql-min-message-severity")) "mssql_min_error_severity" ((documentation . "Sets the minimum error severity void mssql_min_error_severity(int $severity) No value is returned. (PHP 4, PHP 5, PECL odbtp >= 1.1.1)") (versions . "PHP 4, PHP 5, PECL odbtp >= 1.1.1") (return . "No value is returned.
") (prototype . "void mssql_min_error_severity(int $severity)") (purpose . "Sets the minimum error severity") (id . "function.mssql-min-error-severity")) "mssql_init" ((documentation . "Initializes a stored procedure or a remote stored procedure resource mssql_init(string $sp_name [, resource $link_identifier = '']) Returns a resource identifier \"statement\", used in subsequent calls to mssql_bind and mssql_execute, or FALSE on errors. (PHP 4 >= 4.0.7, PHP 5, PECL odbtp >= 1.1.1)") (versions . "PHP 4 >= 4.0.7, PHP 5, PECL odbtp >= 1.1.1") (return . " Returns a resource identifier "statement", used in subsequent calls to mssql_bind and mssql_execute, or FALSE on errors.
Returns the converted string on success.
") (prototype . "string mssql_guid_string(string $binary [, bool $short_format = false])") (purpose . "Converts a 16 byte binary GUID to a string") (id . "function.mssql-guid-string")) "mssql_get_last_message" ((documentation . "Returns the last message from the server string mssql_get_last_message() Returns last error message from server, or an empty string if no error messages are returned from MSSQL. (PHP 4, PHP 5, PECL odbtp >= 1.1.1)") (versions . "PHP 4, PHP 5, PECL odbtp >= 1.1.1") (return . "Returns last error message from server, or an empty string if no error messages are returned from MSSQL.
") (prototype . "string mssql_get_last_message()") (purpose . "Returns the last message from the server") (id . "function.mssql-get-last-message")) "mssql_free_statement" ((documentation . "Free statement memory bool mssql_free_statement(resource $stmt) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.3.2, PHP 5, PECL odbtp >= 1.1.1)") (versions . "PHP 4 >= 4.3.2, PHP 5, PECL odbtp >= 1.1.1") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
The type of the specified field index on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
The name of the specified field index on success or FALSE on failure.
The length of the specified field index on success or FALSE on failure.
Returns an array that corresponds to the fetched row, or FALSE if there are no more rows.
Returns an object with properties that correspond to the fetched row, or FALSE if there are no more rows.
Returns an object containing field information.
The properties of the object are:
Returns the number of rows in the returned batch.
") (prototype . "int mssql_fetch_batch(resource $result)") (purpose . "Returns the next batch of records") (id . "function.mssql-fetch-batch")) "mssql_fetch_assoc" ((documentation . "Returns an associative array of the current row in the result array mssql_fetch_assoc(resource $result_id) Returns an associative array that corresponds to the fetched row, or FALSE if there are no more rows. (PHP 4 >= 4.2.0, PHP 5, PECL odbtp >= 1.1.1)") (versions . "PHP 4 >= 4.2.0, PHP 5, PECL odbtp >= 1.1.1") (return . " Returns an associative array that corresponds to the fetched row, or FALSE if there are no more rows.
Returns an array that corresponds to the fetched row, or FALSE if there are no more rows.
Returns TRUE on success or FALSE on failure.
Returns a MS SQL link identifier on success, or FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the contents of the cell at the row and offset in the specified mSQL result set.
") (prototype . "string msql_result(resource $result, int $row [, mixed $field = ''])") (purpose . "Get result data") (id . "function.msql-result")) "msql_regcase" ((documentation . "Alias of sql_regcase msql_regcase() (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "") (prototype . " msql_regcase()") (purpose . "Alias of sql_regcase") (id . "function.msql-regcase")) "msql_query" ((documentation . "Send mSQL query resource msql_query(string $query [, resource $link_identifier = '']) Returns a positive mSQL query identifier on success, or FALSE on error. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns a positive mSQL query identifier on success, or FALSE on error.
Returns a positive mSQL link identifier on success, or FALSE on error.
Returns the number of rows in the result set.
") (prototype . "int msql_num_rows(resource $query_identifier)") (purpose . "Get number of rows in result") (id . "function.msql-num-rows")) "msql_num_fields" ((documentation . "Get number of fields in result int msql_num_fields(resource $result) Returns the number of fields in the result set. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the number of fields in the result set.
") (prototype . "int msql_num_fields(resource $result)") (purpose . "Get number of fields in result") (id . "function.msql-num-fields")) "msql_list_tables" ((documentation . "List tables in an mSQL database resource msql_list_tables(string $database [, resource $link_identifier = '']) Returns a result set which may be traversed with any function that fetches result sets, such as msql_fetch_array. On failure, this function will return FALSE. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns a result set which may be traversed with any function that fetches result sets, such as msql_fetch_array. On failure, this function will return FALSE.
Returns a result set which may be traversed with any function that fetches result sets, such as msql_fetch_array. On failure, this function will return FALSE.
Returns a result set which may be traversed with any function that fetches result sets, such as msql_fetch_array. On failure, this function will return FALSE.
Returns TRUE on success or FALSE on failure.
The type of the field. One of int, char, real, ident, null or unknown. This functions will return FALSE on failure.
The name of the table on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
The name of the field or FALSE on failure.
Returns the length of the specified field or FALSE on error.
Returns a string containing the field flags of the specified key. This can be: primary key not null, not null, primary key, unique not null or unique.
") (prototype . "string msql_field_flags(resource $result, int $field_offset)") (purpose . "Get field flags") (id . "function.msql-field-flags")) "msql_fetch_row" ((documentation . "Get row as enumerated array array msql_fetch_row(resource $result) Returns an array that corresponds to the fetched row, or FALSE if there are no more rows. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns an array that corresponds to the fetched row, or FALSE if there are no more rows.
Returns an object with properties that correspond to the fetched row, or FALSE if there are no more rows.
Returns an object containing field information. The properties of the object are:
name - column name
table - name of the table the column belongs to
not_null - 1 if the column cannot be NULL
unique - 1 if the column is a unique key
Returns an array that corresponds to the fetched row, or FALSE if there are no more rows.
The last error message or an empty string if no error was issued.
") (prototype . "string msql_error()") (purpose . "Returns error message of last msql call") (id . "function.msql-error")) "msql_drop_db" ((documentation . "Drop (delete) mSQL database bool msql_drop_db(string $database_name [, resource $link_identifier = '']) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns a positive mSQL query identifier to the query result, or FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns a positive mSQL link identifier on success, or FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns the number of affected rows on success, or FALSE on error.
Returns the serialized string.
") (prototype . "string bson_encode(mixed $anything)") (purpose . "Serializes a PHP variable into a BSON string") (id . "function.bson-encode")) "bson_decode" ((documentation . "Deserializes a BSON object into a PHP array array bson_decode(string $bson) Returns the deserialized BSON object. (PECL mongo >=1.0.1)") (versions . "PECL mongo >=1.0.1") (return . "Returns the deserialized BSON object.
") (prototype . "array bson_decode(string $bson)") (purpose . "Deserializes a BSON object into a PHP array") (id . "function.bson-decode")) "maxdb_warning_count" ((documentation . "Returns the number of warnings from the last query for the given link int maxdb_warning_count(resource $link) Number of warnings or zero if there are no warnings. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "Number of warnings or zero if there are no warnings.
") (prototype . "int maxdb_warning_count(resource $link)") (purpose . "Returns the number of warnings from the last query for the given link") (id . "function.maxdb-warning-count")) "maxdb_use_result" ((documentation . "Initiate a result set retrieval resource maxdb_use_result(resource $link) Returns result or FALSE on failure. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . " Returns result or FALSE on failure.
TRUE if the client library is thread-safe, otherwise FALSE.
maxdb_thread_id returns the Thread ID for the current connection.
") (prototype . "int maxdb_thread_id(resource $link)") (purpose . "Returns the thread ID for the current connection") (id . "function.maxdb-thread-id")) "maxdb_store_result" ((documentation . "Transfers a result set from the last query object maxdb_store_result(resource $link) Returns a result resource or FALSE if an error occurred. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . " Returns a result resource or FALSE if an error occurred.
Returns TRUE on success or FALSE on failure.
Returns a string containing the SQLSTATE error code for the last error. The error code consists of five characters. '00000' means no error.
") (prototype . "string maxdb_stmt_sqlstate(resource $stmt)") (purpose . "Returns SQLSTATE error from previous statement operation") (id . "function.maxdb-stmt-sqlstate")) "maxdb_stmt_send_long_data" ((documentation . "Send data in blocks bool maxdb_stmt_send_long_data(resource $stmt, int $param_nr, string $data) Returns TRUE on success or FALSE on failure. (PECL maxdb 1.0)") (versions . "PECL maxdb 1.0") (return . " Returns TRUE on success or FALSE on failure.
maxdb_stmt_result_metadata returns a result resource or FALSE if an error occurred.
Returns TRUE on success or FALSE on failure.
returns an integer representing the number of parameters.
") (prototype . "int maxdb_stmt_param_count(resource $stmt)") (purpose . "Returns the number of parameter for the given statement") (id . "function.maxdb-stmt-param-count")) "maxdb_stmt_num_rows" ((documentation . "Return the number of rows in statements result set int maxdb_stmt_num_rows(resource $stmt) An integer representing the number of rows in result set. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "An integer representing the number of rows in result set.
") (prototype . "int maxdb_stmt_num_rows(resource $stmt)") (purpose . "Return the number of rows in statements result set") (id . "function.maxdb-stmt-num-rows")) "maxdb_stmt_init" ((documentation . "Initializes a statement and returns an resource for use with maxdb_stmt_prepare object maxdb_stmt_init(resource $link) Returns an resource. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "Returns an resource.
") (prototype . "object maxdb_stmt_init(resource $link)") (purpose . "Initializes a statement and returns an resource for use with maxdb_stmt_prepare") (id . "function.maxdb-stmt-init")) "maxdb_stmt_free_result" ((documentation . "Frees stored result memory for the given statement handle void maxdb_stmt_free_result(resource $stmt) This function doesn't return any value. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "This function doesn't return any value.
") (prototype . "void maxdb_stmt_free_result(resource $stmt)") (purpose . "Frees stored result memory for the given statement handle") (id . "function.maxdb-stmt-free-result")) "maxdb_stmt_fetch" ((documentation . "Fetch results from a prepared statement into the bound variables bool maxdb_stmt_fetch(resource $stmt) Return values Value Description TRUE Success. Data has been fetched FALSE Error occurred NULL No more rows/data exists (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "| Value | Description |
|---|---|
TRUE | Success. Data has been fetched |
FALSE | Error occurred |
NULL | No more rows/data exists |
Returns TRUE on success or FALSE on failure.
A string that describes the error. An empty string if no error occurred.
") (prototype . "string maxdb_stmt_error(resource $stmt)") (purpose . "Returns a string description for last statement error") (id . "function.maxdb-stmt-error")) "maxdb_stmt_errno" ((documentation . "Returns the error code for the most recent statement call int maxdb_stmt_errno(resource $stmt) An error code value. Zero means no error occurred. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "An error code value. Zero means no error occurred.
") (prototype . "int maxdb_stmt_errno(resource $stmt)") (purpose . "Returns the error code for the most recent statement call") (id . "function.maxdb-stmt-errno")) "maxdb_stmt_data_seek" ((documentation . "Seeks to an arbitray row in statement result set bool maxdb_stmt_data_seek(resource $statement, int $offset) Returns TRUE on success or FALSE on failure. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
An integer greater than zero indicates the number of rows affected or retrieved. Zero indicates that no records where updated for an UPDATE/DELETE statement, no rows matched the WHERE clause in the query or that no query has yet been executed. -1 indicates that the query has returned an error or the number of rows can not determined.
") (prototype . "int maxdb_stmt_affected_rows(resource $stmt)") (purpose . "Returns the total number of rows changed, deleted, or inserted by the last executed statement") (id . "function.maxdb-stmt-affected-rows")) "maxdb_stat" ((documentation . "Gets the current system status string maxdb_stat(resource $link) A string describing the server status. FALSE if an error occurred. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . " A string describing the server status. FALSE if an error occurred.
Returns a string containing the SQLSTATE error code for the last error. The error code consists of five characters. '00000' means no error.
") (prototype . "string maxdb_sqlstate(resource $link)") (purpose . "Returns the SQLSTATE error from previous MaxDB operation") (id . "function.maxdb-sqlstate")) "maxdb_set_opt" ((documentation . "Alias of maxdb_options maxdb_set_opt() (PECL maxdb 1.0)") (versions . "PECL maxdb 1.0") (return . "") (prototype . " maxdb_set_opt()") (purpose . "Alias of maxdb_options") (id . "function.maxdb-set-opt")) "maxdb_server_init" ((documentation . "Initialize embedded server bool maxdb_server_init([array $server = '' [, array $groups = '']]) (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "") (prototype . "bool maxdb_server_init([array $server = '' [, array $groups = '']])") (purpose . "Initialize embedded server") (id . "function.maxdb-server-init")) "maxdb_server_end" ((documentation . "Shut down the embedded server void maxdb_server_end() (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "") (prototype . "void maxdb_server_end()") (purpose . "Shut down the embedded server") (id . "function.maxdb-server-end")) "maxdb_send_query" ((documentation . "Send the query and return bool maxdb_send_query(resource $link, string $query) (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "") (prototype . "bool maxdb_send_query(resource $link, string $query)") (purpose . "Send the query and return") (id . "function.maxdb-send-query")) "maxdb_send_long_data" ((documentation . "Alias of maxdb_stmt_send_long_data maxdb_send_long_data() (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "") (prototype . " maxdb_send_long_data()") (purpose . "Alias of maxdb_stmt_send_long_data") (id . "function.maxdb-send-long-data")) "maxdb_select_db" ((documentation . "Selects the default database for database queries bool maxdb_select_db(resource $link, string $dbname) Returns TRUE on success or FALSE on failure. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns an escaped string.
") (prototype . "string maxdb_real_escape_string(resource $link, string $escapestr)") (purpose . "Escapes special characters in a string for use in an SQL statement, taking into account the current charset of the connection") (id . "function.maxdb-real-escape-string")) "maxdb_real_connect" ((documentation . "Opens a connection to a MaxDB server bool maxdb_real_connect(resource $link [, string $hostname = '' [, string $username = '' [, string $passwd = '' [, string $dbname = '' [, int $port = '' [, string $socket = '']]]]]]) Returns TRUE on success or FALSE on failure. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure. For SELECT, SHOW, DESCRIBE or EXPLAIN maxdb_query will return a result resource.
maxdb_prepare returns a statement resource or FALSE if an error occurred.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns number of rows in the result set.
") (prototype . "int maxdb_num_rows(resource $result)") (purpose . "Gets the number of rows in a result") (id . "function.maxdb-num-rows")) "maxdb_num_fields" ((documentation . "Get the number of fields in a result int maxdb_num_fields(resource $result) The number of fields from a result set (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "Note:
If the number of rows is greater than maximal int value, the number will be returned as a string.
The number of fields from a result set
") (prototype . "int maxdb_num_fields(resource $result)") (purpose . "Get the number of fields in a result") (id . "function.maxdb-num-fields")) "maxdb_next_result" ((documentation . "Prepare next result from multi_query bool maxdb_next_result(resource $link) Returns FALSE. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . " Returns FALSE.
Returns TRUE on success or FALSE on failure.
Always FALSE.
Returns TRUE on success or FALSE on failure.
The value of the DEFAULT SERIAL field that was updated by the previous query. Returns zero if there was no previous query on the connection or if the query did not update an DEFAULT_SERIAL value.
") (prototype . "mixed maxdb_insert_id(resource $link)") (purpose . "Returns the auto generated id used in the last query") (id . "function.maxdb-insert-id")) "maxdb_init" ((documentation . "Initializes MaxDB and returns an resource for use with maxdb_real_connect resource maxdb_init() Returns an resource. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "Note:
If the number is greater than maximal int value, maxdb_insert_id will return a string.
Returns an resource.
") (prototype . "resource maxdb_init()") (purpose . "Initializes MaxDB and returns an resource for use with maxdb_real_connect") (id . "function.maxdb-init")) "maxdb_info" ((documentation . "Retrieves information about the most recently executed query string maxdb_info(resource $link) A character string representing additional information about the most recently executed query. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "A character string representing additional information about the most recently executed query.
") (prototype . "string maxdb_info(resource $link)") (purpose . "Retrieves information about the most recently executed query") (id . "function.maxdb-info")) "maxdb_get_server_version" ((documentation . "Returns the version of the MaxDB server as an integer int maxdb_get_server_version(resource $link) An integer representing the server version. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "An integer representing the server version.
") (prototype . "int maxdb_get_server_version(resource $link)") (purpose . "Returns the version of the MaxDB server as an integer") (id . "function.maxdb-get-server-version")) "maxdb_get_server_info" ((documentation . "Returns the version of the MaxDB server string maxdb_get_server_info(resource $link) A character string representing the server version. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "A character string representing the server version.
") (prototype . "string maxdb_get_server_info(resource $link)") (purpose . "Returns the version of the MaxDB server") (id . "function.maxdb-get-server-info")) "maxdb_get_proto_info" ((documentation . "Returns the version of the MaxDB protocol used string maxdb_get_proto_info(resource $link) Returns an integer representing the protocol version (constant 10). (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "Returns an integer representing the protocol version (constant 10).
") (prototype . "string maxdb_get_proto_info(resource $link)") (purpose . "Returns the version of the MaxDB protocol used") (id . "function.maxdb-get-proto-info")) "maxdb_get_metadata" ((documentation . "Alias of maxdb_stmt_result_metadata maxdb_get_metadata() (PECL maxdb 1.0)") (versions . "PECL maxdb 1.0") (return . "") (prototype . " maxdb_get_metadata()") (purpose . "Alias of maxdb_stmt_result_metadata") (id . "function.maxdb-get-metadata")) "maxdb_get_host_info" ((documentation . "Returns a string representing the type of connection used string maxdb_get_host_info(resource $link) A character string representing the server hostname and the connection type. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "A character string representing the server hostname and the connection type.
") (prototype . "string maxdb_get_host_info(resource $link)") (purpose . "Returns a string representing the type of connection used") (id . "function.maxdb-get-host-info")) "maxdb_get_client_version" ((documentation . "Get MaxDB client info int maxdb_get_client_version() A number that represents the MaxDB client library version in format: main_version*10000 + minor_version *100 + sub_version. For example, 7.5.0 is returned as 70500. This is useful to quickly determine the version of the client library to know if some capability exists. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "A number that represents the MaxDB client library version in format: main_version*10000 + minor_version *100 + sub_version. For example, 7.5.0 is returned as 70500.
This is useful to quickly determine the version of the client library to know if some capability exists.
") (prototype . "int maxdb_get_client_version()") (purpose . "Get MaxDB client info") (id . "function.maxdb-get-client-version")) "maxdb_get_client_info" ((documentation . "Returns the MaxDB client version as a string string maxdb_get_client_info() A string that represents the MaxDB client library version (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "A string that represents the MaxDB client library version
") (prototype . "string maxdb_get_client_info()") (purpose . "Returns the MaxDB client version as a string") (id . "function.maxdb-get-client-info")) "maxdb_free_result" ((documentation . "Frees the memory associated with a result void maxdb_free_result(resource $result) This function doesn't return any value. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "This function doesn't return any value.
") (prototype . "void maxdb_free_result(resource $result)") (purpose . "Frees the memory associated with a result") (id . "function.maxdb-free-result")) "maxdb_field_tell" ((documentation . "Get current field offset of a result pointer int maxdb_field_tell(resource $result) Returns current offset of field cursor. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "Returns current offset of field cursor.
") (prototype . "int maxdb_field_tell(resource $result)") (purpose . "Get current field offset of a result pointer") (id . "function.maxdb-field-tell")) "maxdb_field_seek" ((documentation . "Set result pointer to a specified field offset bool maxdb_field_seek(resource $result, int $fieldnr) maxdb_field_seek returns previuos value of field cursor. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "maxdb_field_seek returns previuos value of field cursor.
") (prototype . "bool maxdb_field_seek(resource $result, int $fieldnr)") (purpose . "Set result pointer to a specified field offset") (id . "function.maxdb-field-seek")) "maxdb_field_count" ((documentation . "Returns the number of columns for the most recent query int maxdb_field_count(resource $link) An integer representing the number of fields in a result set. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "An integer representing the number of fields in a result set.
") (prototype . "int maxdb_field_count(resource $link)") (purpose . "Returns the number of columns for the most recent query") (id . "function.maxdb-field-count")) "maxdb_fetch" ((documentation . "Alias of maxdb_stmt_fetch maxdb_fetch() (PECL maxdb 1.0)") (versions . "PECL maxdb 1.0") (return . "") (prototype . " maxdb_fetch()") (purpose . "Alias of maxdb_stmt_fetch") (id . "function.maxdb-fetch")) "maxdb_fetch_row" ((documentation . "Get a result row as an enumerated array mixed maxdb_fetch_row(resource $result) maxdb_fetch_row returns an array that corresponds to the fetched row or NULL if there are no more rows in result set. Note: This function sets NULL fields tothe PHP NULL value. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . " maxdb_fetch_row returns an array that corresponds to the fetched row or NULL if there are no more rows in result set.
") (prototype . "mixed maxdb_fetch_row(resource $result)") (purpose . "Get a result row as an enumerated array") (id . "function.maxdb-fetch-row")) "maxdb_fetch_object" ((documentation . "Returns the current row of a result set as an object object maxdb_fetch_object(object $result) Returns an object that corresponds to the fetched row or NULL if there are no more rows in resultset. Note: Field names returned by this functionare case-sensitive. Note: This function sets NULL fields tothe PHP NULL value. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "Note: This function sets NULL fields tothe PHP
NULLvalue.
Returns an object that corresponds to the fetched row or NULL if there are no more rows in resultset.
Note: Field names returned by this functionare case-sensitive.
") (prototype . "object maxdb_fetch_object(object $result)") (purpose . "Returns the current row of a result set as an object") (id . "function.maxdb-fetch-object")) "maxdb_fetch_lengths" ((documentation . "Returns the lengths of the columns of the current row in the result set array maxdb_fetch_lengths(resource $result) An array of integers representing the size of each column (not including any terminating null characters). FALSE if an error occurred. maxdb_fetch_lengths is valid only for the current row of the result set. It returns FALSE if you call it before calling maxdb_fetch_row/array/resource or after retrieving all rows in the result. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "Note: This function sets NULL fields tothe PHP
NULLvalue.
An array of integers representing the size of each column (not including any terminating null characters). FALSE if an error occurred.
maxdb_fetch_lengths is valid only for the current row of the result set. It returns FALSE if you call it before calling maxdb_fetch_row/array/resource or after retrieving all rows in the result.
Returns an array of resources which contains field definition information or FALSE if no field information is available.
| Property | Description |
|---|---|
| name | The name of the column |
| max_length | The maximum width of the field for the result set. |
| type | The data type used for this field |
| decimals | The number of decimals used (for integer fields) |
Returns an resource which contains field definition information or FALSE if no field information is available.
| Property | Description |
|---|---|
| name | The name of the column |
| max_length | The maximum width of the field for the result set. |
| type | The data type used for this field |
| decimals | The number of decimals used (for integer fields) |
Returns an resource which contains field definition information or FALSE if no field information for specified fieldnr is available.
| Attribute | Description |
|---|---|
| name | The name of the column |
| max_length | The maximum width of the field for the result set. |
| type | The data type used for this field |
| decimals | The number of decimals used (for integer fields) |
Returns an array that corresponds to the fetched row or NULL if there are no more rows in resultset.
Returns an array that corresponds to the fetched row or NULL if there are no more rows in resultset.
A string that describes the error. An empty string if no error occurred.
") (prototype . "string maxdb_error(resource $link)") (purpose . "Returns a string description of the last error") (id . "function.maxdb-error")) "maxdb_errno" ((documentation . "Returns the error code for the most recent function call int maxdb_errno(resource $link) An error code value for the last call, if it failed. zero means no error occurred. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "An error code value for the last call, if it failed. zero means no error occurred.
") (prototype . "int maxdb_errno(resource $link)") (purpose . "Returns the error code for the most recent function call") (id . "function.maxdb-errno")) "maxdb_enable_rpl_parse" ((documentation . "Enable RPL parse bool maxdb_enable_rpl_parse(resource $link) (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "") (prototype . "bool maxdb_enable_rpl_parse(resource $link)") (purpose . "Enable RPL parse") (id . "function.maxdb-enable-rpl-parse")) "maxdb_enable_reads_from_master" ((documentation . "Enable reads from master bool maxdb_enable_reads_from_master(resource $link) (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "") (prototype . "bool maxdb_enable_reads_from_master(resource $link)") (purpose . "Enable reads from master") (id . "function.maxdb-enable-reads-from-master")) "maxdb_embedded_connect" ((documentation . "Open a connection to an embedded MaxDB server resource maxdb_embedded_connect([string $dbname = '']) (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "") (prototype . "resource maxdb_embedded_connect([string $dbname = ''])") (purpose . "Open a connection to an embedded MaxDB server") (id . "function.maxdb-embedded-connect")) "maxdb_dump_debug_info" ((documentation . "Dump debugging information into the log bool maxdb_dump_debug_info(resource $link) (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "") (prototype . "bool maxdb_dump_debug_info(resource $link)") (purpose . "Dump debugging information into the log") (id . "function.maxdb-dump-debug-info")) "maxdb_disable_rpl_parse" ((documentation . "Disable RPL parse bool maxdb_disable_rpl_parse(resource $link) (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "") (prototype . "bool maxdb_disable_rpl_parse(resource $link)") (purpose . "Disable RPL parse") (id . "function.maxdb-disable-rpl-parse")) "maxdb_disable_reads_from_master" ((documentation . "Disable reads from master void maxdb_disable_reads_from_master(resource $link) (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "") (prototype . "void maxdb_disable_reads_from_master(resource $link)") (purpose . "Disable reads from master") (id . "function.maxdb-disable-reads-from-master")) "maxdb_debug" ((documentation . "Performs debugging operations void maxdb_debug(string $debug) maxdb_debug doesn't return any value. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "maxdb_debug doesn't return any value.
") (prototype . "void maxdb_debug(string $debug)") (purpose . "Performs debugging operations") (id . "function.maxdb-debug")) "maxdb_data_seek" ((documentation . "Adjusts the result pointer to an arbitary row in the result bool maxdb_data_seek(resource $result, int $offset) Returns TRUE on success or FALSE on failure. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . " Returns TRUE on success or FALSE on failure.
Returns a resource which represents the connection to a MaxDB Server or FALSE if the connection failed.
A string that describes the error. An empty string if no error occurred.
") (prototype . "string maxdb_connect_error()") (purpose . "Returns a string description of the last connect error") (id . "function.maxdb-connect-error")) "maxdb_connect_errno" ((documentation . "Returns the error code from last connect call int maxdb_connect_errno() An error code value for the last call to maxdb_connect, if it failed. zero means no error occurred. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . "An error code value for the last call to maxdb_connect, if it failed. zero means no error occurred.
") (prototype . "int maxdb_connect_errno()") (purpose . "Returns the error code from last connect call") (id . "function.maxdb-connect-errno")) "maxdb_commit" ((documentation . "Commits the current transaction bool maxdb_commit(resource $link) Returns TRUE on success or FALSE on failure. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
The default character set for the current connection, either ascii or unicode.
") (prototype . "string maxdb_character_set_name(resource $link)") (purpose . "Returns the default character set for the database connection") (id . "function.maxdb-character-set-name")) "maxdb_change_user" ((documentation . "Changes the user of the specified database connection bool maxdb_change_user(resource $link, string $user, string $password, string $database) Returns TRUE on success or FALSE on failure. (PECL maxdb >= 1.0)") (versions . "PECL maxdb >= 1.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
An integer greater than zero indicates the number of rows affected or retrieved. Zero indicates that no records where updated for an UPDATE statement, no rows matched the WHERE clause in the query or that no query has yet been executed. -1 indicates that the number of rows affected can not be determined.
") (prototype . "int maxdb_affected_rows(resource $link)") (purpose . "Gets the number of affected rows in a previous MaxDB operation") (id . "function.maxdb-affected-rows")) "ingres_unbuffered_query" ((documentation . "Send an unbuffered SQL query to Ingres mixed ingres_unbuffered_query(resource $link, string $query [, array $params = '' [, string $types = '']]) ingres_unbuffered_query returns a query result identifier when there are rows to fetch; else it returns FALSE when there are no rows, as is the case of an INSERT, UPDATE, or DELETE statement. To see if an error occurred, use ingres_errno, ingres_error, or ingres_errsqlstate. ()") (versions . "") (return . " ingres_unbuffered_query returns a query result identifier when there are rows to fetch; else it returns FALSE when there are no rows, as is the case of an INSERT, UPDATE, or DELETE statement. To see if an error occurred, use ingres_errno, ingres_error, or ingres_errsqlstate.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
ingres_query returns a query result identifier on success else it returns FALSE. To see if an error occurred use ingres_errno, ingres_error or ingres_errsqlstate.
ingres_prepare returns a query result identifier that is used with ingres_execute to execute the query. To see if an error occurred, use ingres_errno, ingres_error, or ingres_errsqlstate.
") (prototype . "mixed ingres_prepare(resource $link, string $query)") (purpose . "Prepare a query for later execution") (id . "function.ingres-prepare")) "ingres_pconnect" ((documentation . "Open a persistent connection to an Ingres database resource ingres_pconnect([string $database = '' [, string $username = '' [, string $password = '' [, array $options = '']]]]) Returns an Ingres link resource on success or FALSE on failure (PHP 4 >= 4.0.2, PHP 5 <= 5.0.5, PECL ingres >= 1.0.0)") (versions . "PHP 4 >= 4.0.2, PHP 5 <= 5.0.5, PECL ingres >= 1.0.0") (return . " Returns an Ingres link resource on success or FALSE on failure
For delete, insert, or update queries, ingres_num_rows returns the number of rows affected by the query. For other queries, ingres_num_rows returns the number of rows in the query's result.
") (prototype . "int ingres_num_rows(resource $result)") (purpose . "Get the number of rows affected or returned by a query") (id . "function.ingres-num-rows")) "ingres_num_fields" ((documentation . "Get the number of fields returned by the last query int ingres_num_fields(resource $result) Returns the number of fields (PHP 4 >= 4.0.2, PHP 5 <= 5.0.5, PECL ingres >= 1.0.0)") (versions . "PHP 4 >= 4.0.2, PHP 5 <= 5.0.5, PECL ingres >= 1.0.0") (return . "Returns the number of fields
") (prototype . "int ingres_num_fields(resource $result)") (purpose . "Get the number of fields returned by the last query") (id . "function.ingres-num-fields")) "ingres_next_error" ((documentation . "Get the next Ingres error bool ingres_next_error([resource $link = '']) ingres_next_error returns TRUE if there is another error to retrieve or FALSE when there are no more errors (PECL ingres >= 2.0.0)") (versions . "PECL ingres >= 2.0.0") (return . " ingres_next_error returns TRUE if there is another error to retrieve or FALSE when there are no more errors
Returns TRUE on success or FALSE on failure.
ingres_field_type returns the type of a field in a query result or FALSE on failure. Examples of types returned are IIAPI_BYTE_TYPE, IIAPI_CHA_TYPE, IIAPI_DTE_TYPE, IIAPI_FLT_TYPE, IIAPI_INT_TYPE, IIAPI_VCH_TYPE. Some of these types can map to more than one SQL type depending on the length of the field (see ingres_field_length). For example IIAPI_FLT_TYPE can be a float4 or a float8. For detailed information, see the Ingres OpenAPI User Guide, Appendix "Data Types" in the Ingres documentation.
Returns the scale of the field, as an integer
") (prototype . "int ingres_field_scale(resource $result, int $index)") (purpose . "Get the scale of a field") (id . "function.ingres-field-scale")) "ingres_field_precision" ((documentation . "Get the precision of a field int ingres_field_precision(resource $result, int $index) Returns the field precision as an integer (PHP 4 >= 4.0.2, PHP 5 <= 5.0.5, PECL ingres >= 1.0.0)") (versions . "PHP 4 >= 4.0.2, PHP 5 <= 5.0.5, PECL ingres >= 1.0.0") (return . "Returns the field precision as an integer
") (prototype . "int ingres_field_precision(resource $result, int $index)") (purpose . "Get the precision of a field") (id . "function.ingres-field-precision")) "ingres_field_nullable" ((documentation . "Test if a field is nullable bool ingres_field_nullable(resource $result, int $index) ingres_field_nullable returns TRUE if the field can be set to the NULL value and FALSE if it cannot (PHP 4 >= 4.0.2, PHP 5 <= 5.0.5, PECL ingres >= 1.0.0)") (versions . "PHP 4 >= 4.0.2, PHP 5 <= 5.0.5, PECL ingres >= 1.0.0") (return . " ingres_field_nullable returns TRUE if the field can be set to the NULL value and FALSE if it cannot
Returns the name of a field in a query result or FALSE on failure
Returns the length of a field.
") (prototype . "int ingres_field_length(resource $result, int $index)") (purpose . "Get the length of a field") (id . "function.ingres-field-length")) "ingres_fetch_row" ((documentation . "Fetch a row of result into an enumerated array array ingres_fetch_row(resource $result) Returns an array that corresponds to the fetched row, or FALSE if there are no more rows (PHP 4 >= 4.0.2, PHP 5 <= 5.0.5, PECL ingres >= 1.0.0)") (versions . "PHP 4 >= 4.0.2, PHP 5 <= 5.0.5, PECL ingres >= 1.0.0") (return . " Returns an array that corresponds to the fetched row, or FALSE if there are no more rows
Returns an integer if there is a return value otherwise it will return NULL.
Returns an object that corresponds to the fetched row, or FALSE if there are no more rows
Returns an associative array that corresponds to the fetched row, or FALSE if there are no more rows
Returns an array that corresponds to the fetched row, or FALSE if there are no more rows
Returns TRUE on success or FALSE on failure.
Returns a string containing the escaped data.
") (prototype . "string ingres_escape_string(resource $link, string $source_string)") (purpose . "Escape special characters for use in a query") (id . "function.ingres-escape-string")) "ingres_errsqlstate" ((documentation . "Get the last SQLSTATE error code generated string ingres_errsqlstate([resource $link = '']) Returns a string containing the last SQLSTATE, or NULL if no error has occurred. (PECL ingres >= 1.1.0)") (versions . "PECL ingres >= 1.1.0") (return . "Returns a string containing the last SQLSTATE, or NULL if no error has occurred.
") (prototype . "string ingres_errsqlstate([resource $link = ''])") (purpose . "Get the last SQLSTATE error code generated") (id . "function.ingres-errsqlstate")) "ingres_error" ((documentation . "Get a meaningful error message for the last error generated string ingres_error([resource $link = '']) Returns a string containing the last error, or NULL if no error has occurred. (PECL ingres >= 1.1.0)") (versions . "PECL ingres >= 1.1.0") (return . "Returns a string containing the last error, or NULL if no error has occurred.
") (prototype . "string ingres_error([resource $link = ''])") (purpose . "Get a meaningful error message for the last error generated") (id . "function.ingres-error")) "ingres_errno" ((documentation . "Get the last Ingres error number generated int ingres_errno([resource $link = '']) Returns an integer containing the last error number. If no error was reported, 0 is returned. (PECL ingres >= 1.1.0)") (versions . "PECL ingres >= 1.1.0") (return . "Returns an integer containing the last error number. If no error was reported, 0 is returned.
") (prototype . "int ingres_errno([resource $link = ''])") (purpose . "Get the last Ingres error number generated") (id . "function.ingres-errno")) "ingres_cursor" ((documentation . "Get a cursor name for a given result resource string ingres_cursor(resource $result) Returns a string containing the active cursor name. If no cursor is active then NULL is returned. (PECL ingres >= 1.1.0)") (versions . "PECL ingres >= 1.1.0") (return . "Returns a string containing the active cursor name. If no cursor is active then NULL is returned.
") (prototype . "string ingres_cursor(resource $result)") (purpose . "Get a cursor name for a given result resource") (id . "function.ingres-cursor")) "ingres_connect" ((documentation . "Open a connection to an Ingres database resource ingres_connect([string $database = '' [, string $username = '' [, string $password = '' [, array $options = '']]]]) Returns a Ingres link resource on success or FALSE on failure (PHP 4 >= 4.0.2, PHP 5 <= 5.0.5, PECL ingres >= 1.0.0)") (versions . "PHP 4 >= 4.0.2, PHP 5 <= 5.0.5, PECL ingres >= 1.0.0") (return . " Returns a Ingres link resource on success or FALSE on failure
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns a string with the value for II_CHARSETxx or returns NULL if the value could not be determined.
") (prototype . "string ingres_charset(resource $link)") (purpose . "Returns the installation character set") (id . "function.ingres-charset")) "ingres_autocommit" ((documentation . "Switch autocommit on or off bool ingres_autocommit(resource $link) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.2, PHP 5 <= 5.0.5, PECL ingres >= 1.0.0)") (versions . "PHP 4 >= 4.0.2, PHP 5 <= 5.0.5, PECL ingres >= 1.0.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE if autocommit is enabled or FALSE when autocommit is disabled
Returns the bytes written as an integer, or FALSE on errors.
Returns the seek position as an integer, or FALSE on errors.
Returns the seek position as an integer, or FALSE on errors.
Returns the slob contents as a string, or FALSE on errors.
Returns the new slob object-id, or FALSE on errors.
Returns TRUE on success or FALSE on failure.
Return the new slob object-id, or FALSE on errors.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns valid Informix result identifier on success, or FALSE on errors.
Returns a valid result identifier for use by ifx_do, or FALSE on errors.
Returns: valid Informix persistent link identifier on success, or FALSE on errors.
Returns the number of fetched rows or FALSE on errors.
Returns the number of columns in query for result_id, or FALSE on errors.
Returns TRUE on success or FALSE on failure.
Returns the number of fetched rows, or FALSE on errors.
Returns an associative array with the following entries: sqlerrd0, sqlerrd1, sqlerrd2, sqlerrd3, sqlerrd4 and sqlerrd5.
") (prototype . "array ifx_getsqlca(resource $result_id)") (purpose . "Get the contents of sqlca.sqlerrd[0..5] after a query") (id . "function.ifx-getsqlca")) "ifx_get_char" ((documentation . "Return the content of the char object string ifx_get_char(int $bid) Returns the contents as a string, or FALSE on errors. (PHP 4, PHP <=5.2.0)") (versions . "PHP 4, PHP <=5.2.0") (return . " Returns the contents as a string, or FALSE on errors.
The contents of the BLOB as a string, or FALSE on errors.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns an associative array with fieldnames as key and the SQL fieldtypes as data for query with result_id. Returns FALSE on error.
Returns an associative array with fieldnames as key and the SQL fieldproperties as data for a query with result_id. Returns FALSE on errors.
Returns an associative array that corresponds to the fetched row, or FALSE if there are no more rows.
Blob columns are returned as integer blob id values for use in ifx_get_blob unless you have used ifx_textasvarchar(1) or ifx_byteasvarchar(1), in which case blobs are returned as string values.
") (prototype . "array ifx_fetch_row(resource $result_id [, mixed $position = ''])") (purpose . "Get row as an associative array") (id . "function.ifx-fetch-row")) "ifx_errormsg" ((documentation . "Returns error message of last Informix call string ifx_errormsg([int $errorcode = '']) Return the error message, as a string. (PHP 4, PHP <=5.2.0)") (versions . "PHP 4, PHP <=5.2.0") (return . "Return the error message, as a string.
") (prototype . "string ifx_errormsg([int $errorcode = ''])") (purpose . "Returns error message of last Informix call") (id . "function.ifx-errormsg")) "ifx_error" ((documentation . "Returns error code of last Informix call string ifx_error([resource $link_identifier = '']) The Informix error codes (SQLSTATE & SQLCODE) formatted as x [SQLSTATE = aa bbb SQLCODE=cccc]. where x = space : no error E : error N : no more data W : warning ? : undefined If the \"x\" character is anything other than space, SQLSTATE and SQLCODE describe the error in more detail. See the Informix manual for the description of SQLSTATE and SQLCODE (PHP 4, PHP <=5.2.0)") (versions . "PHP 4, PHP <=5.2.0") (return . "The Informix error codes (SQLSTATE & SQLCODE) formatted as x [SQLSTATE = aa bbb SQLCODE=cccc].
where x = space : no error
E : error
N : no more data
W : warning
? : undefined
If the "x" character is anything other than space, SQLSTATE and SQLCODE describe the error in more detail.
See the Informix manual for the description of SQLSTATE and SQLCODE
") (prototype . "string ifx_error([resource $link_identifier = ''])") (purpose . "Returns error code of last Informix call") (id . "function.ifx-error")) "ifx_do" ((documentation . "Execute a previously prepared SQL-statement bool ifx_do(resource $result_id) Returns TRUE on success or FALSE on failure. (PHP 4, PHP <=5.2.0)") (versions . "PHP 4, PHP <=5.2.0") (return . " Returns TRUE on success or FALSE on failure.
Returns the new char object id, or FALSE on errors.
Returns the new BLOB object-id, or FALSE on errors.
Returns the new blob object-id, or FALSE on errors.
Returns a connection identifier on success, or FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the number of rows as an integer.
") (prototype . "int ifx_affected_rows(resource $result_id)") (purpose . "Get number of rows affected by a query") (id . "function.ifx-affected-rows")) "db2_tables" ((documentation . "Returns a result set listing the tables and associated metadata in a database resource db2_tables(resource $connection [, string $qualifier = '' [, string $schema = '' [, string $table-name = '' [, string $table-type = '']]]]) 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. (PECL ibm_db2 >= 1.0.0)") (versions . "PECL ibm_db2 >= 1.0.0") (return . "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. |
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. |
Returns a string containing the error message and SQLCODE value for the last error that occurred issuing an SQL statement.
") (prototype . "string db2_stmt_errormsg([resource $stmt = ''])") (purpose . "Returns a string containing the last SQL statement error message") (id . "function.db2-stmt-errormsg")) "db2_stmt_error" ((documentation . "Returns a string containing the SQLSTATE returned by an SQL statement string db2_stmt_error([resource $stmt = '']) Returns a string containing an SQLSTATE value. (PECL ibm_db2 >= 1.0.0)") (versions . "PECL ibm_db2 >= 1.0.0") (return . "Returns a string containing an SQLSTATE value.
") (prototype . "string db2_stmt_error([resource $stmt = ''])") (purpose . "Returns a string containing the SQLSTATE returned by an SQL statement") (id . "function.db2-stmt-error")) "db2_statistics" ((documentation . "Returns a result set listing the index and statistics for a table resource db2_statistics(resource $connection, string $qualifier, string $schema, string $table-name, bool $unique) 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 The row contains (SQL_INDEX_CLUSTERED) 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. (PECL ibm_db2 >= 1.0.0)") (versions . "PECL ibm_db2 >= 1.0.0") (return . "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:
| ||||||||||
| 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:
| ||||||||||
| 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. |
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 |
| ||||||||||||
| 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. |
Returns TRUE on success or FALSE on failure.
Returns an object on a successful call. Returns FALSE on failure.
Returns TRUE on success or FALSE on failure.
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.
") (prototype . "mixed db2_result(resource $stmt, mixed $column)") (purpose . "Returns a single column from a row in the result set") (id . "function.db2-result")) "db2_procedures" ((documentation . "Returns a result set listing the stored procedures registered in a database resource db2_procedures(resource $connection, string $qualifier, string $schema, string $procedure) 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. (PECL ibm_db2 >= 1.0.0)") (versions . "PECL ibm_db2 >= 1.0.0") (return . "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. |
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:
| ||||||||
| 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. |
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. |
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.
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.
Returns TRUE on success or FALSE on failure.
Returns the number of rows affected by the last SQL statement issued by the specified statement handle.
") (prototype . "boolean db2_num_rows(resource $stmt)") (purpose . "Returns the number of rows affected by an SQL statement") (id . "function.db2-num-rows")) "db2_num_fields" ((documentation . "Returns the number of fields contained in a result set int db2_num_fields(resource $stmt) 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. (PECL ibm_db2 >= 1.0.0)") (versions . "PECL ibm_db2 >= 1.0.0") (return . " 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.
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.
Returns the amount of data the user specifies. Returns FALSE if the data cannot be retrieved.
Returns the auto generated ID of last insert query that successfully executed on this connection.
") (prototype . "string db2_last_insert_id(resource $resource)") (purpose . "Returns the auto generated ID of the last insert query that successfully executed on this connection") (id . "function.db2-last-insert-id")) "db2_get_option" ((documentation . "Retrieves an option value for a statement resource or a connection resource string db2_get_option(resource $resource, string $option) Returns the current setting of the connection attribute provided on success or FALSE on failure. (PECL ibm_db2 >= 1.6.0)") (versions . "PECL ibm_db2 >= 1.6.0") (return . " Returns the current setting of the connection attribute provided on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
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. |
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.
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.
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.
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.
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.
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.
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.
Returns TRUE if the requested row exists in the result set. Returns FALSE if the requested row does not exist in the result set.
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.
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.
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.
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.
Returns TRUE on success or FALSE on failure.
Returns a statement resource if the SQL statement was issued successfully, or FALSE if the database failed to execute the SQL statement.
Returns string_literal with the special characters noted above prepended with backslashes.
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.
") (prototype . "int db2_cursor_type(resource $stmt)") (purpose . "Returns the cursor type used by a statement resource") (id . "function.db2-cursor-type")) "db2_connect" ((documentation . "Returns a connection to a database resource db2_connect(string $database, string $username, string $password [, array $options = '']) Returns a connection handle resource if the connection attempt is successful. If the connection attempt fails, db2_connect returns FALSE. (PECL ibm_db2 >= 1.0.0)") (versions . "PECL ibm_db2 >= 1.0.0") (return . " Returns a connection handle resource if the connection attempt is successful. If the connection attempt fails, db2_connect returns FALSE.
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.
") (prototype . "string db2_conn_errormsg([resource $connection = ''])") (purpose . "Returns the last connection error message and SQLCODE value") (id . "function.db2-conn-errormsg")) "db2_conn_error" ((documentation . "Returns a string containing the SQLSTATE returned by the last connection attempt string db2_conn_error([resource $connection = '']) 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. (PECL ibm_db2 >= 1.0.0)") (versions . "PECL ibm_db2 >= 1.0.0") (return . "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.
") (prototype . "string db2_conn_error([resource $connection = ''])") (purpose . "Returns a string containing the SQLSTATE returned by the last connection attempt") (id . "function.db2-conn-error")) "db2_commit" ((documentation . "Commits a transaction bool db2_commit(resource $connection) Returns TRUE on success or FALSE on failure. (PECL ibm_db2 >= 1.0.0)") (versions . "PECL ibm_db2 >= 1.0.0") (return . " Returns TRUE on success or FALSE on failure.
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. |
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. |
Returns TRUE on success or FALSE on failure.
Returns an object on a successful call. Returns FALSE on failure.
Returns TRUE on success or FALSE on failure.
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 0 indicates that AUTOCOMMIT is off, while a value of 1 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. Returns TRUE on success or FALSE on failure.
Returns TRUE if warnings is turned on, FALSE otherwise.
Returns the current username used with the connection, as a string.
") (prototype . "string fbsql_username(resource $link_identifier [, string $username = ''])") (purpose . "Get or set the username for the connection") (id . "function.fbsql-username")) "fbsql_tablename" ((documentation . "Alias of fbsql_table_name fbsql_tablename() (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . "") (prototype . " fbsql_tablename()") (purpose . "Alias of fbsql_table_name") (id . "function.fbsql-tablename")) "fbsql_table_name" ((documentation . "Get table name of field string fbsql_table_name(resource $result, int $index) Returns the name of the table, as a string. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . "Returns the name of the table, as a string.
") (prototype . "string fbsql_table_name(resource $result, int $index)") (purpose . "Get table name of field") (id . "function.fbsql-table-name")) "fbsql_stop_db" ((documentation . "Stop a database on local or remote server bool fbsql_stop_db(string $database_name [, resource $link_identifier = '']) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void fbsql_set_transaction(resource $link_identifier, int $locking, int $isolation)") (purpose . "Set the transaction locking and isolation") (id . "function.fbsql-set-transaction")) "fbsql_set_password" ((documentation . "Change the password for a given user bool fbsql_set_password(resource $link_identifier, string $user, string $password, string $old_password) Returns TRUE on success or FALSE on failure. (PHP 5)") (versions . "PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void fbsql_set_characterset(resource $link_identifier, int $characterset [, int $in_out_both = ''])") (purpose . "Change input/output character set") (id . "function.fbsql-set-characterset")) "fbsql_select_db" ((documentation . "Select a FrontBase database bool fbsql_select_db([string $database_name = '' [, resource $link_identifier = '']]) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns the number of rows, as an integer.
") (prototype . "int fbsql_rows_fetched(resource $result)") (purpose . "Get the number of rows affected by the last statement") (id . "function.fbsql-rows-fetched")) "fbsql_rollback" ((documentation . "Rollback a transaction to the database bool fbsql_rollback([resource $link_identifier = '']) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
") (prototype . "mixed fbsql_result(resource $result [, int $row = '' [, mixed $field = '']])") (purpose . "Get result data") (id . "function.fbsql-result")) "fbsql_read_clob" ((documentation . "Read a CLOB from the database string fbsql_read_clob(string $clob_handle [, resource $link_identifier = '']) Returns a string containing the specified CLOB data. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . "
Returns a string containing the specified CLOB data.
") (prototype . "string fbsql_read_clob(string $clob_handle [, resource $link_identifier = ''])") (purpose . "Read a CLOB from the database") (id . "function.fbsql-read-clob")) "fbsql_read_blob" ((documentation . "Read a BLOB from the database string fbsql_read_blob(string $blob_handle [, resource $link_identifier = '']) Returns a string containing the specified BLOB data. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . "Returns a string containing the specified BLOB data.
") (prototype . "string fbsql_read_blob(string $blob_handle [, resource $link_identifier = ''])") (purpose . "Read a BLOB from the database") (id . "function.fbsql-read-blob")) "fbsql_query" ((documentation . "Send a FrontBase query resource fbsql_query(string $query [, resource $link_identifier = '' [, int $batch_size = '']]) fbsql_query returns TRUE (non-zero) or FALSE to indicate whether or not the query succeeded. A return value of TRUE means that the query was legal and could be executed by the server. It does not indicate anything about the number of rows affected or returned. It is perfectly possible for a query to succeed but affect no rows or return no rows. For SELECT statements, fbsql_query returns a new result identifier that you can pass to fbsql_result. fbsql_query will also fail and return FALSE if you don't have permission to access the table(s) referenced by the query. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . " fbsql_query returns TRUE (non-zero) or FALSE to indicate whether or not the query succeeded. A return value of TRUE means that the query was legal and could be executed by the server. It does not indicate anything about the number of rows affected or returned. It is perfectly possible for a query to succeed but affect no rows or return no rows.
For SELECT statements, fbsql_query returns a new result identifier that you can pass to fbsql_result.
fbsql_query will also fail and return FALSE if you don't have permission to access the table(s) referenced by the query.
Returns a positive FrontBase persistent link identifier on success, or FALSE on error.
Returns the current password used for the connection.
") (prototype . "string fbsql_password(resource $link_identifier [, string $password = ''])") (purpose . "Get or set the user password used with a connection") (id . "function.fbsql-password")) "fbsql_num_rows" ((documentation . "Get number of rows in result int fbsql_num_rows(resource $result) Returns the number of rows returned by the last SELECT statement. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . "Returns the number of rows returned by the last SELECT statement.
") (prototype . "int fbsql_num_rows(resource $result)") (purpose . "Get number of rows in result") (id . "function.fbsql-num-rows")) "fbsql_num_fields" ((documentation . "Get number of fields in result int fbsql_num_fields(resource $result) Returns the number of fields, as an integer. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . "Returns the number of fields, as an integer.
") (prototype . "int fbsql_num_fields(resource $result)") (purpose . "Get number of fields in result") (id . "function.fbsql-num-fields")) "fbsql_next_result" ((documentation . "Move the internal result pointer to the next result bool fbsql_next_result(resource $result) Returns TRUE if an additional result set was available or FALSE otherwise. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . " Returns TRUE if an additional result set was available or FALSE otherwise.
Returns a result pointer which can be used with the fbsql_tablename function to read the actual table names, or FALSE on error.
Returns a result pointer which can be used with the fbsql_field_xxx functions, or FALSE on error.
Returns a result pointer or FALSE on error.
Returns the ID generated from the previous INSERT query, or 0 if the previous query does not generate an DEFAULT UNIQUE value.
If you need to save the value for later, be sure to call this function immediately after the query that generates the value.
") (prototype . "int fbsql_insert_id([resource $link_identifier = ''])") (purpose . "Get the id generated from the previous INSERT operation") (id . "function.fbsql-insert-id")) "fbsql_hostname" ((documentation . "Get or set the host name used with a connection string fbsql_hostname(resource $link_identifier [, string $host_name = '']) Returns the current host name used for the connection. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . "Returns the current host name used for the connection.
") (prototype . "string fbsql_hostname(resource $link_identifier [, string $host_name = ''])") (purpose . "Get or set the host name used with a connection") (id . "function.fbsql-hostname")) "fbsql_get_autostart_info" ((documentation . " array fbsql_get_autostart_info([resource $link_identifier = '']) (PHP 4 >= 4.0.7, PHP 5)") (versions . "PHP 4 >= 4.0.7, PHP 5") (return . "") (prototype . "array fbsql_get_autostart_info([resource $link_identifier = ''])") (purpose . "") (id . "function.fbsql-get-autostart-info")) "fbsql_free_result" ((documentation . "Free result memory bool fbsql_free_result(resource $result) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns the field type, as a string.
This can be one of int, real, string, blob, and others as detailed in the » FrontBase documentation.
") (prototype . "string fbsql_field_type(resource $result [, int $field_offset = ''])") (purpose . "Get the type of the specified field in a result") (id . "function.fbsql-field-type")) "fbsql_field_table" ((documentation . "Get name of the table the specified field is in string fbsql_field_table(resource $result [, int $field_offset = '']) Returns the name of the table, as a string. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . "Returns the name of the table, as a string.
") (prototype . "string fbsql_field_table(resource $result [, int $field_offset = ''])") (purpose . "Get name of the table the specified field is in") (id . "function.fbsql-field-table")) "fbsql_field_seek" ((documentation . "Set result pointer to a specified field offset bool fbsql_field_seek(resource $result [, int $field_offset = '']) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns the name as a string, or FALSE if the field doesn't exist.
Returns the length of the specified field.
") (prototype . "int fbsql_field_len(resource $result [, int $field_offset = ''])") (purpose . "Returns the length of the specified field") (id . "function.fbsql-field-len")) "fbsql_field_flags" ((documentation . "Get the flags associated with the specified field in a result string fbsql_field_flags(resource $result [, int $field_offset = '']) Returns the field flags of the specified field as a single word per flag separated by a single space, so that you can split the returned value using explode. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . "Returns the field flags of the specified field as a single word per flag separated by a single space, so that you can split the returned value using explode.
") (prototype . "string fbsql_field_flags(resource $result [, int $field_offset = ''])") (purpose . "Get the flags associated with the specified field in a result") (id . "function.fbsql-field-flags")) "fbsql_fetch_row" ((documentation . "Get a result row as an enumerated array array fbsql_fetch_row(resource $result) Returns an array that corresponds to the fetched row where each result column is stored in an offset, starting at offset 0, or FALSE if there are no more rows. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . " Returns an array that corresponds to the fetched row where each result column is stored in an offset, starting at offset 0, or FALSE if there are no more rows.
Returns an object with properties that correspond to the fetched row, or FALSE if there are no more rows.
Returns an array, starting at offset 0, that corresponds to the lengths of each field in the last row fetched by fbsql_fetch_row, or FALSE on error.
Returns an object containing field information, or FALSE on errors.
The properties of the object are:
NULL Returns an associative array 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 must use fbsql_fetch_array and have it return the numeric indices as well.
") (prototype . "array fbsql_fetch_assoc(resource $result)") (purpose . "Fetch a result row as an associative array") (id . "function.fbsql-fetch-assoc")) "fbsql_fetch_array" ((documentation . "Fetch a result row as an associative array, a numeric array, or both array fbsql_fetch_array(resource $result [, int $result_type = '']) Returns an array 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 must the numeric index of the column or make an alias for the column. select t1.f1 as foo t2.f1 as bar from t1, t2 (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . " Returns an array 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 must the numeric index of the column or make an alias for the column.
select t1.f1 as foo t2.f1 as bar from t1, t2
Returns the error text from the last fbsql function, or '' (the empty string) if no error occurred.
") (prototype . "string fbsql_error([resource $link_identifier = ''])") (purpose . "Returns the error message from previous operation") (id . "function.fbsql-error")) "fbsql_errno" ((documentation . "Returns the error number from previous operation int fbsql_errno([resource $link_identifier = '']) Returns the error number from the last fbsql function, or 0 (zero) if no error occurred. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . "Returns the error number from the last fbsql function, or 0 (zero) if no error occurred.
") (prototype . "int fbsql_errno([resource $link_identifier = ''])") (purpose . "Returns the error number from previous operation") (id . "function.fbsql-errno")) "fbsql_drop_db" ((documentation . "Drop (delete) a FrontBase database bool fbsql_drop_db(string $database_name [, resource $link_identifier = '']) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns an integer value with the current status. This can be one of the following constants:
FALSE - The exec handler for the host was invalid. This error will occur when the link_identifier connects directly to a database by using a port number. FBExec can be available on the server but no connection has been made for it. FBSQL_UNKNOWN - The Status is unknown. FBSQL_STOPPED - The database is not running. Use fbsql_start_db to start the database. FBSQL_STARTING - The database is starting. FBSQL_RUNNING - The database is running and can be used to perform SQL operations. FBSQL_STOPPING - The database is stopping. FBSQL_NOEXEC - FBExec is not running on the server and it is not possible to get the status of the database. Returns a positive FrontBase result identifier to the query result, or FALSE on error.
Returns the name of the database used with this connection.
") (prototype . "string fbsql_database(resource $link_identifier [, string $database = ''])") (purpose . "Get or set the database name used with a connection") (id . "function.fbsql-database")) "fbsql_database_password" ((documentation . "Sets or retrieves the password for a FrontBase database string fbsql_database_password(resource $link_identifier [, string $database_password = '']) Returns the database password associated with the link identifier. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . "Returns the database password associated with the link identifier.
") (prototype . "string fbsql_database_password(resource $link_identifier [, string $database_password = ''])") (purpose . "Sets or retrieves the password for a FrontBase database") (id . "function.fbsql-database-password")) "fbsql_data_seek" ((documentation . "Move internal result pointer bool fbsql_data_seek(resource $result, int $row_number) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns a resource handle to the newly created CLOB, which can be used with insert and update commands to store the CLOB in the database.
") (prototype . "string fbsql_create_clob(string $clob_data [, resource $link_identifier = ''])") (purpose . "Create a CLOB") (id . "function.fbsql-create-clob")) "fbsql_create_blob" ((documentation . "Create a BLOB string fbsql_create_blob(string $blob_data [, resource $link_identifier = '']) Returns a resource handle to the newly created BLOB, which can be used with insert and update commands to store the BLOB in the database. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . "Returns a resource handle to the newly created BLOB, which can be used with insert and update commands to store the BLOB in the database.
") (prototype . "string fbsql_create_blob(string $blob_data [, resource $link_identifier = ''])") (purpose . "Create a BLOB") (id . "function.fbsql-create-blob")) "fbsql_connect" ((documentation . "Open a connection to a FrontBase Server resource fbsql_connect([string $hostname = ini_get(\"fbsql.default_host\") [, string $username = ini_get(\"fbsql.default_user\") [, string $password = ini_get(\"fbsql.default_password\")]]]) Returns a positive FrontBase link identifier on success, or FALSE on errors. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . " Returns a positive FrontBase link identifier on success, or FALSE on errors.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the CLOB size as an integer, or FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns the BLOB size as an integer, or FALSE on error.
Returns the current autocommit status, as a boolean.
") (prototype . "bool fbsql_autocommit(resource $link_identifier [, bool $OnOff = ''])") (purpose . "Enable or disable autocommit") (id . "function.fbsql-autocommit")) "fbsql_affected_rows" ((documentation . "Get number of affected rows in previous FrontBase operation int fbsql_affected_rows([resource $link_identifier = '']) If the last query failed, this function will return -1. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . "If the last query failed, this function will return -1.
") (prototype . "int fbsql_affected_rows([resource $link_identifier = ''])") (purpose . "Get number of affected rows in previous FrontBase operation") (id . "function.fbsql-affected-rows")) "ibase_wait_event" ((documentation . "Wait for an event to be posted by the database string ibase_wait_event(string $event_name1 [, string $event_name2 = '' [, string $... = '', resource $connection]]) Returns the name of the event that was posted. (PHP 5)") (versions . "PHP 5") (return . "Returns the name of the event that was posted.
") (prototype . "string ibase_wait_event(string $event_name1 [, string $event_name2 = '' [, string $... = '', resource $connection]])") (purpose . "Wait for an event to be posted by the database") (id . "function.ibase-wait-event")) "ibase_trans" ((documentation . "Begin a transaction resource ibase_trans([int $trans_args = '' [, resource $link_identifier = '']]) Returns a transaction handle, or FALSE on error. (PHP 5)") (versions . "PHP 5") (return . " Returns a transaction handle, or FALSE on error.
The return value is an event resource. This resource can be used to free the event handler using ibase_free_event_handler.
") (prototype . "resource ibase_set_event_handler(callable $event_handler, string $event_name1 [, string $event_name2 = '' [, string $... = '', resource $connection]])") (purpose . "Register a callback function to be called when events are posted") (id . "function.ibase-set-event-handler")) "ibase_service_detach" ((documentation . "Disconnect from the service manager bool ibase_service_detach(resource $service_handle) Returns TRUE on success or FALSE on failure. (PHP 5)") (versions . "PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
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.
") (prototype . "resource ibase_query([resource $link_identifier = '', string $query [, int $bind_args = '']])") (purpose . "Execute a query on an InterBase database") (id . "function.ibase-query")) "ibase_prepare" ((documentation . "Prepare a query for later binding of parameter placeholders and execution resource ibase_prepare(string $query, resource $link_identifier, string $trans) Returns a prepared query handle, or FALSE on error. (PHP 5)") (versions . "PHP 5") (return . "Note:
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
TRUEfor these statements if the query succeeded without affecting any rows.
Returns a prepared query handle, or FALSE on error.
Returns an InterBase link identifier on success, or FALSE on error.
Returns an array with the following keys: name, alias, relation, length and type.
") (prototype . "array ibase_param_info(resource $query, int $param_number)") (purpose . "Return information about a parameter in a prepared query") (id . "function.ibase-param-info")) "ibase_num_params" ((documentation . "Return the number of parameters in a prepared query int ibase_num_params(resource $query) Returns the number of parameters as an integer. (PHP 5)") (versions . "PHP 5") (return . "Returns the number of parameters as an integer.
") (prototype . "int ibase_num_params(resource $query)") (purpose . "Return the number of parameters in a prepared query") (id . "function.ibase-num-params")) "ibase_num_fields" ((documentation . "Get the number of fields in a result set int ibase_num_fields(resource $result_id) Returns the number of fields as an integer. (PHP 5)") (versions . "PHP 5") (return . "Returns the number of fields as an integer.
") (prototype . "int ibase_num_fields(resource $result_id)") (purpose . "Get the number of fields in a result set") (id . "function.ibase-num-fields")) "ibase_name_result" ((documentation . "Assigns a name to a result set bool ibase_name_result(resource $result, string $name) Returns TRUE on success or FALSE on failure. (PHP 5)") (versions . "PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns new generator value as integer, or as string if the value is too big.
") (prototype . "mixed ibase_gen_id(string $generator [, int $increment = 1 [, resource $link_identifier = '']])") (purpose . "Increments the named generator and returns its new value") (id . "function.ibase-gen-id")) "ibase_free_result" ((documentation . "Free a result set bool ibase_free_result(resource $result_identifier) Returns TRUE on success or FALSE on failure. (PHP 5)") (versions . "PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns an array with the following keys: name, alias, relation, length and type.
") (prototype . "array ibase_field_info(resource $result, int $field_number)") (purpose . "Get information about a field") (id . "function.ibase-field-info")) "ibase_fetch_row" ((documentation . "Fetch a row from an InterBase database array ibase_fetch_row(resource $result_identifier [, int $fetch_flag = '']) 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. (PHP 5)") (versions . "PHP 5") (return . " 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.
Returns an object with the next row information, or FALSE if there are no more rows.
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.
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.
") (prototype . "resource ibase_execute(resource $query [, mixed $bind_arg = '' [, mixed $... = '']])") (purpose . "Execute a previously prepared query") (id . "function.ibase-execute")) "ibase_errmsg" ((documentation . "Return error messages string ibase_errmsg() Returns the error message as a string, or FALSE if no error occurred. (PHP 5)") (versions . "PHP 5") (return . "Note:
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.
Returns the error message as a string, or FALSE if no error occurred.
Returns the error code as an integer, or FALSE if no error occurred.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns an Firebird/InterBase link identifier on success, or FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns a BLOB handle for later use with ibase_blob_get or FALSE on failure.
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.
") (prototype . "array ibase_blob_info(resource $link_identifier, string $blob_id)") (purpose . "Return blob length and other useful info") (id . "function.ibase-blob-info")) "ibase_blob_import" ((documentation . "Create blob, copy file in it, and close it string ibase_blob_import(resource $link_identifier, resource $file_handle) Returns the BLOB id on success, or FALSE on error. (PHP 5)") (versions . "PHP 5") (return . " Returns the BLOB id on success, or FALSE on error.
Returns at most len bytes from the BLOB, or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns a BLOB handle for later use with ibase_blob_add or FALSE on failure.
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.
Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void ibase_blob_add(resource $blob_handle, string $data)") (purpose . "Add data into a newly created blob") (id . "function.ibase-blob-add")) "ibase_backup" ((documentation . "Initiates a backup task in the service manager and returns immediately mixed ibase_backup(resource $service_handle, string $source_db, string $dest_file [, int $options = '' [, bool $verbose = false]]) (PHP 5)") (versions . "PHP 5") (return . "") (prototype . "mixed ibase_backup(resource $service_handle, string $source_db, string $dest_file [, int $options = '' [, bool $verbose = false]])") (purpose . "Initiates a backup task in the service manager and returns immediately") (id . "function.ibase-backup")) "ibase_affected_rows" ((documentation . "Return the number of rows that were affected by the previous query int ibase_affected_rows([resource $link_identifier = '']) Returns the number of rows as an integer. (PHP 5)") (versions . "PHP 5") (return . "Returns the number of rows as an integer.
") (prototype . "int ibase_affected_rows([resource $link_identifier = ''])") (purpose . "Return the number of rows that were affected by the previous query") (id . "function.ibase-affected-rows")) "ibase_add_user" ((documentation . "Add a user to a security database bool ibase_add_user(resource $service_handle, string $user_name, string $password [, string $first_name = '' [, string $middle_name = '' [, string $last_name = '']]]) Returns TRUE on success or FALSE on failure. (PHP 5)") (versions . "PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the number of rows in the opened filePro database, or FALSE on errors.
Returns the specified data, or FALSE on errors.
Returns the width of the field as a integer, or FALSE on errors.
Returns the edit type of the field as a string, or FALSE on errors.
Returns the name of the field as a string, or FALSE on errors.
Returns the number of fields in the opened filePro database, or FALSE on errors.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns a database link identifier if the database is successfully opened, or FALSE if an error occurred.
The number of records in the database, or FALSE if an error occurs.
The number of fields in the database, or FALSE if an error occurs.
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).
Each field is converted to the appropriate PHP type, except:
On error, dbase_get_record will return FALSE.
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).
Each field is converted to the appropriate PHP type, except:
On error, dbase_get_record_with_names will return FALSE.
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:
If the database header information cannot be read, FALSE is returned.
Returns TRUE on success or FALSE on failure.
Returns a database link identifier if the database is successfully created, or FALSE if an error occurred.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
") (prototype . "int dbplus_xunlockrel(resource $relation)") (purpose . "Free exclusive lock on relation") (id . "function.dbplus-xunlockrel")) "dbplus_xlockrel" ((documentation . "Request exclusive lock on relation int dbplus_xlockrel(resource $relation) (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "
") (prototype . "int dbplus_xlockrel(resource $relation)") (purpose . "Request exclusive lock on relation") (id . "function.dbplus-xlockrel")) "dbplus_update" ((documentation . "Update specified tuple in relation int dbplus_update(resource $relation, array $old, array $new) (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "
") (prototype . "int dbplus_update(resource $relation, array $old, array $new)") (purpose . "Update specified tuple in relation") (id . "function.dbplus-update")) "dbplus_unselect" ((documentation . "Remove a constraint from relation int dbplus_unselect(resource $relation) (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "
") (prototype . "int dbplus_unselect(resource $relation)") (purpose . "Remove a constraint from relation") (id . "function.dbplus-unselect")) "dbplus_unlockrel" ((documentation . "Give up write lock on relation int dbplus_unlockrel(resource $relation) (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "
") (prototype . "int dbplus_unlockrel(resource $relation)") (purpose . "Give up write lock on relation") (id . "function.dbplus-unlockrel")) "dbplus_undoprepare" ((documentation . "Prepare undo int dbplus_undoprepare(resource $relation) (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "
") (prototype . "int dbplus_undoprepare(resource $relation)") (purpose . "Prepare undo") (id . "function.dbplus-undoprepare")) "dbplus_undo" ((documentation . "Undo int dbplus_undo(resource $relation) (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "
") (prototype . "int dbplus_undo(resource $relation)") (purpose . "Undo") (id . "function.dbplus-undo")) "dbplus_tremove" ((documentation . "Remove tuple and return new current tuple int dbplus_tremove(resource $relation, array $tuple [, array $current = '']) (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "
") (prototype . "int dbplus_tremove(resource $relation, array $tuple [, array $current = ''])") (purpose . "Remove tuple and return new current tuple") (id . "function.dbplus-tremove")) "dbplus_tcl" ((documentation . "Execute TCL code on server side string dbplus_tcl(int $sid, string $script) (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "
") (prototype . "string dbplus_tcl(int $sid, string $script)") (purpose . "Execute TCL code on server side") (id . "function.dbplus-tcl")) "dbplus_sql" ((documentation . "Perform SQL query resource dbplus_sql(string $query [, string $server = '' [, string $dbpath = '']]) (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "
") (prototype . "resource dbplus_sql(string $query [, string $server = '' [, string $dbpath = '']])") (purpose . "Perform SQL query") (id . "function.dbplus-sql")) "dbplus_setindexbynumber" ((documentation . "Set index by number int dbplus_setindexbynumber(resource $relation, int $idx_number) (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "
") (prototype . "int dbplus_setindexbynumber(resource $relation, int $idx_number)") (purpose . "Set index by number") (id . "function.dbplus-setindexbynumber")) "dbplus_setindex" ((documentation . "Set index int dbplus_setindex(resource $relation, string $idx_name) (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "
") (prototype . "int dbplus_setindex(resource $relation, string $idx_name)") (purpose . "Set index") (id . "function.dbplus-setindex")) "dbplus_savepos" ((documentation . "Save position int dbplus_savepos(resource $relation) (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "
") (prototype . "int dbplus_savepos(resource $relation)") (purpose . "Save position") (id . "function.dbplus-savepos")) "dbplus_rzap" ((documentation . "Remove all tuples from relation int dbplus_rzap(resource $relation) (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "
") (prototype . "int dbplus_rzap(resource $relation)") (purpose . "Remove all tuples from relation") (id . "function.dbplus-rzap")) "dbplus_runlink" ((documentation . "Remove relation from filesystem int dbplus_runlink(resource $relation) (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "
") (prototype . "int dbplus_runlink(resource $relation)") (purpose . "Remove relation from filesystem") (id . "function.dbplus-runlink")) "dbplus_rsecindex" ((documentation . "Create a new secondary index for a relation mixed dbplus_rsecindex(resource $relation, mixed $domlist, int $type) Returns resource on success or DBPLUS_ERR_UNKNOWN on failure. (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "
Returns resource on success or DBPLUS_ERR_UNKNOWN on failure.
") (prototype . "int dbplus_rrename(resource $relation, string $name)") (purpose . "Rename a relation") (id . "function.dbplus-rrename")) "dbplus_rquery" ((documentation . "Perform local (raw) AQL query resource dbplus_rquery(string $query [, string $dbpath = '']) (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "
") (prototype . "resource dbplus_rquery(string $query [, string $dbpath = ''])") (purpose . "Perform local (raw) AQL query") (id . "function.dbplus-rquery")) "dbplus_ropen" ((documentation . "Open relation file local resource dbplus_ropen(string $name) (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "
") (prototype . "resource dbplus_ropen(string $name)") (purpose . "Open relation file local") (id . "function.dbplus-ropen")) "dbplus_rkeys" ((documentation . "Specify new primary key for a relation mixed dbplus_rkeys(resource $relation, mixed $domlist) Returns resource on success or DBPLUS_ERR_UNKNOWN on failure. (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "
Returns resource on success or DBPLUS_ERR_UNKNOWN on failure.
") (prototype . "int dbplus_restorepos(resource $relation, array $tuple)") (purpose . "Restore position") (id . "function.dbplus-restorepos")) "dbplus_resolve" ((documentation . "Resolve host information for relation array dbplus_resolve(string $relation_name) Returns an array containing these values under the keys sid, host and host_path or FALSE on error. (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "
Returns an array containing these values under the keys sid, host and host_path or FALSE on error.
Returns resource on success or DBPLUS_ERR_UNKNOWN on failure.
Returns resource on success or DBPLUS_ERR_UNKNOWN on failure.
") (prototype . "resource dbplus_rcreate(string $name, mixed $domlist [, bool $overwrite = ''])") (purpose . "Creates a new DB++ relation") (id . "function.dbplus-rcreate")) "dbplus_rchperm" ((documentation . "Change relation permissions int dbplus_rchperm(resource $relation, int $mask, string $user, string $group) (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "
") (prototype . "int dbplus_rchperm(resource $relation, int $mask, string $user, string $group)") (purpose . "Change relation permissions") (id . "function.dbplus-rchperm")) "dbplus_prev" ((documentation . "Get previous tuple from relation int dbplus_prev(resource $relation, array $tuple) Returns DBPLUS_ERR_NOERR on success or a db++ error code on failure. (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "
Returns DBPLUS_ERR_NOERR on success or a db++ error code on failure.
On success a relation file resource (cursor) is returned which must be used in any subsequent commands referencing the relation. Failure leads to a zero return value, the actual error code may be asked for by calling dbplus_errno.
") (prototype . "resource dbplus_open(string $name)") (purpose . "Open relation file") (id . "function.dbplus-open")) "dbplus_next" ((documentation . "Get next tuple from relation int dbplus_next(resource $relation, array $tuple) Returns DBPLUS_ERR_NOERR on success or a db++ error code on failure. (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . " Returns DBPLUS_ERR_NOERR on success or a db++ error code on failure.
") (prototype . "int dbplus_lockrel(resource $relation)") (purpose . "Request write lock on relation") (id . "function.dbplus-lockrel")) "dbplus_last" ((documentation . "Get last tuple from relation int dbplus_last(resource $relation, array $tuple) Returns DBPLUS_ERR_NOERR on success or a db++ error code on failure. (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "
Returns DBPLUS_ERR_NOERR on success or a db++ error code on failure.
Returns DBPLUS_ERR_NOERR on success or a db++ error code on failure.
Returns zero on success or a non-zero error code, especially DBPLUS_ERR_WLOCKED on failure.
") (prototype . "int dbplus_freerlocks(resource $relation)") (purpose . "Free all tuple locks on given relation") (id . "function.dbplus-freerlocks")) "dbplus_freelock" ((documentation . "Release write lock on tuple int dbplus_freelock(resource $relation, string $tuple) (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "
") (prototype . "int dbplus_freelock(resource $relation, string $tuple)") (purpose . "Release write lock on tuple") (id . "function.dbplus-freelock")) "dbplus_freealllocks" ((documentation . "Free all locks held by this client int dbplus_freealllocks() (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "
") (prototype . "int dbplus_freealllocks()") (purpose . "Free all locks held by this client") (id . "function.dbplus-freealllocks")) "dbplus_flush" ((documentation . "Flush all changes made on a relation int dbplus_flush(resource $relation) Returns DBPLUS_ERR_NOERR on success or a db++ error code on failure. (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "
Returns DBPLUS_ERR_NOERR on success or a db++ error code on failure.
Returns DBPLUS_ERR_NOERR on success or a db++ error code on failure.
") (prototype . "int dbplus_find(resource $relation, array $constraints, mixed $tuple)") (purpose . "Set a constraint on a relation") (id . "function.dbplus-find")) "dbplus_errno" ((documentation . "Get error code for last operation int dbplus_errno() Returns the error code, as an integer. (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "
Returns the error code, as an integer.
") (prototype . "int dbplus_errno()") (purpose . "Get error code for last operation") (id . "function.dbplus-errno")) "dbplus_errcode" ((documentation . "Get error string for given errorcode or last error string dbplus_errcode([int $errno = '']) Returns the error message. (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "Returns the error message.
") (prototype . "string dbplus_errcode([int $errno = ''])") (purpose . "Get error string for given errorcode or last error") (id . "function.dbplus-errcode")) "dbplus_curr" ((documentation . "Get current tuple from relation int dbplus_curr(resource $relation, array $tuple) The function will return zero (aka. DBPLUS_ERR_NOERR) on success or a db++ error code on failure. (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . " The function will return zero (aka. DBPLUS_ERR_NOERR) on success or a db++ error code on failure.
Returns TRUE on success or DBPLUS_ERR_UNKNOWN on failure.
Returns the absolute path of the current directory.
") (prototype . "string dbplus_chdir([string $newdir = ''])") (purpose . "Get/Set database virtual current directory") (id . "function.dbplus-chdir")) "dbplus_aql" ((documentation . "Perform AQL query resource dbplus_aql(string $query [, string $server = '' [, string $dbpath = '']]) Returns a relation handle on success. The result data may be fetched from this relation by calling dbplus_next and dbplus_curr. Other relation access functions will not work on a result relation. (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . "Returns a relation handle on success. The result data may be fetched from this relation by calling dbplus_next and dbplus_curr. Other relation access functions will not work on a result relation.
") (prototype . "resource dbplus_aql(string $query [, string $server = '' [, string $dbpath = '']])") (purpose . "Perform AQL query") (id . "function.dbplus-aql")) "dbplus_add" ((documentation . "Add a tuple to a relation int dbplus_add(resource $relation, array $tuple) The function will return DBPLUS_ERR_NOERR on success or a db++ error code on failure. (PHP 4 <= 4.1.0, PECL dbplus >= 0.9)") (versions . "PHP 4 <= 4.1.0, PECL dbplus >= 0.9") (return . " The function will return DBPLUS_ERR_NOERR on success or a db++ error code on failure.
TRUE, when process is successful.
FALSE, when process is unsuccessful.
TRUE, when process is successful.
FALSE, when process is unsuccessful.
Oid of the instance created, when process is successful.
FALSE, when process is unsuccessful.
TRUE, when process is successful.
FALSE, when process is unsuccessful.
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.
Value of a specific field, on success (NULL if value if null).
FALSE on failure.
Escaped string version of the given string, on success.
FALSE on failure.
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.
Returns TRUE if the connection to the server CUBRID server is working, otherwise FALSE.
Number of columns, on success.
-1 if SQL sentence is not SELECT.
FALSE when process is unsuccessful.
An numeric array with all existing Cubrid databases; on success.
FALSE on failure.
Type of the column, on success.
FALSE when invalid field_offset value.
-1 if SQL sentence is not SELECT.
") (prototype . "string cubrid_field_type(resource $result, int $field_offset)") (purpose . "Return the type of the column corresponding to the given field offset") (id . "function.cubrid-field-type")) "cubrid_field_table" ((documentation . "Return the name of the table of the specified field string cubrid_field_table(resource $result, int $field_offset) Name of the table of the specified field, on success. FALSE when invalid field_offset value. -1 if SQL sentence is not SELECT. (PECL CUBRID >= 8.3.0)") (versions . "PECL CUBRID >= 8.3.0") (return . "Name of the table of the specified field, on success.
FALSE when invalid field_offset value.
-1 if SQL sentence is not SELECT.
") (prototype . "string cubrid_field_table(resource $result, int $field_offset)") (purpose . "Return the name of the table of the specified field") (id . "function.cubrid-field-table")) "cubrid_field_seek" ((documentation . "Move the result set cursor to the specified field offset bool cubrid_field_seek(resource $result [, int $field_offset = '']) TRUE on success. FALSE on failure. (PECL CUBRID >= 8.3.0)") (versions . "PECL CUBRID >= 8.3.0") (return . " TRUE on success.
FALSE on failure.
Name of specified field index, on success.
FALSE on failure.
Maximum length, when process is successful.
FALSE on failure.
A string with flags, when process is successful.
FALSE when invalid field_offset value.
-1 if SQL sentence is not SELECT.
") (prototype . "string cubrid_field_flags(resource $result, int $field_offset)") (purpose . "Return a string with the flags of the given field offset") (id . "function.cubrid-field-flags")) "cubrid_fetch_row" ((documentation . "Return a numerical array with the values of the current row array cubrid_fetch_row(resource $result [, int $type = '']) A numerical array, when process is successful. FALSE, when there are no more rows; NULL, when process is unsuccessful. (PECL CUBRID >= 8.3.0)") (versions . "PECL CUBRID >= 8.3.0") (return . "A numerical array, when process is successful.
FALSE, when there are no more rows; NULL, when process is unsuccessful.
An object, when process is successful.
FALSE, when there are no more rows; NULL, when process is unsuccessful.
An numeric array, when process is successful.
FALSE on failure.
Object with certain properties of the specific column, when process is successful.
FALSE on failure.
Associative array, when process is successful.
FALSE, when there are no more rows; NULL, when process is unsuccessful.
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:
Error message that occurred.
") (prototype . "string cubrid_error([resource $connection = ''])") (purpose . "Get the error message") (id . "function.cubrid-error")) "cubrid_errno" ((documentation . "Return the numerical value of the error message from previous CUBRID operation int cubrid_errno([resource $conn_identifier = '']) Returns the error number from the last CUBRID function, or 0 (zero) if no error occurred. (PECL CUBRID >= 8.3.1)") (versions . "PECL CUBRID >= 8.3.1") (return . "
Returns the error number from the last CUBRID function, or 0 (zero) if no error occurred.
") (prototype . "int cubrid_errno([resource $conn_identifier = ''])") (purpose . "Return the numerical value of the error message from previous CUBRID operation") (id . "function.cubrid-errno")) "cubrid_db_name" ((documentation . "Get db name from results of cubrid_list_dbs string cubrid_db_name(array $result, int $index) Returns the database name on success, and FALSE on failure. If FALSE is returned, use cubrid_error to determine the nature of the error. (PECL CUBRID >= 8.3.1)") (versions . "PECL CUBRID >= 8.3.1") (return . " Returns the database name on success, and FALSE on failure. If FALSE is returned, use cubrid_error to determine the nature of the error.
Returns TRUE on success or FALSE on failure.
TRUE, when process is successful.
FALSE, when process is unsuccessful.
A string that represents the CUBRID connection charset; on success.
FALSE on failure.
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.
Version information (eg. "8.3.1.0001").
") (prototype . "string cubrid_version()") (purpose . "Get the CUBRID PHP module's version") (id . "function.cubrid-version")) "cubrid_set_query_timeout" ((documentation . "Set the timeout time of query execution bool cubrid_set_query_timeout(resource $req_identifier, int $timeout) TRUE, when process is successful. FALSE, when process is unsuccessful. (PECL CUBRID >= 8.4.1)") (versions . "PECL CUBRID >= 8.4.1") (return . " TRUE, when process is successful.
FALSE, when process is unsuccessful.
TRUE, when process is successful.
FALSE, when process is unsuccessful.
TRUE on success.
FALSE on failure.
TRUE, when process is successful.
FALSE, when process is unsuccessful.
TRUE, when process is successful.
FALSE, when process is unsuccessful.
TRUE, when process is successful.
FALSE, when process is unsuccessful.
TRUE, when process is successful.
FALSE, when process is unsuccessful.
TRUE, when process is successful.
FALSE, when process is unsuccessful.
Array containing the schema information, when process is successful;
FALSE, when process is unsuccessful
TRUE, when process is successful.
FALSE, when process is unsuccessful.
TRUE, when process is successful.
FALSE, when process is unsuccessful.
Request identifier, if process is successful;
FALSE, if process is unsuccessful.
Connection identifier, when process is successful.
FALSE, when process is unsuccessful.
Connection identifier, when process is successful.
FALSE, when process is unsuccessful.
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.
Number of columns, when process is successful.
FALSE, if SQL statement is not SELECT.
TRUE, when process is successful.
FALSE, when process is unsuccessful.
TRUE, when process is successful.
FALSE, when process is unsucceful.
TRUE, when process is successful.
FALSE, when process is unsuccessful.
TRUE, when process is successful.
FALSE, when process is unsuccessful.
TRUE if the process is successful and FALSE for failure.
It will return the cursor position on the LOB object when it processes successfully.
FALSE on failure.
It will return the cursor position on the LOB object as a string when it processes successfully.
FALSE on failure.
It will return the size of the LOB object when it processes successfully.
FALSE on failure.
It will return the size of the LOB object as a string when it processes successfully.
FALSE on failure.
TRUE if the process is successful and FALSE for failure.
TRUE if the process is successful and FALSE for failure.
Returns the contents as a string.
FALSE when there is no more data.
NULL on failure.
") (prototype . "string cubrid_lob2_read(resource $lob_identifier, int $len)") (purpose . "Read from BLOB/CLOB data.") (id . "function.cubrid-lob2-read")) "cubrid_lob2_new" ((documentation . "Create a lob object. resource cubrid_lob2_new([resource $conn_identifier = '' [, string $type = \"BLOB\"]]) Lob identifier when it is successful. FALSE on failure. (PECL CUBRID >= 8.4.1)") (versions . "PECL CUBRID >= 8.4.1") (return . "
Lob identifier when it is successful.
FALSE on failure.
TRUE if the process is successful and FALSE for failure.
TRUE if the process is successful and FALSE for failure.
TRUE, on success.
FALSE, on failure.
TRUE, when process is successful.
FALSE, when process is unsuccessful.
A string representing LOB data size, when process is successful.
FALSE, when process is unsuccessful.
TRUE, when process is successful.
FALSE, when process is unsuccessful.
Return an array of LOB resources, when process is successful.
FALSE, when process is unsuccessful.
TRUE, when process is successful.
FALSE, when process is unsuccessful.
TRUE, when process is successful.
FALSE, when process is unsuccessful.
1, if such instance exists;
0, if such instance does not exist;
-1, in case of error
") (prototype . "int cubrid_is_instance(resource $conn_identifier, string $oid)") (purpose . "Check whether the instance pointed by OID exists") (id . "function.cubrid-is-instance")) "cubrid_insert_id" ((documentation . "Return the ID generated for the last updated AUTO_INCREMENT column string cubrid_insert_id([resource $conn_identifier = '']) 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. (PECL CUBRID >= 8.3.0)") (versions . "PECL CUBRID >= 8.3.0") (return . "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.
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)
A string that represents the CUBRID server version; on success.
FALSE on failure.
Success: the query timeout value of the current request. Units of msec.
Failure: FALSE
") (prototype . "int cubrid_get_query_timeout(resource $req_identifier)") (purpose . "Get the query timeout value of the request") (id . "function.cubrid-get-query-timeout")) "cubrid_get_db_parameter" ((documentation . "Returns the CUBRID database parameters array cubrid_get_db_parameter(resource $conn_identifier) An associative array with CUBRID database parameters; on success. FALSE on failure. (PECL CUBRID >= 8.3.0)") (versions . "PECL CUBRID >= 8.3.0") (return . "An associative array with CUBRID database parameters; on success.
FALSE on failure.
A string that represents the client library version; on success.
FALSE on failure.
Class name when process is successful.
FALSE, when process is unsuccessful.
A string that represents the CUBRID connection charset; on success.
FALSE on failure.
TRUE, when auto-commit is on.
FALSE, when auto-commit is off.
NULL on error.
TRUE on success.
FALSE on failure.
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:
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.
Request identifier, when process is successful and first param is conn_identifier; TRUE, when process is successful and first argument is request_identifier.
FALSE, when process is unsuccessful.
Error message that occurred.
") (prototype . "string cubrid_error_msg()") (purpose . "Get last error message for the most recent function call") (id . "function.cubrid-error-msg")) "cubrid_error_code" ((documentation . "Get error code for the most recent function call int cubrid_error_code() Error code of the error that occurred, or 0 (zero) if no error occurred. (PECL CUBRID >= 8.3.0)") (versions . "PECL CUBRID >= 8.3.0") (return . "
Error code of the error that occurred, or 0 (zero) if no error occurred.
") (prototype . "int cubrid_error_code()") (purpose . "Get error code for the most recent function call") (id . "function.cubrid-error-code")) "cubrid_error_code_facility" ((documentation . "Get the facility code of error int cubrid_error_code_facility() Facility code of the error code that occurred: CUBRID_FACILITY_DBMS, CUBRID_FACILITY_CAS, CUBRID_FACILITY_CCI, CUBRID_FACILITY_CLIENT (PECL CUBRID >= 8.3.0)") (versions . "PECL CUBRID >= 8.3.0") (return . "
Facility code of the error code that occurred: CUBRID_FACILITY_DBMS, CUBRID_FACILITY_CAS, CUBRID_FACILITY_CCI, CUBRID_FACILITY_CLIENT
") (prototype . "int cubrid_error_code_facility()") (purpose . "Get the facility code of error") (id . "function.cubrid-error-code-facility")) "cubrid_drop" ((documentation . "Delete an instance using OID bool cubrid_drop(resource $conn_identifier, string $oid) TRUE, when process is successful. FALSE, when process is unsuccessful. (PECL CUBRID >= 8.3.0)") (versions . "PECL CUBRID >= 8.3.0") (return . "
TRUE, when process is successful.
FALSE, when process is unsuccessful.
TRUE, when process is successful.
FALSE, when process is unsuccessful.
Oid of current cursor location, when process is successful
FALSE, when process is unsuccessful.
Connection identifier, when process is successful.
FALSE, when process is unsuccessful.
Connection identifier, when process is successful.
FALSE, when process is unsuccessful.
TRUE, when process is successful.
FALSE, when process is unsuccessful.
Array of string values containing the column names, when process is successful.
FALSE, when process is unsuccessful.
Array of string values containing the column names, when process is successful.
FALSE, when process is unsuccessful.
Number of elements, when process is successful.
FALSE, when process is unsuccessful.
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.
Return TRUE on success.
Return TRUE on success.
TRUE, when process is successful.
FALSE, when process is unsuccessful.
Returns an ODBC result identifier containing the information or FALSE on failure.
The result set has the following columns:
The result set is ordered by TABLE_TYPE, TABLE_QUALIFIER, TABLE_OWNER and TABLE_NAME.
") (prototype . "resource odbc_tables(resource $connection_id [, string $qualifier = '' [, string $owner = '' [, string $name = '' [, string $types = '']]]])") (purpose . "Get the list of table names stored in a specific data source") (id . "function.odbc-tables")) "odbc_tableprivileges" ((documentation . "Lists tables and the privileges associated with each table resource odbc_tableprivileges(resource $connection_id, string $qualifier, string $owner, string $name) An ODBC result identifier or FALSE on failure. The result set has the following columns: * TABLE_QUALIFIER * TABLE_OWNER * TABLE_NAME * GRANTOR * GRANTEE * PRIVILEGE * IS_GRANTABLE The result set is ordered by TABLE_QUALIFIER, TABLE_OWNER and TABLE_NAME. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " An ODBC result identifier or FALSE on failure.
The result set has the following columns:
The result set is ordered by TABLE_QUALIFIER, TABLE_OWNER and TABLE_NAME.
") (prototype . "resource odbc_tableprivileges(resource $connection_id, string $qualifier, string $owner, string $name)") (purpose . "Lists tables and the privileges associated with each table") (id . "function.odbc-tableprivileges")) "odbc_statistics" ((documentation . "Retrieve statistics about a table resource odbc_statistics(resource $connection_id, string $qualifier, string $owner, string $table_name, int $unique, int $accuracy) Returns an ODBC result identifier or FALSE on failure. The result set has the following columns: * TABLE_QUALIFIER * TABLE_OWNER * TABLE_NAME * NON_UNIQUE * INDEX_QUALIFIER * INDEX_NAME * TYPE * SEQ_IN_INDEX * COLUMN_NAME * COLLATION * CARDINALITY * PAGES * FILTER_CONDITION The result set is ordered by NON_UNIQUE, TYPE, INDEX_QUALIFIER, INDEX_NAME and SEQ_IN_INDEX. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns an ODBC result identifier or FALSE on failure.
The result set has the following columns:
The result set is ordered by NON_UNIQUE, TYPE, INDEX_QUALIFIER, INDEX_NAME and SEQ_IN_INDEX.
") (prototype . "resource odbc_statistics(resource $connection_id, string $qualifier, string $owner, string $table_name, int $unique, int $accuracy)") (purpose . "Retrieve statistics about a table") (id . "function.odbc-statistics")) "odbc_specialcolumns" ((documentation . "Retrieves special columns resource odbc_specialcolumns(resource $connection_id, int $type, string $qualifier, string $owner, string $table, int $scope, int $nullable) Returns an ODBC result identifier or FALSE on failure. The result set has the following columns: * SCOPE * COLUMN_NAME * DATA_TYPE * TYPE_NAME * PRECISION * LENGTH * SCALE * PSEUDO_COLUMN (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns an ODBC result identifier or FALSE on failure.
The result set has the following columns:
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the string contents of the field, FALSE on error, NULL for NULL data, or TRUE for binary data.
Returns the number of rows in the result or FALSE on error.
Returns an ODBC result identifier containing the information or FALSE on failure.
The result set has the following columns:
Returns the list of input and output parameters, as well as the columns that make up the result set for the specified procedures. Returns an ODBC result identifier or FALSE on failure.
The result set has the following columns:
The result set is ordered by PROCEDURE_QUALIFIER, PROCEDURE_OWNER, PROCEDURE_NAME and COLUMN_TYPE.
") (prototype . "resource odbc_procedurecolumns(resource $connection_id, string $qualifier, string $owner, string $proc, string $column)") (purpose . "Retrieve information about parameters to procedures") (id . "function.odbc-procedurecolumns")) "odbc_primarykeys" ((documentation . "Gets the primary keys for a table resource odbc_primarykeys(resource $connection_id, string $qualifier, string $owner, string $table) Returns an ODBC result identifier or FALSE on failure. The result set has the following columns: * TABLE_QUALIFIER * TABLE_OWNER * TABLE_NAME * COLUMN_NAME * KEY_SEQ * PK_NAME (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns an ODBC result identifier or FALSE on failure.
The result set has the following columns:
Returns an ODBC result identifier if the SQL command was prepared successfully. Returns FALSE on error.
Returns an ODBC connection id or 0 (FALSE) on error.
Returns the number of rows in an ODBC result. This function will return -1 on error.
") (prototype . "int odbc_num_rows(resource $result_id)") (purpose . "Number of rows in a result") (id . "function.odbc-num-rows")) "odbc_num_fields" ((documentation . "Number of columns in a result int odbc_num_fields(resource $result_id) Returns the number of fields, or -1 on error. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the number of fields, or -1 on error.
") (prototype . "int odbc_num_fields(resource $result_id)") (purpose . "Number of columns in a result") (id . "function.odbc-num-fields")) "odbc_next_result" ((documentation . "Checks if multiple results are available bool odbc_next_result(resource $result_id) Returns TRUE if there are more result sets, FALSE otherwise. (PHP 4 >= 4.0.5, PHP 5)") (versions . "PHP 4 >= 4.0.5, PHP 5") (return . " Returns TRUE if there are more result sets, FALSE otherwise.
Returns TRUE on success or FALSE on failure.
Returns an ODBC result identifier or FALSE on failure.
The result set has the following columns:
The result set is ordered by DATA_TYPE and TYPE_NAME.
") (prototype . "resource odbc_gettypeinfo(resource $connection_id [, int $data_type = ''])") (purpose . "Retrieves information about data types supported by the data source") (id . "function.odbc-gettypeinfo")) "odbc_free_result" ((documentation . "Free resources associated with a result bool odbc_free_result(resource $result_id) Always returns TRUE. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Always returns TRUE.
Returns an ODBC result identifier or FALSE on failure.
The result set has the following columns:
If pk_table contains a table name, odbc_foreignkeys returns a result set containing the primary key of the specified table and all of the foreign keys that refer to it.
If fk_table contains a table name, odbc_foreignkeys returns a result set containing all of the foreign keys in the specified table and the primary keys (in other tables) to which they refer.
If both pk_table and fk_table contain table names, odbc_foreignkeys returns the foreign keys in the table specified in fk_table that refer to the primary key of the table specified in pk_table. This should be one key at most.
Returns the field type as a string, or FALSE on error.
Returns the field scale as a integer, or FALSE on error.
Returns the field number as a integer, or FALSE on error. Field numbering starts at 1.
Returns the field name as a string, or FALSE on error.
Returns the field name as a string, or FALSE on error.
Returns TRUE if there was a row, FALSE otherwise.
Returns an object that corresponds to the fetched row, or FALSE if there are no more rows.
Returns the number of columns in the result; FALSE on error.
Returns an array that corresponds to the fetched row, or FALSE if there are no more rows.
Returns TRUE on success or FALSE on failure.
Returns an ODBC result identifier if the SQL command was executed successfully, or FALSE on error.
If connection_id is specified, the last state of that connection is returned, else the last state of any connection is returned.
This function returns meaningful value only if last odbc query failed (i.e. odbc_exec returned FALSE).
If connection_id is specified, the last state of that connection is returned, else the last state of any connection is returned.
This function returns meaningful value only if last odbc query failed (i.e. odbc_exec returned FALSE).
Returns FALSE on error, and an array upon success.
Returns the cursor name, as a string.
") (prototype . "string odbc_cursor(resource $result_id)") (purpose . "Get cursorname") (id . "function.odbc-cursor")) "odbc_connect" ((documentation . "Connect to a datasource resource odbc_connect(string $dsn, string $user, string $password [, int $cursor_type = '']) Returns an ODBC connection or (FALSE) on error. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns an ODBC connection or (FALSE) on error.
Returns TRUE on success or FALSE on failure.
Returns an ODBC result identifier or FALSE on failure.
The result set has the following columns:
The result set is ordered by TABLE_QUALIFIER, TABLE_SCHEM and TABLE_NAME.
") (prototype . "resource odbc_columns(resource $connection_id [, string $qualifier = '' [, string $schema = '' [, string $table_name = '' [, string $column_name = '']]]])") (purpose . "Lists the column names in specified tables") (id . "function.odbc-columns")) "odbc_columnprivileges" ((documentation . "Lists columns and associated privileges for the given table resource odbc_columnprivileges(resource $connection_id, string $qualifier, string $owner, string $table_name, string $column_name) Returns an ODBC result identifier or FALSE on failure. This result identifier can be used to fetch a list of columns and associated privileges. The result set has the following columns: * TABLE_QUALIFIER * TABLE_OWNER * TABLE_NAME * GRANTOR * GRANTEE * PRIVILEGE * IS_GRANTABLE The result set is ordered by TABLE_QUALIFIER, TABLE_OWNER and TABLE_NAME. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns an ODBC result identifier or FALSE on failure. This result identifier can be used to fetch a list of columns and associated privileges.
The result set has the following columns:
The result set is ordered by TABLE_QUALIFIER, TABLE_OWNER and TABLE_NAME.
") (prototype . "resource odbc_columnprivileges(resource $connection_id, string $qualifier, string $owner, string $table_name, string $column_name)") (purpose . "Lists columns and associated privileges for the given table") (id . "function.odbc-columnprivileges")) "odbc_close" ((documentation . "Close an ODBC connection void odbc_close(resource $connection_id) No value is returned. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "No value is returned.
") (prototype . "void odbc_close(resource $connection_id)") (purpose . "Close an ODBC connection") (id . "function.odbc-close")) "odbc_close_all" ((documentation . "Close all ODBC connections void odbc_close_all() No value is returned. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "No value is returned.
") (prototype . "void odbc_close_all()") (purpose . "Close all ODBC connections") (id . "function.odbc-close-all")) "odbc_binmode" ((documentation . "Handling of binary column data bool odbc_binmode(resource $result_id, int $mode) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Without the OnOff parameter, this function returns auto-commit status for connection_id. Non-zero is returned if auto-commit is on, 0 if it is off, or FALSE if an error occurs.
If OnOff is set, this function returns TRUE on success and FALSE on failure.
Returns TRUE on success or FALSE on failure.
dbx_query returns an object or 1 on success, and 0 on failure. The result object is returned only if the query given in sql_statement produces a result set (i.e. a SELECT query, even if the result set is empty).
The returned object has four or five properties depending on flags:
It is a valid handle for the connected database, and as such it can be used in module specific functions (if required).
<?php
$result = dbx_query($link, \"SELECT id FROM table\");
mysql_field_len($result->handle, 0);
?>These contain the number of columns (or fields) and rows (or records) respectively.
<?php
$result = dbx_query($link, 'SELECT id FROM table');
echo $result->rows; // number of records
echo $result->cols; // number of fields
?>DBX_RESULT_INFO or DBX_RESULT_ASSOC is specified in the flags parameter. It is a 2 dimensional array, that has two named rows (name and type) to retrieve column information. Example # lists each field's name and type
<?php
$result = dbx_query($link, 'SELECT id FROM table',
DBX_RESULT_INDEX | DBX_RESULT_INFO);
for ($i = 0; $i < $result->cols; $i++ ) {
echo $result->info['name'][$i] . \"\\n\";
echo $result->info['type'][$i] . \"\\n\";
}
?>flags. If DBX_RESULT_ASSOC is set, it is possible to use $result->data[2]["field_name"]. Example # outputs the content of data property into HTML table
<?php
$result = dbx_query($link, 'SELECT id, parentid, description FROM table');
echo \"<table>\\n\";
foreach ($result->data as $row) {
echo \"<tr>\\n\";
foreach ($row as $field) {
echo \"<td>$field</td>\";
}
echo \"</tr>\\n\";
}
echo \"</table>\\n\";
?>Example # How to handle UNBUFFERED queries
<?php
$result = dbx_query ($link, 'SELECT id, parentid, description FROM table', DBX_RESULT_UNBUFFERED);
echo \"<table>\\n\";
while ($row = dbx_fetch_row($result)) {
echo \"<tr>\\n\";
foreach ($row as $field) {
echo \"<td>$field</td>\";
}
echo \"</tr>\\n\";
}
echo \"</table>\\n\";
?>Returns an object on success that contains the same information as any row would have in the dbx_query result data property, including columns accessible by index or fieldname when the flags for dbx_query were set that way.
Upon failure, returns 0 (e.g. when no more rows are available).
") (prototype . "mixed dbx_fetch_row(object $result_identifier)") (purpose . "Fetches rows from a query-result that had the DBX_RESULT_UNBUFFERED flag set") (id . "function.dbx-fetch-row")) "dbx_escape_string" ((documentation . "Escape a string so it can safely be used in an sql-statement string dbx_escape_string(object $link_identifier, string $text) Returns the text, escaped where necessary (such as quotes, backslashes etc). On error, NULL is returned. (PHP 4 >= 4.3.0, PHP 5 <= 5.0.5, PECL dbx >= 1.1.0)") (versions . "PHP 4 >= 4.3.0, PHP 5 <= 5.0.5, PECL dbx >= 1.1.0") (return . " Returns the text, escaped where necessary (such as quotes, backslashes etc). On error, NULL is returned.
Returns a string containing the error message from the last function call of the abstracted module (e.g. mysql module). If there are multiple connections in the same module, just the last error is given. If there are connections on different modules, the latest error is returned for the module specified by the link_identifier parameter.
Returns an object on success, FALSE on error. If a connection has been made but the database could not be selected, the connection is closed and FALSE is returned.
The returned object has three properties:
It is a valid handle for the connected database, and as such it can be used in module-specific functions (if required).
<?php
$link = dbx_connect(DBX_MYSQL, \"localhost\", \"db\", \"username\", \"password\");
mysql_close($link->handle); // dbx_close($link) would be better here
?> Returns 0 if the row_a[$column_key] is equal to row_b[$column_key], and 1 or -1 if the former is greater or is smaller than the latter one, respectively, or vice versa if the flag is set to DBX_CMP_DESC.
Returns 1 on success and 0 on errors.
") (prototype . "int dbx_close(object $link_identifier)") (purpose . "Close an open connection/database") (id . "function.dbx-close")) "dba_sync" ((documentation . "Synchronize database bool dba_sync(resource $handle) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns a positive handle on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns a positive handle on success or FALSE on failure.
Returns the key on success or FALSE on failure.
An associative array, in the form resourceid => filename.
") (prototype . "array dba_list()") (purpose . "List all open database files") (id . "function.dba-list")) "dba_key_split" ((documentation . "Splits a key in string representation into array representation mixed dba_key_split(mixed $key) Returns an array of the form array(0 => group, 1 => value_name). This function will return FALSE if key is NULL or FALSE. (PHP 5)") (versions . "PHP 5") (return . " Returns an array of the form array(0 => group, 1 => value_name). This function will return FALSE if key is NULL or FALSE.
Returns TRUE on success or FALSE on failure.
Returns an array of database handlers. If full_info is set to TRUE, the array will be associative with the handlers names as keys, and their version information as value. Otherwise, the result will be an indexed array of handlers names.
") (prototype . "array dba_handlers([bool $full_info = false])") (purpose . "List all the handlers available") (id . "function.dba-handlers")) "dba_firstkey" ((documentation . "Fetch first key string dba_firstkey(resource $handle) Returns the key on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Note:
When the internal cdb library is used you will see cdb and cdb_make.
Returns the key on success or FALSE on failure.
Returns the associated string if the key/data pair is found, FALSE otherwise.
Returns TRUE if the key exists, FALSE otherwise.
Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void dba_close(resource $handle)") (purpose . "Close a DBA database") (id . "function.dba-close")) "password_verify" ((documentation . "Verifies that a password matches a hash boolean password_verify(string $password, string $hash) Returns TRUE if the password and hash match, or FALSE otherwise. (PHP 5 >= 5.5.0)") (versions . "PHP 5 >= 5.5.0") (return . " Returns TRUE if the password and hash match, or FALSE otherwise.
Returns TRUE if the hash should be rehashed to match the given algo and options, or FALSE otherwise.
Returns the hashed password, or FALSE on failure.
The used algorithm, cost and salt are returned as part of the hash. Therefore, all information that's needed to verify the hash is included in it. This allows the password_verify function to verify the hash without needing separate storage for the salt or algorithm information.
") (prototype . "string password_hash(string $password, integer $algo [, array $options = ''])") (purpose . "Creates a password hash") (id . "function.password-hash")) "password_get_info" ((documentation . #("Returns information about the given hash array password_get_info(string $hash) Returns an associative array with three elements: * algo, which will match a password algorithm constant * algoName, which has the human readable name of the algorithm * options, which includes the options provided when calling password_hash (PHP 5 >= 5.5.0)" 159 186 (shr-url "password.constants.html"))) (versions . "PHP 5 >= 5.5.0") (return . "Returns an associative array with three elements:
Returns a resource identifier on success or FALSE on failure.
The structure of the returned data is (deliberately) not yet documented, as it is still subject to change.
") (prototype . "array openssl_x509_parse(mixed $x509cert [, bool $shortnames = true])") (purpose . "Parse an X509 certificate and return the information as an array") (id . "function.openssl-x509-parse")) "openssl_x509_free" ((documentation . "Free certificate resource void openssl_x509_free(resource $x509cert) No value is returned. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . "No value is returned.
") (prototype . "void openssl_x509_free(resource $x509cert)") (purpose . "Free certificate resource") (id . "function.openssl-x509-free")) "openssl_x509_export" ((documentation . "Exports a certificate as a string bool openssl_x509_export(mixed $x509, string $output [, bool $notext = '']) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE if the certificate can be used for the intended purpose, FALSE if it cannot, or -1 on error.
Returns TRUE if key is the private key that corresponds to cert, or FALSE otherwise.
Returns 1 if the signature is correct, 0 if it is incorrect, and -1 on error.
") (prototype . "int openssl_verify(string $data, string $signature, mixed $pub_key_id [, mixed $signature_alg = OPENSSL_ALGO_SHA1])") (purpose . "Verify signature") (id . "function.openssl-verify")) "openssl_spki_verify" ((documentation . "Verifies a signed public key and challenge string openssl_spki_verify(string $spkac) Returns a boolean on success or failure. ()") (versions . "") (return . "Returns a boolean on success or failure.
") (prototype . "string openssl_spki_verify(string $spkac)") (purpose . "Verifies a signed public key and challenge") (id . "function.openssl-spki-verify")) "openssl_spki_new" ((documentation . "Generate a new signed public key and challenge string openssl_spki_new(resource $privkey, string $challenge [, int $algorithm = '']) Returns a signed public key and challenge string or NULL on failure. ()") (versions . "") (return . "Returns a signed public key and challenge string or NULL on failure.
") (prototype . "string openssl_spki_new(resource $privkey, string $challenge [, int $algorithm = ''])") (purpose . "Generate a new signed public key and challenge") (id . "function.openssl-spki-new")) "openssl_spki_export" ((documentation . "Exports a valid PEM formatted public key signed public key and challenge string openssl_spki_export(string $spkac) Returns the associated PEM formatted public key or NULL on failure. ()") (versions . "") (return . "Returns the associated PEM formatted public key or NULL on failure.
") (prototype . "string openssl_spki_export(string $spkac)") (purpose . "Exports a valid PEM formatted public key signed public key and challenge") (id . "function.openssl-spki-export")) "openssl_spki_export_challenge" ((documentation . "Exports the challenge assoicated with a signed public key and challenge string openssl_spki_export_challenge(string $spkac) Returns the associated challenge string or NULL on failure. ()") (versions . "") (return . "Returns the associated challenge string or NULL on failure.
") (prototype . "string openssl_spki_export_challenge(string $spkac)") (purpose . "Exports the challenge assoicated with a signed public key and challenge") (id . "function.openssl-spki-export-challenge")) "openssl_sign" ((documentation . "Generate signature bool openssl_sign(string $data, string $signature, mixed $priv_key_id [, mixed $signature_alg = OPENSSL_ALGO_SHA1]) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns the length of the sealed data on success, or FALSE on error. If successful the sealed data is returned in sealed_data, and the envelope keys in env_keys.
Returns the generated string of bytes on success, or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns a resource identifier for the pkey on success, or FALSE on error.
Returns a positive key resource identifier on success, or FALSE on error.
Returns a positive key resource identifier on success, or FALSE on error.
Returns an array with the key details in success or FALSE in failure. Returned array has indexes bits (number of bits), key (string representation of the public key) and type (type of the key which is one of OPENSSL_KEYTYPE_RSA, OPENSSL_KEYTYPE_DSA, OPENSSL_KEYTYPE_DH, OPENSSL_KEYTYPE_EC or -1 meaning unknown).
Depending on the key type used, additional details may be returned. Note that some elements may not always be available.
OPENSSL_KEYTYPE_RSA, an additional array key named "rsa", containing the key data is returned. | Key | Description |
|---|---|
| "n" | |
| "e" | |
| "d" | |
| "p" | |
| "q" | |
| "dmp1" | |
| "dmq1" | |
| "iqmp" |
OPENSSL_KEYTYPE_DSA, an additional array key named "dsa", containing the key data is returned. | Key | Description |
|---|---|
| "p" | |
| "q" | |
| "g" | |
| "priv_key" | |
| "pub_key" |
OPENSSL_KEYTYPE_DH, an additional array key named "dh", containing the key data is returned. | Key | Description |
|---|---|
| "p" | |
| "g" | |
| "priv_key" | |
| "pub_key" |
No value is returned.
") (prototype . "void openssl_pkey_free(resource $key)") (purpose . "Frees a private key") (id . "function.openssl-pkey-free")) "openssl_pkey_export" ((documentation . "Gets an exportable representation of a key into a string bool openssl_pkey_export(mixed $key, string $out [, string $passphrase = '' [, array $configargs = '']]) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE if the signature is verified, FALSE if it is not correct (the message has been tampered with, or the signing certificate is invalid), or -1 on error.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns string or FALSE on failure.
Returns TRUE on success or FALSE on failure.
An array of available digest methods.
") (prototype . "array openssl_get_md_methods([bool $aliases = false])") (purpose . "Gets available digest methods") (id . "function.openssl-get-md-methods")) "openssl_get_cipher_methods" ((documentation . "Gets available cipher methods array openssl_get_cipher_methods([bool $aliases = false]) An array of available cipher methods. (PHP 5 >= 5.3.0)") (versions . "PHP 5 >= 5.3.0") (return . "An array of available cipher methods.
") (prototype . "array openssl_get_cipher_methods([bool $aliases = false])") (purpose . "Gets available cipher methods") (id . "function.openssl-get-cipher-methods")) "openssl_free_key" ((documentation . "Free key resource void openssl_free_key(resource $key_identifier) No value is returned. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . "No value is returned.
") (prototype . "void openssl_free_key(resource $key_identifier)") (purpose . "Free key resource") (id . "function.openssl-free-key")) "openssl_error_string" ((documentation . "Return openSSL error message string openssl_error_string() Returns an error message string, or FALSE if there are no more error messages to return. (PHP 4 >= 4.0.6, PHP 5)") (versions . "PHP 4 >= 4.0.6, PHP 5") (return . " Returns an error message string, or FALSE if there are no more error messages to return.
Returns the encrypted string on success or FALSE on failure.
Returns the digested hash value on success or FALSE on failure.
Returns computed key on success or FALSE on failure.
The decrypted string on success or FALSE on failure.
Returns an x509 certificate resource on success, FALSE on failure.
Returns the CSR.
") (prototype . "mixed openssl_csr_new(array $dn, resource $privkey [, array $configargs = '' [, array $extraattribs = '']])") (purpose . "Generates a CSR") (id . "function.openssl-csr-new")) "openssl_csr_get_subject" ((documentation . "Returns the subject of a CERT array openssl_csr_get_subject(mixed $csr [, bool $use_shortnames = true]) (PHP 5 >= 5.2.0)") (versions . "PHP 5 >= 5.2.0") (return . "") (prototype . "array openssl_csr_get_subject(mixed $csr [, bool $use_shortnames = true])") (purpose . "Returns the subject of a CERT") (id . "function.openssl-csr-get-subject")) "openssl_csr_get_public_key" ((documentation . "Returns the public key of a CERT resource openssl_csr_get_public_key(mixed $csr [, bool $use_shortnames = true]) (PHP 5 >= 5.2.0)") (versions . "PHP 5 >= 5.2.0") (return . "") (prototype . "resource openssl_csr_get_public_key(mixed $csr [, bool $use_shortnames = true])") (purpose . "Returns the public key of a CERT") (id . "function.openssl-csr-get-public-key")) "openssl_csr_export" ((documentation . "Exports a CSR as a string bool openssl_csr_export(resource $csr, string $out [, bool $notext = true]) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the cipher length on success, or FALSE on failure.
Returns the resulting hash (also called digest) or HMAC as a string, or FALSE on error.
Returns the generated key as a string, or FALSE on error.
Returns the name of the hash or FALSE, if the hash does not exist.
Returns the size in bytes or FALSE, if the hash does not exist.
Returns the highest available hash ID. Hashes are numbered from 0 to this hash ID.
") (prototype . "int mhash_count()") (purpose . "Gets the highest available hash ID") (id . "function.mhash-count")) "mdecrypt_generic" ((documentation . "Decrypts data string mdecrypt_generic(resource $td, string $data) (PHP 4 >= 4.0.2, PHP 5)") (versions . "PHP 4 >= 4.0.2, PHP 5") (return . "") (prototype . "string mdecrypt_generic(resource $td, string $data)") (purpose . "Decrypts data") (id . "function.mdecrypt-generic")) "mcrypt_ofb" ((documentation . "Encrypts/decrypts data in OFB mode string mcrypt_ofb(string $cipher, string $key, string $data, int $mode [, string $iv = '']) (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "") (prototype . "string mcrypt_ofb(string $cipher, string $key, string $data, int $mode [, string $iv = ''])") (purpose . "Encrypts/decrypts data in OFB mode") (id . "function.mcrypt-ofb")) "mcrypt_module_self_test" ((documentation . "This function runs a self test on the specified module bool mcrypt_module_self_test(string $algorithm [, string $lib_dir = '']) The function returns TRUE if the self test succeeds, or FALSE when it fails. (PHP 4 >= 4.0.2, PHP 5)") (versions . "PHP 4 >= 4.0.2, PHP 5") (return . " The function returns TRUE if the self test succeeds, or FALSE when it fails.
Normally it returns an encryption descriptor, or FALSE on error.
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).
This function returns TRUE if the specified algorithm is a block algorithm, or FALSE if it is a stream one.
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).
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.
") (prototype . "array mcrypt_module_get_supported_key_sizes(string $algorithm [, string $lib_dir = ''])") (purpose . "Returns an array with the supported keysizes of the opened algorithm") (id . "function.mcrypt-module-get-supported-key-sizes")) "mcrypt_module_get_algo_key_size" ((documentation . "Returns the maximum supported keysize of the opened mode int mcrypt_module_get_algo_key_size(string $algorithm [, string $lib_dir = '']) This function returns the maximum supported key size of the algorithm specified in bytes. (PHP 4 >= 4.0.2, PHP 5)") (versions . "PHP 4 >= 4.0.2, PHP 5") (return . "This function returns the maximum supported key size of the algorithm specified in bytes.
") (prototype . "int mcrypt_module_get_algo_key_size(string $algorithm [, string $lib_dir = ''])") (purpose . "Returns the maximum supported keysize of the opened mode") (id . "function.mcrypt-module-get-algo-key-size")) "mcrypt_module_get_algo_block_size" ((documentation . "Returns the blocksize of the specified algorithm int mcrypt_module_get_algo_block_size(string $algorithm [, string $lib_dir = '']) Returns the block size of the algorithm specified in bytes. (PHP 4 >= 4.0.2, PHP 5)") (versions . "PHP 4 >= 4.0.2, PHP 5") (return . "Returns the block size of the algorithm specified in bytes.
") (prototype . "int mcrypt_module_get_algo_block_size(string $algorithm [, string $lib_dir = ''])") (purpose . "Returns the blocksize of the specified algorithm") (id . "function.mcrypt-module-get-algo-block-size")) "mcrypt_module_close" ((documentation . "Closes the mcrypt module bool mcrypt_module_close(resource $td) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.2, PHP 5)") (versions . "PHP 4 >= 4.0.2, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns an array with all the supported modes.
") (prototype . "array mcrypt_list_modes([string $lib_dir = ini_get(\"mcrypt.modes_dir\")])") (purpose . "Gets an array of all supported modes") (id . "function.mcrypt-list-modes")) "mcrypt_list_algorithms" ((documentation . "Gets an array of all supported ciphers array mcrypt_list_algorithms([string $lib_dir = ini_get(\"mcrypt.algorithms_dir\")]) Returns an array with all the supported algorithms. (PHP 4 >= 4.0.2, PHP 5)") (versions . "PHP 4 >= 4.0.2, PHP 5") (return . "Returns an array with all the supported algorithms.
") (prototype . "array mcrypt_list_algorithms([string $lib_dir = ini_get(\"mcrypt.algorithms_dir\")])") (purpose . "Gets an array of all supported ciphers") (id . "function.mcrypt-list-algorithms")) "mcrypt_get_key_size" ((documentation . "Gets the key size of the specified cipher int mcrypt_get_key_size(string $cipher, string $mode) Returns the maximum supported key size of the algorithm in bytes or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns the maximum supported key size of the algorithm in bytes or FALSE on failure.
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.
This function returns the name of the cipher or FALSE if the cipher does not exist.
Gets the block size, as an integer.
") (prototype . "int mcrypt_get_block_size(string $cipher, string $mode)") (purpose . "Gets the block size of the specified cipher") (id . "function.mcrypt-get-block-size")) "mcrypt_generic" ((documentation . "This function encrypts data string mcrypt_generic(resource $td, string $data) Returns the encrypted data. (PHP 4 >= 4.0.2, PHP 5)") (versions . "PHP 4 >= 4.0.2, PHP 5") (return . "Returns the encrypted data.
") (prototype . "string mcrypt_generic(resource $td, string $data)") (purpose . "This function encrypts data") (id . "function.mcrypt-generic")) "mcrypt_generic_init" ((documentation . "This function initializes all buffers needed for encryption int mcrypt_generic_init(resource $td, string $key, string $iv) 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. (PHP 4 >= 4.0.2, PHP 5)") (versions . "PHP 4 >= 4.0.2, PHP 5") (return . " 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.
Returns TRUE on success or FALSE on failure.
Returns the encrypted data, as a string.
") (prototype . "string mcrypt_encrypt(string $cipher, string $key, string $data, string $mode [, string $iv = ''])") (purpose . "Encrypts plaintext with given parameters") (id . "function.mcrypt-encrypt")) "mcrypt_enc_self_test" ((documentation . "Runs a self test on the opened module int mcrypt_enc_self_test(resource $td) If the self test succeeds it returns FALSE. In case of an error, it returns TRUE. (PHP 4 >= 4.0.2, PHP 5)") (versions . "PHP 4 >= 4.0.2, PHP 5") (return . " If the self test succeeds it returns FALSE. In case of an error, it returns TRUE.
Returns TRUE if the mode outputs blocks of bytes, or FALSE if it outputs just bytes.
Returns TRUE if the algorithm is a block algorithm or FALSE if it is a stream one.
Returns TRUE if the mode is for use with block algorithms, otherwise it returns FALSE.
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.
") (prototype . "array mcrypt_enc_get_supported_key_sizes(resource $td)") (purpose . "Returns an array with the supported keysizes of the opened algorithm") (id . "function.mcrypt-enc-get-supported-key-sizes")) "mcrypt_enc_get_modes_name" ((documentation . "Returns the name of the opened mode string mcrypt_enc_get_modes_name(resource $td) Returns the name as a string. (PHP 4 >= 4.0.2, PHP 5)") (versions . "PHP 4 >= 4.0.2, PHP 5") (return . "Returns the name as a string.
") (prototype . "string mcrypt_enc_get_modes_name(resource $td)") (purpose . "Returns the name of the opened mode") (id . "function.mcrypt-enc-get-modes-name")) "mcrypt_enc_get_key_size" ((documentation . "Returns the maximum supported keysize of the opened mode int mcrypt_enc_get_key_size(resource $td) Returns the maximum supported key size of the algorithm in bytes. (PHP 4 >= 4.0.2, PHP 5)") (versions . "PHP 4 >= 4.0.2, PHP 5") (return . "Returns the maximum supported key size of the algorithm in bytes.
") (prototype . "int mcrypt_enc_get_key_size(resource $td)") (purpose . "Returns the maximum supported keysize of the opened mode") (id . "function.mcrypt-enc-get-key-size")) "mcrypt_enc_get_iv_size" ((documentation . "Returns the size of the IV of the opened algorithm int mcrypt_enc_get_iv_size(resource $td) Returns the size of the IV, or 0 if the IV is ignored by the algorithm. (PHP 4 >= 4.0.2, PHP 5)") (versions . "PHP 4 >= 4.0.2, PHP 5") (return . "Returns the size of the IV, or 0 if the IV is ignored by the algorithm.
") (prototype . "int mcrypt_enc_get_iv_size(resource $td)") (purpose . "Returns the size of the IV of the opened algorithm") (id . "function.mcrypt-enc-get-iv-size")) "mcrypt_enc_get_block_size" ((documentation . "Returns the blocksize of the opened algorithm int mcrypt_enc_get_block_size(resource $td) Returns the block size of the specified algorithm in bytes. (PHP 4 >= 4.0.2, PHP 5)") (versions . "PHP 4 >= 4.0.2, PHP 5") (return . "Returns the block size of the specified algorithm in bytes.
") (prototype . "int mcrypt_enc_get_block_size(resource $td)") (purpose . "Returns the blocksize of the opened algorithm") (id . "function.mcrypt-enc-get-block-size")) "mcrypt_enc_get_algorithms_name" ((documentation . "Returns the name of the opened algorithm string mcrypt_enc_get_algorithms_name(resource $td) Returns the name of the opened algorithm as a string. (PHP 4 >= 4.0.2, PHP 5)") (versions . "PHP 4 >= 4.0.2, PHP 5") (return . "Returns the name of the opened algorithm as a string.
") (prototype . "string mcrypt_enc_get_algorithms_name(resource $td)") (purpose . "Returns the name of the opened algorithm") (id . "function.mcrypt-enc-get-algorithms-name")) "mcrypt_ecb" ((documentation . "Deprecated: Encrypts/decrypts data in ECB mode string mcrypt_ecb(string $cipher, string $key, string $data, int $mode [, string $iv = '']) (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "") (prototype . "string mcrypt_ecb(string $cipher, string $key, string $data, int $mode [, string $iv = ''])") (purpose . "Deprecated: Encrypts/decrypts data in ECB mode") (id . "function.mcrypt-ecb")) "mcrypt_decrypt" ((documentation . "Decrypts crypttext with given parameters string mcrypt_decrypt(string $cipher, string $key, string $data, string $mode [, string $iv = '']) Returns the decrypted data as a string. (PHP 4 >= 4.0.2, PHP 5)") (versions . "PHP 4 >= 4.0.2, PHP 5") (return . "Returns the decrypted data as a string.
") (prototype . "string mcrypt_decrypt(string $cipher, string $key, string $data, string $mode [, string $iv = ''])") (purpose . "Decrypts crypttext with given parameters") (id . "function.mcrypt-decrypt")) "mcrypt_create_iv" ((documentation . "Creates an initialization vector (IV) from a random source string mcrypt_create_iv(int $size [, int $source = MCRYPT_DEV_RANDOM]) Returns the initialization vector, or FALSE on error. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns the initialization vector, or FALSE on error.
Returns a string containing the calculated message digest as lowercase hexits unless raw_output is set to true in which case the raw binary representation of the message digest is returned.
Returns TRUE.
Actual number of bytes added to the hashing context from handle.
Returns TRUE on success or FALSE on failure.
Returns a string containing the derived key as lowercase hexits unless raw_output is set to TRUE in which case the raw binary representation of the derived key is returned.
Returns a Hashing Context resource for use with hash_update, hash_update_stream, hash_update_file, and hash_final.
") (prototype . "resource hash_init(string $algo [, int $options = '' [, string $key = '']])") (purpose . "Initialize an incremental hashing context") (id . "function.hash-init")) "hash_hmac" ((documentation . "Generate a keyed hash value using the HMAC method string hash_hmac(string $algo, string $data, string $key [, bool $raw_output = false]) Returns a string containing the calculated message digest as lowercase hexits unless raw_output is set to true in which case the raw binary representation of the message digest is returned. Returns FALSE when algo is unknown. (PHP 5 >= 5.1.2, PECL hash >= 1.1)") (versions . "PHP 5 >= 5.1.2, PECL hash >= 1.1") (return . " Returns a string containing the calculated message digest as lowercase hexits unless raw_output is set to true in which case the raw binary representation of the message digest is returned. Returns FALSE when algo is unknown.
Returns a string containing the calculated message digest as lowercase hexits unless raw_output is set to true in which case the raw binary representation of the message digest is returned.
Returns a string containing the calculated message digest as lowercase hexits unless raw_output is set to true in which case the raw binary representation of the message digest is returned.
Returns a string containing the calculated message digest as lowercase hexits unless raw_output is set to true in which case the raw binary representation of the message digest is returned.
Returns a copy of Hashing Context resource.
") (prototype . "resource hash_copy(resource $context)") (purpose . "Copy hashing context") (id . "function.hash-copy")) "hash_algos" ((documentation . "Return a list of registered hashing algorithms array hash_algos() Returns a numerically indexed array containing the list of supported hashing algorithms. (PHP 5 >= 5.1.2, PECL hash >= 1.1)") (versions . "PHP 5 >= 5.1.2, PECL hash >= 1.1") (return . "Returns a numerically indexed array containing the list of supported hashing algorithms.
") (prototype . "array hash_algos()") (purpose . "Return a list of registered hashing algorithms") (id . "function.hash-algos")) "crack_opendict" ((documentation . "Opens a new CrackLib dictionary resource crack_opendict(string $dictionary) Returns a dictionary resource identifier on success or FALSE on failure. (PECL crack >= 0.1)") (versions . "PECL crack >= 0.1") (return . " Returns a dictionary resource identifier on success or FALSE on failure.
The message from the last obscure check or FALSE if there was no obscure checks made so far.
The returned message is one of:
Returns TRUE on success or FALSE on failure.
Returns TRUE if password is strong, or FALSE otherwise.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
") (prototype . "bool m_verifysslcert(resource $conn, int $tf)") (purpose . "Set whether or not to verify the server ssl certificate") (id . "function.m-verifysslcert")) "m_verifyconnection" ((documentation . "Set whether or not to PING upon connect to verify connection bool m_verifyconnection(resource $conn, int $tf) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "bool m_verifyconnection(resource $conn, int $tf)") (purpose . "Set whether or not to PING upon connect to verify connection") (id . "function.m-verifyconnection")) "m_validateidentifier" ((documentation . "Whether or not to validate the passed identifier on any transaction it is passed to int m_validateidentifier(resource $conn, int $tf) (PHP 5 >= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 5 >= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "int m_validateidentifier(resource $conn, int $tf)") (purpose . "Whether or not to validate the passed identifier on any transaction it is passed to") (id . "function.m-validateidentifier")) "m_uwait" ((documentation . "Wait x microsecs int m_uwait(int $microsecs) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "int m_uwait(int $microsecs)") (purpose . "Wait x microsecs") (id . "function.m-uwait")) "m_transsend" ((documentation . "Finalize and send the transaction int m_transsend(resource $conn, int $identifier) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "int m_transsend(resource $conn, int $identifier)") (purpose . "Finalize and send the transaction") (id . "function.m-transsend")) "m_transnew" ((documentation . "Start a new transaction int m_transnew(resource $conn) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "int m_transnew(resource $conn)") (purpose . "Start a new transaction") (id . "function.m-transnew")) "m_transkeyval" ((documentation . "Add key/value pair to a transaction. Replaces deprecated transparam() int m_transkeyval(resource $conn, int $identifier, string $key, string $value) (PHP 5 >= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 5 >= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "int m_transkeyval(resource $conn, int $identifier, string $key, string $value)") (purpose . "Add key/value pair to a transaction. Replaces deprecated transparam()") (id . "function.m-transkeyval")) "m_transinqueue" ((documentation . "Number of transactions in client-queue int m_transinqueue(resource $conn) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "int m_transinqueue(resource $conn)") (purpose . "Number of transactions in client-queue") (id . "function.m-transinqueue")) "m_transactionssent" ((documentation . "Check to see if outgoing buffer is clear int m_transactionssent(resource $conn) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "int m_transactionssent(resource $conn)") (purpose . "Check to see if outgoing buffer is clear") (id . "function.m-transactionssent")) "m_sslcert_gen_hash" ((documentation . "Generate hash for SSL client certificate verification string m_sslcert_gen_hash(string $filename) (PECL mcve >= 5.2.0)") (versions . "PECL mcve >= 5.2.0") (return . "
") (prototype . "string m_sslcert_gen_hash(string $filename)") (purpose . "Generate hash for SSL client certificate verification") (id . "function.m-sslcert-gen-hash")) "m_settimeout" ((documentation . "Set maximum transaction time (per trans) int m_settimeout(resource $conn, int $seconds) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "int m_settimeout(resource $conn, int $seconds)") (purpose . "Set maximum transaction time (per trans)") (id . "function.m-settimeout")) "m_setssl" ((documentation . "Set the connection method to SSL int m_setssl(resource $conn, string $host, int $port) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "int m_setssl(resource $conn, string $host, int $port)") (purpose . "Set the connection method to SSL") (id . "function.m-setssl")) "m_setssl_files" ((documentation . "Set certificate key files and certificates if server requires client certificate verification int m_setssl_files(resource $conn, string $sslkeyfile, string $sslcertfile) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "int m_setssl_files(resource $conn, string $sslkeyfile, string $sslcertfile)") (purpose . "Set certificate key files and certificates if server requires client certificate verification") (id . "function.m-setssl-files")) "m_setssl_cafile" ((documentation . "Set SSL CA (Certificate Authority) file for verification of server certificate int m_setssl_cafile(resource $conn, string $cafile) (PHP 5 >= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 5 >= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "int m_setssl_cafile(resource $conn, string $cafile)") (purpose . "Set SSL CA (Certificate Authority) file for verification of server certificate") (id . "function.m-setssl-cafile")) "m_setip" ((documentation . "Set the connection method to IP int m_setip(resource $conn, string $host, int $port) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "int m_setip(resource $conn, string $host, int $port)") (purpose . "Set the connection method to IP") (id . "function.m-setip")) "m_setdropfile" ((documentation . "Set the connection method to Drop-File int m_setdropfile(resource $conn, string $directory) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "int m_setdropfile(resource $conn, string $directory)") (purpose . "Set the connection method to Drop-File") (id . "function.m-setdropfile")) "m_setblocking" ((documentation . "Set blocking/non-blocking mode for connection int m_setblocking(resource $conn, int $tf) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "int m_setblocking(resource $conn, int $tf)") (purpose . "Set blocking/non-blocking mode for connection") (id . "function.m-setblocking")) "m_returnstatus" ((documentation . "Check to see if the transaction was successful int m_returnstatus(resource $conn, int $identifier) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "int m_returnstatus(resource $conn, int $identifier)") (purpose . "Check to see if the transaction was successful") (id . "function.m-returnstatus")) "m_responseparam" ((documentation . "Get a custom response parameter string m_responseparam(resource $conn, int $identifier, string $key) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "string m_responseparam(resource $conn, int $identifier, string $key)") (purpose . "Get a custom response parameter") (id . "function.m-responseparam")) "m_responsekeys" ((documentation . "Returns array of strings which represents the keys that can be used for response parameters on this transaction array m_responsekeys(resource $conn, int $identifier) (PHP 5 >= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 5 >= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "array m_responsekeys(resource $conn, int $identifier)") (purpose . "Returns array of strings which represents the keys that can be used for response parameters on this transaction") (id . "function.m-responsekeys")) "m_parsecommadelimited" ((documentation . "Parse the comma delimited response so m_getcell, etc will work int m_parsecommadelimited(resource $conn, int $identifier) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "int m_parsecommadelimited(resource $conn, int $identifier)") (purpose . "Parse the comma delimited response so m_getcell, etc will work") (id . "function.m-parsecommadelimited")) "m_numrows" ((documentation . "Number of rows returned in a comma delimited response int m_numrows(resource $conn, int $identifier) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "int m_numrows(resource $conn, int $identifier)") (purpose . "Number of rows returned in a comma delimited response") (id . "function.m-numrows")) "m_numcolumns" ((documentation . "Number of columns returned in a comma delimited response int m_numcolumns(resource $conn, int $identifier) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "int m_numcolumns(resource $conn, int $identifier)") (purpose . "Number of columns returned in a comma delimited response") (id . "function.m-numcolumns")) "m_monitor" ((documentation . "Perform communication with MCVE (send/receive data) Non-blocking int m_monitor(resource $conn) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "int m_monitor(resource $conn)") (purpose . "Perform communication with MCVE (send/receive data) Non-blocking") (id . "function.m-monitor")) "m_maxconntimeout" ((documentation . "The maximum amount of time the API will attempt a connection to MCVE bool m_maxconntimeout(resource $conn, int $secs) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "bool m_maxconntimeout(resource $conn, int $secs)") (purpose . "The maximum amount of time the API will attempt a connection to MCVE") (id . "function.m-maxconntimeout")) "m_iscommadelimited" ((documentation . "Checks to see if response is comma delimited int m_iscommadelimited(resource $conn, int $identifier) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "int m_iscommadelimited(resource $conn, int $identifier)") (purpose . "Checks to see if response is comma delimited") (id . "function.m-iscommadelimited")) "m_initengine" ((documentation . "Ready the client for IP/SSL Communication int m_initengine(string $location) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "int m_initengine(string $location)") (purpose . "Ready the client for IP/SSL Communication") (id . "function.m-initengine")) "m_initconn" ((documentation . "Create and initialize an MCVE_CONN structure resource m_initconn() Returns an MCVE_CONN resource. (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
Returns an MCVE_CONN resource.
") (prototype . "resource m_initconn()") (purpose . "Create and initialize an MCVE_CONN structure") (id . "function.m-initconn")) "m_getheader" ((documentation . "Get the name of the column in a comma-delimited response string m_getheader(resource $conn, int $identifier, int $column_num) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "") (prototype . "string m_getheader(resource $conn, int $identifier, int $column_num)") (purpose . "Get the name of the column in a comma-delimited response") (id . "function.m-getheader")) "m_getcommadelimited" ((documentation . "Get the RAW comma delimited data returned from MCVE string m_getcommadelimited(resource $conn, int $identifier) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "string m_getcommadelimited(resource $conn, int $identifier)") (purpose . "Get the RAW comma delimited data returned from MCVE") (id . "function.m-getcommadelimited")) "m_getcellbynum" ((documentation . "Get a specific cell from a comma delimited response by column number string m_getcellbynum(resource $conn, int $identifier, int $column, int $row) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "string m_getcellbynum(resource $conn, int $identifier, int $column, int $row)") (purpose . "Get a specific cell from a comma delimited response by column number") (id . "function.m-getcellbynum")) "m_getcell" ((documentation . "Get a specific cell from a comma delimited response by column name string m_getcell(resource $conn, int $identifier, string $column, int $row) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "string m_getcell(resource $conn, int $identifier, string $column, int $row)") (purpose . "Get a specific cell from a comma delimited response by column name") (id . "function.m-getcell")) "m_destroyengine" ((documentation . "Free memory associated with IP/SSL connectivity void m_destroyengine() No value is returned. (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
No value is returned.
") (prototype . "void m_destroyengine()") (purpose . "Free memory associated with IP/SSL connectivity") (id . "function.m-destroyengine")) "m_destroyconn" ((documentation . "Destroy the connection and MCVE_CONN structure bool m_destroyconn(resource $conn) Returns TRUE. (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . " Returns TRUE.
") (prototype . "bool m_deletetrans(resource $conn, int $identifier)") (purpose . "Delete specified transaction from MCVE_CONN structure") (id . "function.m-deletetrans")) "m_connectionerror" ((documentation . "Get a textual representation of why a connection failed string m_connectionerror(resource $conn) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "string m_connectionerror(resource $conn)") (purpose . "Get a textual representation of why a connection failed") (id . "function.m-connectionerror")) "m_connect" ((documentation . "Establish the connection to MCVE int m_connect(resource $conn) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
") (prototype . "int m_connect(resource $conn)") (purpose . "Establish the connection to MCVE") (id . "function.m-connect")) "m_completeauthorizations" ((documentation . "Number of complete authorizations in queue, returning an array of their identifiers int m_completeauthorizations(resource $conn, int $array) What the function returns, first on success, then on failure. See also the &return.success; entity (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "
What the function returns, first on success, then on failure. See also the &return.success; entity
") (prototype . "int m_completeauthorizations(resource $conn, int $array)") (purpose . "Number of complete authorizations in queue, returning an array of their identifiers") (id . "function.m-completeauthorizations")) "m_checkstatus" ((documentation . "Check to see if a transaction has completed int m_checkstatus(resource $conn, int $identifier) (PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0)") (versions . "PHP 4 >= 4.3.9, PHP 5 <= 5.0.5, PECL mcve >= 1.0.0") (return . "") (prototype . "int m_checkstatus(resource $conn, int $identifier)") (purpose . "Check to see if a transaction has completed") (id . "function.m-checkstatus")) "zlib_get_coding_type" ((documentation . "Returns the coding type used for output compression string zlib_get_coding_type() Possible return values are gzip, deflate, or FALSE. (PHP 4 >= 4.3.2, PHP 5)") (versions . "PHP 4 >= 4.3.2, PHP 5") (return . "
Possible return values are gzip, deflate, or FALSE.
") (prototype . "string zlib_encode(string $data, string $encoding [, string $level = -1])") (purpose . "Compress data with the specified encoding") (id . "function.zlib-encode")) "zlib_decode" ((documentation . "Uncompress any raw/gzip/zlib encoded data string zlib_decode(string $data [, string $max_decoded_len = '']) (PHP 5 >= 5.4.0)") (versions . "PHP 5 >= 5.4.0") (return . "
") (prototype . "string zlib_decode(string $data [, string $max_decoded_len = ''])") (purpose . "Uncompress any raw/gzip/zlib encoded data") (id . "function.zlib-decode")) "readgzfile" ((documentation . "Output a gz-file int readgzfile(string $filename [, int $use_include_path = '']) Returns the number of (uncompressed) bytes read from the file. If an error occurs, FALSE is returned and unless the function was called as @readgzfile, an error message is printed. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "
Returns the number of (uncompressed) bytes read from the file. If an error occurs, FALSE is returned and unless the function was called as @readgzfile, an error message is printed.
Returns the number of (uncompressed) bytes written to the given gz-file stream.
") (prototype . "int gzwrite(resource $zp, string $string [, int $length = ''])") (purpose . "Binary-safe gz-file write") (id . "function.gzwrite")) "gzuncompress" ((documentation . "Uncompress a compressed string string gzuncompress(string $data [, int $length = '']) The original uncompressed data or FALSE on error. The function will return an error if the uncompressed data is more than 32768 times the length of the compressed input data or more than the optional parameter length. (PHP 4 >= 4.0.1, PHP 5)") (versions . "PHP 4 >= 4.0.1, PHP 5") (return . " The original uncompressed data or FALSE on error.
The function will return an error if the uncompressed data is more than 32768 times the length of the compressed input data or more than the optional parameter length.
The position of the file pointer or FALSE if an error occurs.
Upon success, returns 0; otherwise, returns -1. Note that seeking past EOF is not considered an error.
") (prototype . "int gzseek(resource $zp, int $offset [, int $whence = SEEK_SET])") (purpose . "Seek on a gz-file pointer") (id . "function.gzseek")) "gzrewind" ((documentation . "Rewind the position of a gz-file pointer bool gzrewind(resource $zp) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
The data that have been read.
") (prototype . "string gzread(resource $zp, int $length)") (purpose . "Binary-safe gz-file read") (id . "function.gzread")) "gzputs" ((documentation . "Alias of gzwrite gzputs() (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "") (prototype . " gzputs()") (purpose . "Alias of gzwrite") (id . "function.gzputs")) "gzpassthru" ((documentation . "Output all remaining data on a gz-file pointer int gzpassthru(resource $zp) The number of uncompressed characters read from gz and passed through to the input, or FALSE on error. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " The number of uncompressed characters read from gz and passed through to the input, or FALSE on error.
Returns a file pointer to the file opened, after that, everything you read from this file descriptor will be transparently decompressed and what you write gets compressed.
If the open fails, the function returns FALSE.
The original uncompressed data or FALSE on error.
The function will return an error if the uncompressed data is more than 32768 times the length of the compressed input data or more than the optional parameter length.
The uncompressed and stripped string, or FALSE on error.
The uncompressed string, or FALSE on error.
The uncompressed character or FALSE on EOF (unlike gzeof).
An array containing the file, one line per cell.
") (prototype . "array gzfile(string $filename [, int $use_include_path = ''])") (purpose . "Read entire gz-file into an array") (id . "function.gzfile")) "gzeof" ((documentation . "Test for EOF on a gz-file pointer int gzeof(resource $zp) Returns TRUE if the gz-file pointer is at EOF or an error occurs; otherwise returns FALSE. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE if the gz-file pointer is at EOF or an error occurs; otherwise returns FALSE.
The encoded string, or FALSE if an error occurred.
The deflated string or FALSE if an error occurred.
The decoded string, or FALSE if an error occurred.
The compressed string or FALSE if an error occurred.
Returns TRUE on success or FALSE on failure.
Returns a directory entry resource for later use with the zip_entry_... functions, or FALSE if there are no more entries to read, or an error code if an error occurred.
Returns a resource handle for later use with zip_read and zip_close or returns the number of error if filename does not exist or in case of other error.
Returns the data read, empty string on end of a file, or FALSE on error.
Returns TRUE on success or FALSE on failure.
") (prototype . "bool zip_entry_open(resource $zip, resource $zip_entry [, string $mode = ''])") (purpose . "Open a directory entry for reading") (id . "function.zip-entry-open")) "zip_entry_name" ((documentation . "Retrieve the name of a directory entry string zip_entry_name(resource $zip_entry) The name of the directory entry. (PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PECL zip >= 1.0.0)") (versions . "PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PECL zip >= 1.0.0") (return . "Note:
Unlike fopen and other similar functions, the return value of zip_entry_open only indicates the result of the operation and is not needed for reading or closing the directory entry.
The name of the directory entry.
") (prototype . "string zip_entry_name(resource $zip_entry)") (purpose . "Retrieve the name of a directory entry") (id . "function.zip-entry-name")) "zip_entry_filesize" ((documentation . "Retrieve the actual file size of a directory entry int zip_entry_filesize(resource $zip_entry) The size of the directory entry. (PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PECL zip >= 1.0.0)") (versions . "PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PECL zip >= 1.0.0") (return . "The size of the directory entry.
") (prototype . "int zip_entry_filesize(resource $zip_entry)") (purpose . "Retrieve the actual file size of a directory entry") (id . "function.zip-entry-filesize")) "zip_entry_compressionmethod" ((documentation . "Retrieve the compression method of a directory entry string zip_entry_compressionmethod(resource $zip_entry) The compression method. (PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PECL zip >= 1.0.0)") (versions . "PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PECL zip >= 1.0.0") (return . "The compression method.
") (prototype . "string zip_entry_compressionmethod(resource $zip_entry)") (purpose . "Retrieve the compression method of a directory entry") (id . "function.zip-entry-compressionmethod")) "zip_entry_compressedsize" ((documentation . "Retrieve the compressed size of a directory entry int zip_entry_compressedsize(resource $zip_entry) The compressed size. (PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PECL zip >= 1.0.0)") (versions . "PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PECL zip >= 1.0.0") (return . "The compressed size.
") (prototype . "int zip_entry_compressedsize(resource $zip_entry)") (purpose . "Retrieve the compressed size of a directory entry") (id . "function.zip-entry-compressedsize")) "zip_entry_close" ((documentation . "Close a directory entry bool zip_entry_close(resource $zip_entry) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PECL zip >= 1.0.0)") (versions . "PHP 4 >= 4.1.0, PHP 5 >= 5.2.0, PECL zip >= 1.0.0") (return . " Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void zip_close(resource $zip)") (purpose . "Close a ZIP file archive") (id . "function.zip-close")) "rar_open" ((documentation . "Open RAR archive RarArchive rar_open(string $filename [, string $password = null [, callable $volume_callback = null]]) Returns the requested RarArchive instance or FALSE on failure. (PECL rar >= 2.0.0)") (versions . "PECL rar >= 2.0.0") (return . " Returns the requested RarArchive instance or FALSE on failure.
Returns TRUE if the archive is solid, FALSE otherwise.
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.
Returns the matching RarEntry object or FALSE on failure.
rar_list returns array of RarEntry objects or FALSE on failure.
Returns the comment or NULL if there is none.
") (prototype . "string rar_comment_get(RarArchive $rarfile)") (purpose . "Get comment text from the RAR archive") (id . "rararchive.getcomment")) "rar_close" ((documentation . "Close RAR archive and free all resources bool rar_close(RarArchive $rarfile) Returns TRUE on success or FALSE on failure. (PECL rar >= 2.0.0)") (versions . "PECL rar >= 2.0.0") (return . "Note:
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.
Returns TRUE on success or FALSE on failure.
") (prototype . "string rar_wrapper_cache_stats()") (purpose . "Cache hits and misses for the URL wrapper") (id . "function.rar-wrapper-cache-stats")) "PharException" ((documentation . "The PharException class provides a phar-specific exception class for try/catch blocks. PharException() (Unknown)") (versions . "Unknown") (return . "") (prototype . " PharException()") (purpose . "The PharException class provides a phar-specific exception class for try/catch blocks.") (id . "pharexception.intro.unused")) "lzf_optimized_for" ((documentation . "Determines what LZF extension was optimized for int lzf_optimized_for() Returns 1 if LZF was optimized for speed, 0 for compression. (PECL lzf >= 1.0.0)") (versions . "PECL lzf >= 1.0.0") (return . "
Returns 1 if LZF was optimized for speed, 0 for compression.
") (prototype . "int lzf_optimized_for()") (purpose . "Determines what LZF extension was optimized for") (id . "function.lzf-optimized-for")) "lzf_decompress" ((documentation . "LZF decompression string lzf_decompress(string $data) Returns the decompressed data or FALSE if an error occurred. (PECL lzf >= 0.1.0)") (versions . "PECL lzf >= 0.1.0") (return . " Returns the decompressed data or FALSE if an error occurred.
Returns the compressed data or FALSE if an error occurred.
Returns the number of bytes written, or FALSE on error.
Returns the uncompressed data, or FALSE on error.
If the open fails, bzopen returns FALSE, otherwise it returns a pointer to the newly opened file.
Returns TRUE on success or FALSE on failure.
Returns a string containing the error message.
") (prototype . "string bzerrstr(resource $bz)") (purpose . "Returns a bzip2 error string") (id . "function.bzerrstr")) "bzerror" ((documentation . "Returns the bzip2 error number and error string in an array array bzerror(resource $bz) Returns an associative array, with the error code in the errno entry, and the error message in the errstr entry. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . "Returns an associative array, with the error code in the errno entry, and the error message in the errstr entry.
") (prototype . "array bzerror(resource $bz)") (purpose . "Returns the bzip2 error number and error string in an array") (id . "function.bzerror")) "bzerrno" ((documentation . "Returns a bzip2 error number int bzerrno(resource $bz) Returns the error number as an integer. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . "Returns the error number as an integer.
") (prototype . "int bzerrno(resource $bz)") (purpose . "Returns a bzip2 error number") (id . "function.bzerrno")) "bzdecompress" ((documentation . "Decompresses bzip2 encoded data mixed bzdecompress(string $source [, int $small = '']) The decompressed string, or an error number if an error occurred. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . "The decompressed string, or an error number if an error occurred.
") (prototype . "mixed bzdecompress(string $source [, int $small = ''])") (purpose . "Decompresses bzip2 encoded data") (id . "function.bzdecompress")) "bzcompress" ((documentation . "Compress a string into bzip2 encoded data mixed bzcompress(string $source [, int $blocksize = 4 [, int $workfactor = '']]) The compressed string, or an error number if an error occurred. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . "The compressed string, or an error number if an error occurred.
") (prototype . "mixed bzcompress(string $source [, int $blocksize = 4 [, int $workfactor = '']])") (purpose . "Compress a string into bzip2 encoded data") (id . "function.bzcompress")) "bzclose" ((documentation . "Close a bzip2 file int bzclose(resource $bz) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns a single string from the user. The line returned has the ending newline removed.
") (prototype . "string readline([string $prompt = ''])") (purpose . "Reads a line") (id . "function.readline")) "readline_write_history" ((documentation . "Writes the history bool readline_write_history([string $filename = '']) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void readline_redisplay()") (purpose . "Redraws the display") (id . "function.readline-redisplay")) "readline_read_history" ((documentation . "Reads the history bool readline_read_history([string $filename = '']) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void readline_on_new_line()") (purpose . "Inform readline that the cursor has moved to a new line") (id . "function.readline-on-new-line")) "readline_list_history" ((documentation . "Lists the history array readline_list_history() Returns an array of the entire command line history. The elements are indexed by integers starting at zero. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns an array of the entire command line history. The elements are indexed by integers starting at zero.
") (prototype . "array readline_list_history()") (purpose . "Lists the history") (id . "function.readline-list-history")) "readline_info" ((documentation . "Gets/sets various internal readline variables mixed readline_info([string $varname = '' [, string $newvalue = '']]) If called with no parameters, this function returns an array of values for all the setting readline uses. The elements will be indexed by the following values: done, end, erase_empty_line, library_version, line_buffer, mark, pending_input, point, prompt, readline_name, and terminal_name. If called with one or two parameters, the old value is returned. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "If called with no parameters, this function returns an array of values for all the setting readline uses. The elements will be indexed by the following values: done, end, erase_empty_line, library_version, line_buffer, mark, pending_input, point, prompt, readline_name, and terminal_name.
If called with one or two parameters, the old value is returned.
") (prototype . "mixed readline_info([string $varname = '' [, string $newvalue = '']])") (purpose . "Gets/sets various internal readline variables") (id . "function.readline-info")) "readline_completion_function" ((documentation . "Registers a completion function bool readline_completion_function(callable $function) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void readline_callback_read_char()") (purpose . "Reads a character and informs the readline callback interface when a line is received") (id . "function.readline-callback-read-char")) "readline_callback_handler_remove" ((documentation . "Removes a previously installed callback handler and restores terminal settings bool readline_callback_handler_remove() Returns TRUE if a previously installed callback handler was removed, or FALSE if one could not be found. (PHP 5 >= 5.1.0)") (versions . "PHP 5 >= 5.1.0") (return . " Returns TRUE if a previously installed callback handler was removed, or FALSE if one could not be found.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
What the function returns, first on success, then on failure. See also the &return.success; entity
") (prototype . "int newt_win_ternary(string $title, string $button1_text, string $button2_text, string $button3_text, string $format [, mixed $args = '' [, mixed $... = '']])") (purpose . "") (id . "function.newt-win-ternary")) "newt_win_messagev" ((documentation . " void newt_win_messagev(string $title, string $button_text, string $format, array $args) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_win_messagev(string $title, string $button_text, string $format, array $args)") (purpose . "") (id . "function.newt-win-messagev")) "newt_win_message" ((documentation . " void newt_win_message(string $title, string $button_text, string $format [, mixed $args = '' [, mixed $... = '']]) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_win_message(string $title, string $button_text, string $format [, mixed $args = '' [, mixed $... = '']])") (purpose . "") (id . "function.newt-win-message")) "newt_win_menu" ((documentation . " int newt_win_menu(string $title, string $text, int $suggestedWidth, int $flexDown, int $flexUp, int $maxListHeight, array $items, int $listItem [, string $button1 = '' [, string $... = '']]) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "int newt_win_menu(string $title, string $text, int $suggestedWidth, int $flexDown, int $flexUp, int $maxListHeight, array $items, int $listItem [, string $button1 = '' [, string $... = '']])") (purpose . "") (id . "function.newt-win-menu")) "newt_win_entries" ((documentation . " int newt_win_entries(string $title, string $text, int $suggested_width, int $flex_down, int $flex_up, int $data_width, array $items, string $button1 [, string $... = '']) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "") (prototype . "int newt_win_entries(string $title, string $text, int $suggested_width, int $flex_down, int $flex_up, int $data_width, array $items, string $button1 [, string $... = ''])") (purpose . "") (id . "function.newt-win-entries")) "newt_win_choice" ((documentation . " int newt_win_choice(string $title, string $button1_text, string $button2_text, string $format [, mixed $args = '' [, mixed $... = '']]) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
") (prototype . "int newt_win_choice(string $title, string $button1_text, string $button2_text, string $format [, mixed $args = '' [, mixed $... = '']])") (purpose . "") (id . "function.newt-win-choice")) "newt_wait_for_key" ((documentation . "Doesn't return until a key has been pressed void newt_wait_for_key() No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
No value is returned.
") (prototype . "void newt_wait_for_key()") (purpose . "Doesn't return until a key has been pressed") (id . "function.newt-wait-for-key")) "newt_vertical_scrollbar" ((documentation . " resource newt_vertical_scrollbar(int $left, int $top, int $height [, int $normal_colorset = '' [, int $thumb_colorset = '']]) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "") (prototype . "resource newt_vertical_scrollbar(int $left, int $top, int $height [, int $normal_colorset = '' [, int $thumb_colorset = '']])") (purpose . "") (id . "function.newt-vertical-scrollbar")) "newt_textbox" ((documentation . " resource newt_textbox(int $left, int $top, int $width, int $height [, int $flags = '']) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
") (prototype . "resource newt_textbox(int $left, int $top, int $width, int $height [, int $flags = ''])") (purpose . "") (id . "function.newt-textbox")) "newt_textbox_set_text" ((documentation . " void newt_textbox_set_text(resource $textbox, string $text) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
No value is returned.
") (prototype . "void newt_textbox_set_text(resource $textbox, string $text)") (purpose . "") (id . "function.newt-textbox-set-text")) "newt_textbox_set_height" ((documentation . " void newt_textbox_set_height(resource $textbox, int $height) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_textbox_set_height(resource $textbox, int $height)") (purpose . "") (id . "function.newt-textbox-set-height")) "newt_textbox_reflowed" ((documentation . " resource newt_textbox_reflowed(int $left, int $top, char $*text, int $width, int $flex_down, int $flex_up [, int $flags = '']) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "") (prototype . "resource newt_textbox_reflowed(int $left, int $top, char $*text, int $width, int $flex_down, int $flex_up [, int $flags = ''])") (purpose . "") (id . "function.newt-textbox-reflowed")) "newt_textbox_get_num_lines" ((documentation . " int newt_textbox_get_num_lines(resource $textbox) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
") (prototype . "int newt_textbox_get_num_lines(resource $textbox)") (purpose . "") (id . "function.newt-textbox-get-num-lines")) "newt_suspend" ((documentation . "Tells newt to return the terminal to its initial state void newt_suspend() No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
No value is returned.
") (prototype . "void newt_suspend()") (purpose . "Tells newt to return the terminal to its initial state") (id . "function.newt-suspend")) "newt_set_suspend_callback" ((documentation . "Set a callback function which gets invoked when user presses the suspend key void newt_set_suspend_callback(callable $function, mixed $data) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_set_suspend_callback(callable $function, mixed $data)") (purpose . "Set a callback function which gets invoked when user presses the suspend key") (id . "function.newt-set-suspend-callback")) "newt_set_help_callback" ((documentation . " void newt_set_help_callback(mixed $function) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_set_help_callback(mixed $function)") (purpose . "") (id . "function.newt-set-help-callback")) "newt_scrollbar_set" ((documentation . " void newt_scrollbar_set(resource $scrollbar, int $where, int $total) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_scrollbar_set(resource $scrollbar, int $where, int $total)") (purpose . "") (id . "function.newt-scrollbar-set")) "newt_scale" ((documentation . " resource newt_scale(int $left, int $top, int $width, int $full_value) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "") (prototype . "resource newt_scale(int $left, int $top, int $width, int $full_value)") (purpose . "") (id . "function.newt-scale")) "newt_scale_set" ((documentation . " void newt_scale_set(resource $scale, int $amount) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
No value is returned.
") (prototype . "void newt_scale_set(resource $scale, int $amount)") (purpose . "") (id . "function.newt-scale-set")) "newt_run_form" ((documentation . "Runs a form resource newt_run_form(resource $form) The component which caused the form to stop running. Note: Notice that this function doesn't fit in with newt's normal naming convention. It is an older interface which will not work for all forms. It was left in newt only for legacy applications. It is a simpler interface than the new newt_form_run though, and is still used quite often as a result. When an application is done with a form, it destroys the form and all of the components the form contains. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "The component which caused the form to stop running.
") (prototype . "resource newt_run_form(resource $form)") (purpose . "Runs a form") (id . "function.newt-run-form")) "newt_resume" ((documentation . "Resume using the newt interface after calling newt_suspend void newt_resume() No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "Note:
Notice that this function doesn't fit in with newt's normal naming convention. It is an older interface which will not work for all forms. It was left in newt only for legacy applications. It is a simpler interface than the new newt_form_run though, and is still used quite often as a result. When an application is done with a form, it destroys the form and all of the components the form contains.
No value is returned.
") (prototype . "void newt_resume()") (purpose . "Resume using the newt interface after calling newt_suspend") (id . "function.newt-resume")) "newt_resize_screen" ((documentation . " void newt_resize_screen([bool $redraw = '']) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_resize_screen([bool $redraw = ''])") (purpose . "") (id . "function.newt-resize-screen")) "newt_refresh" ((documentation . "Updates modified portions of the screen void newt_refresh() No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_refresh()") (purpose . "Updates modified portions of the screen") (id . "function.newt-refresh")) "newt_reflow_text" ((documentation . " string newt_reflow_text(string $text, int $width, int $flex_down, int $flex_up, int $actual_width, int $actual_height) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "") (prototype . "string newt_reflow_text(string $text, int $width, int $flex_down, int $flex_up, int $actual_width, int $actual_height)") (purpose . "") (id . "function.newt-reflow-text")) "newt_redraw_help_line" ((documentation . " void newt_redraw_help_line() No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
No value is returned.
") (prototype . "void newt_redraw_help_line()") (purpose . "") (id . "function.newt-redraw-help-line")) "newt_radiobutton" ((documentation . " resource newt_radiobutton(int $left, int $top, string $text, bool $is_default [, resource $prev_button = '']) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "") (prototype . "resource newt_radiobutton(int $left, int $top, string $text, bool $is_default [, resource $prev_button = ''])") (purpose . "") (id . "function.newt-radiobutton")) "newt_radio_get_current" ((documentation . " resource newt_radio_get_current(resource $set_member) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
") (prototype . "resource newt_radio_get_current(resource $set_member)") (purpose . "") (id . "function.newt-radio-get-current")) "newt_push_help_line" ((documentation . "Saves the current help line on a stack, and displays the new line void newt_push_help_line([string $text = '']) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
No value is returned.
") (prototype . "void newt_push_help_line([string $text = ''])") (purpose . "Saves the current help line on a stack, and displays the new line") (id . "function.newt-push-help-line")) "newt_pop_window" ((documentation . "Removes the top window from the display void newt_pop_window() No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_pop_window()") (purpose . "Removes the top window from the display") (id . "function.newt-pop-window")) "newt_pop_help_line" ((documentation . "Replaces the current help line with the one from the stack void newt_pop_help_line() No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_pop_help_line()") (purpose . "Replaces the current help line with the one from the stack") (id . "function.newt-pop-help-line")) "newt_open_window" ((documentation . "Open a window of the specified size and position int newt_open_window(int $left, int $top, int $width, int $height [, string $title = '']) Returns 1 on success, 0 on failure. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "Returns 1 on success, 0 on failure.
") (prototype . "int newt_open_window(int $left, int $top, int $width, int $height [, string $title = ''])") (purpose . "Open a window of the specified size and position") (id . "function.newt-open-window")) "newt_listitem" ((documentation . " resource newt_listitem(int $left, int $top, string $text, bool $is_default, resouce $prev_item, mixed $data [, int $flags = '']) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "") (prototype . "resource newt_listitem(int $left, int $top, string $text, bool $is_default, resouce $prev_item, mixed $data [, int $flags = ''])") (purpose . "") (id . "function.newt-listitem")) "newt_listitem_set" ((documentation . " void newt_listitem_set(resource $item, string $text) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
No value is returned.
") (prototype . "void newt_listitem_set(resource $item, string $text)") (purpose . "") (id . "function.newt-listitem-set")) "newt_listitem_get_data" ((documentation . " mixed newt_listitem_get_data(resource $item) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "") (prototype . "mixed newt_listitem_get_data(resource $item)") (purpose . "") (id . "function.newt-listitem-get-data")) "newt_listbox" ((documentation . " resource newt_listbox(int $left, int $top, int $height [, int $flags = '']) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
") (prototype . "resource newt_listbox(int $left, int $top, int $height [, int $flags = ''])") (purpose . "") (id . "function.newt-listbox")) "newt_listbox_set_width" ((documentation . " void newt_listbox_set_width(resource $listbox, int $width) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
No value is returned.
") (prototype . "void newt_listbox_set_width(resource $listbox, int $width)") (purpose . "") (id . "function.newt-listbox-set-width")) "newt_listbox_set_entry" ((documentation . " void newt_listbox_set_entry(resource $listbox, int $num, string $text) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_listbox_set_entry(resource $listbox, int $num, string $text)") (purpose . "") (id . "function.newt-listbox-set-entry")) "newt_listbox_set_data" ((documentation . " void newt_listbox_set_data(resource $listbox, int $num, mixed $data) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_listbox_set_data(resource $listbox, int $num, mixed $data)") (purpose . "") (id . "function.newt-listbox-set-data")) "newt_listbox_set_current" ((documentation . " void newt_listbox_set_current(resource $listbox, int $num) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_listbox_set_current(resource $listbox, int $num)") (purpose . "") (id . "function.newt-listbox-set-current")) "newt_listbox_set_current_by_key" ((documentation . " void newt_listbox_set_current_by_key(resource $listbox, mixed $key) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_listbox_set_current_by_key(resource $listbox, mixed $key)") (purpose . "") (id . "function.newt-listbox-set-current-by-key")) "newt_listbox_select_item" ((documentation . " void newt_listbox_select_item(resource $listbox, mixed $key, int $sense) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_listbox_select_item(resource $listbox, mixed $key, int $sense)") (purpose . "") (id . "function.newt-listbox-select-item")) "newt_listbox_item_count" ((documentation . " int newt_listbox_item_count(resource $listbox) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "") (prototype . "int newt_listbox_item_count(resource $listbox)") (purpose . "") (id . "function.newt-listbox-item-count")) "newt_listbox_insert_entry" ((documentation . " void newt_listbox_insert_entry(resource $listbox, string $text, mixed $data, mixed $key) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
No value is returned.
") (prototype . "void newt_listbox_insert_entry(resource $listbox, string $text, mixed $data, mixed $key)") (purpose . "") (id . "function.newt-listbox-insert-entry")) "newt_listbox_get_selection" ((documentation . " array newt_listbox_get_selection(resource $listbox) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "") (prototype . "array newt_listbox_get_selection(resource $listbox)") (purpose . "") (id . "function.newt-listbox-get-selection")) "newt_listbox_get_current" ((documentation . " string newt_listbox_get_current(resource $listbox) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
") (prototype . "string newt_listbox_get_current(resource $listbox)") (purpose . "") (id . "function.newt-listbox-get-current")) "newt_listbox_delete_entry" ((documentation . " void newt_listbox_delete_entry(resource $listbox, mixed $key) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
No value is returned.
") (prototype . "void newt_listbox_delete_entry(resource $listbox, mixed $key)") (purpose . "") (id . "function.newt-listbox-delete-entry")) "newt_listbox_clear" ((documentation . " void newt_listbox_clear(resource $listobx) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_listbox_clear(resource $listobx)") (purpose . "") (id . "function.newt-listbox-clear")) "newt_listbox_clear_selection" ((documentation . " void newt_listbox_clear_selection(resource $listbox) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_listbox_clear_selection(resource $listbox)") (purpose . "") (id . "function.newt-listbox-clear-selection")) "newt_listbox_append_entry" ((documentation . " void newt_listbox_append_entry(resource $listbox, string $text, mixed $data) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_listbox_append_entry(resource $listbox, string $text, mixed $data)") (purpose . "") (id . "function.newt-listbox-append-entry")) "newt_label" ((documentation . " resource newt_label(int $left, int $top, string $text) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "") (prototype . "resource newt_label(int $left, int $top, string $text)") (purpose . "") (id . "function.newt-label")) "newt_label_set_text" ((documentation . " void newt_label_set_text(resource $label, string $text) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
No value is returned.
") (prototype . "void newt_label_set_text(resource $label, string $text)") (purpose . "") (id . "function.newt-label-set-text")) "newt_init" ((documentation . "Initialize newt int newt_init() Returns 1 on success, 0 on failure. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "Returns 1 on success, 0 on failure.
") (prototype . "int newt_init()") (purpose . "Initialize newt") (id . "function.newt-init")) "newt_grid_wrapped_window" ((documentation . " void newt_grid_wrapped_window(resource $grid, string $title) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_grid_wrapped_window(resource $grid, string $title)") (purpose . "") (id . "function.newt-grid-wrapped-window")) "newt_grid_wrapped_window_at" ((documentation . " void newt_grid_wrapped_window_at(resource $grid, string $title, int $left, int $top) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_grid_wrapped_window_at(resource $grid, string $title, int $left, int $top)") (purpose . "") (id . "function.newt-grid-wrapped-window-at")) "newt_grid_v_stacked" ((documentation . " resource newt_grid_v_stacked(int $element1_type, resource $element1 [, resource $... = '']) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "") (prototype . "resource newt_grid_v_stacked(int $element1_type, resource $element1 [, resource $... = ''])") (purpose . "") (id . "function.newt-grid-v-stacked")) "newt_grid_v_close_stacked" ((documentation . " resource newt_grid_v_close_stacked(int $element1_type, resource $element1 [, resource $... = '']) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
") (prototype . "resource newt_grid_v_close_stacked(int $element1_type, resource $element1 [, resource $... = ''])") (purpose . "") (id . "function.newt-grid-v-close-stacked")) "newt_grid_simple_window" ((documentation . " resource newt_grid_simple_window(resource $text, resource $middle, resource $buttons) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
") (prototype . "resource newt_grid_simple_window(resource $text, resource $middle, resource $buttons)") (purpose . "") (id . "function.newt-grid-simple-window")) "newt_grid_set_field" ((documentation . " void newt_grid_set_field(resource $grid, int $col, int $row, int $type, resource $val, int $pad_left, int $pad_top, int $pad_right, int $pad_bottom, int $anchor [, int $flags = '']) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
No value is returned.
") (prototype . "void newt_grid_set_field(resource $grid, int $col, int $row, int $type, resource $val, int $pad_left, int $pad_top, int $pad_right, int $pad_bottom, int $anchor [, int $flags = ''])") (purpose . "") (id . "function.newt-grid-set-field")) "newt_grid_place" ((documentation . " void newt_grid_place(resource $grid, int $left, int $top) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_grid_place(resource $grid, int $left, int $top)") (purpose . "") (id . "function.newt-grid-place")) "newt_grid_h_stacked" ((documentation . " resource newt_grid_h_stacked(int $element1_type, resource $element1 [, resource $... = '']) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "") (prototype . "resource newt_grid_h_stacked(int $element1_type, resource $element1 [, resource $... = ''])") (purpose . "") (id . "function.newt-grid-h-stacked")) "newt_grid_h_close_stacked" ((documentation . " resource newt_grid_h_close_stacked(int $element1_type, resource $element1 [, resource $... = '']) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
") (prototype . "resource newt_grid_h_close_stacked(int $element1_type, resource $element1 [, resource $... = ''])") (purpose . "") (id . "function.newt-grid-h-close-stacked")) "newt_grid_get_size" ((documentation . " void newt_grid_get_size(resouce $grid, int $width, int $height) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
No value is returned.
") (prototype . "void newt_grid_get_size(resouce $grid, int $width, int $height)") (purpose . "") (id . "function.newt-grid-get-size")) "newt_grid_free" ((documentation . " void newt_grid_free(resource $grid, bool $recurse) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_grid_free(resource $grid, bool $recurse)") (purpose . "") (id . "function.newt-grid-free")) "newt_grid_basic_window" ((documentation . " resource newt_grid_basic_window(resource $text, resource $middle, resource $buttons) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "") (prototype . "resource newt_grid_basic_window(resource $text, resource $middle, resource $buttons)") (purpose . "") (id . "function.newt-grid-basic-window")) "newt_grid_add_components_to_form" ((documentation . " void newt_grid_add_components_to_form(resource $grid, resource $form, bool $recurse) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
No value is returned.
") (prototype . "void newt_grid_add_components_to_form(resource $grid, resource $form, bool $recurse)") (purpose . "") (id . "function.newt-grid-add-components-to-form")) "newt_get_screen_size" ((documentation . "Fills in the passed references with the current size of the terminal void newt_get_screen_size(int $cols, int $rows) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_get_screen_size(int $cols, int $rows)") (purpose . "Fills in the passed references with the current size of the terminal") (id . "function.newt-get-screen-size")) "newt_form" ((documentation . "Create a form resource newt_form([resource $vert_bar = '' [, string $help = '' [, int $flags = '']]]) Returns a resource link to the created form component, or FALSE on error. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . " Returns a resource link to the created form component, or FALSE on error.
No value is returned.
") (prototype . "void newt_form_watch_fd(resource $form, resource $stream [, int $flags = ''])") (purpose . "") (id . "function.newt-form-watch-fd")) "newt_form_set_width" ((documentation . " void newt_form_set_width(resource $form, int $width) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_form_set_width(resource $form, int $width)") (purpose . "") (id . "function.newt-form-set-width")) "newt_form_set_timer" ((documentation . " void newt_form_set_timer(resource $form, int $milliseconds) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_form_set_timer(resource $form, int $milliseconds)") (purpose . "") (id . "function.newt-form-set-timer")) "newt_form_set_size" ((documentation . " void newt_form_set_size(resource $form) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_form_set_size(resource $form)") (purpose . "") (id . "function.newt-form-set-size")) "newt_form_set_height" ((documentation . " void newt_form_set_height(resource $form, int $height) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_form_set_height(resource $form, int $height)") (purpose . "") (id . "function.newt-form-set-height")) "newt_form_set_background" ((documentation . " void newt_form_set_background(resource $from, int $background) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_form_set_background(resource $from, int $background)") (purpose . "") (id . "function.newt-form-set-background")) "newt_form_run" ((documentation . "Runs a form void newt_form_run(resource $form, array $exit_struct) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_form_run(resource $form, array $exit_struct)") (purpose . "Runs a form") (id . "function.newt-form-run")) "newt_form_get_current" ((documentation . " resource newt_form_get_current(resource $form) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "") (prototype . "resource newt_form_get_current(resource $form)") (purpose . "") (id . "function.newt-form-get-current")) "newt_form_destroy" ((documentation . "Destroys a form void newt_form_destroy(resource $form) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
No value is returned.
") (prototype . "void newt_form_destroy(resource $form)") (purpose . "Destroys a form") (id . "function.newt-form-destroy")) "newt_form_add_hot_key" ((documentation . " void newt_form_add_hot_key(resource $form, int $key) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_form_add_hot_key(resource $form, int $key)") (purpose . "") (id . "function.newt-form-add-hot-key")) "newt_form_add_components" ((documentation . "Add several components to the form void newt_form_add_components(resource $form, array $components) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_form_add_components(resource $form, array $components)") (purpose . "Add several components to the form") (id . "function.newt-form-add-components")) "newt_form_add_component" ((documentation . "Adds a single component to the form void newt_form_add_component(resource $form, resource $component) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_form_add_component(resource $form, resource $component)") (purpose . "Adds a single component to the form") (id . "function.newt-form-add-component")) "newt_finished" ((documentation . "Uninitializes newt interface int newt_finished() Returns 1 on success, 0 on failure. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "Returns 1 on success, 0 on failure.
") (prototype . "int newt_finished()") (purpose . "Uninitializes newt interface") (id . "function.newt-finished")) "newt_entry" ((documentation . " resource newt_entry(int $left, int $top, int $width [, string $init_value = '' [, int $flags = '']]) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "") (prototype . "resource newt_entry(int $left, int $top, int $width [, string $init_value = '' [, int $flags = '']])") (purpose . "") (id . "function.newt-entry")) "newt_entry_set" ((documentation . " void newt_entry_set(resource $entry, string $value [, bool $cursor_at_end = '']) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
No value is returned.
") (prototype . "void newt_entry_set(resource $entry, string $value [, bool $cursor_at_end = ''])") (purpose . "") (id . "function.newt-entry-set")) "newt_entry_set_flags" ((documentation . " void newt_entry_set_flags(resource $entry, int $flags, int $sense) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_entry_set_flags(resource $entry, int $flags, int $sense)") (purpose . "") (id . "function.newt-entry-set-flags")) "newt_entry_set_filter" ((documentation . " void newt_entry_set_filter(resource $entry, callable $filter, mixed $data) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_entry_set_filter(resource $entry, callable $filter, mixed $data)") (purpose . "") (id . "function.newt-entry-set-filter")) "newt_entry_get_value" ((documentation . " string newt_entry_get_value(resource $entry) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "") (prototype . "string newt_entry_get_value(resource $entry)") (purpose . "") (id . "function.newt-entry-get-value")) "newt_draw_root_text" ((documentation . "Displays the string text at the position indicated void newt_draw_root_text(int $left, int $top, string $text) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
No value is returned.
") (prototype . "void newt_draw_root_text(int $left, int $top, string $text)") (purpose . "Displays the string text at the position indicated") (id . "function.newt-draw-root-text")) "newt_draw_form" ((documentation . " void newt_draw_form(resource $form) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_draw_form(resource $form)") (purpose . "") (id . "function.newt-draw-form")) "newt_delay" ((documentation . " void newt_delay(int $microseconds) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_delay(int $microseconds)") (purpose . "") (id . "function.newt-delay")) "newt_cursor_on" ((documentation . " void newt_cursor_on() No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_cursor_on()") (purpose . "") (id . "function.newt-cursor-on")) "newt_cursor_off" ((documentation . " void newt_cursor_off() No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_cursor_off()") (purpose . "") (id . "function.newt-cursor-off")) "newt_create_grid" ((documentation . " resource newt_create_grid(int $cols, int $rows) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "") (prototype . "resource newt_create_grid(int $cols, int $rows)") (purpose . "") (id . "function.newt-create-grid")) "newt_component_takes_focus" ((documentation . " void newt_component_takes_focus(resource $component, bool $takes_focus) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
No value is returned.
") (prototype . "void newt_component_takes_focus(resource $component, bool $takes_focus)") (purpose . "") (id . "function.newt-component-takes-focus")) "newt_component_add_callback" ((documentation . " void newt_component_add_callback(resource $component, mixed $func_name, mixed $data) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_component_add_callback(resource $component, mixed $func_name, mixed $data)") (purpose . "") (id . "function.newt-component-add-callback")) "newt_compact_button" ((documentation . " resource newt_compact_button(int $left, int $top, string $text) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "") (prototype . "resource newt_compact_button(int $left, int $top, string $text)") (purpose . "") (id . "function.newt-compact-button")) "newt_cls" ((documentation . " void newt_cls() No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
No value is returned.
") (prototype . "void newt_cls()") (purpose . "") (id . "function.newt-cls")) "newt_clear_key_buffer" ((documentation . "Discards the contents of the terminal's input buffer without waiting for additional input void newt_clear_key_buffer() No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_clear_key_buffer()") (purpose . "Discards the contents of the terminal's input buffer without waiting for additional input") (id . "function.newt-clear-key-buffer")) "newt_checkbox" ((documentation . " resource newt_checkbox(int $left, int $top, string $text, string $def_value [, string $seq = '']) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "") (prototype . "resource newt_checkbox(int $left, int $top, string $text, string $def_value [, string $seq = ''])") (purpose . "") (id . "function.newt-checkbox")) "newt_checkbox_tree" ((documentation . " resource newt_checkbox_tree(int $left, int $top, int $height [, int $flags = '']) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
") (prototype . "resource newt_checkbox_tree(int $left, int $top, int $height [, int $flags = ''])") (purpose . "") (id . "function.newt-checkbox-tree")) "newt_checkbox_tree_set_width" ((documentation . " void newt_checkbox_tree_set_width(resource $checkbox_tree, int $width) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
No value is returned.
") (prototype . "void newt_checkbox_tree_set_width(resource $checkbox_tree, int $width)") (purpose . "") (id . "function.newt-checkbox-tree-set-width")) "newt_checkbox_tree_set_entry" ((documentation . " void newt_checkbox_tree_set_entry(resource $checkboxtree, mixed $data, string $text) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_checkbox_tree_set_entry(resource $checkboxtree, mixed $data, string $text)") (purpose . "") (id . "function.newt-checkbox-tree-set-entry")) "newt_checkbox_tree_set_entry_value" ((documentation . " void newt_checkbox_tree_set_entry_value(resource $checkboxtree, mixed $data, string $value) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_checkbox_tree_set_entry_value(resource $checkboxtree, mixed $data, string $value)") (purpose . "") (id . "function.newt-checkbox-tree-set-entry-value")) "newt_checkbox_tree_set_current" ((documentation . " void newt_checkbox_tree_set_current(resource $checkboxtree, mixed $data) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_checkbox_tree_set_current(resource $checkboxtree, mixed $data)") (purpose . "") (id . "function.newt-checkbox-tree-set-current")) "newt_checkbox_tree_multi" ((documentation . " resource newt_checkbox_tree_multi(int $left, int $top, int $height, string $seq [, int $flags = '']) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "") (prototype . "resource newt_checkbox_tree_multi(int $left, int $top, int $height, string $seq [, int $flags = ''])") (purpose . "") (id . "function.newt-checkbox-tree-multi")) "newt_checkbox_tree_get_selection" ((documentation . " array newt_checkbox_tree_get_selection(resource $checkboxtree) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
") (prototype . "array newt_checkbox_tree_get_selection(resource $checkboxtree)") (purpose . "") (id . "function.newt-checkbox-tree-get-selection")) "newt_checkbox_tree_get_multi_selection" ((documentation . " array newt_checkbox_tree_get_multi_selection(resource $checkboxtree, string $seqnum) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
") (prototype . "array newt_checkbox_tree_get_multi_selection(resource $checkboxtree, string $seqnum)") (purpose . "") (id . "function.newt-checkbox-tree-get-multi-selection")) "newt_checkbox_tree_get_entry_value" ((documentation . " string newt_checkbox_tree_get_entry_value(resource $checkboxtree, mixed $data) (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
") (prototype . "string newt_checkbox_tree_get_entry_value(resource $checkboxtree, mixed $data)") (purpose . "") (id . "function.newt-checkbox-tree-get-entry-value")) "newt_checkbox_tree_get_current" ((documentation . "Returns checkbox tree selected item mixed newt_checkbox_tree_get_current(resource $checkboxtree) Returns current (selected) checkbox tree item. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "
Returns current (selected) checkbox tree item.
") (prototype . "mixed newt_checkbox_tree_get_current(resource $checkboxtree)") (purpose . "Returns checkbox tree selected item") (id . "function.newt-checkbox-tree-get-current")) "newt_checkbox_tree_find_item" ((documentation . "Finds an item in the checkbox tree array newt_checkbox_tree_find_item(resource $checkboxtree, mixed $data) Returns checkbox tree item resource, or NULL if it wasn't found. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . " Returns checkbox tree item resource, or NULL if it wasn't found.
No value is returned.
") (prototype . "void newt_checkbox_tree_add_item(resource $checkboxtree, string $text, mixed $data, int $flags, int $index [, int $... = ''])") (purpose . "Adds new item to the checkbox tree") (id . "function.newt-checkbox-tree-add-item")) "newt_checkbox_set_value" ((documentation . "Sets the value of the checkbox void newt_checkbox_set_value(resource $checkbox, string $value) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_checkbox_set_value(resource $checkbox, string $value)") (purpose . "Sets the value of the checkbox") (id . "function.newt-checkbox-set-value")) "newt_checkbox_set_flags" ((documentation . "Configures checkbox resource void newt_checkbox_set_flags(resource $checkbox, int $flags, int $sense) No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_checkbox_set_flags(resource $checkbox, int $flags, int $sense)") (purpose . "Configures checkbox resource") (id . "function.newt-checkbox-set-flags")) "newt_checkbox_get_value" ((documentation . "Retreives value of checkox resource string newt_checkbox_get_value(resource $checkbox) Returns character indicating the value of the checkbox. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "Returns character indicating the value of the checkbox.
") (prototype . "string newt_checkbox_get_value(resource $checkbox)") (purpose . "Retreives value of checkox resource") (id . "function.newt-checkbox-get-value")) "newt_centered_window" ((documentation . "Open a centered window of the specified size int newt_centered_window(int $width, int $height [, string $title = '']) Undefined value. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "Undefined value.
") (prototype . "int newt_centered_window(int $width, int $height [, string $title = ''])") (purpose . "Open a centered window of the specified size") (id . "function.newt-centered-window")) "newt_button" ((documentation . "Create a new button resource newt_button(int $left, int $top, string $text) Returns a resource link to the created button component, or FALSE on error. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . " Returns a resource link to the created button component, or FALSE on error.
Returns grid containing the buttons created.
") (prototype . "resource newt_button_bar(array $buttons)") (purpose . "This function returns a grid containing the buttons created.") (id . "function.newt-button-bar")) "newt_bell" ((documentation . "Send a beep to the terminal void newt_bell() No value is returned. (PECL newt >= 0.1)") (versions . "PECL newt >= 0.1") (return . "No value is returned.
") (prototype . "void newt_bell()") (purpose . "Send a beep to the terminal") (id . "function.newt-bell")) "ncurses_wvline" ((documentation . "Draws a vertical line in a window at current position using an attributed character and max. n characters long int ncurses_wvline(resource $window, int $charattr, int $n) (PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_wvline(resource $window, int $charattr, int $n)") (purpose . "Draws a vertical line in a window at current position using an attributed character and max. n characters long") (id . "function.ncurses-wvline")) "ncurses_wstandout" ((documentation . "Enter standout mode for a window int ncurses_wstandout(resource $window) (PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_wstandout(resource $window)") (purpose . "Enter standout mode for a window") (id . "function.ncurses-wstandout")) "ncurses_wstandend" ((documentation . "End standout mode for a window int ncurses_wstandend(resource $window) (PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_wstandend(resource $window)") (purpose . "End standout mode for a window") (id . "function.ncurses-wstandend")) "ncurses_wrefresh" ((documentation . "Refresh window on terminal screen int ncurses_wrefresh(resource $window) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_wrefresh(resource $window)") (purpose . "Refresh window on terminal screen") (id . "function.ncurses-wrefresh")) "ncurses_wnoutrefresh" ((documentation . "Copies window to virtual screen int ncurses_wnoutrefresh(resource $window) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_wnoutrefresh(resource $window)") (purpose . "Copies window to virtual screen") (id . "function.ncurses-wnoutrefresh")) "ncurses_wmove" ((documentation . "Moves windows output position int ncurses_wmove(resource $window, int $y, int $x) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_wmove(resource $window, int $y, int $x)") (purpose . "Moves windows output position") (id . "function.ncurses-wmove")) "ncurses_wmouse_trafo" ((documentation . "Transforms window/stdscr coordinates bool ncurses_wmouse_trafo(resource $window, int $y, int $x, bool $toscreen) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "bool ncurses_wmouse_trafo(resource $window, int $y, int $x, bool $toscreen)") (purpose . "Transforms window/stdscr coordinates") (id . "function.ncurses-wmouse-trafo")) "ncurses_whline" ((documentation . "Draws a horizontal line in a window at current position using an attributed character and max. n characters long int ncurses_whline(resource $window, int $charattr, int $n) (PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_whline(resource $window, int $charattr, int $n)") (purpose . "Draws a horizontal line in a window at current position using an attributed character and max. n characters long") (id . "function.ncurses-whline")) "ncurses_wgetch" ((documentation . "Reads a character from keyboard (window) int ncurses_wgetch(resource $window) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_wgetch(resource $window)") (purpose . "Reads a character from keyboard (window)") (id . "function.ncurses-wgetch")) "ncurses_werase" ((documentation . "Erase window contents int ncurses_werase(resource $window) (PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_werase(resource $window)") (purpose . "Erase window contents") (id . "function.ncurses-werase")) "ncurses_wcolor_set" ((documentation . "Sets windows color pairings int ncurses_wcolor_set(resource $window, int $color_pair) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_wcolor_set(resource $window, int $color_pair)") (purpose . "Sets windows color pairings") (id . "function.ncurses-wcolor-set")) "ncurses_wclear" ((documentation . "Clears window int ncurses_wclear(resource $window) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_wclear(resource $window)") (purpose . "Clears window") (id . "function.ncurses-wclear")) "ncurses_wborder" ((documentation . "Draws a border around the window using attributed characters int ncurses_wborder(resource $window, int $left, int $right, int $top, int $bottom, int $tl_corner, int $tr_corner, int $bl_corner, int $br_corner) (PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_wborder(resource $window, int $left, int $right, int $top, int $bottom, int $tl_corner, int $tr_corner, int $bl_corner, int $br_corner)") (purpose . "Draws a border around the window using attributed characters") (id . "function.ncurses-wborder")) "ncurses_wattrset" ((documentation . "Set the attributes for a window int ncurses_wattrset(resource $window, int $attrs) (PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_wattrset(resource $window, int $attrs)") (purpose . "Set the attributes for a window") (id . "function.ncurses-wattrset")) "ncurses_wattron" ((documentation . "Turns on attributes for a window int ncurses_wattron(resource $window, int $attrs) (PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_wattron(resource $window, int $attrs)") (purpose . "Turns on attributes for a window") (id . "function.ncurses-wattron")) "ncurses_wattroff" ((documentation . "Turns off attributes for a window int ncurses_wattroff(resource $window, int $attrs) (PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_wattroff(resource $window, int $attrs)") (purpose . "Turns off attributes for a window") (id . "function.ncurses-wattroff")) "ncurses_waddstr" ((documentation . "Outputs text at current postion in window int ncurses_waddstr(resource $window, string $str [, int $n = '']) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_waddstr(resource $window, string $str [, int $n = ''])") (purpose . "Outputs text at current postion in window") (id . "function.ncurses-waddstr")) "ncurses_waddch" ((documentation . "Adds character at current position in a window and advance cursor int ncurses_waddch(resource $window, int $ch) (PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_waddch(resource $window, int $ch)") (purpose . "Adds character at current position in a window and advance cursor") (id . "function.ncurses-waddch")) "ncurses_vline" ((documentation . "Draw a vertical line at current position using an attributed character and max. n characters long int ncurses_vline(int $charattr, int $n) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_vline(int $charattr, int $n)") (purpose . "Draw a vertical line at current position using an attributed character and max. n characters long") (id . "function.ncurses-vline")) "ncurses_vidattr" ((documentation . "Display the string on the terminal in the video attribute mode int ncurses_vidattr(int $intarg) (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_vidattr(int $intarg)") (purpose . "Display the string on the terminal in the video attribute mode") (id . "function.ncurses-vidattr")) "ncurses_use_extended_names" ((documentation . "Control use of extended names in terminfo descriptions int ncurses_use_extended_names(bool $flag) (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_use_extended_names(bool $flag)") (purpose . "Control use of extended names in terminfo descriptions") (id . "function.ncurses-use-extended-names")) "ncurses_use_env" ((documentation . "Control use of environment information about terminal size void ncurses_use_env(bool $flag) (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "void ncurses_use_env(bool $flag)") (purpose . "Control use of environment information about terminal size") (id . "function.ncurses-use-env")) "ncurses_use_default_colors" ((documentation . "Assign terminal default colors to color id -1 bool ncurses_use_default_colors() (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "bool ncurses_use_default_colors()") (purpose . "Assign terminal default colors to color id -1") (id . "function.ncurses-use-default-colors")) "ncurses_update_panels" ((documentation . "Refreshes the virtual screen to reflect the relations between panels in the stack void ncurses_update_panels() (PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "void ncurses_update_panels()") (purpose . "Refreshes the virtual screen to reflect the relations between panels in the stack") (id . "function.ncurses-update-panels")) "ncurses_ungetmouse" ((documentation . "Pushes mouse event to queue bool ncurses_ungetmouse(array $mevent) Returns FALSE on success, TRUE otherwise. (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . " Returns FALSE on success, TRUE otherwise.
Returns the shortname of the terminal, truncated to 14 characters. On errors, returns NULL.
Returns 0 on success, or -1 if the color table could not be allocated or ncurses was not initialized.
") (prototype . "int ncurses_start_color()") (purpose . "Initializes color functionality") (id . "function.ncurses-start-color")) "ncurses_standout" ((documentation . "Start using 'standout' attribute int ncurses_standout() (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_standout()") (purpose . "Start using 'standout' attribute") (id . "function.ncurses-standout")) "ncurses_standend" ((documentation . "Stop using 'standout' attribute int ncurses_standend() (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_standend()") (purpose . "Stop using 'standout' attribute") (id . "function.ncurses-standend")) "ncurses_slk_touch" ((documentation . "Forces output when ncurses_slk_noutrefresh is performed int ncurses_slk_touch() (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_slk_touch()") (purpose . "Forces output when ncurses_slk_noutrefresh is performed") (id . "function.ncurses-slk-touch")) "ncurses_slk_set" ((documentation . "Sets function key labels bool ncurses_slk_set(int $labelnr, string $label, int $format) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "bool ncurses_slk_set(int $labelnr, string $label, int $format)") (purpose . "Sets function key labels") (id . "function.ncurses-slk-set")) "ncurses_slk_restore" ((documentation . "Restores soft label keys int ncurses_slk_restore() (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_slk_restore()") (purpose . "Restores soft label keys") (id . "function.ncurses-slk-restore")) "ncurses_slk_refresh" ((documentation . "Copies soft label keys to screen int ncurses_slk_refresh() (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_slk_refresh()") (purpose . "Copies soft label keys to screen") (id . "function.ncurses-slk-refresh")) "ncurses_slk_noutrefresh" ((documentation . "Copies soft label keys to virtual screen bool ncurses_slk_noutrefresh() (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "bool ncurses_slk_noutrefresh()") (purpose . "Copies soft label keys to virtual screen") (id . "function.ncurses-slk-noutrefresh")) "ncurses_slk_init" ((documentation . "Initializes soft label key functions bool ncurses_slk_init(int $format) Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on errors, FALSE otherwise.
The attribute, as an integer.
") (prototype . "int ncurses_slk_attr()") (purpose . "Returns current soft label key attribute") (id . "function.ncurses-slk-attr")) "ncurses_show_panel" ((documentation . "Places an invisible panel on top of the stack, making it visible int ncurses_show_panel(resource $panel) (PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_show_panel(resource $panel)") (purpose . "Places an invisible panel on top of the stack, making it visible") (id . "function.ncurses-show-panel")) "ncurses_scrl" ((documentation . "Scroll window content up or down without changing current position int ncurses_scrl(int $count) (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_scrl(int $count)") (purpose . "Scroll window content up or down without changing current position") (id . "function.ncurses-scrl")) "ncurses_scr_set" ((documentation . "Inherit screen from file dump int ncurses_scr_set(string $filename) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_scr_set(string $filename)") (purpose . "Inherit screen from file dump") (id . "function.ncurses-scr-set")) "ncurses_scr_restore" ((documentation . "Restore screen from file dump int ncurses_scr_restore(string $filename) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_scr_restore(string $filename)") (purpose . "Restore screen from file dump") (id . "function.ncurses-scr-restore")) "ncurses_scr_init" ((documentation . "Initialize screen from file dump int ncurses_scr_init(string $filename) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_scr_init(string $filename)") (purpose . "Initialize screen from file dump") (id . "function.ncurses-scr-init")) "ncurses_scr_dump" ((documentation . "Dump screen content to file int ncurses_scr_dump(string $filename) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_scr_dump(string $filename)") (purpose . "Dump screen content to file") (id . "function.ncurses-scr-dump")) "ncurses_savetty" ((documentation . "Saves terminal state bool ncurses_savetty() Always returns FALSE. (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . " Always returns FALSE.
Always returns FALSE.
Returns TRUE if any error occurred, otherwise FALSE.
If panel is null, returns the bottom panel in the stack.
") (prototype . "resource ncurses_panel_above(resource $panel)") (purpose . "Returns the panel above panel") (id . "function.ncurses-panel-above")) "ncurses_pair_content" ((documentation . "Retrieves foreground and background colors of a color pair int ncurses_pair_content(int $pair, int $f, int $b) Returns -1 if the function was successful, and 0 if ncurses or terminal color capabilities have not been initialized. (PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "Returns -1 if the function was successful, and 0 if ncurses or terminal color capabilities have not been initialized.
") (prototype . "int ncurses_pair_content(int $pair, int $f, int $b)") (purpose . "Retrieves foreground and background colors of a color pair") (id . "function.ncurses-pair-content")) "ncurses_noraw" ((documentation . "Switch terminal out of raw mode bool ncurses_noraw() Returns TRUE if any error occurred, otherwise FALSE. (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . " Returns TRUE if any error occurred, otherwise FALSE.
Returns TRUE if any error occurred, FALSE otherwise.
Returns TRUE if any error occurred, otherwise FALSE.
Returns a resource ID for the new window.
") (prototype . "resource ncurses_newwin(int $rows, int $cols, int $y, int $x)") (purpose . "Create a new window") (id . "function.ncurses-newwin")) "ncurses_newpad" ((documentation . "Creates a new pad (window) resource ncurses_newpad(int $rows, int $cols) (PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "resource ncurses_newpad(int $rows, int $cols)") (purpose . "Creates a new pad (window)") (id . "function.ncurses-newpad")) "ncurses_new_panel" ((documentation . "Create a new panel and associate it with window resource ncurses_new_panel(resource $window) (PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "resource ncurses_new_panel(resource $window)") (purpose . "Create a new panel and associate it with window") (id . "function.ncurses-new-panel")) "ncurses_napms" ((documentation . "Sleep int ncurses_napms(int $milliseconds) (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_napms(int $milliseconds)") (purpose . "Sleep") (id . "function.ncurses-napms")) "ncurses_mvwaddstr" ((documentation . "Add string at new position in window int ncurses_mvwaddstr(resource $window, int $y, int $x, string $text) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_mvwaddstr(resource $window, int $y, int $x, string $text)") (purpose . "Add string at new position in window") (id . "function.ncurses-mvwaddstr")) "ncurses_mvvline" ((documentation . "Set new position and draw a vertical line using an attributed character and max. n characters long int ncurses_mvvline(int $y, int $x, int $attrchar, int $n) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_mvvline(int $y, int $x, int $attrchar, int $n)") (purpose . "Set new position and draw a vertical line using an attributed character and max. n characters long") (id . "function.ncurses-mvvline")) "ncurses_mvinch" ((documentation . "Move position and get attributed character at new position int ncurses_mvinch(int $y, int $x) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_mvinch(int $y, int $x)") (purpose . "Move position and get attributed character at new position") (id . "function.ncurses-mvinch")) "ncurses_mvhline" ((documentation . "Set new position and draw a horizontal line using an attributed character and max. n characters long int ncurses_mvhline(int $y, int $x, int $attrchar, int $n) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_mvhline(int $y, int $x, int $attrchar, int $n)") (purpose . "Set new position and draw a horizontal line using an attributed character and max. n characters long") (id . "function.ncurses-mvhline")) "ncurses_mvgetch" ((documentation . "Move position and get character at new position int ncurses_mvgetch(int $y, int $x) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_mvgetch(int $y, int $x)") (purpose . "Move position and get character at new position") (id . "function.ncurses-mvgetch")) "ncurses_mvdelch" ((documentation . "Move position and delete character, shift rest of line left int ncurses_mvdelch(int $y, int $x) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_mvdelch(int $y, int $x)") (purpose . "Move position and delete character, shift rest of line left") (id . "function.ncurses-mvdelch")) "ncurses_mvcur" ((documentation . "Move cursor immediately int ncurses_mvcur(int $old_y, int $old_x, int $new_y, int $new_x) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_mvcur(int $old_y, int $old_x, int $new_y, int $new_x)") (purpose . "Move cursor immediately") (id . "function.ncurses-mvcur")) "ncurses_mvaddstr" ((documentation . "Move position and add string int ncurses_mvaddstr(int $y, int $x, string $s) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_mvaddstr(int $y, int $x, string $s)") (purpose . "Move position and add string") (id . "function.ncurses-mvaddstr")) "ncurses_mvaddnstr" ((documentation . "Move position and add string with specified length int ncurses_mvaddnstr(int $y, int $x, string $s, int $n) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_mvaddnstr(int $y, int $x, string $s, int $n)") (purpose . "Move position and add string with specified length") (id . "function.ncurses-mvaddnstr")) "ncurses_mvaddchstr" ((documentation . "Move position and add attributed string int ncurses_mvaddchstr(int $y, int $x, string $s) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_mvaddchstr(int $y, int $x, string $s)") (purpose . "Move position and add attributed string") (id . "function.ncurses-mvaddchstr")) "ncurses_mvaddchnstr" ((documentation . "Move position and add attributed string with specified length int ncurses_mvaddchnstr(int $y, int $x, string $s, int $n) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_mvaddchnstr(int $y, int $x, string $s, int $n)") (purpose . "Move position and add attributed string with specified length") (id . "function.ncurses-mvaddchnstr")) "ncurses_mvaddch" ((documentation . "Move current position and add character int ncurses_mvaddch(int $y, int $x, int $c) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_mvaddch(int $y, int $x, int $c)") (purpose . "Move current position and add character") (id . "function.ncurses-mvaddch")) "ncurses_move" ((documentation . "Move output position int ncurses_move(int $y, int $x) (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_move(int $y, int $x)") (purpose . "Move output position") (id . "function.ncurses-move")) "ncurses_move_panel" ((documentation . "Moves a panel so that its upper-left corner is at [startx, starty] int ncurses_move_panel(resource $panel, int $startx, int $starty) (PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_move_panel(resource $panel, int $startx, int $starty)") (purpose . "Moves a panel so that its upper-left corner is at [startx, starty]") (id . "function.ncurses-move-panel")) "ncurses_mousemask" ((documentation . "Sets mouse options int ncurses_mousemask(int $newmask, int $oldmask) Returns a mask to indicated which of the in parameter newmask specified mouse events can be reported. On complete failure, it returns 0. (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . " Returns a mask to indicated which of the in parameter newmask specified mouse events can be reported. On complete failure, it returns 0.
Returns the description, as a string truncated to 128 characters. On errors, returns NULL.
Returns the kill character, as a string.
") (prototype . "string ncurses_killchar()") (purpose . "Returns current line kill character") (id . "function.ncurses-killchar")) "ncurses_keypad" ((documentation . "Turns keypad on or off int ncurses_keypad(resource $window, bool $bf) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_keypad(resource $window, bool $bf)") (purpose . "Turns keypad on or off") (id . "function.ncurses-keypad")) "ncurses_keyok" ((documentation . "Enable or disable a keycode int ncurses_keyok(int $keycode, bool $enable) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_keyok(int $keycode, bool $enable)") (purpose . "Enable or disable a keycode") (id . "function.ncurses-keyok")) "ncurses_isendwin" ((documentation . "Ncurses is in endwin mode, normal screen output may be performed bool ncurses_isendwin() Returns TRUE, if ncurses_end has been called without any subsequent calls to ncurses_wrefresh, FALSE otherwise. (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . " Returns TRUE, if ncurses_end has been called without any subsequent calls to ncurses_wrefresh, FALSE otherwise.
Returns the number of characters.
") (prototype . "int ncurses_instr(string $buffer)") (purpose . "Reads string from terminal screen") (id . "function.ncurses-instr")) "ncurses_insstr" ((documentation . "Insert string at current position, moving rest of line right int ncurses_insstr(string $text) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_insstr(string $text)") (purpose . "Insert string at current position, moving rest of line right") (id . "function.ncurses-insstr")) "ncurses_insertln" ((documentation . "Insert a line, move rest of screen down int ncurses_insertln() (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_insertln()") (purpose . "Insert a line, move rest of screen down") (id . "function.ncurses-insertln")) "ncurses_insdelln" ((documentation . "Insert lines before current line scrolling down (negative numbers delete and scroll up) int ncurses_insdelln(int $count) (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_insdelln(int $count)") (purpose . "Insert lines before current line scrolling down (negative numbers delete and scroll up)") (id . "function.ncurses-insdelln")) "ncurses_insch" ((documentation . "Insert character moving rest of line including character at current position int ncurses_insch(int $character) (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_insch(int $character)") (purpose . "Insert character moving rest of line including character at current position") (id . "function.ncurses-insch")) "ncurses_init" ((documentation . "Initialize ncurses void ncurses_init() No value is returned. (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "No value is returned.
") (prototype . "void ncurses_init()") (purpose . "Initialize ncurses") (id . "function.ncurses-init")) "ncurses_init_pair" ((documentation . "Define a color pair int ncurses_init_pair(int $pair, int $fg, int $bg) Returns -1 if the function was successful, and 0 if ncurses or color support were not initialized. (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "Returns -1 if the function was successful, and 0 if ncurses or color support were not initialized.
") (prototype . "int ncurses_init_pair(int $pair, int $fg, int $bg)") (purpose . "Define a color pair") (id . "function.ncurses-init-pair")) "ncurses_init_color" ((documentation . "Define a terminal color int ncurses_init_color(int $color, int $r, int $g, int $b) Returns -1 if the function was successful, and 0 if ncurses or terminal color capabilities have not been initialized or the terminal does not have color changing capabilities. (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "Returns -1 if the function was successful, and 0 if ncurses or terminal color capabilities have not been initialized or the terminal does not have color changing capabilities.
") (prototype . "int ncurses_init_color(int $color, int $r, int $g, int $b)") (purpose . "Define a terminal color") (id . "function.ncurses-init-color")) "ncurses_inch" ((documentation . "Get character and attribute at current position string ncurses_inch() Returns the character, as a string. (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "Returns the character, as a string.
") (prototype . "string ncurses_inch()") (purpose . "Get character and attribute at current position") (id . "function.ncurses-inch")) "ncurses_hline" ((documentation . "Draw a horizontal line at current position using an attributed character and max. n characters long int ncurses_hline(int $charattr, int $n) (PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_hline(int $charattr, int $n)") (purpose . "Draw a horizontal line at current position using an attributed character and max. n characters long") (id . "function.ncurses-hline")) "ncurses_hide_panel" ((documentation . "Remove panel from the stack, making it invisible int ncurses_hide_panel(resource $panel) (PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_hide_panel(resource $panel)") (purpose . "Remove panel from the stack, making it invisible") (id . "function.ncurses-hide-panel")) "ncurses_has_key" ((documentation . "Check for presence of a function key on terminal keyboard int ncurses_has_key(int $keycode) (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_has_key(int $keycode)") (purpose . "Check for presence of a function key on terminal keyboard") (id . "function.ncurses-has-key")) "ncurses_has_il" ((documentation . "Check for line insert- and delete-capabilities bool ncurses_has_il() Returns TRUE if the terminal has insert/delete-line capabilities, FALSE otherwise. (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . " Returns TRUE if the terminal has insert/delete-line capabilities, FALSE otherwise.
Returns TRUE if the terminal has insert/delete-capabilities, FALSE otherwise.
Return TRUE if the terminal has color capabilities, FALSE otherwise.
Returns FALSE if a mouse event is actually visible in the given window, otherwise returns TRUE.
No value is returned.
") (prototype . "void ncurses_getmaxyx(resource $window, int $y, int $x)") (purpose . "Returns the size of a window") (id . "function.ncurses-getmaxyx")) "ncurses_getch" ((documentation . "Read a character from keyboard int ncurses_getch() (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "") (prototype . "int ncurses_getch()") (purpose . "Read a character from keyboard") (id . "function.ncurses-getch")) "ncurses_flushinp" ((documentation . "Flush keyboard input buffer bool ncurses_flushinp() Returns FALSE on success, otherwise TRUE. (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . " Returns FALSE on success, otherwise TRUE.
Returns FALSE on success, otherwise TRUE.
The current erase char, as a string.
") (prototype . "string ncurses_erasechar()") (purpose . "Returns current erase character") (id . "function.ncurses-erasechar")) "ncurses_erase" ((documentation . "Erase terminal screen bool ncurses_erase() Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . " Returns TRUE on success or FALSE on failure.
Returns FALSE on success, TRUE if any error occurred.
Returns TRUE on success or FALSE on failure.
Returns FALSE on success, otherwise TRUE.
Returns FALSE on success, TRUE otherwise.
Returns FALSE on success, TRUE otherwise.
Returns FALSE on success, otherwise TRUE.
Returns -1 on success, and 0 on failure.
") (prototype . "int ncurses_color_set(int $pair)") (purpose . "Set active foreground and background colors") (id . "function.ncurses-color-set")) "ncurses_color_content" ((documentation . "Retrieves RGB components of a color int ncurses_color_content(int $color, int $r, int $g, int $b) Returns -1 if the function was successful, and 0 if ncurses or terminal color capabilities have not been initialized. (PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . "Returns -1 if the function was successful, and 0 if ncurses or terminal color capabilities have not been initialized.
") (prototype . "int ncurses_color_content(int $color, int $r, int $g, int $b)") (purpose . "Retrieves RGB components of a color") (id . "function.ncurses-color-content")) "ncurses_clrtoeol" ((documentation . "Clear screen from current position to end of line bool ncurses_clrtoeol() Returns TRUE on success or FALSE on failure. (PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0)") (versions . "PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE or NCURSES_ERR if any error occurred.
Return TRUE if the programmer can change color definitions, FALSE otherwise.
Returns error messages as string from failed radius functions.
") (prototype . "string radius_strerror(resource $radius_handle)") (purpose . "Returns an error message") (id . "function.radius-strerror")) "radius_server_secret" ((documentation . "Returns the shared secret string radius_server_secret(resource $radius_handle) Returns the server's shared secret as string, or FALSE on error. (PECL radius >= 1.1.0)") (versions . "PECL radius >= 1.1.0") (return . " Returns the server's shared secret as string, or FALSE on error.
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.
Returns the salt-encrypted data or FALSE on failure.
Returns the request authenticator as string, or FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns an associative array containing the attribute-type, vendor and the data, or FALSE on error.
Returns the tag from the tagged attribute or FALSE on failure.
Returns the data from the tagged attribute or FALSE on failure.
Returns an associative array containing the attribute-type and the data, or error number <= 0.
") (prototype . "mixed radius_get_attr(resource $radius_handle)") (purpose . "Extracts an attribute") (id . "function.radius-get-attr")) "radius_demangle" ((documentation . "Demangles data string radius_demangle(resource $radius_handle, string $mangled) Returns the demangled string, or FALSE on error. (PECL radius >= 1.2.0)") (versions . "PECL radius >= 1.2.0") (return . " Returns the demangled string, or FALSE on error.
Returns the demangled string, or FALSE on error.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns a handle on success, FALSE on error. This function only fails if insufficient memory is available.
Returns TRUE on success or FALSE on failure.
Returns a handle on success, FALSE on error. This function only fails if insufficient memory is available.
Returns TRUE on success or FALSE on failure.
Returns a KADM5 handle on success or FALSE on failure.
Returns array of principals on success or FALSE on failure.
Returns array of options containing the following keys: KADM5_PRINCIPAL, KADM5_PRINC_EXPIRE_TIME, KADM5_PW_EXPIRATION, KADM5_ATTRIBUTES, KADM5_MAX_LIFE, KADM5_MOD_NAME, KADM5_MOD_TIME, KADM5_KVNO, KADM5_POLICY, KADM5_MAX_RLIFE, KADM5_LAST_SUCCESS, KADM5_LAST_FAILED, KADM5_FAIL_AUTH_COUNT on success or FALSE on failure.
Returns array of policies on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns a stream resource on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the type associated with the property being retrieved or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns an Open AL(Source) resource on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns a float or array of floats (as appropriate) or FALSE on failure.
Returns an Open AL(Device) resource on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns an Open AL(Context) resource on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns an integer value appropriate to the property requested or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns an Open AL(Buffer) resource on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the version number of the ID3 tag of the file. As a tag can contain ID3 v1.x and v2.x tags, the return value of this function should be bitwise compared with the predefined constants ID3_V1_0, ID3_V1_1 and ID3_V2.
Returns an associative array with various keys like: title, artist, ..
The key genre will contain an integer between 0 and 147. You may use id3_get_genre_name to convert it to a human readable string.
") (prototype . "array id3_get_tag(string $filename [, int $version = ID3_BEST])") (purpose . "Get all information stored in an ID3 tag") (id . "function.id3-get-tag")) "id3_get_genre_name" ((documentation . "Get the name for a genre id string id3_get_genre_name(int $genre_id) Returns the name as a string. (PECL id3 >= 0.1)") (versions . "PECL id3 >= 0.1") (return . "Returns the name as a string.
") (prototype . "string id3_get_genre_name(int $genre_id)") (purpose . "Get the name for a genre id") (id . "function.id3-get-genre-name")) "id3_get_genre_list" ((documentation . "Get all possible genre values array id3_get_genre_list() Returns an array containing all possible genres that may be stored in an ID3 tag. (PECL id3 >= 0.1)") (versions . "PECL id3 >= 0.1") (return . "Returns an array containing all possible genres that may be stored in an ID3 tag.
") (prototype . "array id3_get_genre_list()") (purpose . "Get all possible genre values") (id . "function.id3-get-genre-list")) "id3_get_genre_id" ((documentation . "Get the id for a genre int id3_get_genre_id(string $genre) The genre id or FALSE on errors. (PECL id3 >= 0.1)") (versions . "PECL id3 >= 0.1") (return . " The genre id or FALSE on errors.
Returns the frame short name or FALSE on errors.
The values returned by id3_get_frame_short_name are used in the array returned by id3_get_tag.
") (prototype . "string id3_get_frame_short_name(string $frameId)") (purpose . "Get the short name of an ID3v2 frame") (id . "function.id3-get-frame-short-name")) "id3_get_frame_long_name" ((documentation . "Get the long name of an ID3v2 frame string id3_get_frame_long_name(string $frameId) Returns the frame long name or FALSE on errors. (PECL id3 >= 0.2)") (versions . "PECL id3 >= 0.2") (return . " Returns the frame long name or FALSE on errors.
NULL
An array of xhprof sample data, from the run.
") (prototype . "array xhprof_sample_disable()") (purpose . "Stops xhprof sample profiler") (id . "function.xhprof-sample-disable")) "xhprof_enable" ((documentation . "Start xhprof profiler void xhprof_enable([int $flags = '' [, array $options = '']]) NULL (PECL xhprof >= 0.9.0)") (versions . "PECL xhprof >= 0.9.0") (return . " NULL
An array of xhprof data, from the run.
") (prototype . "array xhprof_disable()") (purpose . "Stops xhprof profiler") (id . "function.xhprof-disable")) "wincache_unlock" ((documentation . "Releases an exclusive lock on a given key bool wincache_unlock(string $key) Returns TRUE on success or FALSE on failure. (PECL wincache >= 1.1.0)") (versions . "PECL wincache >= 1.1.0") (return . " Returns TRUE on success or FALSE on failure.
If key is string, the function returns TRUE on success and FALSE on failure.
If key is an array, the function returns:
FALSE; Array of meta data about user cache memory usage or FALSE on failure
The array returned by this function contains the following elements:
Array of meta data about user cache or FALSE on failure
The array returned by this function contains the following elements:
ucache_entries - an array that contains the information about all the cached items:
Returns the incremented value on success and FALSE on failure.
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.
Returns TRUE if variable with the key exitsts, otherwise returns FALSE.
Returns TRUE on success or FALSE on failure.
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.
Returns the decremented value on success and FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
If key is string, the function returns TRUE on success and FALSE on failure.
If key is an array, the function returns:
FALSE; Array of meta data about session cache memory usage or FALSE on failure
The array returned by this function contains the following elements:
Array of meta data about session cache or FALSE on failure
The array returned by this function contains the following elements:
scache_entries - an array that contains the information about all the cached items:
Array of meta data that describes memory usage by resolve file path cache. or FALSE on failure
The array returned by this function contains the following elements:
Array of meta data about the resolve file path cache or FALSE on failure
The array returned by this function contains the following elements:
rplist_entries - an array that contains the information about all the cached file paths:
Returns TRUE on success or FALSE on failure.
Array of meta data about opcode cache memory usage or FALSE on failure
The array returned by this function contains the following elements:
Array of meta data about opcode cache or FALSE on failure
The array returned by this function contains the following elements:
file_entries - an array that contains the information about all the cached files:
Returns TRUE on success or FALSE on failure.
Array of meta data about file cache memory usage or FALSE on failure
The array returned by this function contains the following elements:
Array of meta data about file cache or FALSE on failure
The array returned by this function contains the following elements:
file_entries - an array that contains the information about all the cached files:
") (prototype . "void uopz_undefine(string $class, string $constant)") (purpose . "Undefine a constant") (id . "function.uopz-undefine")) "uopz_restore" ((documentation . "Restore a previously backed up function void uopz_restore(string $class, string $function) (PECL uopz >= 1.0.3)") (versions . "PECL uopz >= 1.0.3") (return . "
") (prototype . "void uopz_restore(string $class, string $function)") (purpose . "Restore a previously backed up function") (id . "function.uopz-restore")) "uopz_rename" ((documentation . "Rename a function at runtime void uopz_rename(string $class, string $function, string $rename) (PECL uopz >= 1.0.0)") (versions . "PECL uopz >= 1.0.0") (return . "
") (prototype . "void uopz_rename(string $class, string $function, string $rename)") (purpose . "Rename a function at runtime") (id . "function.uopz-rename")) "uopz_redefine" ((documentation . "Redefine a constant void uopz_redefine(string $class, string $constant, mixed $value) (PECL uopz >= 1.0.0)") (versions . "PECL uopz >= 1.0.0") (return . "
") (prototype . "void uopz_redefine(string $class, string $constant, mixed $value)") (purpose . "Redefine a constant") (id . "function.uopz-redefine")) "uopz_overload" ((documentation . "Overload a VM opcode void uopz_overload(int $opcode, Callable $callable) (PECL uopz >= 1.0.0)") (versions . "PECL uopz >= 1.0.0") (return . "
") (prototype . "void uopz_overload(int $opcode, Callable $callable)") (purpose . "Overload a VM opcode") (id . "function.uopz-overload")) "uopz_implement" ((documentation . "Implements an interface at runtime void uopz_implement(string $class, string $interface) (PECL uopz >= 1.0.0)") (versions . "PECL uopz >= 1.0.0") (return . "
") (prototype . "void uopz_implement(string $class, string $interface)") (purpose . "Implements an interface at runtime") (id . "function.uopz-implement")) "uopz_function" ((documentation . "Creates a function at runtime void uopz_function(string $class, string $function, Closure $handler [, int $modifiers = '']) (PECL uopz >= 1.0.0)") (versions . "PECL uopz >= 1.0.0") (return . "
") (prototype . "void uopz_function(string $class, string $function, Closure $handler [, int $modifiers = ''])") (purpose . "Creates a function at runtime") (id . "function.uopz-function")) "uopz_flags" ((documentation . "Get or set flags on function or class int uopz_flags(string $class, string $function, int $flags) If setting, returns old flags, else returns flags (PECL uopz >= 2.0.2)") (versions . "PECL uopz >= 2.0.2") (return . "
If setting, returns old flags, else returns flags
") (prototype . "int uopz_flags(string $class, string $function, int $flags)") (purpose . "Get or set flags on function or class") (id . "function.uopz-flags")) "uopz_extend" ((documentation . "Extend a class at runtime void uopz_extend(string $class, string $parent) (PECL uopz >= 1.0.0)") (versions . "PECL uopz >= 1.0.0") (return . "") (prototype . "void uopz_extend(string $class, string $parent)") (purpose . "Extend a class at runtime") (id . "function.uopz-extend")) "uopz_delete" ((documentation . "Delete a function void uopz_delete(string $class, string $function) (PECL uopz >= 1.0.0)") (versions . "PECL uopz >= 1.0.0") (return . "
") (prototype . "void uopz_delete(string $class, string $function)") (purpose . "Delete a function") (id . "function.uopz-delete")) "uopz_copy" ((documentation . "Copy a function Closure uopz_copy(string $class, string $function) A Closure for the specified function (PECL uopz >= 1.0.4)") (versions . "PECL uopz >= 1.0.4") (return . "
A Closure for the specified function
") (prototype . "Closure uopz_copy(string $class, string $function)") (purpose . "Copy a function") (id . "function.uopz-copy")) "uopz_compose" ((documentation . "Compose a class void uopz_compose(string $name, array $classes [, array $methods = '' [, array $properties = '' [, int $flags = '']]]) (PECL uopz >= 1.0.0)") (versions . "PECL uopz >= 1.0.0") (return . "") (prototype . "void uopz_compose(string $name, array $classes [, array $methods = '' [, array $properties = '' [, int $flags = '']]])") (purpose . "Compose a class") (id . "function.uopz-compose")) "uopz_backup" ((documentation . "Backup a function void uopz_backup(string $class, string $function) (PECL uopz >= 1.0.3)") (versions . "PECL uopz >= 1.0.3") (return . "
") (prototype . "void uopz_backup(string $class, string $function)") (purpose . "Backup a function") (id . "function.uopz-backup")) "runkit_superglobals" ((documentation . "Return numerically indexed array of registered superglobals array runkit_superglobals() Returns a numerically indexed array of the currently registered superglobals. i.e. _GET, _POST, _REQUEST, _COOKIE, _SESSION, _SERVER, _ ENV, _FILES (PECL runkit >= 0.7.0)") (versions . "PECL runkit >= 0.7.0") (return . "
Returns a numerically indexed array of the currently registered superglobals. i.e. _GET, _POST, _REQUEST, _COOKIE, _SESSION, _SERVER, _ENV, _FILES
") (prototype . "array runkit_superglobals()") (purpose . "Return numerically indexed array of registered superglobals") (id . "function.runkit-superglobals")) "runkit_sandbox_output_handler" ((documentation . "Specify a function to capture and/or process output from a runkit sandbox mixed runkit_sandbox_output_handler(object $sandbox [, mixed $callback = '']) Returns the name of the previously defined output handler callback, or FALSE if no handler was previously defined. (PECL runkit >= 0.7.0)") (versions . "PECL runkit >= 0.7.0") (return . " Returns the name of the previously defined output handler callback, or FALSE if no handler was previously defined.
Returns TRUE if the function's return value is used by the calling scope, otherwise FALSE
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the Zend Engine version number, as a string.
") (prototype . "string zend_version()") (purpose . "Gets the version of the current Zend engine") (id . "function.zend-version")) "zend_thread_id" ((documentation . "Returns a unique identifier for the current thread int zend_thread_id() Returns the thread id as an integer. (PHP 5)") (versions . "PHP 5") (return . "Returns the thread id as an integer.
") (prototype . "int zend_thread_id()") (purpose . "Returns a unique identifier for the current thread") (id . "function.zend-thread-id")) "zend_logo_guid" ((documentation . "Gets the Zend guid string zend_logo_guid() Returns PHPE9568F35-D428-11d2-A769-00AA001ACF42. (PHP 4, PHP 5 < 5.5)") (versions . "PHP 4, PHP 5 < 5.5") (return . "Returns PHPE9568F35-D428-11d2-A769-00AA001ACF42.
") (prototype . "string zend_logo_guid()") (purpose . "Gets the Zend guid") (id . "function.zend-logo-guid")) "version_compare" ((documentation . "Compares two \"PHP-standardized\" version number strings mixed version_compare(string $version1, string $version2 [, string $operator = '']) By default, version_compare returns -1 if the first version is lower than the second, 0 if they are equal, and 1 if the second is lower. When using the optional operator argument, the function will return TRUE if the relationship is the one specified by the operator, FALSE otherwise. (PHP 4 >= 4.1.0, PHP 5)") (versions . "PHP 4 >= 4.1.0, PHP 5") (return . "By default, version_compare returns -1 if the first version is lower than the second, 0 if they are equal, and 1 if the second is lower.
When using the optional operator argument, the function will return TRUE if the relationship is the one specified by the operator, FALSE otherwise.
Returns the path of the temporary directory.
") (prototype . "string sys_get_temp_dir()") (purpose . "Returns directory path used for temporary files") (id . "function.sys-get-temp-dir")) "set_time_limit" ((documentation . "Limits the maximum execution time void set_time_limit(int $seconds) No value is returned. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "No value is returned.
") (prototype . "void set_time_limit(int $seconds)") (purpose . "Limits the maximum execution time") (id . "function.set-time-limit")) "set_magic_quotes_runtime" ((documentation . "Sets the current active configuration setting of magic_quotes_runtime bool set_magic_quotes_runtime(bool $new_setting) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
Returns the old include_path on success or FALSE on failure.
No value is returned.
") (prototype . "void restore_include_path()") (purpose . "Restores the value of the include_path configuration option") (id . "function.restore-include-path")) "putenv" ((documentation . "Sets the value of an environment variable bool putenv(string $setting) Returns TRUE on success or FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure.
If the optional extension parameter is specified, phpversion returns the version of that extension, or FALSE if there is no version information associated or the extension isn't enabled.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the description, as a string.
") (prototype . "string php_uname([string $mode = \"a\"])") (purpose . "Returns information about the operating system PHP is running on") (id . "function.php-uname")) "php_sapi_name" ((documentation . "Returns the type of interface between web server and PHP string php_sapi_name() Returns the interface type, as a lowercase string. Although not exhaustive, the possible return values include aolserver, apache, apache2filter, apache2handler, caudium, cgi (until PHP 5.3), cgi-fcgi, cli, cli-server, continuity, embed, isapi, litespeed, milter, nsapi, phttpd, pi3web, roxen, thttpd, tux, and webjames. (PHP 4 >= 4.0.1, PHP 5)") (versions . "PHP 4 >= 4.0.1, PHP 5") (return . "Returns the interface type, as a lowercase string.
Although not exhaustive, the possible return values include aolserver, apache, apache2filter, apache2handler, caudium, cgi (until PHP 5.3), cgi-fcgi, cli, cli-server, continuity, embed, isapi, litespeed, milter, nsapi, phttpd, pi3web, roxen, thttpd, tux, and webjames.
") (prototype . "string php_sapi_name()") (purpose . "Returns the type of interface between web server and PHP") (id . "function.php-sapi-name")) "php_logo_guid" ((documentation . "Gets the logo guid string php_logo_guid() Returns PHPE9568F34-D428-11d2-A769-00AA001ACF42. (PHP 4, PHP 5 < 5.5)") (versions . "PHP 4, PHP 5 < 5.5") (return . "Returns PHPE9568F34-D428-11d2-A769-00AA001ACF42.
") (prototype . "string php_logo_guid()") (purpose . "Gets the logo guid") (id . "function.php-logo-guid")) "php_ini_scanned_files" ((documentation . "Return a list of .ini files parsed from the additional ini dir string php_ini_scanned_files() Returns a comma-separated string of .ini files on success. Each comma is followed by a newline. If the directive --with-config-file-scan-dir wasn't set, FALSE is returned. If it was set and the directory was empty, an empty string is returned. If a file is unrecognizable, the file will still make it into the returned string but a PHP error will also result. This PHP error will be seen both at compile time and while using php_ini_scanned_files. (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . " Returns a comma-separated string of .ini files on success. Each comma is followed by a newline. If the directive --with-config-file-scan-dir wasn't set, FALSE is returned. If it was set and the directory was empty, an empty string is returned. If a file is unrecognizable, the file will still make it into the returned string but a PHP error will also result. This PHP error will be seen both at compile time and while using php_ini_scanned_files.
The loaded php.ini path, or FALSE if one is not loaded.
Returns the memory amount in bytes.
") (prototype . "int memory_get_usage([bool $real_usage = false])") (purpose . "Returns the amount of memory allocated to PHP") (id . "function.memory-get-usage")) "memory_get_peak_usage" ((documentation . "Returns the peak of memory allocated by PHP int memory_get_peak_usage([bool $real_usage = false]) Returns the memory peak in bytes. (PHP 5 >= 5.2.0)") (versions . "PHP 5 >= 5.2.0") (return . "Returns the memory peak in bytes.
") (prototype . "int memory_get_peak_usage([bool $real_usage = false])") (purpose . "Returns the peak of memory allocated by PHP") (id . "function.memory-get-peak-usage")) "main" ((documentation . "Dummy for main main() ()") (versions . "") (return . "") (prototype . " main()") (purpose . "Dummy for main") (id . "function.main")) "magic_quotes_runtime" ((documentation . "Alias of set_magic_quotes_runtime magic_quotes_runtime() (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "") (prototype . " magic_quotes_runtime()") (purpose . "Alias of set_magic_quotes_runtime") (id . "function.magic-quotes-runtime")) "ini_set" ((documentation . "Sets the value of a configuration option string ini_set(string $varname, string $newvalue) Returns the old value on success, FALSE on failure. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns the old value on success, FALSE on failure.
No value is returned.
") (prototype . "void ini_restore(string $varname)") (purpose . "Restores the value of a configuration option") (id . "function.ini-restore")) "ini_get" ((documentation . "Gets the value of a configuration option string ini_get(string $varname) Returns the value of the configuration option as a string on success, or an empty string for null values. Returns FALSE if the configuration option doesn't exist. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns the value of the configuration option as a string on success, or an empty string for null values. Returns FALSE if the configuration option doesn't exist.
Returns an associative array with directive name as the array key.
When details is TRUE (default) the array will contain global_value (set in php.ini), local_value (perhaps set with ini_set or .htaccess), and access (the access level).
When details is FALSE the value will be the current value of the option.
See the manual section for information on what access levels mean.
") (prototype . "array ini_get_all([string $extension = '' [, bool $details = true]])") (purpose . "Gets all configuration options") (id . "function.ini-get-all")) "ini_alter" ((documentation . "Alias of ini_set ini_alter() (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "") (prototype . " ini_alter()") (purpose . "Alias of ini_set") (id . "function.ini-alter")) "getrusage" ((documentation . "Gets the current resource usages array getrusage([int $who = '']) Returns an associative array containing the data returned from the system call. All entries are accessible by using their documented field names. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Note:
It's possible for a directive to have multiple access levels, which is why access shows the appropriate bitmask values.
Returns an associative array containing the data returned from the system call. All entries are accessible by using their documented field names.
") (prototype . "array getrusage([int $who = ''])") (purpose . "Gets the current resource usages") (id . "function.getrusage")) "getopt" ((documentation . "Gets options from the command line argument list array getopt(string $options [, array $longopts = '']) This function will return an array of option / argument pairs or FALSE on failure. Note: The parsing of options will end at the first non-option found, anything that follows is discarded. (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . " This function will return an array of option / argument pairs or FALSE on failure.
") (prototype . "array getopt(string $options [, array $longopts = ''])") (purpose . "Gets options from the command line argument list") (id . "function.getopt")) "getmyuid" ((documentation . "Gets PHP script owner's UID int getmyuid() Returns the user ID of the current script, or FALSE on error. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Note:
The parsing of options will end at the first non-option found, anything that follows is discarded.
Returns the user ID of the current script, or FALSE on error.
Returns the current PHP process ID, or FALSE on error.
Returns the current script's inode as an integer, or FALSE on error.
Returns the group ID of the current script, or FALSE on error.
Returns the time of the last modification of the current page. The value returned is a Unix timestamp, suitable for feeding to date. Returns FALSE on error.
Returns the value of the environment variable varname, or FALSE if the environment variable varname does not exist.
Returns 0 if magic_quotes_runtime is off, 1 otherwise. Or always returns FALSE as of PHP 5.4.0.
Returns 0 if magic_quotes_gpc is off, 1 otherwise. Or always returns FALSE as of PHP 5.4.0.
Returns an indexed array of all the modules names.
") (prototype . "array get_loaded_extensions([bool $zend_extensions = false])") (purpose . "Returns an array with the names of all modules compiled and loaded") (id . "function.get-loaded-extensions")) "get_included_files" ((documentation . "Returns an array with the names of included or required files array get_included_files() Returns an array of the names of all files. The script originally called is considered an \"included file,\" so it will be listed together with the files referenced by include and family. Files that are included or required multiple times only show up once in the returned array. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns an array of the names of all files.
The script originally called is considered an "included file," so it will be listed together with the files referenced by include and family.
Files that are included or required multiple times only show up once in the returned array.
") (prototype . "array get_included_files()") (purpose . "Returns an array with the names of included or required files") (id . "function.get-included-files")) "get_include_path" ((documentation . "Gets the current include_path configuration option string get_include_path() Returns the path, as a string. (PHP 4 >= 4.3.0, PHP 5)") (versions . "PHP 4 >= 4.3.0, PHP 5") (return . "Returns the path, as a string.
") (prototype . "string get_include_path()") (purpose . "Gets the current include_path configuration option") (id . "function.get-include-path")) "get_extension_funcs" ((documentation . "Returns an array with the names of the functions of a module array get_extension_funcs(string $module_name) Returns an array with all the functions, or FALSE if module_name is not a valid extension. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns an array with all the functions, or FALSE if module_name is not a valid extension.
Returns an array of constant name => constant value array, optionally groupped by extension name registering the constant.
") (prototype . "array get_defined_constants([bool $categorize = false])") (purpose . "Returns an associative array with the names of all the constants and their values") (id . "function.get-defined-constants")) "get_current_user" ((documentation . "Gets the name of the owner of the current PHP script string get_current_user() Returns the username as a string. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "Returns the username as a string.
") (prototype . "string get_current_user()") (purpose . "Gets the name of the owner of the current PHP script") (id . "function.get-current-user")) "get_cfg_var" ((documentation . "Gets the value of a PHP configuration option string get_cfg_var(string $option) Returns the current value of the PHP configuration variable specified by option, or FALSE if an error occurs. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns the current value of the PHP configuration variable specified by option, or FALSE if an error occurs.
Returns TRUE if the garbage collector is enabled, FALSE otherwise.
No value is returned.
") (prototype . "void gc_enable()") (purpose . "Activates the circular reference collector") (id . "function.gc-enable")) "gc_disable" ((documentation . "Deactivates the circular reference collector void gc_disable() No value is returned. (PHP 5 >= 5.3.0)") (versions . "PHP 5 >= 5.3.0") (return . "No value is returned.
") (prototype . "void gc_disable()") (purpose . "Deactivates the circular reference collector") (id . "function.gc-disable")) "gc_collect_cycles" ((documentation . "Forces collection of any existing garbage cycles int gc_collect_cycles() Returns number of collected cycles. (PHP 5 >= 5.3.0)") (versions . "PHP 5 >= 5.3.0") (return . "Returns number of collected cycles.
") (prototype . "int gc_collect_cycles()") (purpose . "Forces collection of any existing garbage cycles") (id . "function.gc-collect-cycles")) "extension_loaded" ((documentation . "Find out whether an extension is loaded bool extension_loaded(string $name) Returns TRUE if the extension identified by name is loaded, FALSE otherwise. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE if the extension identified by name is loaded, FALSE otherwise.
Returns TRUE on success or FALSE on failure. If the functionality of loading modules is not available or has been disabled (either by setting enable_dl off or by enabling safe mode in php.ini) an E_ERROR is emitted and execution is stopped. If dl fails because the specified library couldn't be loaded, in addition to FALSE an E_WARNING message is emitted.
Returns TRUE on success or FALSE on failure.
Return a string with the current process title or NULL on error.
FALSE if the assertion is false, TRUE otherwise.
Returns the original setting of any option or FALSE on errors.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
This will return an array with the output handlers in use (if any). If output_buffering is enabled or an anonymous function was used with ob_start, ob_list_handlers will return "default output handler".
") (prototype . "array ob_list_handlers()") (purpose . "List all output handlers in use") (id . "function.ob-list-handlers")) "ob_implicit_flush" ((documentation . "Turn implicit flush on/off void ob_implicit_flush([int $flag = true]) No value is returned. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "No value is returned.
") (prototype . "void ob_implicit_flush([int $flag = true])") (purpose . "Turn implicit flush on/off") (id . "function.ob-implicit-flush")) "ob_gzhandler" ((documentation . "ob_start callback function to gzip output buffer string ob_gzhandler(string $buffer, int $mode) (PHP 4 >= 4.0.4, PHP 5)") (versions . "PHP 4 >= 4.0.4, PHP 5") (return . "") (prototype . "string ob_gzhandler(string $buffer, int $mode)") (purpose . "ob_start callback function to gzip output buffer") (id . "function.ob-gzhandler")) "ob_get_status" ((documentation . "Get status of output buffers array ob_get_status([bool $full_status = FALSE]) If called without the full_status parameter or with full_status = FALSE a simple array with the following elements is returned: Array( [level] => 2 [type] => 0 [status] => 0 [name] => URL-Rewriter [del] => 1) Simple ob_get_status results Key Value level Output nesting level type PHP_OUTPUT_HANDLER_INTERNAL (0) or PHP_OUTPUT_HANDLER_USER (1) status One of PHP_OUTPUT_HANDLER_START (0), PHP_OUTPUT_HANDLER_CONT (1) or PHP_OUTPUT_HANDLER_END (2) name Name of active output handler or ' default output handler' if none is set del Erase-flag as set by ob_start If called with full_status = TRUE an array with one element for each active output buffer level is returned. The output level is used as key of the top level array and each array element itself is another array holding status information on one active output level. Array( [0] => Array ( [chunk_size] => 0 [size] => 40960 [block_size] => 10240 [type] => 1 [status] => 0 [name] => default output handler [del] => 1 ) [1] => Array ( [chunk_size] => 0 [size] => 40960 [block_size] => 10240 [type] => 0 [buffer_size] => 0 [status] => 0 [name] => URL-Rewriter [del] => 1 )) The full output contains these additional elements: Full ob_get_status results Key Value chunk_size Chunk size as set by ob_start size ... blocksize ... (PHP 4 >= 4.2.0, PHP 5)") (versions . "PHP 4 >= 4.2.0, PHP 5") (return . "
If called without the full_status parameter or with full_status = FALSE a simple array with the following elements is returned:
Array( [level] => 2 [type] => 0 [status] => 0 [name] => URL-Rewriter [del] => 1)
| Key | Value |
|---|---|
| level | Output nesting level |
| type | PHP_OUTPUT_HANDLER_INTERNAL (0) or PHP_OUTPUT_HANDLER_USER (1) |
| status | One of PHP_OUTPUT_HANDLER_START (0), PHP_OUTPUT_HANDLER_CONT (1) or PHP_OUTPUT_HANDLER_END (2) |
| name | Name of active output handler or ' default output handler' if none is set |
| del | Erase-flag as set by ob_start |
If called with full_status = TRUE an array with one element for each active output buffer level is returned. The output level is used as key of the top level array and each array element itself is another array holding status information on one active output level.
Array( [0] => Array ( [chunk_size] => 0 [size] => 40960 [block_size] => 10240 [type] => 1 [status] => 0 [name] => default output handler [del] => 1 ) [1] => Array ( [chunk_size] => 0 [size] => 40960 [block_size] => 10240 [type] => 0 [buffer_size] => 0 [status] => 0 [name] => URL-Rewriter [del] => 1 ))
The full output contains these additional elements:
| Key | Value |
|---|---|
| chunk_size | Chunk size as set by ob_start |
| size | ... |
| blocksize | ... |
Returns the level of nested output buffering handlers or zero if output buffering is not active.
") (prototype . "int ob_get_level()") (purpose . "Return the nesting level of the output buffering mechanism") (id . "function.ob-get-level")) "ob_get_length" ((documentation . "Return the length of the output buffer int ob_get_length() Returns the length of the output buffer contents or FALSE if no buffering is active. (PHP 4 >= 4.0.2, PHP 5)") (versions . "PHP 4 >= 4.0.2, PHP 5") (return . " Returns the length of the output buffer contents or FALSE if no buffering is active.
Returns the output buffer or FALSE if no buffering is active.
This will return the contents of the output buffer or FALSE, if output buffering isn't active.
Returns the contents of the output buffer and end output buffering. If output buffering isn't active then FALSE is returned.
No value is returned.
") (prototype . "void ob_flush()") (purpose . "Flush (send) the output buffer") (id . "function.ob-flush")) "ob_end_flush" ((documentation . "Flush (send) the output buffer and turn off output buffering bool ob_end_flush() Returns TRUE on success or FALSE on failure. Reasons for failure are first that you called the function without an active buffer or that for some reason a buffer could not be deleted (possible for special buffer). (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . " Returns TRUE on success or FALSE on failure. Reasons for failure are first that you called the function without an active buffer or that for some reason a buffer could not be deleted (possible for special buffer).
Returns TRUE on success or FALSE on failure. Reasons for failure are first that you called the function without an active buffer or that for some reason a buffer could not be deleted (possible for special buffer).
No value is returned.
") (prototype . "void ob_clean()") (purpose . "Clean (erase) the output buffer") (id . "function.ob-clean")) "flush" ((documentation . "Flush the output buffer void flush() No value is returned. (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "No value is returned.
") (prototype . "void flush()") (purpose . "Flush the output buffer") (id . "function.flush")) "opcache_reset" ((documentation . "Resets the contents of the opcode cache boolean opcache_reset() Returns TRUE if the opcode cache was reset, or FALSE if the opcode cache is disabled. (PHP 5 >= 5.5.0, PECL ZendOpcache >= 7.0.0)") (versions . "PHP 5 >= 5.5.0, PECL ZendOpcache >= 7.0.0") (return . " Returns TRUE if the opcode cache was reset, or FALSE if the opcode cache is disabled.
Returns TRUE if the opcode cache for script was invalidated or if there was nothing to invalidate, or FALSE if the opcode cache is disabled.
Returns an array of information, optionally containing script specific state information
") (prototype . "array opcache_get_status([boolean $get_scripts = ''])") (purpose . "Get status information about the cache") (id . "function.opcache-get-status")) "opcache_get_configuration" ((documentation . "Get configuration information about the cache array opcache_get_configuration() Returns an array of information, including ini, blacklist and version (PHP 5 >= 5.5.5, PECL ZendOpcache > 7.0.2)") (versions . "PHP 5 >= 5.5.5, PECL ZendOpcache > 7.0.2") (return . "Returns an array of information, including ini, blacklist and version
") (prototype . "array opcache_get_configuration()") (purpose . "Get configuration information about the cache") (id . "function.opcache-get-configuration")) "opcache_compile_file" ((documentation . "Compiles and caches a PHP script without executing it boolean opcache_compile_file(string $file) Returns TRUE if file was compiled successfully or FALSE on failure. (PHP 5 >= 5.5.5, PECL ZendOpcache > 7.0.2)") (versions . "PHP 5 >= 5.5.5, PECL ZendOpcache > 7.0.2") (return . " Returns TRUE if file was compiled successfully or FALSE on failure.
The inclued data.
") (prototype . "array inclued_get_data()") (purpose . "Get the inclued data") (id . "function.inclued-get-data")) "user_error" ((documentation . "Alias of trigger_error user_error() (PHP 4, PHP 5)") (versions . "PHP 4, PHP 5") (return . "") (prototype . " user_error()") (purpose . "Alias of trigger_error") (id . "function.user-error")) "trigger_error" ((documentation . "Generates a user-level error/warning/notice message bool trigger_error(string $error_msg [, int $error_type = E_USER_NOTICE]) This function returns FALSE if wrong error_type is specified, TRUE otherwise. (PHP 4 >= 4.0.1, PHP 5)") (versions . "PHP 4 >= 4.0.1, PHP 5") (return . " This function returns FALSE if wrong error_type is specified, TRUE otherwise.
Returns the name of the previously defined exception handler, or NULL on error. If no previous handler was defined, NULL is also returned.
Returns a string containing the previously defined error handler (if any). If the built-in error handler is used NULL is returned. NULL is also returned in case of an error such as an invalid callback. If the previous error handler was a class method, this function will return an indexed array with the class and the method name.
This function always returns TRUE.
This function always returns TRUE.
Returns the old error_reporting level or the current level if no level parameter is given.
Returns TRUE on success or FALSE on failure.
Returns an associative array describing the last error with keys "type", "message", "file" and "line". If the error has been caused by a PHP internal function then the "message" begins with its name. Returns NULL if there hasn't been an error yet.
No value is returned.
") (prototype . "void debug_print_backtrace([int $options = '' [, int $limit = '']])") (purpose . "Prints a backtrace") (id . "function.debug-print-backtrace")) "debug_backtrace" ((documentation . #("Generates a backtrace array debug_backtrace([int $options = DEBUG_BACKTRACE_PROVIDE_OBJECT [, int $limit = '']]) Returns an array of associative arrays. The possible returned elements are as follows: Possible returned elements from debug_backtrace Name Type Description function string The current function name. See also __FUNCTION__. line integer The current line number. See also __LINE__. file string The current file name. See also __FILE__. class string The current class name. See also __CLASS__ object object The current object. type string The current call type. If a method call, \"->\" is returned. If a static method call, \"::\" is returned. If a function call, nothing is returned. args array If inside a function, this lists the functions arguments. If inside an included file, this lists the included file name(s). (PHP 4 >= 4.3.0, PHP 5)" 361 373 (shr-url "language.constants.predefined.html") 429 437 (shr-url "language.constants.predefined.html") 491 499 (shr-url "language.constants.predefined.html") 533 538 (shr-url "language.oop5.html") 554 563 (shr-url "language.constants.predefined.html") 596 602 (shr-url "language.oop5.html"))) (versions . "PHP 4 >= 4.3.0, PHP 5") (return . "Returns an array of associative arrays. The possible returned elements are as follows:
| Name | Type | Description |
|---|---|---|
| function | string | The current function name. See also __FUNCTION__. |
| line | integer | The current line number. See also __LINE__. |
| file | string | The current file name. See also __FILE__. |
| class | string | The current class name. See also __CLASS__ |
| object | object | The current object. |
| type | string | The current call type. If a method call, "->" is returned. If a static method call, "::" is returned. If a function call, nothing is returned. |
| args | array | If inside a function, this lists the functions arguments. If inside an included file, this lists the included file name(s). |
BLENC will return the redistributable key that must be saved into key_file: the path of key_file is specified at runtime with the option blenc.key_file
") (prototype . "string blenc_encrypt(string $plaintext, string $encodedfile [, string $encryption_key = ''])") (purpose . "Encrypt a PHP script with BLENC.") (id . "function.blenc-encrypt")) "bcompiler_write_included_filename" ((documentation . "Writes an included file as bytecodes bool bcompiler_write_included_filename(resource $filehandle, string $filename) Returns TRUE on success or FALSE on failure. (PECL bcompiler >= 0.5)") (versions . "PECL bcompiler >= 0.5") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void apd_set_session(int $debug_level)") (purpose . "Changes or sets the current debugging level") (id . "function.apd-set-session")) "apd_set_session_trace" ((documentation . "Starts the session debugging void apd_set_session_trace(int $debug_level [, string $dump_directory = ini_get(\"apd.dumpdir\")]) No value is returned. (PECL apd 0.2-0.4)") (versions . "PECL apd 0.2-0.4") (return . "No value is returned.
") (prototype . "void apd_set_session_trace(int $debug_level [, string $dump_directory = ini_get(\"apd.dumpdir\")])") (purpose . "Starts the session debugging") (id . "function.apd-set-session-trace")) "apd_set_session_trace_socket" ((documentation . "Starts the remote session debugging bool apd_set_session_trace_socket(string $tcp_server, int $socket_type, int $port, int $debug_level) Returns TRUE on success or FALSE on failure. (PECL apd >= 0.2)") (versions . "PECL apd >= 0.2") (return . " Returns TRUE on success or FALSE on failure.
Returns path of the destination file.
") (prototype . "string apd_set_pprof_trace([string $dump_directory = ini_get(\"apd.dumpdir\") [, string $fragment = \"pprof\"]])") (purpose . "Starts the session debugging") (id . "function.apd-set-pprof-trace")) "apd_get_active_symbols" ((documentation . "Get an array of the current variables names in the local scope array apd_get_active_symbols() A multidimensional array with all the variables. (PECL apd 0.2)") (versions . "PECL apd 0.2") (return . "A multidimensional array with all the variables.
") (prototype . "array apd_get_active_symbols()") (purpose . "Get an array of the current variables names in the local scope") (id . "function.apd-get-active-symbols")) "apd_echo" ((documentation . "Echo to the debugging socket bool apd_echo(string $output) Returns TRUE on success or FALSE on failure. (PECL apd >= 0.2)") (versions . "PECL apd >= 0.2") (return . " Returns TRUE on success or FALSE on failure.
An array containing the current regular resources.
") (prototype . "array apd_dump_regular_resources()") (purpose . "Return all current regular resources as an array") (id . "function.apd-dump-regular-resources")) "apd_dump_persistent_resources" ((documentation . "Return all persistent resources as an array array apd_dump_persistent_resources() An array containing the current call stack. (PECL apd 0.2-0.4)") (versions . "PECL apd 0.2-0.4") (return . "An array containing the current call stack.
") (prototype . "array apd_dump_persistent_resources()") (purpose . "Return all persistent resources as an array") (id . "function.apd-dump-persistent-resources")) "apd_dump_function_table" ((documentation . "Outputs the current function table void apd_dump_function_table() No value is returned. (Unknown)") (versions . "Unknown") (return . "No value is returned.
") (prototype . "void apd_dump_function_table()") (purpose . "Outputs the current function table") (id . "function.apd-dump-function-table")) "apd_croak" ((documentation . "Throw an error, a callstack and then exit void apd_croak(string $warning [, string $delimiter = \"\"]) No value is returned. (PECL apd 0.2-0.4)") (versions . "PECL apd 0.2-0.4") (return . "No value is returned.
") (prototype . "void apd_croak(string $warning [, string $delimiter = \"\"])") (purpose . "Throw an error, a callstack and then exit") (id . "function.apd-croak")) "apd_continue" ((documentation . "Restarts the interpreter bool apd_continue(int $debug_level) Returns TRUE on success or FALSE on failure. (PECL apd >= 0.2)") (versions . "PECL apd >= 0.2") (return . " Returns TRUE on success or FALSE on failure.
No value is returned.
") (prototype . "void apd_clunk(string $warning [, string $delimiter = \"\"])") (purpose . "Throw a warning and a callstack") (id . "function.apd-clunk")) "apd_callstack" ((documentation . "Returns the current call stack as an array array apd_callstack() An array containing the current call stack. (PECL apd 0.2-0.4)") (versions . "PECL apd 0.2-0.4") (return . "An array containing the current call stack.
") (prototype . "array apd_callstack()") (purpose . "Returns the current call stack as an array") (id . "function.apd-callstack")) "apd_breakpoint" ((documentation . "Stops the interpreter and waits on a CR from the socket bool apd_breakpoint(int $debug_level) Returns TRUE on success or FALSE on failure. (PECL apd >= 0.2)") (versions . "PECL apd >= 0.2") (return . " Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure. Second syntax returns array with error keys.
Array of Shared Memory Allocation data; FALSE on failure.
Returns TRUE on success or FALSE on failure.
Returns the current value of key's value on success, or FALSE on failure
The stored variable or array of variables on success; FALSE on failure
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.
Returns TRUE on success or FALSE on failure.
Returns TRUE on success or FALSE on failure. Or if keys is an array, then an empty array is returned on success, or an array of failed files is returned.
Returns TRUE on success or FALSE on failure.
Returns the current value of key's value on success, or FALSE on failure
Returns TRUE on success or FALSE on failure.
Returns TRUE always
Returns TRUE on success or FALSE on failure.
Array of cached data (and meta-data) or FALSE on failure
") (prototype . "array apc_cache_info([string $cache_type = \"\" [, bool $limited = false]])") (purpose . "Retrieves cached information from APC's data store") (id . "function.apc-cache-info")) "apc_bin_loadfile" ((documentation . "Load a binary dump from a file into the APC file/user cache bool apc_bin_loadfile(string $filename [, resource $context = null [, int $flags = '']]) Returns TRUE on success, otherwise FALSE Reasons it may return FALSE include APC is not enabled, filename is an invalid file name or empty, filename can't be opened, the file dump can't be completed, or if the data is not a valid APC binary dump (e.g., unexpected size). (PECL apc >= 3.1.4)") (versions . "PECL apc >= 3.1.4") (return . "Note: apc_cache_info will raise a warning if it is unable to retrieve APC cache data. This typically occurs when APC is not enabled.
Returns TRUE on success, otherwise FALSE Reasons it may return FALSE include APC is not enabled, filename is an invalid file name or empty, filename can't be opened, the file dump can't be completed, or if the data is not a valid APC binary dump (e.g., unexpected size).
Returns TRUE if the binary dump data was loaded with success, otherwise FALSE is returned. FALSE is returned if APC is not enabled, or if the data is not a valid APC binary dump (e.g., unexpected size).
The number of bytes written to the file, otherwise FALSE if APC is not enabled, filename is an invalid file name, filename can't be opened, the file dump can't be completed (e.g., the hard drive is out of disk space), or an unknown error was encountered.
Returns a binary dump of the given files and user variables from the APC cache, FALSE if APC is not enabled, or NULL if an unknown error is encountered.
Returns TRUE if something has effectively been added into the cache, FALSE otherwise. Second syntax returns array with error keys.
") (prototype . "array apc_add(string $key, mixed $var [, int $ttl = '', array $values [, mixed $unused = null]])") (purpose . "Cache a new variable in the data store") (id . "function.apc-add")) "if" ((purpose . "Control structure") (id concat "control-structures." php-control-structure)) "else" ((purpose . "Control structure") (id concat "control-structures." php-control-structure)) "elseif" ((purpose . "Control structure") (id concat "control-structures." php-control-structure)) "while" ((purpose . "Control structure") (id concat "control-structures." php-control-structure)) "do.while" ((purpose . "Control structure") (id concat "control-structures." php-control-structure)) "for" ((purpose . "Control structure") (id concat "control-structures." php-control-structure)) "foreach" ((purpose . "Control structure") (id concat "control-structures." php-control-structure)) "break" ((purpose . "Control structure") (id concat "control-structures." php-control-structure)) "continue" ((purpose . "Control structure") (id concat "control-structures." php-control-structure)) "switch" ((purpose . "Control structure") (id concat "control-structures." php-control-structure)) "declare" ((purpose . "Control structure") (id concat "control-structures." php-control-structure)) "return" ((purpose . "Control structure") (id concat "control-structures." php-control-structure)) "require" ((purpose . "Control structure") (id concat "control-structures." php-control-structure)) "include" ((purpose . "Control structure") (id concat "control-structures." php-control-structure)) "require_once" ((purpose . "Control structure") (id concat "control-structures." php-control-structure)) "include_once" ((purpose . "Control structure") (id concat "control-structures." php-control-structure)) "goto" ((purpose . "Control structure") (id concat "control-structures." php-control-structure))))) (provide 'php-extras-eldoc-functions) ;;; php-extras-eldoc-functions.el ends here