===================================================
*Below this are the various PHP-specific functions *
===================================================
- <phpsyntax function="COM_invoke" usage="mixed COM_invoke(int module, string handler_name [, mixed arg [, mixed ...]])\n" description="Invokes a COM module"></phpsyntax>
- <phpsyntax function="COM_load" usage="int com_load(string module_name [, string remote_host [, int codepage [, string typelib]]])\n" description="Loads a COM module"></phpsyntax>
- <phpsyntax function="abs" usage="int abs(int number)\n" description="Return the absolute value of the number"></phpsyntax>
+ <phpsyntax function="COM_invoke" usage="mixed COM_invoke(int module, string handler_name [, mixed arg [, mixed ...]])">Invokes a COM module</phpsyntax>
+ <phpsyntax function="COM_load" usage="int com_load(string module_name [, string remote_host [, int codepage [, string typelib]]])">Loads a COM module</phpsyntax>
+ <phpsyntax function="abs" usage="int abs(int number)">Return the absolute value of the number</phpsyntax>
<phpsyntax function="accept_connect"></phpsyntax>
- <phpsyntax function="acos" usage="float acos(float number)" description="Return the arc cosine of the number in radians"></phpsyntax>
+ <phpsyntax function="acos" usage="float acos(float arg)">Return the arc cosine of the arg in radians</phpsyntax>
+ <phpsyntax function="acosh" usage="float acosh(float arg)">Returns the inverse hyperbolic cosine of arg</phpsyntax>
<phpsyntax function="add"></phpsyntax>
<phpsyntax function="add_iovec"></phpsyntax>
<phpsyntax function="addaction"></phpsyntax>
<phpsyntax function="addcolor"></phpsyntax>
- <phpsyntax function="addcslashes"></phpsyntax>
+ <phpsyntax function="addcslashes" usage="string addcslashes (string str, string charlist)">
+Returns a string with backslashes before characters that are listed in charlist parameter.
+It escapes \n, \r etc. in C-like style, characters with ASCII code lower than 32 and
+higher than 126 are converted to octal representation.</phpsyntax>
<phpsyntax function="addentry"></phpsyntax>
<phpsyntax function="addfill"></phpsyntax>
<phpsyntax function="addshape"></phpsyntax>
- <phpsyntax function="addslashes"></phpsyntax>
- <phpsyntax function="addstring"></phpsyntax>
+ <phpsyntax function="addslashes" usage="string addslashes (string str)">
+Returns a string with backslashes before characters that need to be quoted in database queries etc.
+These characters are single quote ('), double quote ("), backslash (\) and NUL (the NULL byte).</phpsyntax>
<phpsyntax function="addstring"></phpsyntax>
+ <phpsyntax function="aggregate" usage="void aggregate ( object object, string class_name)">
+Aggregates methods and properties defined in a class to an existing object.
+Methods and properties with names starting with an underscore character (_) are considered private
+to the aggregated class and are not used, constructors are also excluded from the aggregation procedure.</phpsyntax>
<phpsyntax function="align"></phpsyntax>
- <phpsyntax function="apache_child_terminate"></phpsyntax>
- <phpsyntax function="apache_lookup_uri"></phpsyntax>
- <phpsyntax function="apache_lookup_uri"></phpsyntax>
+ <phpsyntax function="apache_child_terminate" usage="bool apache_child_terminate ( void)">
+apache_child_terminate() will register the Apache process executing the current PHP request for termination
+once execution of PHP code it is completed. It may be used to terminate a process after a script with
+high memory consumption has been run as memory will usually only be freed internally but not given
+back to the operating system.
+ </phpsyntax>
+ <phpsyntax function="apache_lookup_uri" usage="object apache_lookup_uri ( string filename)">
+This performs a partial request for a URI. It goes just far enough to obtain all the important information
+about the given resource and returns this information in a class.
+ </phpsyntax>
<phpsyntax function="apache_note"></phpsyntax>
<phpsyntax function="apache_sub_req"></phpsyntax>
<phpsyntax function="array_count_values"></phpsyntax>
<phpsyntax function="chroot"></phpsyntax>
<phpsyntax function="chroot"></phpsyntax>
<phpsyntax function="chunk_split"></phpsyntax>
- <phpsyntax function="class_exists" usage="bool class_exists(string classname)\n" description="Checks if the class exists"></phpsyntax>
+ <phpsyntax function="class_exists" usage="Checks if the class exists">bool class_exists(string classname)</phpsyntax>
<phpsyntax function="clearstatcache"></phpsyntax>
<phpsyntax function="close"></phpsyntax>
- <phpsyntax function="closedir" usage="void closedir([resource dir_handle])\n" description="Close directory connection identified by the dir_handle"></phpsyntax>
+ <phpsyntax function="closedir" usage="Close directory connection identified by the dir_handle">void closedir([resource dir_handle])</phpsyntax>
<phpsyntax function="closelog"></phpsyntax>
<phpsyntax function="com_get"></phpsyntax>
<phpsyntax function="com_propget"></phpsyntax>
<phpsyntax function="crack_opendict"></phpsyntax>
<phpsyntax function="crash"></phpsyntax>
<phpsyntax function="crc32"></phpsyntax>
- <phpsyntax function="create_function" usage="string create_function(string args, string code)\n" description="Creates an anonymous function, and returns its name (funny, eh?)"></phpsyntax>
+ <phpsyntax function="create_function" usage="string create_function(string args, string code)">Creates an anonymous function, and returns its name (funny, eh?)</phpsyntax>
<phpsyntax function="crypt"></phpsyntax>
<phpsyntax function="crypt"></phpsyntax>
<phpsyntax function="ctype_alnum"></phpsyntax>
<phpsyntax function="decbin"></phpsyntax>
<phpsyntax function="dechex"></phpsyntax>
<phpsyntax function="decoct"></phpsyntax>
- <phpsyntax function="define" usage="bool define(string constant_name, mixed value, case_sensitive=true)\n" description="Define a new constant"></phpsyntax>
+ <phpsyntax function="define" usage="bool define(string constant_name, mixed value, case_sensitive=true)">Define a new constant</phpsyntax>
<phpsyntax function="define_syslog_variables"></phpsyntax>
- <phpsyntax function="defined" usage="bool defined(string constant_name)\n" description="Check whether a constant exists"></phpsyntax>
+ <phpsyntax function="defined" usage="bool defined(string constant_name)">Check whether a constant exists</phpsyntax>
<phpsyntax function="deg2rad"></phpsyntax>
<phpsyntax function="delete_iovec"></phpsyntax>
<phpsyntax function="dgettext"></phpsyntax>
- <phpsyntax function="dir" usage="class dir(string directory)\n" description="Directory class with properties, handle and class and methods read, rewind and close"></phpsyntax>
+ <phpsyntax function="dir" usage="class dir(string directory)">
+Directory class with properties, handle and class and methods read, rewind and close.
+ </phpsyntax>
<phpsyntax function="dirname"></phpsyntax>
<phpsyntax function="diskfreespace"></phpsyntax>
<phpsyntax function="display_disabled_function"></phpsyntax>
<phpsyntax function="mcal_event_set_alarm"></phpsyntax>
<phpsyntax function="mcal_event_set_category"></phpsyntax>
<phpsyntax function="mcal_event_set_class"></phpsyntax>
- <phpsyntax function="mcal_event_set_description"></phpsyntax>
+ <phpsyntax function="mcal_event_set_usage"></phpsyntax>
<phpsyntax function="mcal_event_set_end"></phpsyntax>
<phpsyntax function="mcal_event_set_recur_daily"></phpsyntax>
<phpsyntax function="mcal_event_set_recur_monthly_mday"></phpsyntax>
<phpsyntax function="muscat_give"></phpsyntax>
<phpsyntax function="muscat_setup"></phpsyntax>
<phpsyntax function="muscat_setup_net"></phpsyntax>
- <phpsyntax function="mysql"></phpsyntax>
- <phpsyntax function="mysql_affected_rows"></phpsyntax>
- <phpsyntax function="mysql_close"></phpsyntax>
- <phpsyntax function="mysql_connect"></phpsyntax>
- <phpsyntax function="mysql_create_db"></phpsyntax>
- <phpsyntax function="mysql_createdb"></phpsyntax>
- <phpsyntax function="mysql_data_seek"></phpsyntax>
- <phpsyntax function="mysql_db_name"></phpsyntax>
- <phpsyntax function="mysql_db_query"></phpsyntax>
- <phpsyntax function="mysql_dbname"></phpsyntax>
- <phpsyntax function="mysql_drop_db"></phpsyntax>
- <phpsyntax function="mysql_dropdb"></phpsyntax>
- <phpsyntax function="mysql_errno"></phpsyntax>
- <phpsyntax function="mysql_error"></phpsyntax>
- <phpsyntax function="mysql_escape_string"></phpsyntax>
- <phpsyntax function="mysql_fetch_array"></phpsyntax>
- <phpsyntax function="mysql_fetch_assoc"></phpsyntax>
- <phpsyntax function="mysql_fetch_field"></phpsyntax>
- <phpsyntax function="mysql_fetch_lengths"></phpsyntax>
- <phpsyntax function="mysql_fetch_object"></phpsyntax>
- <phpsyntax function="mysql_fetch_row"></phpsyntax>
- <phpsyntax function="mysql_field_flags"></phpsyntax>
- <phpsyntax function="mysql_field_len"></phpsyntax>
- <phpsyntax function="mysql_field_name"></phpsyntax>
- <phpsyntax function="mysql_field_seek"></phpsyntax>
- <phpsyntax function="mysql_field_table"></phpsyntax>
- <phpsyntax function="mysql_field_type"></phpsyntax>
- <phpsyntax function="mysql_fieldflags"></phpsyntax>
- <phpsyntax function="mysql_fieldlen"></phpsyntax>
- <phpsyntax function="mysql_fieldname"></phpsyntax>
- <phpsyntax function="mysql_fieldtable"></phpsyntax>
- <phpsyntax function="mysql_fieldtype"></phpsyntax>
- <phpsyntax function="mysql_free_result"></phpsyntax>
- <phpsyntax function="mysql_freeresult"></phpsyntax>
- <phpsyntax function="mysql_get_client_info"></phpsyntax>
- <phpsyntax function="mysql_get_host_info"></phpsyntax>
- <phpsyntax function="mysql_get_proto_info"></phpsyntax>
- <phpsyntax function="mysql_get_server_info"></phpsyntax>
- <phpsyntax function="mysql_insert_id"></phpsyntax>
- <phpsyntax function="mysql_list_dbs"></phpsyntax>
- <phpsyntax function="mysql_list_fields"></phpsyntax>
- <phpsyntax function="mysql_list_tables"></phpsyntax>
- <phpsyntax function="mysql_listdbs"></phpsyntax>
- <phpsyntax function="mysql_listfields"></phpsyntax>
- <phpsyntax function="mysql_listtables"></phpsyntax>
- <phpsyntax function="mysql_num_fields"></phpsyntax>
- <phpsyntax function="mysql_num_rows"></phpsyntax>
- <phpsyntax function="mysql_numfields"></phpsyntax>
- <phpsyntax function="mysql_numrows"></phpsyntax>
- <phpsyntax function="mysql_pconnect"></phpsyntax>
- <phpsyntax function="mysql_query"></phpsyntax>
+ <phpsyntax function="mysql_affected_rows" usage="int mysql_affected_rows ( [resource link_identifier])">
+mysql_affected_rows() returns the number of rows affected by the last INSERT,
+UPDATE or DELETE query associated with link_identifier.
+If the link identifier isn't specified, the last link opened by mysql_connect() is assumed.
+
+Note: If you are using transactions, you need to call mysql_affected_rows()
+after your INSERT, UPDATE, or DELETE query, not after the commit.
+
+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.
+
+Note: When using UPDATE, MySQL will not update columns where the new value is the same as the old value.
+This creates the possiblity 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.
+
+mysql_affected_rows() does not work with SELECT statements; only on statements which modify records.
+To retrieve the number of rows returned by a SELECT, use mysql_num_rows().
+
+If the last query failed, this function will return -1.
+ </phpsyntax>
+ <phpsyntax function="mysql_close" usage="bool mysql_close ( [resource link_identifier])"></phpsyntax>
+ <phpsyntax function="mysql_connect" usage="resource mysql_connect ( [string server [, string username [, string password [, bool new_link [, int client_flags]]]]])"></phpsyntax>
+ <phpsyntax function="mysql_create_db" usage="bool mysql_create_db ( string database name [, resource link_identifier])"></phpsyntax>
+ <phpsyntax function="mysql_data_seek" usage="bool mysql_data_seek ( resource result_identifier, int row_number)"></phpsyntax>
+ <phpsyntax function="mysql_db_name" usage="string mysql_db_name ( resource result, int row [, mixed field])"></phpsyntax>
+ <phpsyntax function="mysql_db_query" usage="resource mysql_db_query ( string database, string query [, resource link_identifier])"></phpsyntax>
+ <phpsyntax function="mysql_drop_db" usage="bool mysql_drop_db ( string database_name [, resource link_identifier])">
+Returns TRUE on success or FALSE on failure.
+
+mysql_drop_db() attempts to drop (remove) an entire database from the server
+associated with the specified link identifier.
+
+For downward compatibility mysql_dropdb() can also be used. This is deprecated, however.
+
+Note: The function mysql_drop_db() is deprecated.
+It is preferable to use mysql_query() to issue a SQL DROP DATABASE statement instead.
+ </phpsyntax>
+ <phpsyntax function="mysql_errno" usage="int mysql_errno ( [resource link_identifier])">
+Returns the error number from the last MySQL function, or 0 (zero) if no error occurred.
+
+Errors coming back from the MySQL database backend no longer issue warnings.
+Instead, use mysql_errno() to retrieve the error code.
+Note that this function only returns the error code from the most recently executed
+MySQL function (not including mysql_error() and mysql_errno()), so if you want to use it,
+make sure you check the value before calling another MySQL function.
+ </phpsyntax>
+ <phpsyntax function="mysql_error" usage="string mysql_error ( [resource link_identifier])">
+Returns the error text from the last MySQL function, or '' (the empty string) if no error occurred.
+
+Errors coming back from the MySQL database backend no longer issue warnings.
+Instead, use mysql_error() to retrieve the error text.
+Note that this function only returns the error text from the most recently
+executed MySQL function (not including mysql_error() and mysql_errno()),
+so if you want to use it, make sure you check the value before calling another MySQL function.
+ </phpsyntax>
+ <phpsyntax function="mysql_escape_string" usage="string mysql_escape_string ( string unescaped_string)"></phpsyntax>
+ <phpsyntax function="mysql_fetch_array" usage="array mysql_fetch_array ( resource result [, int result_type])">
+Returns an array that corresponds to the fetched row, or FALSE if there are no more rows.
+
+mysql_fetch_array() is an extended version of mysql_fetch_row().
+In addition to storing the data in the numeric indices of the result array,
+it also stores the data in associative indices, using the field names as keys.
+
+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.
+ </phpsyntax>
+ <phpsyntax function="mysql_fetch_assoc" usage="array mysql_fetch_assoc ( resource result)">
+Returns an associative array that corresponds to the fetched row, or FALSE if there are no more rows.
+
+mysql_fetch_assoc() is equivalent to calling mysql_fetch_array() with MYSQL_ASSOC
+for the optional second parameter. It only returns an associative array.
+This is the way mysql_fetch_array() originally worked.
+If you need the numeric indices as well as the associative, use mysql_fetch_array().
+
+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.
+
+An important thing to note is that using mysql_fetch_assoc() is not significantly slower
+than using mysql_fetch_row(), while it provides a significant added value.
+ </phpsyntax>
+ <phpsyntax function="mysql_fetch_field" usage="object mysql_fetch_field ( resource result [, int field_offset])">
+Returns an object containing field information.
+
+mysql_fetch_field() can be used in order to obtain information about fields in a certain query result.
+If the field offset isn't specified, the next field that wasn't yet retrieved by mysql_fetch_field()
+is retrieved.
+
+The properties of the object are:
+name - column name
+table - name of the table the column belongs to
+max_length - maximum length of the column
+not_null - 1 if the column cannot be NULL
+primary_key - 1 if the column is a primary key
+unique_key - 1 if the column is a unique key
+multiple_key - 1 if the column is a non-unique key
+numeric - 1 if the column is numeric
+blob - 1 if the column is a BLOB
+type - the type of the column
+unsigned - 1 if the column is unsigned
+zerofill - 1 if the column is zero-filled
+ </phpsyntax>
+ <phpsyntax function="mysql_fetch_lengths" usage=""></phpsyntax>
+ <phpsyntax function="mysql_fetch_object" usage=""></phpsyntax>
+ <phpsyntax function="mysql_fetch_row" usage=""></phpsyntax>
+ <phpsyntax function="mysql_field_flags" usage=""></phpsyntax>
+ <phpsyntax function="mysql_field_len" usage=""></phpsyntax>
+ <phpsyntax function="mysql_field_name" usage=""></phpsyntax>
+ <phpsyntax function="mysql_field_seek" usage=""></phpsyntax>
+ <phpsyntax function="mysql_field_table" usage=""></phpsyntax>
+ <phpsyntax function="mysql_field_type" usage=""></phpsyntax>
+ <phpsyntax function="mysql_fieldflags" usage=""></phpsyntax>
+ <phpsyntax function="mysql_fieldlen" usage=""></phpsyntax>
+ <phpsyntax function="mysql_fieldname" usage=""></phpsyntax>
+ <phpsyntax function="mysql_fieldtable" usage=""></phpsyntax>
+ <phpsyntax function="mysql_fieldtype" usage=""></phpsyntax>
+ <phpsyntax function="mysql_free_result" usage=""></phpsyntax>
+ <phpsyntax function="mysql_freeresult" usage=""></phpsyntax>
+ <phpsyntax function="mysql_get_client_info" usage=""></phpsyntax>
+ <phpsyntax function="mysql_get_host_info" usage=""></phpsyntax>
+ <phpsyntax function="mysql_get_proto_info" usage=""></phpsyntax>
+ <phpsyntax function="mysql_get_server_info" usage=""></phpsyntax>
+ <phpsyntax function="mysql_insert_id" usage=""></phpsyntax>
+ <phpsyntax function="mysql_list_dbs" usage=""></phpsyntax>
+ <phpsyntax function="mysql_list_fields" usage=""></phpsyntax>
+ <phpsyntax function="mysql_list_tables" usage=""></phpsyntax>
+ <phpsyntax function="mysql_listdbs" usage=""></phpsyntax>
+ <phpsyntax function="mysql_listfields" usage=""></phpsyntax>
+ <phpsyntax function="mysql_listtables" usage=""></phpsyntax>
+ <phpsyntax function="mysql_num_fields" usage=""></phpsyntax>
+ <phpsyntax function="mysql_num_rows" usage=""></phpsyntax>
+ <phpsyntax function="mysql_numfields" usage=""></phpsyntax>
+ <phpsyntax function="mysql_numrows" usage=""></phpsyntax>
+ <phpsyntax function="mysql_pconnect" usage=""></phpsyntax>
+ <phpsyntax function="mysql_query" usage="resource mysql_query ( string query [, resource link_identifier [, int result_mode]])">
+mysql_query() sends a query to the currently active database on the server
+that's associated with the specified link identifier.
+If link_identifier isn't specified, the last opened link is assumed.
+If no link is open, the function tries to establish a link as if mysql_connect()
+was called with no arguments, and use it.
+
+The optional result_mode parameter can be MYSQL_USE_RESULT and MYSQL_STORE_RESULT.
+It defaults to MYSQL_STORE_RESULT, so the result is buffered.
+See also mysql_unbuffered_query() for the counterpart of this behaviour.
+ </phpsyntax>
<phpsyntax function="mysql_result"></phpsyntax>
<phpsyntax function="mysql_select_db"></phpsyntax>
<phpsyntax function="mysql_selectdb"></phpsyntax>
<phpsyntax function="mysql_tablename"></phpsyntax>
- <phpsyntax function="mysql_unbuffered_query"></phpsyntax>
+ <phpsyntax function="mysql_unbuffered_query" usage="resource mysql_unbuffered_query ( string query [, resource link_identifier [, int result_mode]])">
+mysql_unbuffered_query() sends a SQL query query to MySQL, without fetching and buffering the
+result rows automatically, as mysql_query() does.
+On the one hand, this saves a considerable amount of memory with SQL queries
+that produce large result sets. On the other hand, you can start working on
+the result set immediately after the first row has been retrieved: you don't
+have to wait until the complete SQL query has been performed. When using multiple DB-connects,
+you have to specify the optional parameter link_identifier.
+
+The optional result_mode parameter can be MYSQL_USE_RESULT and MYSQL_STORE_RESULT.
+It defaults to MYSQL_USE_RESULT, so the result is not buffered.
+See also mysql_query() for the counterpart of this behaviour.
+ </phpsyntax>
<phpsyntax function="natcasesort"></phpsyntax>
<phpsyntax function="natsort"></phpsyntax>
<phpsyntax function="new_xmldoc"></phpsyntax>
<phpsyntax function="strtoupper"></phpsyntax>
<phpsyntax function="strtr"></phpsyntax>
<phpsyntax function="strval"></phpsyntax>
- <phpsyntax function="substr" usage="string substr(string str, int start [, int length])\n" description="Returns part of a string"></phpsyntax>
+ <phpsyntax function="substr" usage="string substr(string str, int start [, int length])">Returns part of a string</phpsyntax>
<phpsyntax function="substr_count"></phpsyntax>
<phpsyntax function="substr_replace"></phpsyntax>
<phpsyntax function="swf_actiongeturl"></phpsyntax>
git://secure.phpeclipse.com / phpeclipse.git / blobdiff