diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000000..b2f1b48faafa --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +entities.*.xml diff --git a/appendices/aliases.xml b/appendices/aliases.xml index a8408ce1a133..f1eeadbcdce3 100644 --- a/appendices/aliases.xml +++ b/appendices/aliases.xml @@ -31,56 +31,6 @@ gettext Gettext - - add - swfmovie_add - Ming (flash) - - - add - swfsprite_add - Ming (flash) - - - addaction - swfbutton_addAction - Ming (flash) - - - addcolor - swfdisplayitem_addColor - Ming (flash) - - - addentry - swfgradient_addEntry - Ming (flash) - - - addfill - swfshape_addfill - Ming (flash) - - - addshape - swfbutton_addShape - Ming (flash) - - - addstring - swftext_addString - Ming (flash) - - - addstring - swftextfield_addString - Ming (flash) - - - align - swftextfield_align - Ming (flash) - chop rtrim @@ -121,51 +71,6 @@ floatval Base syntax - - drawarc - swfshape_drawarc - Ming (flash) - - - drawcircle - swfshape_drawcircle - Ming (flash) - - - drawcubic - swfshape_drawcubic - Ming (flash) - - - drawcubicto - swfshape_drawcubicto - Ming (flash) - - - drawcurve - swfshape_drawcurve - Ming (flash) - - - drawcurveto - swfshape_drawcurveto - Ming (flash) - - - drawglyph - swfshape_drawglyph - Ming (flash) - - - drawline - swfshape_drawline - Ming (flash) - - - drawlineto - swfshape_drawlineto - Ming (flash) - fbsql fbsql_db_query @@ -176,66 +81,6 @@ fwrite Base syntax - - getascent - swffont_getAscent - Ming (flash) - - - getascent - swftext_getAscent - Ming (flash) - - - getdescent - swffont_getDescent - Ming (flash) - - - getdescent - swftext_getDescent - Ming (flash) - - - getheight - swfbitmap_getHeight - Ming (flash) - - - getleading - swffont_getLeading - Ming (flash) - - - getleading - swftext_getLeading - Ming (flash) - - - getshape1 - swfmorph_getShape1 - Ming (flash) - - - getshape2 - swfmorph_getShape2 - Ming (flash) - - - getwidth - swfbitmap_getWidth - Ming (flash) - - - getwidth - swffont_getWidth - Ming (flash) - - - getwidth - swftext_getWidth - Ming (flash) - gzputs gzwrite @@ -371,16 +216,6 @@ array_key_exists Base syntax - - labelframe - swfmovie_labelFrame - Ming (flash) - - - labelframe - swfsprite_labelFrame - Ming (flash) - ldap_close ldap_unbind @@ -416,46 +251,6 @@ mb_substr Multi-bytes Strings - - ming_setcubicthreshold - ming_setCubicThreshold - Ming (flash) - - - ming_setscale - ming_setScale - Ming (flash) - - - move - swfdisplayitem_move - Ming (flash) - - - movepen - swfshape_movepen - Ming (flash) - - - movepento - swfshape_movepento - Ming (flash) - - - moveto - swfdisplayitem_moveTo - Ming (flash) - - - moveto - swffill_moveTo - Ming (flash) - - - moveto - swftext_moveTo - Ming (flash) - msql msql_db_query @@ -546,201 +341,6 @@ msql_result mSQL - - mssql_affected_rows - sybase_affected_rows - Sybase - - - mssql_affected_rows - sybase_affected_rows - Sybase - - - mssql_close - sybase_close - Sybase - - - mssql_close - sybase_close - Sybase - - - mssql_connect - sybase_connect - Sybase - - - mssql_connect - sybase_connect - Sybase - - - mssql_data_seek - sybase_data_seek - Sybase - - - mssql_data_seek - sybase_data_seek - Sybase - - - mssql_fetch_array - sybase_fetch_array - Sybase - - - mssql_fetch_array - sybase_fetch_array - Sybase - - - mssql_fetch_field - sybase_fetch_field - Sybase - - - mssql_fetch_field - sybase_fetch_field - Sybase - - - mssql_fetch_object - sybase_fetch_object - Sybase - - - mssql_fetch_object - sybase_fetch_object - Sybase - - - mssql_fetch_row - sybase_fetch_row - Sybase - - - mssql_fetch_row - sybase_fetch_row - Sybase - - - mssql_field_seek - sybase_field_seek - Sybase - - - mssql_field_seek - sybase_field_seek - Sybase - - - mssql_free_result - sybase_free_result - Sybase - - - mssql_free_result - sybase_free_result - Sybase - - - mssql_get_last_message - sybase_get_last_message - Sybase - - - mssql_get_last_message - sybase_get_last_message - Sybase - - - mssql_min_client_severity - sybase_min_client_severity - Sybase - - - mssql_min_error_severity - sybase_min_error_severity - Sybase - - - mssql_min_message_severity - sybase_min_message_severity - Sybase - - - mssql_min_server_severity - sybase_min_server_severity - Sybase - - - mssql_num_fields - sybase_num_fields - Sybase - - - mssql_num_fields - sybase_num_fields - Sybase - - - mssql_num_rows - sybase_num_rows - Sybase - - - mssql_num_rows - sybase_num_rows - Sybase - - - mssql_pconnect - sybase_pconnect - Sybase - - - mssql_pconnect - sybase_pconnect - Sybase - - - mssql_query - sybase_query - Sybase - - - mssql_query - sybase_query - Sybase - - - mssql_result - sybase_result - Sybase - - - mssql_result - sybase_result - Sybase - - - mssql_select_db - sybase_select_db - Sybase - - - mssql_select_db - sybase_select_db - Sybase - - - multcolor - swfdisplayitem_multColor - Ming (flash) - mysql mysql_db_query @@ -831,16 +431,6 @@ mysql_result MySQL - - nextframe - swfmovie_nextFrame - Ming (flash) - - - nextframe - swfsprite_nextFrame - Ming (flash) - ociassignelem OCI-Collection::assignElem @@ -1091,11 +681,6 @@ odbc_field_len ODBC - - output - swfmovie_output - Ming (flash) - pdf_add_outline pdf_add_bookmark @@ -1121,211 +706,6 @@ recode_string Recode - - remove - swfmovie_remove - Ming (flash) - - - remove - swfsprite_remove - Ming (flash) - - - rotate - swfdisplayitem_rotate - Ming (flash) - - - rotateto - swfdisplayitem_rotateTo - Ming (flash) - - - rotateto - swffill_rotateTo - Ming (flash) - - - save - swfmovie_save - Ming (flash) - - - savetofile - swfmovie_saveToFile - Ming (flash) - - - scale - swfdisplayitem_scale - Ming (flash) - - - scaleto - swfdisplayitem_scaleTo - Ming (flash) - - - scaleto - swffill_scaleTo - Ming (flash) - - - setaction - swfbutton_setAction - Ming (flash) - - - setbackground - swfmovie_setBackground - Ming (flash) - - - setbounds - swftextfield_setBounds - Ming (flash) - - - setcolor - swftext_setColor - Ming (flash) - - - setcolor - swftextfield_setColor - Ming (flash) - - - setdepth - swfdisplayitem_setDepth - Ming (flash) - - - setdimension - swfmovie_setDimension - Ming (flash) - - - setdown - swfbutton_setDown - Ming (flash) - - - setfont - swftext_setFont - Ming (flash) - - - setfont - swftextfield_setFont - Ming (flash) - - - setframes - swfmovie_setFrames - Ming (flash) - - - setframes - swfsprite_setFrames - Ming (flash) - - - setheight - swftext_setHeight - Ming (flash) - - - setheight - swftextfield_setHeight - Ming (flash) - - - sethit - swfbutton_setHit - Ming (flash) - - - setindentation - swftextfield_setIndentation - Ming (flash) - - - setleftfill - swfshape_setleftfill - Ming (flash) - - - setleftmargin - swftextfield_setLeftMargin - Ming (flash) - - - setline - swfshape_setline - Ming (flash) - - - setlinespacing - swftextfield_setLineSpacing - Ming (flash) - - - setmargins - swftextfield_setMargins - Ming (flash) - - - setmatrix - swfdisplayitem_setMatrix - Ming (flash) - - - setname - swfdisplayitem_setName - Ming (flash) - - - setname - swftextfield_setName - Ming (flash) - - - setover - swfbutton_setOver - Ming (flash) - - - setrate - swfmovie_setRate - Ming (flash) - - - setratio - swfdisplayitem_setRatio - Ming (flash) - - - setrightfill - swfshape_setrightfill - Ming (flash) - - - setrightmargin - swftextfield_setRightMargin - Ming (flash) - - - setspacing - swftext_setSpacing - Ming (flash) - - - setup - swfbutton_setUp - Ming (flash) - show_source highlight_file @@ -1336,36 +716,6 @@ count Base syntax - - skewx - swfdisplayitem_skewX - Ming (flash) - - - skewxto - swfdisplayitem_skewXTo - Ming (flash) - - - skewxto - swffill_skewXTo - Ming (flash) - - - skewy - swfdisplayitem_skewY - Ming (flash) - - - skewyto - swfdisplayitem_skewYTo - Ming (flash) - - - skewyto - swffill_skewYTo - Ming (flash) - snmpwalkoid snmprealwalk @@ -1376,71 +726,6 @@ strstr Base syntax - - streammp3 - swfmovie_streamMp3 - Ming (flash) - - - swfaction - swfaction_init - Ming (flash) - - - swfbitmap - swfbitmap_init - Ming (flash) - - - swfbutton - swfbutton_init - Ming (flash) - - - swffill - swffill_init - Ming (flash) - - - swffont - swffont_init - Ming (flash) - - - swfgradient - swfgradient_init - Ming (flash) - - - swfmorph - swfmorph_init - Ming (flash) - - - swfmovie - swfmovie_init - Ming (flash) - - - swfshape - swfshape_init - Ming (flash) - - - swfsprite - swfsprite_init - Ming (flash) - - - swftext - swftext_init - Ming (flash) - - - swftextfield - swftextfield_init - Ming (flash) - xptr_new_context xpath_new_context diff --git a/appendices/extensions.xml b/appendices/extensions.xml index 527103dec3bf..d31c7a4e309c 100644 --- a/appendices/extensions.xml +++ b/appendices/extensions.xml @@ -13,28 +13,20 @@ - - - - - - - - @@ -52,7 +44,6 @@ - @@ -62,7 +53,6 @@ - @@ -72,33 +62,23 @@ - - - - - - - - - - @@ -108,22 +88,17 @@ - - - - - @@ -133,21 +108,16 @@ - - - - - @@ -167,7 +137,6 @@ - @@ -180,20 +149,14 @@ - - - - - - @@ -209,16 +172,13 @@ - - - @@ -233,10 +193,8 @@ - - @@ -352,7 +310,6 @@ - @@ -373,7 +330,6 @@ - @@ -389,16 +345,8 @@ &extcat.membership.pecl; - - - - - - - - @@ -406,60 +354,39 @@ - - - - - - - - - - - - - - - - - - - - - @@ -472,18 +399,13 @@ - - - - + - - @@ -491,21 +413,17 @@ - - - - @@ -535,23 +453,16 @@ &extcat.state.experimental; - - - - - - - diff --git a/appendices/ini.core.xml b/appendices/ini.core.xml index 322aefe8959d..a3c16c5a5155 100644 --- a/appendices/ini.core.xml +++ b/appendices/ini.core.xml @@ -1274,7 +1274,7 @@ See also: magic_quotes_gpc, magic_quotes_runtime, and - magic_quotes_sybase. + magic_quotes_sybase. @@ -1671,7 +1671,7 @@ include_path = ".:${USER}/pear/php" Name of dynamically loadable Zend extension (for example - APD) to load when PHP starts up. + XDebug) to load when PHP starts up. diff --git a/appendices/ini.list.xml b/appendices/ini.list.xml index adbbcc3e35cb..e96bfe8225ba 100644 --- a/appendices/ini.list.xml +++ b/appendices/ini.list.xml @@ -48,186 +48,6 @@ PHP_INI_PERDIR - - apc.cache_by_default - "1" - PHP_INI_ALL - PHP_INI_SYSTEM in APC <= 3.0.12. Available since APC 3.0.0. - - - apc.enabled - "1" - PHP_INI_SYSTEM - PHP_INI_SYSTEM in APC 2. PHP_INI_ALL in APC <= 3.0.12. - - - apc.enable_cli - "0" - PHP_INI_SYSTEM - Available since APC 3.0.7. - - - apc.file_update_protection - "2" - PHP_INI_SYSTEM - Available since APC 3.0.6. - - - apc.filters - NULL - PHP_INI_SYSTEM - - - - apc.gc_ttl - "3600" - PHP_INI_SYSTEM - - - - apc.include_once_override - "0" - PHP_INI_SYSTEM - Available since APC 3.0.12. - - - apc.localcache - "0" - PHP_INI_SYSTEM - Available since APC 3.0.14. - - - apc.localcache.size - "512" - PHP_INI_SYSTEM - Available since APC 3.0.14. - - - apc.max_file_size - "1M" - PHP_INI_SYSTEM - Available since APC 3.0.7. - - - apc.mmap_file_mask - NULL - PHP_INI_SYSTEM - - - - apc.num_files_hint - "1000" - PHP_INI_SYSTEM - - - - apc.optimization - "0" - PHP_INI_ALL - PHP_INI_SYSTEM in APC 2. Removed in APC 3.0.13. - - - apc.report_autofilter - "0" - PHP_INI_SYSTEM - Available since APC 3.0.11. - - - apc.rfc1867 - "0" - PHP_INI_SYSTEM - Available since APC 3.0.13. - - - apc.rfc1867_freq - "0" - PHP_INI_SYSTEM - - - - apc.rfc1867_name - "APC_UPLOAD_PROGRESS" - PHP_INI_SYSTEM - - - - apc.rfc1867_prefix - "upload_" - PHP_INI_SYSTEM - - - - apc.shm_segments - "1" - PHP_INI_SYSTEM - - - - apc.shm_size - "30" - PHP_INI_SYSTEM - - - - apc.slam_defense - "0" - PHP_INI_SYSTEM - Available since APC 3.0.0. - - - apc.stat - "1" - PHP_INI_SYSTEM - Available since APC 3.0.10. - - - apc.stat_ctime - "0" - PHP_INI_SYSTEM - Available since APC 3.0.13. - - - apc.ttl - "0" - PHP_INI_SYSTEM - Available since APC 3.0.0. - - - apc.user_entries_hint - "4096" - PHP_INI_SYSTEM - Available since APC 3.0.0. - - - apc.user_ttl - "0" - PHP_INI_SYSTEM - Available since APC 3.0.0. - - - apc.write_lock - "1" - PHP_INI_SYSTEM - Available since APC 3.0.11. - - - apd.bitmask - "0" - PHP_INI_ALL - Removed in apd 0.9. - - - apd.dumpdir - NULL - PHP_INI_ALL - - - - apd.statement_tracing - "0" - PHP_INI_ALL - Available since apd 0.9. - arg_separator.input "&" @@ -984,30 +804,6 @@ PHP_INI_ALL - - htscanner.config_file - ".htaccess" - PHP_INI_SYSTEM - - - - htscanner.default_docroot - "/" - PHP_INI_SYSTEM - - - - htscanner.default_ttl - "300" - PHP_INI_SYSTEM - Available since htscanner 0.6.0. - - - htscanner.stop_on_error - "0" - PHP_INI_SYSTEM - Available since htscanner 0.7.0. - http.allowed_methods "" @@ -1436,12 +1232,6 @@ PHP_INI_ALL Removed in PHP 5.4.0. - - magic_quotes_sybase - "0" - PHP_INI_ALL - Removed in PHP 5.4.0. - mail.add_x_header "0" @@ -2244,13 +2034,13 @@ Added in PHP 5.3.0 - runkit.internal_override + runkit.internal_override "0" PHP_INI_SYSTEM - runkit.superglobal + runkit.superglobal "" PHP_INI_PERDIR @@ -2649,66 +2439,6 @@ - - sybase.allow_persistent - "1" - PHP_INI_ALL - - - - sybase.interface_file - "" - PHP_INI_ALL - - - - sybase.max_links - "-1" - PHP_INI_ALL - - - - sybase.max_persistent - "-1" - PHP_INI_ALL - - - - sybase.min_error_severity - "10" - PHP_INI_ALL - - - - sybase.min_message_severity - "10" - PHP_INI_ALL - - - - sybct.deadlock_retry_count - "0" - PHP_INI_ALL - - - - sybct.login_timeout - "-1" - PHP_INI_ALL - - - - sybct.packet_size - "0" - PHP_INI_ALL - - - - sybct.timeout - "0" - PHP_INI_ALL - - syslog.facility "LOG_USER" diff --git a/appendices/migration51.xml b/appendices/migration51.xml index b540ddc33a2a..1fdf0d5fc636 100644 --- a/appendices/migration51.xml +++ b/appendices/migration51.xml @@ -588,7 +588,7 @@ class test { pecl/dio - ext/fam + ext/fam Not actively maintained @@ -600,11 +600,11 @@ class test { Not actively maintained - ext/mcve + ext/mcve pecl/mcve - ext/mnogosearch + ext/mnogosearch Not actively maintained @@ -627,7 +627,7 @@ class test { pecl/ffi - ext/yp + ext/yp Not actively maintained diff --git a/appendices/migration52.xml b/appendices/migration52.xml index 78b7af001c20..bf67a5f565df 100644 --- a/appendices/migration52.xml +++ b/appendices/migration52.xml @@ -669,7 +669,7 @@ $obj->getCommentName(''); - ming: + ming: @@ -938,7 +938,7 @@ $obj->getCommentName(''); - ming (As of PHP 5.2.1): + ming (As of PHP 5.2.1): @@ -1291,7 +1291,7 @@ $obj->getCommentName(''); - Hyperwave API + Hyperwave API @@ -1696,7 +1696,7 @@ $obj->getCommentName(''); - ming: + ming: diff --git a/appendices/migration53.xml b/appendices/migration53.xml index 7591a6e8e716..a60ce77bb44e 100644 --- a/appendices/migration53.xml +++ b/appendices/migration53.xml @@ -594,7 +594,7 @@ try { - magic_quotes_sybase + magic_quotes_sybase @@ -849,7 +849,7 @@ try { - sybase_ct: + sybase_ct: @@ -1535,8 +1535,7 @@ try { - ming - - Maintained + ming - Maintained @@ -1553,8 +1552,8 @@ try { - sybase - - Discontinued; use the sybase_ct + sybase + - Discontinued; use the sybase_ct extension instead diff --git a/appendices/migration54.xml b/appendices/migration54.xml index 708241a58743..2b20ac1fd736 100644 --- a/appendices/migration54.xml +++ b/appendices/migration54.xml @@ -1285,7 +1285,7 @@ magic_quotes_gpc, magic_quotes_runtime, - and magic_quotes_sybase + and magic_quotes_sybase diff --git a/appendices/migration70/incompatible/removed-functions.xml b/appendices/migration70/incompatible/removed-functions.xml index 81964064a278..8e4927b02d9a 100644 --- a/appendices/migration70/incompatible/removed-functions.xml +++ b/appendices/migration70/incompatible/removed-functions.xml @@ -65,9 +65,13 @@ All ext/mssql functions - All ext/mssql functions were removed. - For a list of alternatives, see the - MSSQL Introduction. + All ext/mssql functions were removed. + + PDO_SQLSRV + PDO_ODBC + SQLSRV + Unified ODBC API + diff --git a/faq/using.xml b/faq/using.xml index 8ba6165bffb6..8c5be8d2dda1 100644 --- a/faq/using.xml +++ b/faq/using.xml @@ -406,10 +406,6 @@ foreach ($headers as $name => $content) { FPDF and TCPDF. - - There is also the Haru extension - that uses the free libHaru external library. - diff --git a/install/windows/legacy/extensions.xml b/install/windows/legacy/extensions.xml index 9472dffd280f..4e32e8095553 100644 --- a/install/windows/legacy/extensions.xml +++ b/install/windows/legacy/extensions.xml @@ -132,11 +132,6 @@ extension=php_bz2.dll Calendar conversion functions None - - php_crack.dll - Crack functions - None - php_ctype.dll ctype family functions @@ -274,21 +269,11 @@ extension=php_bz2.dll Mimetype functions Requires: magic.mime (bundled) - - php_ming.dll - Ming functions for Flash - None - php_msql.dll mSQL functions Requires: msql.dll (bundled) - - php_mssql.dll - MSSQL functions - Requires: ntwdblib.dll (bundled) - php_mysql.dll MySQL functions @@ -341,11 +326,6 @@ extension=php_bz2.dll Socket functions None - - php_sybase_ct.dll - Sybase functions - Requires: Sybase client libraries - php_tidy.dll Tidy functions diff --git a/language-snippets.ent b/language-snippets.ent index 3a6b7b82926f..a4590b569d0a 100644 --- a/language-snippets.ent +++ b/language-snippets.ent @@ -325,8 +325,8 @@ This function should be used at your own risk. '> The IMAP, recode, -YAZ and Cyrus +linkend="book.imap">IMAP, recode and +YAZ extensions cannot be used in conjunction, because they share the same internal symbols. Note: Yaz 2.0 and above does not suffer from this problem.'> diff --git a/reference/apache/functions/apache-child-terminate.xml b/reference/apache/functions/apache-child-terminate.xml index 813f2bc2b5e1..4f4b12501354 100644 --- a/reference/apache/functions/apache-child-terminate.xml +++ b/reference/apache/functions/apache-child-terminate.xml @@ -21,6 +21,11 @@ been run as memory will usually only be freed internally but not given back to the operating system. + + Works in the Apache, FastCGI and + NSAPI server module + in Netscape/iPlanet/SunONE webservers. + @@ -34,31 +39,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - This function became available under FastCGI. Previously, it was - supported only when PHP was installed as an Apache module. - - - - - - - - &reftitle.notes; ¬e.no-windows; diff --git a/reference/apache/functions/apache-request-headers.xml b/reference/apache/functions/apache-request-headers.xml index 575c28c23d58..b959fdea5804 100644 --- a/reference/apache/functions/apache-request-headers.xml +++ b/reference/apache/functions/apache-request-headers.xml @@ -14,7 +14,9 @@ - Fetches all HTTP request headers from the current request. + Fetches all HTTP request headers from the current request. Works in the + Apache, FastCGI, CLI, FPM and NSAPI server module + in Netscape/iPlanet/SunONE webservers. @@ -44,21 +46,6 @@ This function became available in the FPM SAPI. - - 5.5.7 - - This function became available in the CLI server. - - - - 5.4.0 - - This function became available under FastCGI. Previously, it was - supported when PHP was installed as an Apache module or by the - NSAPI server module in Netscape/iPlanet/SunONE - webservers. - - diff --git a/reference/apache/functions/apache-response-headers.xml b/reference/apache/functions/apache-response-headers.xml index 220955aef742..f81ada55721e 100644 --- a/reference/apache/functions/apache-response-headers.xml +++ b/reference/apache/functions/apache-response-headers.xml @@ -14,7 +14,9 @@ - Fetch all HTTP response headers. + Fetch all HTTP response headers. Works in the + Apache, FastCGI, CLI, FPM and NSAPI server module + in Netscape/iPlanet/SunONE webservers. @@ -24,39 +26,6 @@ An array of all Apache response headers on success&return.falseforfailure;. - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.5.7 - - This function became available in the CLI server. - - - - 5.4.0 - - This function became available under FastCGI. Previously, it was - supported when PHP was installed as an Apache module or by the - NSAPI server module in Netscape/iPlanet/SunONE - webservers. - - - - - - - &reftitle.examples; diff --git a/reference/apache/functions/getallheaders.xml b/reference/apache/functions/getallheaders.xml index 61f51a5ef98d..ed4a80563240 100644 --- a/reference/apache/functions/getallheaders.xml +++ b/reference/apache/functions/getallheaders.xml @@ -49,21 +49,6 @@ This function became available in the FPM SAPI. - - 5.5.7 - - This function became available in the CLI server. - - - - 5.4.0 - - This function became available under FastCGI. Previously, it was - supported when PHP was installed as an Apache module or by the - NSAPI server module in Netscape/iPlanet/SunONE - webservers. - - diff --git a/reference/apc/apciterator.xml b/reference/apc/apciterator.xml deleted file mode 100644 index a8411b11f458..000000000000 --- a/reference/apc/apciterator.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - The APCIterator class - APCIterator - - - - -
- &reftitle.intro; - - The APCIterator class makes it easier to iterate - over large APC caches. This is helpful as it allows iterating over large - caches in steps, while grabbing a defined number of entries per lock instance, - so it frees the cache locks for other activities rather than hold up the - entire cache to grab 100 (the default) entries. Also, using regular expression - matching is more efficient as it's been moved to the C level. - -
- - -
- &reftitle.classsynopsis; - - - - APCIterator - - - - - APCIterator - - - - Iterator - - - - - - Methods - - - - -
- - - - &reference.apc.entities.apciterator; - - - - diff --git a/reference/apc/apciterator/construct.xml b/reference/apc/apciterator/construct.xml deleted file mode 100644 index 3fa1a22922ed..000000000000 --- a/reference/apc/apciterator/construct.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - APCIterator::__construct - Constructs an APCIterator iterator object - - - - &reftitle.description; - - public APCIterator::__construct - stringcache - mixedsearch&null; - intformatAPC_ITER_ALL - intchunk_size100 - intlistAPC_LIST_ACTIVE - - - Constructs an APCIterator object. - - - - - &reftitle.parameters; - - - cache - - - The cache type, which will be user or - file. - - - - - search - - - A PCRE regular expression that - matches against APC key names, either as a string for - a single regular expression, or as an array of regular - expressions. Or, optionally pass in &null; to skip the search. - - - - - format - - - The desired format, as configured with one or more of the - APC_ITER_* constants. - - - - - chunk_size - - - The chunk size. Must be a value greater than 0. The default - value is 100. - - - - - list - - - The type to list. Either pass in APC_LIST_ACTIVE - or APC_LIST_DELETED. - - - - - - - - &reftitle.returnvalues; - - An APCIterator object on success, - or &null; on failure. - - - - - &reftitle.examples; - - - A <function>APCIterator::__construct</function> example - - -]]> - - - - - - - &reftitle.seealso; - - apc_exists - apc_cache_info - - - - - - diff --git a/reference/apc/apciterator/current.xml b/reference/apc/apciterator/current.xml deleted file mode 100644 index dc8e6035ae2f..000000000000 --- a/reference/apc/apciterator/current.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - APCIterator::current - Get current item - - - - &reftitle.description; - - public mixedAPCIterator::current - - - - Gets the current item from the APCIterator stack. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the current item on success, or &false; if no - more items or exist, or on failure. - - - - - &reftitle.seealso; - - APCIterator::next - Iterator::current - - - - - - diff --git a/reference/apc/apciterator/gettotalcount.xml b/reference/apc/apciterator/gettotalcount.xml deleted file mode 100644 index e0bce96f60d5..000000000000 --- a/reference/apc/apciterator/gettotalcount.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - APCIterator::getTotalCount - Get total count - - - - &reftitle.description; - - public intAPCIterator::getTotalCount - - - - Get the total count. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The total count. - - - - - &reftitle.seealso; - - APCIterator::getTotalHits - APCIterator::getTotalSize - apc_cache_info - - - - - - diff --git a/reference/apc/apciterator/gettotalhits.xml b/reference/apc/apciterator/gettotalhits.xml deleted file mode 100644 index 501d78a040e3..000000000000 --- a/reference/apc/apciterator/gettotalhits.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - APCIterator::getTotalHits - Get total cache hits - - - - &reftitle.description; - - public intAPCIterator::getTotalHits - - - - Gets the total number of cache hits. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The number of hits on success, or &false; on failure. - - - - - &reftitle.seealso; - - APCIterator::getTotalCount - APCIterator::getTotalSize - apc_cache_info - - - - - - diff --git a/reference/apc/apciterator/gettotalsize.xml b/reference/apc/apciterator/gettotalsize.xml deleted file mode 100644 index 7919955aa0cf..000000000000 --- a/reference/apc/apciterator/gettotalsize.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - - APCIterator::getTotalSize - Get total cache size - - - - &reftitle.description; - - public intAPCIterator::getTotalSize - - - - Gets the total cache size. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The total cache size. - - - - - &reftitle.seealso; - - APCIterator::getTotalCount - APCIterator::getTotalHits - apc_cache_info - - - - - - diff --git a/reference/apc/apciterator/key.xml b/reference/apc/apciterator/key.xml deleted file mode 100644 index d56f925d04b0..000000000000 --- a/reference/apc/apciterator/key.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - APCIterator::key - Get iterator key - - - - &reftitle.description; - - public stringAPCIterator::key - - - - Gets the current iterator key. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the key on success, or &false; upon failure. - - - - - &reftitle.seealso; - - APCIterator::current - Iterator::key - - - - - - diff --git a/reference/apc/apciterator/next.xml b/reference/apc/apciterator/next.xml deleted file mode 100644 index 35c8bd3981a0..000000000000 --- a/reference/apc/apciterator/next.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - APCIterator::next - Move pointer to next item - - - - &reftitle.description; - - public boolAPCIterator::next - - - - Moves the iterator pointer to the next element. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - APCIterator::current - APCIterator::rewind - Iterator::next - - - - - - diff --git a/reference/apc/apciterator/rewind.xml b/reference/apc/apciterator/rewind.xml deleted file mode 100644 index 1a0ccc43d6ed..000000000000 --- a/reference/apc/apciterator/rewind.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - APCIterator::rewind - Rewinds iterator - - - - &reftitle.description; - - public voidAPCIterator::rewind - - - - Rewinds back the iterator to the first element. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - APCIterator::next - Iterator::next - - - - - - diff --git a/reference/apc/apciterator/valid.xml b/reference/apc/apciterator/valid.xml deleted file mode 100644 index 1b20c54cd579..000000000000 --- a/reference/apc/apciterator/valid.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - APCIterator::valid - Checks if current position is valid - - - - &reftitle.description; - - public boolAPCIterator::valid - - - - Checks if the current iterator position is valid. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; if the current iterator position is valid, otherwise &false;. - - - - - &reftitle.seealso; - - APCIterator::current - Iterator::valid - - - - - - diff --git a/reference/apc/book.xml b/reference/apc/book.xml deleted file mode 100644 index 6a5da529a64f..000000000000 --- a/reference/apc/book.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - Alternative PHP Cache - APC - - - &reftitle.intro; - - The Alternative PHP Cache (APC) is a free and open opcode cache for PHP. - Its goal is to provide a free, open, and robust framework for - caching and optimizing PHP intermediate code. - - - - &pecl.info.dead.git; &url.apc.source;. - - - - - Alternatives to this extension are OPcache, APCu, - Windows Cache for PHP and the Session Upload Progress API. - - - - - &reference.apc.setup; - &reference.apc.constants; - &reference.apc.reference; - &reference.apc.apciterator; - - - - - diff --git a/reference/apc/constants.xml b/reference/apc/constants.xml deleted file mode 100644 index 074825720eb2..000000000000 --- a/reference/apc/constants.xml +++ /dev/null @@ -1,264 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - - - APC_BIN_VERIFY_CRC32 - (integer) - - - - - - - - - - APC_BIN_VERIFY_MD5 - (integer) - - - - - - - - - - APC_ITER_ALL - (integer) - - - - - - - - - - APC_ITER_ATIME - (integer) - - - - - - - - - - APC_ITER_CTIME - (integer) - - - - - - - - - - APC_ITER_DEVICE - (integer) - - - - - - - - - - APC_ITER_DTIME - (integer) - - - - - - - - - - APC_ITER_FILENAME - (integer) - - - - - - - - - - APC_ITER_INODE - (integer) - - - - - - - - - - APC_ITER_KEY - (integer) - - - - - - - - - - APC_ITER_MD5 - (integer) - - - - - - - - - - APC_ITER_MEM_SIZE - (integer) - - - - - - - - - - APC_ITER_MTIME - (integer) - - - - - - - - - - APC_ITER_NONE - (integer) - - - - - - - - - - APC_ITER_NUM_HITS - (integer) - - - - - - - - - - APC_ITER_REFCOUNT - (integer) - - - - - - - - - - APC_ITER_TTL - (integer) - - - - - - - - - - APC_ITER_TYPE - (integer) - - - - - - - - - - APC_ITER_VALUE - (integer) - - - - - - - - - - APC_LIST_ACTIVE - (integer) - - - - - - - - - - APC_LIST_DELETED - (integer) - - - - - - - - - - - - diff --git a/reference/apc/functions/apc-add.xml b/reference/apc/functions/apc-add.xml deleted file mode 100644 index dab992b4bc9e..000000000000 --- a/reference/apc/functions/apc-add.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - apc_add - - Cache a new variable in the data store - - - - &reftitle.description; - - boolapc_add - stringkey - mixedvar - intttl0 - - - arrayapc_add - arrayvalues - mixedunusedNULL - intttl0 - - - Caches a variable in the data store, only if it's not already stored. - - - - Unlike many other mechanisms in PHP, variables stored using - apc_add will persist between requests (until the - value is removed from the cache). - - - - - &reftitle.parameters; - - - - key - - - Store the variable using this name. keys are - cache-unique, so attempting to use apc_add to - store data with a key that already exists will not overwrite the - existing data, and will instead return &false;. (This is the only - difference between apc_add and - apc_store.) - - - - - var - - - The variable to store - - - - - ttl - - - Time To Live; store var in the cache for - ttl seconds. After the - ttl has passed, the stored variable will be - expunged from the cache (on the next request). If no ttl - is supplied (or if the ttl is - 0), the value will persist until it is removed from - the cache manually, or otherwise fails to exist in the cache (clear, - restart, etc.). - - - - - values - - - Names in key, variables in value. - - - - - - - - &reftitle.returnvalues; - - Returns TRUE if something has effectively been added into the cache, FALSE otherwise. - Second syntax returns array with error keys. - - - - - &reftitle.examples; - - - A <function>apc_add</function> example - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - apc_store - apc_fetch - apc_delete - - - - - - - diff --git a/reference/apc/functions/apc-bin-dump.xml b/reference/apc/functions/apc-bin-dump.xml deleted file mode 100644 index a26e8751003c..000000000000 --- a/reference/apc/functions/apc-bin-dump.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - apc_bin_dump - Get a binary dump of the given files and user variables - - - - &reftitle.description; - - stringapc_bin_dump - arrayfilesNULL - arrayuser_varsNULL - - - Returns a binary dump of the given files and user variables from the APC cache. - A &null; for files or user_vars signals a dump of every entry, whereas array() will dump - nothing. - - - - - &reftitle.parameters; - - - files - - - The files. Passing in &null; signals a dump of every entry, while - passing in array will dump nothing. - - - - - user_vars - - - The user vars. Passing in &null; signals a dump of every entry, while - passing in array will dump nothing. - - - - - - - - &reftitle.returnvalues; - - 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. - - - - - &reftitle.seealso; - - apc_bin_dumpfile - apc_bin_load - - - - - - diff --git a/reference/apc/functions/apc-bin-dumpfile.xml b/reference/apc/functions/apc-bin-dumpfile.xml deleted file mode 100644 index 42f52239b4de..000000000000 --- a/reference/apc/functions/apc-bin-dumpfile.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - apc_bin_dumpfile - Output a binary dump of cached files and user variables to a file - - - - &reftitle.description; - - intapc_bin_dumpfile - arrayfiles - arrayuser_vars - stringfilename - intflags0 - resourcecontextNULL - - - Outputs a binary dump of the given files and user variables from the APC - cache to the named file. - - - - - &reftitle.parameters; - - - files - - - The file names being dumped. - - - - - user_vars - - - The user variables being dumped. - - - - - filename - - - The filename where the dump is being saved. - - - - - flags - - - Flags passed to the filename stream. See the - file_put_contents documentation for details. - - - - - context - - - The context passed to the filename stream. See the - file_put_contents documentation for details. - - - - - - - - &reftitle.returnvalues; - - 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. - - - - - &reftitle.seealso; - - apc_bin_dump - apc_bin_load - - - - - - diff --git a/reference/apc/functions/apc-bin-load.xml b/reference/apc/functions/apc-bin-load.xml deleted file mode 100644 index 6f4754dbcb2a..000000000000 --- a/reference/apc/functions/apc-bin-load.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - apc_bin_load - Load a binary dump into the APC file/user cache - - - - &reftitle.description; - - boolapc_bin_load - stringdata - intflags0 - - - Loads the given binary dump into the APC file/user cache. - - - - - &reftitle.parameters; - - - data - - - The binary dump being loaded, likely from - apc_bin_dump. - - - - - flags - - - Either APC_BIN_VERIFY_CRC32, APC_BIN_VERIFY_MD5, - or both. - - - - - - - - &reftitle.returnvalues; - - 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). - - - - - &reftitle.examples; - - <function>apc_bin_load</function> example - - -]]> - - - - - - &reftitle.seealso; - - apc_bin_dump - apc_bin_loadfile - - - - - - diff --git a/reference/apc/functions/apc-bin-loadfile.xml b/reference/apc/functions/apc-bin-loadfile.xml deleted file mode 100644 index 7d9221367485..000000000000 --- a/reference/apc/functions/apc-bin-loadfile.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - apc_bin_loadfile - Load a binary dump from a file into the APC file/user cache - - - - &reftitle.description; - - boolapc_bin_loadfile - stringfilename - resourcecontextNULL - intflags0 - - - Loads a binary dump from a file into the APC file/user cache. - - - - - &reftitle.parameters; - - - filename - - - The file name containing the dump, likely from - apc_bin_dumpfile. - - - - - context - - - The files context. - - - - - flags - - - Either APC_BIN_VERIFY_CRC32, APC_BIN_VERIFY_MD5, - or both. - - - - - - - - &reftitle.returnvalues; - - 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). - - - - - &reftitle.seealso; - - apc_bin_dumpfile - apc_bin_load - - - - - diff --git a/reference/apc/functions/apc-cache-info.xml b/reference/apc/functions/apc-cache-info.xml deleted file mode 100644 index 39f28e610c91..000000000000 --- a/reference/apc/functions/apc-cache-info.xml +++ /dev/null @@ -1,182 +0,0 @@ - - - - - apc_cache_info - - Retrieves cached information from APC's data store - - - - &reftitle.description; - - arrayapc_cache_info - stringcache_type"" - boollimited&false; - - - Retrieves cached information and meta-data from APC's data store. - - - - - &reftitle.parameters; - - - - cache_type - - - If cache_type is "user", - information about the user cache will be returned. - - - If cache_type is "filehits", - information about which files have been served from the bytecode cache - for the current request will be returned. This feature must be enabled at - compile time using . - - - If an invalid or no cache_type is specified, information about - the system cache (cached files) will be returned. - - - - - limited - - - If limited is &true;, the - return value will exclude the individual list of cache entries. This - is useful when trying to optimize calls for statistics gathering. - - - - - - - - - &reftitle.returnvalues; - - Array of cached data (and meta-data)&return.falseforfailure; - - - - apc_cache_info will raise a warning if it is unable to - retrieve APC cache data. This typically occurs when APC is not enabled. - - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 3.0.11 - - The limited parameter was introduced. - - - - 3.0.16 - - The "filehits" option for the - cache_type parameter was introduced. - - - - - - - - - - &reftitle.examples; - - - A <function>apc_cache_info</function> example - - -]]> - - &example.outputs.similar; - - 2000 - [ttl] => 0 - [num_hits] => 9 - [num_misses] => 3 - [start_time] => 1123958803 - [cache_list] => Array - ( - [0] => Array - ( - [filename] => /path/to/apc_test.php - [device] => 29954 - [inode] => 1130511 - [type] => file - [num_hits] => 1 - [mtime] => 1123960686 - [creation_time] => 1123960696 - [deletion_time] => 0 - [access_time] => 1123962864 - [ref_count] => 1 - [mem_size] => 677 - ) - [1] => Array (...iterates for each cached file) -) -]]> - - - - - - - &reftitle.seealso; - - - APC configuration directives - APCIterator::getTotalSize - APCIterator::getTotalHits - APCIterator::getTotalCount - - - - - - - \ No newline at end of file diff --git a/reference/apc/functions/apc-cas.xml b/reference/apc/functions/apc-cas.xml deleted file mode 100644 index f0de46f42336..000000000000 --- a/reference/apc/functions/apc-cas.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - - apc_cas - Updates an old value with a new value - - - - &reftitle.description; - - boolapc_cas - stringkey - intold - intnew - - - apc_cas updates an already existing integer value if the - old parameter matches the currently stored value - with the value of the new parameter. - - - - - &reftitle.parameters; - - - key - - - The key of the value being updated. - - - - - old - - - The old value (the value currently stored). - - - - - new - - - The new value to update to. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - <function>apc_cas</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - apc_dec - apc_store - - - - - - diff --git a/reference/apc/functions/apc-clear-cache.xml b/reference/apc/functions/apc-clear-cache.xml deleted file mode 100644 index 01f76d39144e..000000000000 --- a/reference/apc/functions/apc-clear-cache.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - apc_clear_cache - - Clears the APC cache - - - - &reftitle.description; - - boolapc_clear_cache - stringcache_type"" - - - Clears the user/system cache. - - - - - &reftitle.parameters; - - - - cache_type - - - If cache_type is "user", the - user cache will be cleared; otherwise, the system cache (cached files) - will be cleared. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; always - - - - - &reftitle.seealso; - - - apc_cache_info - - - - - - - diff --git a/reference/apc/functions/apc-compile-file.xml b/reference/apc/functions/apc-compile-file.xml deleted file mode 100644 index 1b16bf373dff..000000000000 --- a/reference/apc/functions/apc-compile-file.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - apc_compile_file - - Stores a file in the bytecode cache, bypassing all filters - - - - &reftitle.description; - - mixedapc_compile_file - stringfilename - boolatomic&true; - - - Stores a file in the bytecode cache, bypassing all filters. - - - - - &reftitle.parameters; - - - - filename - - - Full or relative path to a PHP file that will be compiled and stored in - the bytecode cache. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - apc_bin_dumpfile - apc_bin_loadfile - - - - - - diff --git a/reference/apc/functions/apc-dec.xml b/reference/apc/functions/apc-dec.xml deleted file mode 100644 index 493c1c14537a..000000000000 --- a/reference/apc/functions/apc-dec.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - apc_dec - Decrease a stored number - - - - &reftitle.description; - - intapc_dec - stringkey - intstep1 - boolsuccess - - - Decreases a stored integer value. - - - - - &reftitle.parameters; - - - key - - - The key of the value being decreased. - - - - - step - - - The step, or value to decrease. - - - - - success - - - Optionally pass the success or fail boolean value to - this referenced variable. - - - - - - - - &reftitle.returnvalues; - - Returns the current value of key's value on success, - &return.falseforfailure; - - - - - &reftitle.examples; - - <function>apc_dec</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - apc_inc - - - - - - diff --git a/reference/apc/functions/apc-define-constants.xml b/reference/apc/functions/apc-define-constants.xml deleted file mode 100644 index cb3f19d62474..000000000000 --- a/reference/apc/functions/apc-define-constants.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - apc_define_constants - - Defines a set of constants for retrieval and mass-definition - - - - &reftitle.description; - - boolapc_define_constants - stringkey - arrayconstants - boolcase_sensitive&true; - - - - define is notoriously slow. Since the main benefit of - APC is to increase the performance of scripts/applications, this mechanism - is provided to streamline the process of mass constant definition. However, - this function does not perform as well as anticipated. - - - - For a better-performing solution, try the - hidef extension from PECL. - - - - - To remove a set of stored constants (without clearing the entire cache), an - empty array may be passed as the constants - parameter, effectively clearing the stored value(s). - - - - - - &reftitle.parameters; - - - - key - - - The key serves as the name of the constant set - being stored. This key is used to retrieve the - stored constants in apc_load_constants. - - - - - constants - - - An associative array of constant_name => value - pairs. The constant_name must follow the normal - constant naming rules. - value must evaluate to a scalar value. - - - - - case_sensitive - - - The default behaviour for constants is to be declared case-sensitive; - i.e. CONSTANT and Constant - represent different values. If this parameter evaluates to &false; the - constants will be declared as case-insensitive symbols. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - &reftitle.examples; - - - <function>apc_define_constants</function> example - - 1, - 'TWO' => 2, - 'THREE' => 3, -); -apc_define_constants('numbers', $constants); -echo ONE, TWO, THREE; -?> -]]> - - &example.outputs; - - - - - - - - - - &reftitle.seealso; - - - apc_load_constants - define - constant - - Or the PHP constants reference - - - - - - - - diff --git a/reference/apc/functions/apc-delete-file.xml b/reference/apc/functions/apc-delete-file.xml deleted file mode 100644 index a8cc399d1103..000000000000 --- a/reference/apc/functions/apc-delete-file.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - apc_delete_file - Deletes files from the opcode cache - - - - &reftitle.description; - - mixedapc_delete_file - mixedkeys - - - Deletes the given files from the opcode cache. - - - - - &reftitle.parameters; - - - keys - - - The files to be deleted. Accepts a string, - array of strings, or an APCIterator - object. - - - - - - - - &reftitle.returnvalues; - - &return.success; - Or if keys is an array, then - an empty array is returned on success, or an array of failed files - is returned. - - - - - &reftitle.examples; - - <function>apc_delete_file</function> example - - -]]> - - &example.outputs.similar; - - - string(14) "donotexist.php" -} -[Mon May 24 09:30:33 2010] [apc-warning] Could not stat file donotexist.php, unable to delete from cache. in /tmp/test.php on line 18. -bool(false) -]]> - - - - - - &reftitle.seealso; - - apc_clear_cache - apc_delete - apc_exists - - - - - diff --git a/reference/apc/functions/apc-delete.xml b/reference/apc/functions/apc-delete.xml deleted file mode 100644 index 1524525239db..000000000000 --- a/reference/apc/functions/apc-delete.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - apc_delete - - Removes a stored variable from the cache - - - - &reftitle.description; - - mixedapc_delete - stringkey - - - Removes a stored variable from the cache. - - - - &reftitle.parameters; - - - - key - - - The key used to store the value (with - apc_store). - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - A <function>apc_delete</function> example - - -]]> - - - - - - - &reftitle.seealso; - - - apc_store - apc_fetch - - - - - - - diff --git a/reference/apc/functions/apc-exists.xml b/reference/apc/functions/apc-exists.xml deleted file mode 100644 index f1ed93641702..000000000000 --- a/reference/apc/functions/apc-exists.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - - apc_exists - Checks if APC key exists - - - - &reftitle.description; - - mixedapc_exists - mixedkeys - - - Checks if one or more APC keys exist. - - - - - &reftitle.parameters; - - - keys - - - A string, or an array of strings, that - contain keys. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the key exists, otherwise &false; Or if an - array was passed to keys, then - an array is returned that contains all existing keys, or an empty - array if none exist. - - - - - &reftitle.examples; - - <function>apc_exists</function> example - - -]]> - - &example.outputs.similar; - - - bool(true) - ["bar"]=> - bool(true) -} -]]> - - - - - - &reftitle.seealso; - - apc_cache_info - apc_fetch - - - - - diff --git a/reference/apc/functions/apc-fetch.xml b/reference/apc/functions/apc-fetch.xml deleted file mode 100644 index b5e23ecddb9c..000000000000 --- a/reference/apc/functions/apc-fetch.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - apc_fetch - - Fetch a stored variable from the cache - - - - &reftitle.description; - - mixedapc_fetch - mixedkey - boolsuccess - - - Fetches a stored variable from the cache. - - - - &reftitle.parameters; - - - - key - - - The key used to store the value (with - apc_store). If an array is passed then each - element is fetched and returned. - - - - - success - - - Set to &true; in success and &false; in failure. - - - - - - - - &reftitle.returnvalues; - - The stored variable or array of variables on success; &false; on failure - - - - - &reftitle.examples; - - - A <function>apc_fetch</function> example - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 3.0.17 - - The success parameter was added. - - - - - - - - - &reftitle.seealso; - - - apc_store - apc_delete - APCIterator - - - - - - - diff --git a/reference/apc/functions/apc-inc.xml b/reference/apc/functions/apc-inc.xml deleted file mode 100644 index c9bd4b76f6b2..000000000000 --- a/reference/apc/functions/apc-inc.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - apc_inc - Increase a stored number - - - - &reftitle.description; - - intapc_inc - stringkey - intstep1 - boolsuccess - - - Increases a stored number. - - - - - &reftitle.parameters; - - - key - - - The key of the value being increased. - - - - - step - - - The step, or value to increase. - - - - - success - - - Optionally pass the success or fail boolean value to - this referenced variable. - - - - - - - - &reftitle.returnvalues; - - Returns the current value of key's value on success, - &return.falseforfailure; - - - - - &reftitle.examples; - - <function>apc_inc</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - apc_dec - - - - - - diff --git a/reference/apc/functions/apc-load-constants.xml b/reference/apc/functions/apc-load-constants.xml deleted file mode 100644 index 5c1c2351b353..000000000000 --- a/reference/apc/functions/apc-load-constants.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - apc_load_constants - - Loads a set of constants from the cache - - - - &reftitle.description; - - boolapc_load_constants - stringkey - boolcase_sensitive&true; - - - Loads a set of constants from the cache. - - - - &reftitle.parameters; - - - - key - - - The name of the constant set (that was stored with - apc_define_constants) to be retrieved. - - - - - case_sensitive - - - The default behaviour for constants is to be declared case-sensitive; - i.e. CONSTANT and Constant - represent different values. If this parameter evaluates to &false; the - constants will be declared as case-insensitive symbols. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>apc_load_constants</function> example - - 1, - 'TWO' => 2, - 'THREE' => 3, -); -apc_define_constants('numbers', $constants); -apc_load_constants('numbers'); -echo ONE, TWO, THREE; -?> -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - apc_define_constants - define - constant - - Or the PHP constants reference - - - - - - - - diff --git a/reference/apc/functions/apc-sma-info.xml b/reference/apc/functions/apc-sma-info.xml deleted file mode 100644 index 019a119546b4..000000000000 --- a/reference/apc/functions/apc-sma-info.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - apc_sma_info - - Retrieves APC's Shared Memory Allocation information - - - - &reftitle.description; - - arrayapc_sma_info - boollimited&false; - - - Retrieves APC's Shared Memory Allocation information. - - - - - &reftitle.parameters; - - - - limited - - - When set to &false; (default) apc_sma_info will - return a detailed information about each segment. - - - - - - - - - &reftitle.returnvalues; - - Array of Shared Memory Allocation data; &false; on failure. - - - - - &reftitle.examples; - - - A <function>apc_sma_info</function> example - - -]]> - - &example.outputs.similar; - - 1 - [seg_size] => 31457280 - [avail_mem] => 31448408 - [block_lists] => Array - ( - [0] => Array - ( - [0] => Array - ( - [size] => 31448408 - [offset] => 8864 - ) - - ) - - ) - -) -]]> - - - - - - - &reftitle.seealso; - - - - APC configuration directives - - - - - - - - diff --git a/reference/apc/functions/apc-store.xml b/reference/apc/functions/apc-store.xml deleted file mode 100644 index e97dbf953a91..000000000000 --- a/reference/apc/functions/apc-store.xml +++ /dev/null @@ -1,147 +0,0 @@ - - - - - apc_store - - Cache a variable in the data store - - - - &reftitle.description; - - boolapc_store - stringkey - mixedvar - intttl0 - - - arrayapc_store - arrayvalues - mixedunusedNULL - intttl0 - - - Cache a variable in the data store. - - - - Unlike many other mechanisms in PHP, variables stored using - apc_store will persist between requests (until the - value is removed from the cache). - - - - - &reftitle.parameters; - - - - key - - - Store the variable using this name. keys are - cache-unique, so storing a second value with the same - key will overwrite the original value. - - - - - var - - - The variable to store - - - - - ttl - - - Time To Live; store var in the cache for - ttl seconds. After the - ttl has passed, the stored variable will be - expunged from the cache (on the next request). If no ttl - is supplied (or if the ttl is - 0), the value will persist until it is removed from - the cache manually, or otherwise fails to exist in the cache (clear, - restart, etc.). - - - - - values - - - Names in key, variables in value. - - - - - - - - &reftitle.returnvalues; - - &return.success; - Second syntax returns array with error keys. - - - - - &reftitle.examples; - - - A <function>apc_store</function> example - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - apc_add - apc_fetch - apc_delete - - - - - - - diff --git a/reference/apc/ini.xml b/reference/apc/ini.xml deleted file mode 100644 index 28a850e93ac8..000000000000 --- a/reference/apc/ini.xml +++ /dev/null @@ -1,961 +0,0 @@ - - -
- &reftitle.runtime; - &extension.runtime; - - Although the default APC settings are fine for many installations, serious - users should consider tuning the following parameters. - - - There are two primary decisions to be made configuring APC. First, - how much memory is going to be allocated to APC; and second, whether APC - will check if a file has been modified on every request. The two ini - directives that control these settings are apc.shm_size - and apc.stat, respectively. Read the sections on these - two directive carefully below. - - - Once the server is running, the apc.php script that - is bundled with the extension should be copied somewhere into the docroot and - viewed with a browser as it provides a detailed analysis of the internal - workings of APC. If GD is enabled in PHP, it will even display some - interesting graphs. The first thing to ensure, of course, is that it is - actually caching files. If APC is working, the Cache full count - number (on the left) will display the number of times the cache - has reached maximum capacity and has had to forcefully clean any entries that - haven't been accessed in the last apc.ttl seconds. This - number is minimized in a well-configured cache. If the cache is constantly - being filled, and thusly forcefully freed, the resulting churning will have - disparaging effects on script performance. The easiest way to minimize this - number is to allocate more memory for APC. Barring that, the apc.filters - ought to be used to cache fewer scripts. - - - When APC is compiled with mmap support (Memory Mapping), it will use only one - memory segment, unlike when APC is built with SHM (SysV Shared Memory) support - that uses multiple memory segments. MMAP does not have a maximum limit like SHM - does in /proc/sys/kernel/shmmax. In general MMAP support is - recommended because it will reclaim the memory faster when the webserver is - restarted and all in all reduces memory allocation impact at startup. - - - - APC configuration options - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - apc.enabled - "1" - PHP_INI_SYSTEM - PHP_INI_SYSTEM in APC 2. PHP_INI_ALL in APC <= 3.0.12. - - - apc.shm_segments - "1" - PHP_INI_SYSTEM - - - - apc.shm_size - "32M" - PHP_INI_SYSTEM - - - - apc.shm_strings_buffer - "4M" - PHP_INI_SYSTEM - Available since APC 3.1.4. - - - apc.optimization - "0" - PHP_INI_ALL - PHP_INI_SYSTEM in APC 2. Removed in APC 3.0.13. - - - apc.num_files_hint - "1000" - PHP_INI_SYSTEM - - - - apc.user_entries_hint - "4096" - PHP_INI_SYSTEM - Available since APC 3.0.0. - - - apc.ttl - "0" - PHP_INI_SYSTEM - Available since APC 3.0.0. - - - apc.user_ttl - "0" - PHP_INI_SYSTEM - Available since APC 3.0.0. - - - apc.gc_ttl - "3600" - PHP_INI_SYSTEM - - - - apc.cache_by_default - "1" - PHP_INI_ALL - PHP_INI_SYSTEM in APC <= 3.0.12. Available since APC 3.0.0. - - - apc.filters - NULL - PHP_INI_SYSTEM - - - - apc.mmap_file_mask - NULL - PHP_INI_SYSTEM - - - - apc.slam_defense - "1" - PHP_INI_SYSTEM - Available since APC 3.0.0. Prior to APC 3.1.4, the default value was "0" (disabled). - - - apc.file_update_protection - "2" - PHP_INI_SYSTEM - Available since APC 3.0.6. - - - apc.enable_cli - "0" - PHP_INI_SYSTEM - Available since APC 3.0.7. - - - apc.max_file_size - "1M" - PHP_INI_SYSTEM - Available since APC 3.0.7. - - - apc.use_request_time - "1" - PHP_INI_ALL - Available since APC 3.1.3. - - - apc.stat - "1" - PHP_INI_SYSTEM - Available since APC 3.0.10. - - - apc.write_lock - "1" - PHP_INI_SYSTEM - Available since APC 3.0.11. - - - apc.report_autofilter - "0" - PHP_INI_SYSTEM - Available since APC 3.0.11. - - - apc.serializer - "default" - PHP_INI_SYSTEM - Available since APC 3.1.0. - - - apc.include_once_override - "0" - PHP_INI_SYSTEM - Available since APC 3.0.12. - - - apc.rfc1867 - "0" - PHP_INI_SYSTEM - Available since APC 3.0.13. - - - apc.rfc1867_prefix - "upload_" - PHP_INI_SYSTEM - - - - apc.rfc1867_name - "APC_UPLOAD_PROGRESS" - PHP_INI_SYSTEM - - - - apc.rfc1867_freq - "0" - PHP_INI_SYSTEM - - - - apc.rfc1867_ttl - "3600" - PHP_INI_SYSTEM - Available since APC 3.1.1. - - - apc.localcache - "0" - PHP_INI_SYSTEM - Available in APC 3.0.14 - 3.1.11. - - - apc.localcache.size - "512" - PHP_INI_SYSTEM - vailable in APC 3.0.14 - 3.1.11. - - - apc.coredump_unmap - "0" - PHP_INI_SYSTEM - Available since APC 3.0.16. - - - apc.stat_ctime - "0" - PHP_INI_SYSTEM - Available since APC 3.0.13. - - - apc.preload_path - NULL - PHP_INI_SYSTEM - Available since APC 3.1.1. - - - apc.file_md5 - "0" - PHP_INI_SYSTEM - Available since APC 3.1.1. - - - apc.canonicalize - "1" - PHP_INI_SYSTEM - Available since APC 3.1.1. - - - apc.lazy_functions - 0 - PHP_INI_SYSTEM - Available since APC 3.1.3. - - - apc.lazy_classes - 0 - PHP_INI_SYSTEM - Available since APC 3.1.3. - - - -
- &ini.php.constants; - - - &ini.descriptions.title; - - - - - - apc.enabled - boolean - - - - apc.enabled can be set to 0 to disable APC. This is - primarily useful when APC is statically compiled - into PHP, since there is no other way to disable - it (when compiled as a DSO, the extension - line in php.ini can just be commented-out). - - - - - - apc.shm_segments - integer - - - - The number of shared memory segments to allocate - for the compiler cache. If APC is running out of - shared memory but apc.shm_size - is set as high as the system allows, raising - this value might prevent APC from exhausting its memory. - - - - - - apc.shm_size - string - - - - The size of each shared memory segment given by a shorthand notation as - described in this FAQ. - By default, some systems (including most BSD - variants) have very low limits on the size of a - shared memory segment. - - - - - - apc.shm_strings_buffer - string - - - - The size of memory to use as a shared buffer for strings used internally - by APC. Size Should be suffixed by M for megabytes, G for gigabytes. - Enabling this option will reduce the amount of memory used per PHP-FPM - worker as strings will be stored once rather than for each worker. - - - - - - apc.optimization - integer - - - - The optimization level. Zero disables the - optimizer, and higher values use more aggressive - optimizations. Expect very modest speed - improvements. This is experimental. - - - - - - apc.num_files_hint - integer - - - - A "hint" about the number of distinct source files - that will be included or requested on your web - server. Set to zero or omit if unsure; - this setting is mainly useful for sites that have - many thousands of source files. - - - - - - apc.user_entries_hint - integer - - - - Just like apc.num_files_hint, - a "hint" about the number of distinct user cache variables to store. - Set to zero or omit if not sure. - - - - - - apc.ttl - integer - - - - The number of seconds a cache entry is allowed to - idle in a slot in case this cache entry slot is - needed by another entry. Leaving this at zero - means that APC's cache could potentially fill up - with stale entries while newer entries won't be - cached. In the event of a cache running out of - available memory, the cache will be completely - expunged if ttl is equal to 0. Otherwise, if the - ttl is greater than 0, APC will attempt to remove - expired entries. - - - - - - apc.user_ttl - integer - - - - The number of seconds a cache entry is allowed to - idle in a slot in case this cache entry slot is - needed by another entry. Leaving this at zero - means that APC's cache could potentially fill up - with stale entries while newer entries won't be - cached. In the event of a cache running out of - available memory, the cache will be completely - expunged if ttl is equal to 0. Otherwise, if the - ttl is greater than 0, APC will attempt to remove - expired entries. - - - - - - apc.gc_ttl - integer - - - - The number of seconds that a cache entry may - remain on the garbage-collection list. This value - provides a fail-safe in the event that a server - process dies while executing a cached source file; - if that source file is modified, the memory - allocated for the old version will not be - reclaimed until this TTL reached. Set to zero to - disable this feature. - - - - - - apc.cache_by_default - boolean - - - - On by default, but can be set to off and used in - conjunction with positive apc.filters so that files - are only cached if matched by a positive filter. - - - - - - apc.filters - string - - - - A comma-separated list of POSIX extended regular - expressions. If any pattern matches the source - filename, the file will not be cached. Note that - the filename used for matching is the one passed - to include/require, not the absolute path. If the - first character of the expression is a + then the - expression will be additive in the sense that any - files matched by the expression will be cached, and - if the first character is a - then anything matched - will not be cached. The - case is the default, so - it can be left off. - - - - - - apc.mmap_file_mask - string - - - - If compiled with MMAP support by using --enable-mmap - this is the mktemp-style file_mask to pass to the - mmap module for determining whether your mmap'ed memory - region is going to be file-backed or shared memory - backed. For straight file-backed mmap, set it to - something like /tmp/apc.XXXXXX - (exactly 6 Xs). - To use POSIX-style shm_open/mmap put a .shm - somewhere in your mask. e.g. /apc.shm.XXXXXX - You can also set it to /dev/zero to use your - kernel's /dev/zero interface to anonymous mmap'ed - memory. Leaving it undefined will force an anonymous mmap. - - - - - - apc.slam_defense - integer - - - - On very busy servers whenever you start the server or - modify files you can create a race of many processes - all trying to cache the same file at the same time. - This option sets the percentage of processes that will - skip trying to cache an uncached file. Or think of it - as the probability of a single process to skip caching. - For example, setting apc.slam_defense - to 75 would mean that there is - a 75% chance that the process will not cache an uncached - file. So, the higher the setting the greater the defense - against cache slams. Setting this to 0 - disables this feature. - - - Deprecated by apc.write_lock. - - - - - - apc.file_update_protection - integer - - - - When a file is modified on a live web server it really - ought to be done in an atomic manner. That is, written to a - temporary file and renamed (mv) the file into its - permanent position when it is ready. Many text editors, - cp, tar and - other such programs don't do this. This means that there - is a chance that a file is accessed (and cached) while it - is still being written to. This apc.file_update_protection - setting puts a delay on caching brand new files. The - default is 2 seconds, which means that if the modification - timestamp (mtime) on a file shows that it is less than 2 - seconds old when it is accessed, it will not be cached. - The unfortunate person who accessed this half-written file - will still see weirdness, but at least it won't persist. - If all of the webserver's files are atomically updated, via - some method like rsync (which updates correctly), - this protection can be disabled by setting this directive to 0. - If the system is flooded with i/o and some update procedures - are taking longer than 2 seconds, this setting should be increased - to enable the protection on those slower update operations. - - - - - - apc.enable_cli - integer - - - - Mostly for testing and debugging. Setting this enables APC - for the CLI version of PHP. Under normal circumstances, it is - not ideal to create, populate and destroy the APC cache on every - CLI request, but for various test scenarios it is useful to be - able to enable APC for the CLI version of PHP easily. - - - - - - apc.max_file_size - integer - - - - Prevent files larger than this value from getting cached. Defaults to - 1M. - - - - - - apc.stat - integer - - - - Be careful changing this setting. This defaults to on, forcing APC to - stat (check) the script on each request to determine if it has been modified. - If it has been modified it will recompile and cache the new version. - If this setting is off, APC will not check, which usually means that to - force APC to recheck files, the web server will have to be restarted or the - cache will have to be manually cleared. Note that FastCGI web server configurations - may not clear the cache on restart. On a production server where the - script files rarely change, a significant performance boost can be - achieved by disabled stats. - - - For included/required files this option applies as well, but note that - for relative path includes (any path that doesn't start - with / on Unix) APC has to check in order to uniquely identify the file. - If you use absolute path includes APC can skip the stat and use that - absolute path as the unique identifier for the file. - - - - - - - apc.write_lock - boolean - - - - On busy servers, when the web server is first started, or when many files - have been modified at the same time, APC may try to compile and cache the - same file multiple times. Write_lock guarantees that only one process - will attempt to compile and cache an uncached script. The other processes - attempting to use the script will run without using the opcode cache, rather - than locking and waiting for the cache to prime. - - - - - - - apc.report_autofilter - boolean - - - - Logs any scripts that were automatically excluded from being cached due - to early/late binding issues. - - - - - - - apc.serializer - string - - - - Used to configure APC to use a third party serializer. - - - - - - - apc.include_once_override - boolean - - - - Optimize include_once and require_once - calls and avoid the expensive system calls used. - - - - This feature is EXPERIMENTAL. The behaviour of this - directive, its name, and surrounding documentation may change without - notice in a future release of APC. This feature should be used at your - own risk. - - - - - - - - apc.rfc1867 - boolean - - - - RFC1867 File Upload Progress hook handler is only available if APC - was compiled against PHP 5.2.0 or later. When enabled, any file uploads - which includes a field called APC_UPLOAD_PROGRESS - before the file field in an upload form will cause APC to automatically - create an upload_key user cache entry where - key is the value of the - APC_UPLOAD_PROGRESS form entry. - - - Note that the hidden field specified by - APC_UPLOAD_PROGRESS must come before the file field, - otherwise the upload progress will not work correctly. - - - Note that the file upload tracking is not threadsafe at this point, so - new uploads that happen while a previous one is still going will disable - the tracking for the previous. - - - Note that the rate is only available once all file - transfers are completed. - - - - An apc.rfc1867 example - - -]]> - - &example.outputs.similar; - - 1142543 - [current] => 1142543 - [rate] => 1828068.8 - [filename] => test - [name] => file - [temp_filename] => /tmp/php8F - [cancel_upload] => 0 - [done] => 1 -) -]]> - - - - - - - - - apc.rfc1867_prefix - string - - - - Key prefix to use for the user cache entry generated by rfc1867 upload - progress functionality. - - - - - - - apc.rfc1867_name - string - - - - Specify the hidden form entry name that activates APC upload progress - and specifies the user cache key suffix. - - - - - - - apc.rfc1867_freq - string - - - - The frequency that updates should be made to the user cache entry for - upload progress. This can take the form of a percentage of the total - file size or a size in bytes optionally suffixed with - "k", "m", or "g" - for kilobytes, megabytes, or gigabytes respectively (case insensitive). - A setting of 0 updates as often as possible, which may cause slower - uploads. - - - - - - - apc.rfc1867_ttl - integer - - - - TTL for rfc1867 entries. - - - - - - - apc.localcache - boolean - - - - This enables a lock-free local process shadow-cache which reduces lock - contention when the cache is being written to. - - - - - - - apc.localcache.size - integer - - - - The size of the local process shadow-cache, should be set to a - sufficiently large value, approximately half of - apc.num_files_hint. - - - - - - - apc.coredump_unmap - boolean - - - - Enables APC handling of signals, such as SIGSEGV, that write - core files when signaled. When these signals are received, - APC will attempt to unmap the shared memory segment in order - to exclude it from the core file. This setting may improve - system stability when fatal signals are received and a large - APC shared memory segment is configured. - - - - This feature is potentially dangerous. Unmapping the shared - memory segment in a fatal signal handler may cause undefined - behaviour if a fatal error occurs. - - - - - Although some kernels may provide a facility to ignore various - types of shared memory when generating a core dump file, these - implementations may also ignore important shared memory segments - such as the Apache scoreboard. - - - - - - - - apc.stat_ctime - integer - - - - Verification with ctime will avoid problems caused by programs such - as svn or rsync by making sure inodes haven't changed since the last - stat. APC will normally only check mtime. - - - - - - - apc.canonicalize - bool - - - - If on, then relative paths are canonicalized in no-stat mode. If set, - then files included via stream wrappers can not be cached as - realpath does not support stream wrappers. - - - - - - - apc.preload_path - string - - - - Optionally, set a path to the directory that APC will load - cache data at startup. - - - - - - - apc.use_request_time - bool - - - - Use the SAPI request start time for - TTL. - - - - - - - apc.file_md5 - bool - - - - Records a md5 hash of files. - - - - - - - apc.lazy_functions - integer - - - - Enables lazy loading for functions. - - - - - - - apc.lazy_classes - integer - - - - Enables lazy loading for classes. - - - - - -
- - diff --git a/reference/apc/reference.xml b/reference/apc/reference.xml deleted file mode 100644 index c2a4fe96c75f..000000000000 --- a/reference/apc/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - APC &Functions; - - &reference.apc.entities.functions; - - - - - diff --git a/reference/apc/setup.xml b/reference/apc/setup.xml deleted file mode 100644 index 410c617143c1..000000000000 --- a/reference/apc/setup.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.required; - &no.requirement; -
- -
- &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;apc. - - - &pecl.windows.download; - - - - On Windows, APC needs a temp path to exist, and be - writable by the web server. It checks the TMP, TEMP - and USERPROFILE environment variables in that order - and finally tries the WINDOWS directory if none of - those are set. - - - - - For more in-depth, highly technical implementation details, see the - - developer-supplied TECHNOTES file - . - - -
- - &reference.apc.ini; - -
- &reftitle.resources; - &no.resource; -
- - - - - diff --git a/reference/apc/versions.xml b/reference/apc/versions.xml deleted file mode 100644 index d551838f9250..000000000000 --- a/reference/apc/versions.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/apcu/book.xml b/reference/apcu/book.xml index 1fde7cc18526..c6674d3ecf7d 100644 --- a/reference/apcu/book.xml +++ b/reference/apcu/book.xml @@ -8,7 +8,7 @@ &reftitle.intro; - APCu is APC stripped of opcode caching. + APCu is APC stripped of opcode caching. The first APCu codebase was versioned 4.0.0, it was forked from the head of the APC master branch at the time. diff --git a/reference/apd/book.xml b/reference/apd/book.xml deleted file mode 100644 index db95c220c3d0..000000000000 --- a/reference/apd/book.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - Advanced PHP debugger - APD - - - &reftitle.intro; - - APD is the Advanced PHP Debugger. It was written to provide profiling and - debugging capabilities for PHP code, as well as to provide the ability to - print out a full stack backtrace. APD supports interactive debugging, but - by default it writes data to trace files. It also offers event based - logging so that varying levels of information (including function calls, - arguments passed, timings, etc.) can be turned on or off for individual - scripts. - - - APD is a Zend Extension, modifying the way the internals of PHP handle - function calls, and thus may or may not be compatible with other Zend - Extensions (for example Zend Optimizer). - - - - - - &reference.apd.setup; - &reference.apd.constants; - &reference.apd.examples; - &reference.apd.reference; - - - - - diff --git a/reference/apd/constants.xml b/reference/apd/constants.xml deleted file mode 100644 index 7a2cfac53d06..000000000000 --- a/reference/apd/constants.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - APD constants - - - - Constant - Value - Description - - - - - - FUNCTION_TRACE - (integer) - - 1 - - - - - ARGS_TRACE - (integer) - - 2 - - - - - ASSIGNMENT_TRACE - (integer) - - 4 - - - - - STATEMENT_TRACE - (integer) - - 8 - - - - - MEMORY_TRACE - (integer) - - 16 - - - - - TIMING_TRACE - (integer) - - 32 - - - - - SUMMARY_TRACE - (integer) - - 64 - - - - - ERROR_TRACE - (integer) - - 128 - - - - - PROF_TRACE - (integer) - - 256 - - - - - APD_VERSION - (string) - - example: 1.0.2-dev - - - - -
- - - diff --git a/reference/apd/examples.xml b/reference/apd/examples.xml deleted file mode 100644 index fee3790465bc..000000000000 --- a/reference/apd/examples.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - &reftitle.examples; -
- How to use PHP-APD in your scripts - - - - As the first line of your PHP script, call the apd_set_pprof_trace() function - to start the trace: - - - - -]]> - - - - You can insert the line anywhere in your script, but if you do not start - tracing at the beginning of your script you discard profile data that might - otherwise lead you to a performance bottleneck. - - - - - Now run your script. The dump output will be written to - apd.dumpdir/pprof_pid.ext. - - - If you're running the CGI version of PHP, you will need to add the '-e' - flag to enable extended information for apd to work properly. For - example: - php -e -f script.php - - - - - - - To display formatted profile data, issue the pprofp - command with the sort and display options of your choice. The formatted - output will look something like: - - - - - - The -R option used in this example sorts the profile table by the amount - of real time the script spent executing a given function. The "cumm call" - column reveals how many times each function was called, and the "s/call" - column reveals how many seconds each call to the function required, on - average. - - - - - To generate a calltree file that you can import into the KCacheGrind - profile analysis application, issue the pprof2calltree - comand. - - - -
- - - - diff --git a/reference/apd/functions/apd-breakpoint.xml b/reference/apd/functions/apd-breakpoint.xml deleted file mode 100644 index 4ef362409956..000000000000 --- a/reference/apd/functions/apd-breakpoint.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - apd_breakpoint - Stops the interpreter and waits on a CR from the socket - - - &reftitle.description; - - boolapd_breakpoint - intdebug_level - - - This can be used to stop the running of your script, and await responses - on the connected socket. To step the program, just send enter (a blank - line), or enter a php command to be executed. - - - - - &reftitle.parameters; - - - &apd.debug-level.description; - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Typical session using tcplisten - -\n -statement: /home/alan/Projects/project2/test.php:8 ->\n -statement: /home/alan/Projects/project2/test.php:8 ->\n -statement: /home/alan/Projects/project2/test.php:10 ->apd_echo($i); -EXEC: apd_echo($i); -0 ->apd_echo(serialize(apd_get_active_symbols())); -EXEC: apd_echo(serialize(apd_get_active_symbols())); -a:47:{i:0;s:4:"PWD";i:1;s:10:"COLORFGBG";i:2;s:11:"XAUTHORITY";i:3;s:14:" -COLORTERM_BCE";i:4;s:9:"WINDOWID";i:5;s:14:"ETERM_VERSION";i:6;s:16:"SE -SSION_MANAGER";i:7;s:4:"PS1";i:8;s:11:"GDMSESSION";i:9;s:5:"USER";i:10;s:5:" -MAIL";i:11;s:7:"OLDPWD";i:12;s:5:"LANG";i:13;s:10:"COLORTERM";i:14;s:8:"DISP -LAY";i:15;s:8:"LOGNAME";i:16;s:6:" ->apd_echo(system('ls /home/mydir')); -........ ->apd_continue(0); -]]> - - - - - - - - diff --git a/reference/apd/functions/apd-callstack.xml b/reference/apd/functions/apd-callstack.xml deleted file mode 100644 index c85b9171bc81..000000000000 --- a/reference/apd/functions/apd-callstack.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - apd_callstack - Returns the current call stack as an array - - - &reftitle.description; - - arrayapd_callstack - - - - Returns the current call stack as an array - - - - - &reftitle.returnvalues; - - An array containing the current call stack. - - - - - &reftitle.examples; - - - <function>apd_callstack</function> example - - -]]> - - - - - - - diff --git a/reference/apd/functions/apd-clunk.xml b/reference/apd/functions/apd-clunk.xml deleted file mode 100644 index 289bb6401a38..000000000000 --- a/reference/apd/functions/apd-clunk.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - apd_clunk - Throw a warning and a callstack - - - &reftitle.description; - - voidapd_clunk - stringwarning - stringdelimiter"<BR />" - - - Behaves like perl's Carp::cluck. Throw a warning and a callstack. - - - - - &reftitle.parameters; - - - - warning - - - The warning to throw. - - - - - delimiter - - - The delimiter. Default to <BR />. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>apd_clunk</function> example - -"); -?> -]]> - - - - - - - &reftitle.seealso; - - - apd_croak - - - - - - diff --git a/reference/apd/functions/apd-continue.xml b/reference/apd/functions/apd-continue.xml deleted file mode 100644 index c593193fb3dd..000000000000 --- a/reference/apd/functions/apd-continue.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - apd_continue - Restarts the interpreter - - - &reftitle.description; - - boolapd_continue - intdebug_level - - - Usually sent via the socket to restart the interpreter. - - - - - &reftitle.parameters; - - - &apd.debug-level.description; - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>apd_continue</function> example - - -]]> - - - - - - - diff --git a/reference/apd/functions/apd-croak.xml b/reference/apd/functions/apd-croak.xml deleted file mode 100644 index 54a47509b534..000000000000 --- a/reference/apd/functions/apd-croak.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - apd_croak - Throw an error, a callstack and then exit - - - &reftitle.description; - - voidapd_croak - stringwarning - stringdelimiter"<BR />" - - - Behaves like perl's Carp::croak. Throw an error, a callstack and then - exit. - - - - - &reftitle.parameters; - - - - warning - - - The warning to throw. - - - - - delimiter - - - The delimiter. Default to <BR />. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>apd_croak</function> example - -"); -?> -]]> - - - - - - - &reftitle.seealso; - - - apd_clunk - - - - - - diff --git a/reference/apd/functions/apd-dump-function-table.xml b/reference/apd/functions/apd-dump-function-table.xml deleted file mode 100644 index 0027d8ee0b5c..000000000000 --- a/reference/apd/functions/apd-dump-function-table.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - apd_dump_function_table - Outputs the current function table - - - &reftitle.description; - - voidapd_dump_function_table - - - - Outputs the current function table. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>apd_dump_function_table</function> example - - -]]> - - - - - - - diff --git a/reference/apd/functions/apd-dump-persistent-resources.xml b/reference/apd/functions/apd-dump-persistent-resources.xml deleted file mode 100644 index 2e7b9e40a18f..000000000000 --- a/reference/apd/functions/apd-dump-persistent-resources.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - apd_dump_persistent_resources - Return all persistent resources as an array - - - &reftitle.description; - - arrayapd_dump_persistent_resources - - - - Return all persistent resources as an array. - - - - - &reftitle.returnvalues; - - An array containing the current persistent resources. - - - - - &reftitle.examples; - - - <function>apd_dump_persistent_resources</function> example - - -]]> - - - - - - &reftitle.seealso; - - - apd_dump_regular_resources - - - - - - - diff --git a/reference/apd/functions/apd-dump-regular-resources.xml b/reference/apd/functions/apd-dump-regular-resources.xml deleted file mode 100644 index 916a6a503c2c..000000000000 --- a/reference/apd/functions/apd-dump-regular-resources.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - apd_dump_regular_resources - Return all current regular resources as an array - - - &reftitle.description; - - arrayapd_dump_regular_resources - - - - Return all current regular resources as an array. - - - - - &reftitle.returnvalues; - - An array containing the current regular resources. - - - - - &reftitle.examples; - - - <function>apd_dump_regular_resources</function> example - - -]]> - - - - - - - &reftitle.seealso; - - - apd_dump_persistent_resources - - - - - - diff --git a/reference/apd/functions/apd-echo.xml b/reference/apd/functions/apd-echo.xml deleted file mode 100644 index c4a480887d5b..000000000000 --- a/reference/apd/functions/apd-echo.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - apd_echo - Echo to the debugging socket - - - &reftitle.description; - - boolapd_echo - stringoutput - - - Usually sent via the socket to request information about the running - script. - - - - - &reftitle.parameters; - - - - output - - - The debugged variable. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>apd_echo</function> example - - -]]> - - - - - - - diff --git a/reference/apd/functions/apd-get-active-symbols.xml b/reference/apd/functions/apd-get-active-symbols.xml deleted file mode 100644 index 99afa7cf738e..000000000000 --- a/reference/apd/functions/apd-get-active-symbols.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - apd_get_active_symbols - Get an array of the current variables names in the local scope - - - &reftitle.description; - - arrayapd_get_active_symbols - - - - Returns the names of all the variables defined in the active scope, (not - their values). - - - - - &reftitle.returnvalues; - - A multidimensional array with all the variables. - - - - - &reftitle.examples; - - - <function>apd_get_active_symbols</function> example - - -]]> - - - - - - - diff --git a/reference/apd/functions/apd-set-pprof-trace.xml b/reference/apd/functions/apd-set-pprof-trace.xml deleted file mode 100644 index e3fd91760795..000000000000 --- a/reference/apd/functions/apd-set-pprof-trace.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - apd_set_pprof_trace - Starts the session debugging - - - &reftitle.description; - - stringapd_set_pprof_trace - stringdump_directoryini_get("apd.dumpdir") - stringfragment"pprof" - - - Starts debugging to pprof_{process_id} in the - dump directory. - - - - - &reftitle.parameters; - - - - dump_directory - - - The directory in which the profile dump file is written. If not set, - the setting from the &php.ini; file is used. - - - - - fragment - - - - - - - - - - - &reftitle.returnvalues; - - Returns path of the destination file. - - - - - &reftitle.examples; - - - <function>apd_set_pprof_trace</function> example - - -]]> - - - - - - - &reftitle.seealso; - - - apd_set_session_trace - - - - - - - diff --git a/reference/apd/functions/apd-set-session-trace-socket.xml b/reference/apd/functions/apd-set-session-trace-socket.xml deleted file mode 100644 index 52ede42d94ef..000000000000 --- a/reference/apd/functions/apd-set-session-trace-socket.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - apd_set_session_trace_socket - Starts the remote session debugging - - - &reftitle.description; - - boolapd_set_session_trace_socket - stringtcp_server - intsocket_type - intport - intdebug_level - - - Connects to the specified tcp_server (eg. tcplisten) - and sends debugging data to the socket. - - - - - &reftitle.parameters; - - - - tcp_server - - - IP or Unix Domain socket (like a file) of the TCP server. - - - - - socket_type - - - Can be AF_UNIX for file based sockets or - APD_AF_INET for standard tcp/ip. - - - - - port - - - You can use any port, but higher numbers are better as most of the - lower numbers may be used by other system services. - - - - &apd.debug-level.description; - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>apd_set_session_trace_socket</function> example - - -]]> - - - - - - - - diff --git a/reference/apd/functions/apd-set-session-trace.xml b/reference/apd/functions/apd-set-session-trace.xml deleted file mode 100644 index 6fb43910c6b8..000000000000 --- a/reference/apd/functions/apd-set-session-trace.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - apd_set_session_trace - Starts the session debugging - - - &reftitle.description; - - voidapd_set_session_trace - intdebug_level - stringdump_directoryini_get("apd.dumpdir") - - - Starts debugging to apd_dump_{process_id} in the - dump directory. - - - - - &reftitle.parameters; - - - &apd.debug-level.description; - - dump_directory - - - The directory in which the profile dump file is written. If not set, - the apd.dumpdir setting from the &php.ini; file is used. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>apd_set_session_trace</function> example - - -]]> - - - - - - - - diff --git a/reference/apd/functions/apd-set-session.xml b/reference/apd/functions/apd-set-session.xml deleted file mode 100644 index a54b429111e9..000000000000 --- a/reference/apd/functions/apd-set-session.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - apd_set_session - Changes or sets the current debugging level - - - &reftitle.description; - - voidapd_set_session - intdebug_level - - - This can be used to increase or decrease debugging in a different area of - your application. - - - - - &reftitle.parameters; - - - &apd.debug-level.description; - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>apd_set_session</function> example - - -]]> - - - - - - - diff --git a/reference/apd/functions/override-function.xml b/reference/apd/functions/override-function.xml deleted file mode 100644 index e8dee676cfcc..000000000000 --- a/reference/apd/functions/override-function.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - override_function - Overrides built-in functions - - - &reftitle.description; - - booloverride_function - stringfunction_name - stringfunction_args - stringfunction_code - - - Overrides built-in functions by replacing them in the symbol table. - - - - - - &reftitle.parameters; - - - - function_name - - - The function to override. - - - - - function_args - - - The function arguments, as a comma separated string. - - - Usually you will want to pass this parameter, as well as the - function_code parameter, as a single quote - delimited string. The reason for using single quoted strings, is to - protect the variable names from parsing, otherwise, if you use double - quotes there will be a need to escape the variable names, e.g. - \$your_var. - - - - - function_code - - - The new code for the function. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>override_function</function> example - - -]]> - - - - - - - diff --git a/reference/apd/functions/rename-function.xml b/reference/apd/functions/rename-function.xml deleted file mode 100644 index 2641b91b7e52..000000000000 --- a/reference/apd/functions/rename-function.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - rename_function - Renames orig_name to new_name in the global function table - - - &reftitle.description; - - boolrename_function - stringoriginal_name - stringnew_name - - - Renames a orig_name to new_name in the global function table. Useful - for temporarily overriding built-in functions. - - - - - &reftitle.parameters; - - - - original_name - - - The original function name. - - - - - new_name - - - The new name for the original_name function. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>rename_function</function> example - - -]]> - - - - - - - diff --git a/reference/apd/ini.xml b/reference/apd/ini.xml deleted file mode 100644 index c63ffda9da63..000000000000 --- a/reference/apd/ini.xml +++ /dev/null @@ -1,94 +0,0 @@ - - -
- &reftitle.runtime; - &extension.runtime; - - - APD Configuration Options - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - apd.dumpdir - NULL - PHP_INI_ALL - - - - apd.statement_tracing - "0" - PHP_INI_ALL - Available since apd 0.9. - - - -
- &ini.php.constants; - - - &ini.descriptions.title; - - - - - - apd.dumpdir - string - - - - Sets the directory in which APD writes profile dump files. - You can specify an absolute path or a relative path. - - - You can specify a different directory as an argument - to apd_set_pprof_trace. - - - - - - apd.statement_tracing - boolean - - - - Specfies whether or not to do per-line tracings. Turning this on (1) will - impact the performance of your application. - - - - - - - -
- - diff --git a/reference/apd/reference.xml b/reference/apd/reference.xml deleted file mode 100644 index 13d099db7b62..000000000000 --- a/reference/apd/reference.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - APD &Functions; - -
- Contact information - - If you have comments, bugfixes, enhancements or want to help developing - this beast, you can send an mail to - &email.apd;. Any help is very - welcome. - -
- - - &reference.apd.entities.functions; - - - - - diff --git a/reference/apd/setup.xml b/reference/apd/setup.xml deleted file mode 100644 index 53cdf4c98970..000000000000 --- a/reference/apd/setup.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.required; - &no.requirement; -
- -
- &reftitle.install; - - &pecl.info; - &url.pecl.package;apd. - - - &pecl.windows.download; - - - In your INI file, add the following lines: - - - - - - - - Depending on your PHP build, the zend_extension directive can be one of the - following: - - - - - - -
- -
- Building on Win32 - - To build APD under Windows you need a working PHP compilation - environment as described on http://php.net/ -- basically, it requires - you to have Microsoft Visual C++, win32build.zip, bison/flex, and some know how - to get it to work. Also ensure that adp.dsp has DOS line endings; if it has unix - line endings, Microsoft Visual C++ will complain about it. - -
- - &reference.apd.ini; - -
- &reftitle.resources; - &no.resource; -
- - - - - diff --git a/reference/apd/versions.xml b/reference/apd/versions.xml deleted file mode 100644 index 6452c33bdb4c..000000000000 --- a/reference/apd/versions.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/array/functions/array-combine.xml b/reference/array/functions/array-combine.xml index 3c7ba6700892..6c5330b31fdd 100644 --- a/reference/array/functions/array-combine.xml +++ b/reference/array/functions/array-combine.xml @@ -64,31 +64,6 @@ match. - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - Previous versions issued E_WARNING and returned - &false; for empty arrays. - - - - - - - &reftitle.examples; diff --git a/reference/array/functions/array-multisort.xml b/reference/array/functions/array-multisort.xml index 7e04cfeeba4a..e5c6e83e6234 100644 --- a/reference/array/functions/array-multisort.xml +++ b/reference/array/functions/array-multisort.xml @@ -121,38 +121,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - The SORT_NATURAL and SORT_FLAG_CASE - were added to array1_sort_flags as possible sort flags. - - - - 5.3.0 - - The SORT_LOCALE_STRING was added to - array1_sort_flags as possible sort flags. - - - - - - - - &reftitle.examples; diff --git a/reference/array/functions/array-product.xml b/reference/array/functions/array-product.xml index 77a95d2c7144..aa8433a92468 100644 --- a/reference/array/functions/array-product.xml +++ b/reference/array/functions/array-product.xml @@ -38,30 +38,6 @@ xmlns:xlink="http://www.w3.org/1999/xlink"> Returns the product as an integer or float. - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.6 - - The product of an empty array is now 1, when before this function would - return 0 for an empty array. - - - - - - - &reftitle.examples; diff --git a/reference/array/functions/array-rand.xml b/reference/array/functions/array-rand.xml index 69fae82f060b..0d2fb7adf59e 100644 --- a/reference/array/functions/array-rand.xml +++ b/reference/array/functions/array-rand.xml @@ -71,12 +71,6 @@ The internal randomization algorithm has been changed to use the Mersenne Twister Random Number Generator instead of the libc rand function. - - 5.2.10 - - The resulting array of keys is no longer shuffled. - - diff --git a/reference/array/functions/array-reduce.xml b/reference/array/functions/array-reduce.xml index 944350cd194a..79c627a2a965 100644 --- a/reference/array/functions/array-reduce.xml +++ b/reference/array/functions/array-reduce.xml @@ -85,29 +85,6 @@ array_reduce returns &null;. - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - Changed initial to allow mixed, previously integer. - - - - - - - &reftitle.examples; diff --git a/reference/array/functions/array-search.xml b/reference/array/functions/array-search.xml index e3f389ea347c..6823ce055341 100644 --- a/reference/array/functions/array-search.xml +++ b/reference/array/functions/array-search.xml @@ -74,31 +74,6 @@ &return.falseproblem; - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - As with all internal PHP functions as of 5.3.0, - array_search returns &null; if invalid parameters - are passed to it. - - - - - - - &reftitle.examples; diff --git a/reference/array/functions/array-slice.xml b/reference/array/functions/array-slice.xml index ac563e428839..7348ae023b28 100644 --- a/reference/array/functions/array-slice.xml +++ b/reference/array/functions/array-slice.xml @@ -96,39 +96,6 @@ Returns the slice. If the offset is larger than the size of the array, an empty array is returned. - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.4 - - The default value of the length parameter was - changed to &null;. A &null; length now tells - the function to use the length of array. - Prior to this version, a &null; length was - taken to mean a zero length (nothing will be returned). - - - - 5.0.2 - - The optional preserve_keys parameter was added. - - - - - - &reftitle.examples; diff --git a/reference/array/functions/array-unique.xml b/reference/array/functions/array-unique.xml index 18425d70fabc..48f1435ce79d 100644 --- a/reference/array/functions/array-unique.xml +++ b/reference/array/functions/array-unique.xml @@ -105,21 +105,6 @@ in different numeric indexes. - - 5.2.10 - - Changed the default value of sort_flags back to - SORT_STRING. - - - - 5.2.9 - - Added the optional sort_flags defaulting - to SORT_REGULAR. Prior to 5.2.9, this function used to sort - the array with SORT_STRING internally. - - diff --git a/reference/array/functions/natsort.xml b/reference/array/functions/natsort.xml index 9dfa2fedbded..bd64a4c35abc 100644 --- a/reference/array/functions/natsort.xml +++ b/reference/array/functions/natsort.xml @@ -42,28 +42,6 @@ - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 5.2.10 - - Zero padded numeric strings (e.g., '00005') now essentially ignore the 0 padding. - - - - - - - &reftitle.examples; diff --git a/reference/array/functions/sort.xml b/reference/array/functions/sort.xml index a128ef33ebf3..abc6aa466398 100644 --- a/reference/array/functions/sort.xml +++ b/reference/array/functions/sort.xml @@ -84,34 +84,6 @@ &return.success; - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 5.4.0 - - Added support for SORT_NATURAL and - SORT_FLAG_CASE as sort_flags - - - - 5.0.2 - - Added SORT_LOCALE_STRING - - - - - - &reftitle.examples; diff --git a/reference/bcompiler/book.xml b/reference/bcompiler/book.xml deleted file mode 100644 index cdd5ee591d51..000000000000 --- a/reference/bcompiler/book.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - PHP bytecode Compiler - bcompiler - - - &reftitle.intro; - &warn.experimental; - - Bcompiler was written for several reasons: - - To encode entire script in a proprietary PHP application - To encode some classes and/or functions in a proprietary PHP application - - To enable the production of php-gtk applications that could be used on - client desktops, without the need for a php.exe. - - To do the feasibility study for a PHP to C converter - - The first of these goals is achieved using the - bcompiler_write_header, - bcompiler_write_file and - bcompiler_write_footer - functions. The bytecode files can - be written as either uncompressed or plain. - To use the generated bytecode, you can simply include it - with include or require statements. - - - The second of these goals is achieved using the - bcompiler_write_header, - bcompiler_write_class, - bcompiler_write_footer, - bcompiler_read, - and bcompiler_load functions. The bytecode files can - be written as either uncompressed or plain. The - bcompiler_load reads a bzip compressed bytecode file, - which tends to be 1/3 of the size of the original file. - - - To create EXE type files, bcompiler has to be used with a modified sapi - file or a version of PHP which has been compiled as a shared library. In - this scenario, bcompiler reads the compressed bytecode from the end of the - exe file. - - - bcompiler can improve performance by about 30% when used with uncompressed - bytecodes only. But keep in mind that uncompressed bytecode can be up - to 5 times larger than the original source code. Using bytecode - compression can save your space, but decompression requires much more - time than parsing a source. bcompiler also does not do any bytecode - optimization, this could be added in the future... - - - In terms of code protection, it is safe to say that it would be impossible - to recreate the exact source code that it was built from, and without the - accompanying source code comments. It would effectively be useless to use - the bcompiler bytecodes to recreate and modify a class. However it is - possible to retrieve data from a bcompiled bytecode file - so don't put - your private passwords or anything in it. - - - - &reference.bcompiler.setup; - &reference.bcompiler.constants; - &reference.bcompiler.reference; - - - - - diff --git a/reference/bcompiler/configure.xml b/reference/bcompiler/configure.xml deleted file mode 100644 index 9d2b59155341..000000000000 --- a/reference/bcompiler/configure.xml +++ /dev/null @@ -1,36 +0,0 @@ - - -
- &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;bcompiler. - - - &pecl.windows.download; - -
- - diff --git a/reference/bcompiler/constants.xml b/reference/bcompiler/constants.xml deleted file mode 100644 index 885227af62df..000000000000 --- a/reference/bcompiler/constants.xml +++ /dev/null @@ -1,28 +0,0 @@ - - - - - &reftitle.constants; - &no.constants; - - - - diff --git a/reference/bcompiler/functions/bcompiler-load-exe.xml b/reference/bcompiler/functions/bcompiler-load-exe.xml deleted file mode 100644 index 84a574a33ec1..000000000000 --- a/reference/bcompiler/functions/bcompiler-load-exe.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - bcompiler_load_exe - Reads and creates classes from a bcompiler exe file - - - - &reftitle.description; - - boolbcompiler_load_exe - stringfilename - - - Reads data from a bcompiler exe file and creates classes from the bytecodes. - - - - - &reftitle.parameters; - - - - filename - - - The exe file path, as a string. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>bcompiler_load_exe</function> example - - -]]> - - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - - bcompiler_load - - - - - - - diff --git a/reference/bcompiler/functions/bcompiler-load.xml b/reference/bcompiler/functions/bcompiler-load.xml deleted file mode 100644 index 8c6b48a1983a..000000000000 --- a/reference/bcompiler/functions/bcompiler-load.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - bcompiler_load - Reads and creates classes from a bz compressed file - - - - &reftitle.description; - - boolbcompiler_load - stringfilename - - - Reads data from a bzcompressed file and creates classes from the bytecodes. - - - - - &reftitle.parameters; - - - - filename - - - The bzcompressed file path, as a string. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>bcompiler_load</function> example - - -]]> - - - - - - - &reftitle.notes; - &warn.experimental.func; - - - Please use include or require statements to parse bytecodes, it's more - portable and convenient way than using this function. - - - Please note that this function won't execute script body code contained - in the bytecode file. - - - - - - &reftitle.seealso; - - - bcompiler_load_exe - - - - - - - diff --git a/reference/bcompiler/functions/bcompiler-parse-class.xml b/reference/bcompiler/functions/bcompiler-parse-class.xml deleted file mode 100644 index d6520c3bb098..000000000000 --- a/reference/bcompiler/functions/bcompiler-parse-class.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - bcompiler_parse_class - Reads the bytecodes of a class and calls back to a user function - - - - &reftitle.description; - - boolbcompiler_parse_class - stringclass - stringcallback - - - Reads the bytecodes of a class and calls back to a user function. - - - - - &reftitle.parameters; - - - - class - - - The class name, as a string. - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>bcompiler_parse_class</function> example - - -]]> - - - - - - - &reftitle.notes; - &warn.experimental.func; - - - This function has been removed from bcompiler and is no longer available - as of bcompiler 0.5. - - - - - - - diff --git a/reference/bcompiler/functions/bcompiler-read.xml b/reference/bcompiler/functions/bcompiler-read.xml deleted file mode 100644 index 830dc87c023e..000000000000 --- a/reference/bcompiler/functions/bcompiler-read.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - bcompiler_read - Reads and creates classes from a filehandle - - - - &reftitle.description; - - boolbcompiler_read - resourcefilehandle - - - Reads data from a open file handle and creates classes from the bytecodes. - - - - - &reftitle.parameters; - - - - filehandle - - - A file handle as returned by fopen. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>bcompiler_read</function> example - - -]]> - - - - - - - &reftitle.notes; - &warn.experimental.func; - - - Please use include or require statements to parse bytecodes, it's more - portable and convenient way than using this function. - - - Please note that this function won't execute script body code contained - in the bytecode file. - - - - - - - diff --git a/reference/bcompiler/functions/bcompiler-write-class.xml b/reference/bcompiler/functions/bcompiler-write-class.xml deleted file mode 100644 index 90371127718f..000000000000 --- a/reference/bcompiler/functions/bcompiler-write-class.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - bcompiler_write_class - Writes a defined class as bytecodes - - - - &reftitle.description; - - boolbcompiler_write_class - resourcefilehandle - stringclassName - stringextends - - - Reads the bytecodes from PHP for an existing class, and writes them to the - open file handle. - - - - - &reftitle.parameters; - - - - filehandle - - - A file handle as returned by fopen. - - - - - className - - - The class name, as a string. - - - - - extends - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>bcompiler_write_class</function> example - - -]]> - - - - - - - &reftitle.notes; - &warn.experimental.func; - - - This function does not perform dependency checking, so make sure you - write the classes in an order that will not result in an - undefined class error occurring when you load it. - - - - - - &reftitle.seealso; - - - bcompiler_write_header - bcompiler_write_footer - - - - - - - diff --git a/reference/bcompiler/functions/bcompiler-write-constant.xml b/reference/bcompiler/functions/bcompiler-write-constant.xml deleted file mode 100644 index a78e66defb2d..000000000000 --- a/reference/bcompiler/functions/bcompiler-write-constant.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - bcompiler_write_constant - Writes a defined constant as bytecodes - - - - &reftitle.description; - - boolbcompiler_write_constant - resourcefilehandle - stringconstantName - - - Reads the bytecodes from PHP for an existing constant, and writes them to - the open file handle. - - - - - &reftitle.parameters; - - - - filehandle - - - A file handle as returned by fopen. - - - - - constantName - - - The name of the defined constant, as a string. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>bcompiler_write_constant</function> example - - -]]> - - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - - bcompiler_write_header - bcompiler_write_footer - - - - - - - diff --git a/reference/bcompiler/functions/bcompiler-write-exe-footer.xml b/reference/bcompiler/functions/bcompiler-write-exe-footer.xml deleted file mode 100644 index 5e2cebf5666b..000000000000 --- a/reference/bcompiler/functions/bcompiler-write-exe-footer.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - bcompiler_write_exe_footer - Writes the start pos, and sig to the end of a exe type file - - - - &reftitle.description; - - boolbcompiler_write_exe_footer - resourcefilehandle - intstartpos - - - An EXE (or self executable) file consists of 3 parts: - - - The stub (executable code, e.g. a compiled C program) that loads PHP - interpreter, bcompiler extension, stored Bytecodes and initiates a call - for the specified function (e.g. main) or class method (e.g. main::main) - - The Bytecodes (uncompressed only for the moment) - The bcompiler EXE footer - - - - To obtain a suitable stub you can compile php_embed-based stub phpe.c - located in the examples/embed directory on bcompiler's CVS. - - - - - &reftitle.parameters; - - - - filehandle - - - A file handle as returned by fopen. - - - - - startpos - - - The file position at which the Bytecodes start, and can be obtained - using ftell. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>bcompiler_write_exe_footer</function> example - - -]]> - - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - - bcompiler_write_header - bcompiler_write_class - bcompiler_write_footer - - - - - - - diff --git a/reference/bcompiler/functions/bcompiler-write-file.xml b/reference/bcompiler/functions/bcompiler-write-file.xml deleted file mode 100644 index 862841c263a6..000000000000 --- a/reference/bcompiler/functions/bcompiler-write-file.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - bcompiler_write_file - Writes a php source file as bytecodes - - - - &reftitle.description; - - boolbcompiler_write_file - resourcefilehandle - stringfilename - - - This function compiles specified source file into bytecodes, and writes - them to the open file handle. - - - - - &reftitle.parameters; - - - - filehandle - - - A file handle as returned by fopen. - - - - - filename - - - The source file path, as a string. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>bcompiler_write_file</function> example - - -]]> - - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - - bcompiler_write_header - bcompiler_write_footer - - - - - - - diff --git a/reference/bcompiler/functions/bcompiler-write-footer.xml b/reference/bcompiler/functions/bcompiler-write-footer.xml deleted file mode 100644 index 1a7df4c1ae65..000000000000 --- a/reference/bcompiler/functions/bcompiler-write-footer.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - bcompiler_write_footer - Writes the single character \x00 to indicate End of compiled data - - - - &reftitle.description; - - boolbcompiler_write_footer - resourcefilehandle - - - Writes the single character \x00 to indicate End of compiled data. - - - - - &reftitle.parameters; - - - - filehandle - - - A file handle as returned by fopen. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>bcompiler_write_footer</function> example - - -]]> - - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - - bcompiler_write_header - - - - - - - diff --git a/reference/bcompiler/functions/bcompiler-write-function.xml b/reference/bcompiler/functions/bcompiler-write-function.xml deleted file mode 100644 index 9895f55c172c..000000000000 --- a/reference/bcompiler/functions/bcompiler-write-function.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - bcompiler_write_function - Writes a defined function as bytecodes - - - - &reftitle.description; - - boolbcompiler_write_function - resourcefilehandle - stringfunctionName - - - Reads the bytecodes from PHP for an existing function, and writes them to - the open file handle. Order is not important, (eg. if function b uses - function a, and you compile it like the example below, it will work - perfectly OK). - - - - - &reftitle.parameters; - - - - filehandle - - - A file handle as returned by fopen. - - - - - functionName - - - The function name, as a string. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>bcompiler_write_function</function> example - - -]]> - - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - - bcompiler_write_header - bcompiler_write_footer - - - - - - - diff --git a/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml b/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml deleted file mode 100644 index c2bf0238fdd0..000000000000 --- a/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - bcompiler_write_functions_from_file - Writes all functions defined in a file as bytecodes - - - - &reftitle.description; - - boolbcompiler_write_functions_from_file - resourcefilehandle - stringfileName - - - Searches for all functions declared in the given file, and writes their - correspondent bytecodes to the open file handle. - - - - - &reftitle.parameters; - - - - filehandle - - - A file handle as returned by fopen. - - - - - fileName - - - The file to be compiled. - You must always include or require the file you intend to compile. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>bcompiler_write_functions_from_file</function> example - - -]]> - - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - - bcompiler_write_header - bcompiler_write_footer - - - - - - - diff --git a/reference/bcompiler/functions/bcompiler-write-header.xml b/reference/bcompiler/functions/bcompiler-write-header.xml deleted file mode 100644 index 1f8163102a40..000000000000 --- a/reference/bcompiler/functions/bcompiler-write-header.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - bcompiler_write_header - Writes the bcompiler header - - - - &reftitle.description; - - boolbcompiler_write_header - resourcefilehandle - stringwrite_ver - - - Writes the header part of a bcompiler file. - - - - - &reftitle.parameters; - - - - filehandle - - - A file handle as returned by fopen. - - - - - write_ver - - - Can be used to write bytecode in a previously used format, so that you - can use it with older versions of bcompiler. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>bcompiler_write_header</function> example - - -]]> - - - - - - - &reftitle.notes; - &warn.experimental.func; - - - - &reftitle.seealso; - - - bcompiler_write_footer - - - - - - - diff --git a/reference/bcompiler/functions/bcompiler-write-included-filename.xml b/reference/bcompiler/functions/bcompiler-write-included-filename.xml deleted file mode 100644 index b20f3ac91aa9..000000000000 --- a/reference/bcompiler/functions/bcompiler-write-included-filename.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - bcompiler_write_included_filename - Writes an included file as bytecodes - - - - &reftitle.description; - - boolbcompiler_write_included_filename - resourcefilehandle - stringfilename - - &warn.undocumented.func; - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - &warn.experimental.func; - - - - - diff --git a/reference/bcompiler/reference.xml b/reference/bcompiler/reference.xml deleted file mode 100644 index 80ba9fc5aa2a..000000000000 --- a/reference/bcompiler/reference.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - bcompiler &Functions; - -
- Contact Information - - If you have comments, bugfixes, enhancements or want to help - developing this beast, you can drop me a mail at alan_k@php.net. Any help is very - welcome. - -
- - - &reference.bcompiler.entities.functions; - - - - - diff --git a/reference/bcompiler/setup.xml b/reference/bcompiler/setup.xml deleted file mode 100644 index b826428fc9c2..000000000000 --- a/reference/bcompiler/setup.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.required; - &no.requirement; -
- - &reference.bcompiler.configure; - -
- &reftitle.runtime; - &no.config; -
- -
- &reftitle.resources; - &no.resource; -
- - - - - diff --git a/reference/bcompiler/versions.xml b/reference/bcompiler/versions.xml deleted file mode 100644 index b142766b2711..000000000000 --- a/reference/bcompiler/versions.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/cairo/book.xml b/reference/cairo/book.xml deleted file mode 100644 index 00f0c751dc73..000000000000 --- a/reference/cairo/book.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - Cairo - Cairo - - - &reftitle.intro; - - Cairo is a native PHP extension to create and modify graphics using the Cairo - Graphics Library. - - - The Cairo Graphics Library is a 2D library written in C with support for - multiple output devices. Currently supported output targets include the X - Window System, Quartz, Win32, image buffers, PostScript, PDF, and SVG file - output. Experimental backends include OpenGL (through glitz), XCB, BeOS, - OS/2, and DirectFB. The library also has support for two types of text - manipulation and layout. The "toy" API provides demo quality support, and - the glyphs API, although full-featured, works best with a helper library - such as pango. Font backend support includes FreeType, Quartz, Win32, and - User fonts. - - - There are two types of computer graphics, vector and raster. Raster graphics - are the representation of images as an array of pixels. Vector graphics use - geometrical primitives such as points, lines, curves or polygons to represent - images. The primitives are created using mathematical equations. The Cairo - Graphics Library takes a vector approach to graphics, allowing smaller size, - infinite zooming, and moving, scaling and rotating without degrading image - quality. - - - Operations in the cairo graphics library including stroking and filling cubic - Bézier splines, transforming and compositing translucent images, and - antialiased text rendering. All drawing operations can be transformed by any - affine transformation (scale, rotation, shear, and others) This is very - similar to drawing operations for PostScript and PDF drawing. - - - The Cairo PHP Extension aims to provide support for all officially supported - font backends and surface backends, as well as expose all available - functionality in cairo to PHP users. - - - - - - &reference.cairo.setup; - &reference.cairo.constants; - &reference.cairo.examples; - &reference.cairo.reference; - - &reference.cairo.cairo; - &reference.cairo.cairocontext; - &reference.cairo.cairoexception; - &reference.cairo.cairostatus; - - &reference.cairo.cairosurface; - &reference.cairo.cairosvgsurface; - &reference.cairo.cairoimagesurface; - &reference.cairo.cairopdfsurface; - &reference.cairo.cairopssurface; - &reference.cairo.cairosurfacetype; - - - &reference.cairo.cairofontface; - &reference.cairo.cairofontoptions; - &reference.cairo.cairofontslant; - &reference.cairo.cairofonttype; - &reference.cairo.cairofontweight; - &reference.cairo.cairoscaledfont; - &reference.cairo.cairotoyfontface; - - &reference.cairo.cairopatterntype; - &reference.cairo.cairopattern; - &reference.cairo.cairogradientpattern; - &reference.cairo.cairosolidpattern; - &reference.cairo.cairosurfacepattern; - &reference.cairo.cairolineargradient; - &reference.cairo.cairoradialgradient; - - &reference.cairo.cairoantialias; - &reference.cairo.cairocontent; - &reference.cairo.cairoextend; - &reference.cairo.cairoformat; - &reference.cairo.cairofillrule; - &reference.cairo.cairofilter; - &reference.cairo.cairohintmetrics; - &reference.cairo.cairohintstyle; - &reference.cairo.cairolinecap; - &reference.cairo.cairolinejoin; - &reference.cairo.cairomatrix; - &reference.cairo.cairooperator; - &reference.cairo.cairopath; - &reference.cairo.cairopslevel; - &reference.cairo.cairosubpixelorder; - &reference.cairo.cairosvgversion; - - - - diff --git a/reference/cairo/cairo.xml b/reference/cairo/cairo.xml deleted file mode 100644 index 89e7a23fb09d..000000000000 --- a/reference/cairo/cairo.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The Cairo class - Cairo - - - - -
- &reftitle.intro; - - Simple class with some static helper methods. - -
- - -
- &reftitle.classsynopsis; - - - - Cairo - - - - - Cairo - - - - - &Methods; - - - - -
- - - - &reference.cairo.entities.cairo; - - - - diff --git a/reference/cairo/cairo/availablefonts.xml b/reference/cairo/cairo/availablefonts.xml deleted file mode 100644 index 2b68dee5cdc2..000000000000 --- a/reference/cairo/cairo/availablefonts.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - - Cairo::availableFonts - cairo_available_fonts - Retrieves the availables font types - - - - &reftitle.description; - &style.oop;: - - public static arrayCairo::availableFonts - - - &style.procedural;: - - arraycairo_available_fonts - - - - Returns an array with the available font backends - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A list-type array with all available font backends. - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - string(5) "WIN32" - [1]=> - string(4) "USER" -} -]]> - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - string(5) "WIN32" - [1]=> - string(4) "USER" -} -]]> - - - - - - - &reftitle.seealso; - - - Cairo::availableSurfaces - - - - - - - diff --git a/reference/cairo/cairo/availablesurfaces.xml b/reference/cairo/cairo/availablesurfaces.xml deleted file mode 100644 index 26e1eea1966e..000000000000 --- a/reference/cairo/cairo/availablesurfaces.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - Cairo::availableSurfaces - cairo_available_surfaces - Retrieves all available surfaces - - - - &reftitle.description; - &style.oop; (method): - - public static arrayCairo::availableSurfaces - - - &style.procedural;: - - arraycairo_available_surfaces - - - - Returns an array with the available surface backends - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A list-type array with all available surface backends. - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - string(5) "IMAGE" - [1]=> - string(3) "PNG" - [2]=> - string(3) "PDF" - [3]=> - string(2) "PS" - [4]=> - string(3) "SVG" - [5]=> - string(5) "WIN32" -} -]]> - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - string(5) "IMAGE" - [1]=> - string(3) "PNG" - [2]=> - string(3) "PDF" - [3]=> - string(2) "PS" - [4]=> - string(3) "SVG" - [5]=> - string(5) "WIN32" -} -]]> - - - - - - - &reftitle.seealso; - - - Cairo::availableFonts - - - - - - - diff --git a/reference/cairo/cairo/statustostring.xml b/reference/cairo/cairo/statustostring.xml deleted file mode 100644 index 3b748c94248c..000000000000 --- a/reference/cairo/cairo/statustostring.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - Cairo::statusToString - cairo_status_to_string - Retrieves the current status as string - - - - &reftitle.description; - &style.oop; (method): - - public static stringCairo::statusToString - intstatus - - &style.procedural;: - - stringcairo_status_to_string - intstatus - - - Retrieves the current status as a readable string - - - - - - &reftitle.parameters; - - - - status - - - A valid status code given by cairo_status or CairoContext::status - - - - - - - - - &reftitle.returnvalues; - - A string containing the current status of a CairoContext object - - - - - &reftitle.examples; - - - &style.oop; - -status())); -?> -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - CairoContext::status - - - - - - - diff --git a/reference/cairo/cairo/version.xml b/reference/cairo/cairo/version.xml deleted file mode 100644 index 1a32d2d528cb..000000000000 --- a/reference/cairo/cairo/version.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - Cairo::version - cairo_version - Retrieves cairo's library version - - - - &reftitle.description; - &style.oop; (method): - - public static intCairo::version - - - &style.procedural;: - - intcairo_version - - - - Retrieves the current version of the cairo library as an integer value - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Current Cairo library version integer - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Cairo::versionString - - - - - - - diff --git a/reference/cairo/cairo/versionstring.xml b/reference/cairo/cairo/versionstring.xml deleted file mode 100644 index 3c2e7e06f2e6..000000000000 --- a/reference/cairo/cairo/versionstring.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - Cairo::versionString - cairo_version_string - Retrieves cairo version as string - - - - &reftitle.description; - &style.oop; (method): - - public static stringCairo::versionString - - - &style.procedural;: - - stringcairo_version_string - - - - Retrieves the current cairo library version as a string. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Current Cairo library version string - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Cairo::version - - - - - - - diff --git a/reference/cairo/cairoantialias.xml b/reference/cairo/cairoantialias.xml deleted file mode 100644 index 3a6e2b16e11e..000000000000 --- a/reference/cairo/cairoantialias.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - The CairoAntialias class - CairoAntialias - - - - -
- &reftitle.intro; - - Enum class that specifies the type of antialiasing to do when rendering text or shapes. - -
- - -
- &reftitle.classsynopsis; - - - - CairoAntialias - - - - - CairoAntialias - - - - &Constants; - - const - integer - CairoAntialias::MODE_DEFAULT - 0 - - - const - integer - CairoAntialias::MODE_NONE - 1 - - - const - integer - CairoAntialias::MODE_GRAY - 2 - - - const - integer - CairoAntialias::MODE_SUBPIXEL - 3 - - - - - -
- - -
- &reftitle.constants; - - - - CairoAntialias::MODE_DEFAULT - - Use the default antialiasing for the subsystem and target device - - - - - CairoAntialias::MODE_NONE - - Use a bilevel alpha mask - - - - - CairoAntialias::MODE_GRAY - - Perform single-color antialiasing (using shades of gray for black text on a white background, for example). - - - - - CairoAntialias::MODE_SUBPIXEL - - Perform antialiasing by taking advantage of the order of subpixel elements on devices such as LCD panels. - - - - -
- - - - - - - - - - diff --git a/reference/cairo/cairocontent.xml b/reference/cairo/cairocontent.xml deleted file mode 100644 index c01d013a590f..000000000000 --- a/reference/cairo/cairocontent.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - The CairoContent class - CairoContent - - - - -
- &reftitle.intro; - - CairoContent is used to describe the content that a surface will contain, - whether color information, alpha information (translucence vs. opacity), or both. - - - Note: The large values here are designed to keep CairoContent values distinct from - CairoContent values so that the implementation can detect the error if users confuse the - two types. - -
- - -
- &reftitle.classsynopsis; - - - - CairoContent - - - - - CairoContent - - - - &Constants; - - const - integer - CairoContent::COLOR - 4096 - - - const - integer - CairoContent::ALPHA - 8192 - - - const - integer - CairoContent::COLOR_ALPHA - 12288 - - - - - -
- - -
- &reftitle.constants; - - - - CairoContent::COLOR - - The surface will hold color content only. - - - - - CairoContent::ALPHA - - The surface will hold alpha content only. - - - - - CairoContent::COLOR_ALPHA - - The surface will hold color and alpha content. - - - - -
- - - - - - - - - - diff --git a/reference/cairo/cairocontext.xml b/reference/cairo/cairocontext.xml deleted file mode 100644 index 4e3d94bd31e5..000000000000 --- a/reference/cairo/cairocontext.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - The CairoContext class - CairoContext - - - - -
- &reftitle.intro; - - Context is the main object used when drawing with cairo. To draw with cairo, you create a - CairoContext, set the target CairoSurface, - and drawing options for the CairoContext, create shapes with functions . - like CairoContext::moveTo and - CairoContext::lineTo, and then draw shapes with - CairoContext::stroke or CairoContext::fill. - - Contexts can be pushed to a stack via CairoContext::save. - They may then safely be changed, without losing the current state. Use - CairoContext::restore - to restore to the saved state. - -
- - -
- &reftitle.classsynopsis; - - - - CairoContext - - - - - CairoContext - - - - - &Methods; - - - - -
- - - - &reference.cairo.entities.cairocontext; - - - - diff --git a/reference/cairo/cairocontext/appendpath.xml b/reference/cairo/cairocontext/appendpath.xml deleted file mode 100644 index 6443d626d5e7..000000000000 --- a/reference/cairo/cairocontext/appendpath.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - CairoContext::appendPath - cairo_append_path - Appends a path to current path - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::appendPath - CairoPathpath - - &style.procedural;: - - voidcairo_append_path - CairoContextcontext - CairoPathpath - - - Appends the path onto the current path. - The path may be either the return value from one of CairoContext::copyPath or - CairoContext::copyPathFlat; - - - if path is not a valid CairoPath instance - a CairoException will be thrown - - - - - - &reftitle.parameters; - - - - context - - - CairoContext object - - - - - path - - - CairoPath object - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - &style.oop; - -copyPath(); - -$context->appendPath($path); - -?> -]]> - - - - - - &style.procedural; - - -]]> - - - - - - - &reftitle.seealso; - - - CairoPath - CairoContext::copyPath - CairoContext::copyPathFlat - - - - - - - diff --git a/reference/cairo/cairocontext/arc.xml b/reference/cairo/cairocontext/arc.xml deleted file mode 100644 index 455c5e62f815..000000000000 --- a/reference/cairo/cairocontext/arc.xml +++ /dev/null @@ -1,218 +0,0 @@ - - - - - - CairoContext::arc - cairo_arc - Adds a circular arc - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::arc - floatx - floaty - floatradius - floatangle1 - floatangle2 - - &style.procedural;: - - voidcairo_arc - CairoContextcontext - floatx - floaty - floatradius - floatangle1 - floatangle2 - - - Adds a circular arc of the given radius to the current path. - The arc is centered at (x, y), begins at - angle1 and proceeds in the direction of increasing angles to end at - angle2. - If angle2 is less than angle1 it will be - progressively increased by 2*M_PI until it is greater than angle1. - - If there is a current point, an initial line segment will be added to the path to connect the - current point to the beginning of the arc. If this initial line is undesired, - it can be avoided by calling CairoContext::newSubPath or procedural - cairo_new_sub_path before calling CairoContext::arc - or cairo_arc. - - Angles are measured in radians. An angle of 0.0 is in the direction of the positive X axis - (in user space). An angle of M_PI/2.0 radians (90 degrees) is in the direction of the positive - Y axis (in user space). Angles increase in the direction from the positive X axis toward the - positive Y axis. So with the default transformation matrix, angles increase in a clockwise direction. - - (To convert from degrees to radians, use degrees * (M_PI / 180.).) - This function gives the arc in the direction of increasing angles; see - CairoContext::arcNegative or cairo_arc_negative - to get the arc in the direction of decreasing angles. - - - - - - - - &reftitle.parameters; - - - - context - - - A valid CairoContext object - - - - - x - - - x position - - - - - y - - - y position - - - - - radius - - - Radius of the arc - - - - - angle1 - - - start angle - - - - - angle2 - - - end angle - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - &style.oop; - -setSourceRgb(0, 0, 0); -$c->paint(); - -$c->setLineWidth(1); -$c->setSourceRgb(1, 1, 1); - -for ($r = 50; $r > 0; $r -= 10) { - $c->arc(50, 50, $r, 0, 2 * M_PI); - $c->stroke(); - $c->fill(); -} - -$s->writeToPng(dirname(__FILE__) . '/CairoContext__arc.png'); -?> -]]> - - - - - - &style.procedural; - - 0; $r -= 10) { - cairo_arc($c, 50, 50, $r, 0, 2 * M_PI); - cairo_stroke($c); - cairo_fill($c); -} - -cairo_surface_write_to_png($s, dirname(__FILE__) . '/cairo_arc.png'); -?> -]]> - - - - - - - &reftitle.seealso; - - - CairoContext::arcNegative - - - - - - - diff --git a/reference/cairo/cairocontext/arcnegative.xml b/reference/cairo/cairocontext/arcnegative.xml deleted file mode 100644 index fd76ccd7b8a9..000000000000 --- a/reference/cairo/cairocontext/arcnegative.xml +++ /dev/null @@ -1,199 +0,0 @@ - - - - - - CairoContext::arcNegative - cairo_arc_negative - Adds a negative arc - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::arcNegative - floatx - floaty - floatradius - floatangle1 - floatangle2 - - &style.procedural;: - - voidcairo_arc_negative - CairoContextcontext - floatx - floaty - floatradius - floatangle1 - floatangle2 - - - Adds a circular arc of the given radius to the current path. - The arc is centered at (x, y), begins at - angle1 and proceeds in the direction of decreasing angles to end at - angle2. If angle2 is greater than - angle1 it will be progressively decreased by 2*M_PI until it is less than - angle1. - - See CairoContext::arc or cairo_arc for more details. - This function differs only in the direction of the arc between the two angles. - - - - - - &reftitle.parameters; - - - - context - - - A valid CairoContext object - - - - - x - - - double x position - - - - - y - - - double y position - - - - - radius - - - The radius of the desired negative arc - - - - - angle1 - - - Start angle of the arc - - - - - angle2 - - - End angle of the arc - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - &style.oop; - -setSourceRgb(0, 0, 0); -$c->paint(); - -$c->setLineWidth(1); -$c->setSourceRgb(1, 1, 1); - -for ($r = 50; $r > 0; $r -= 10) { - $c->arcNegative(50, 50, $r, 2 * M_PI, 0); - $c->stroke(); - $c->fill(); -} - -$s->writeToPng(dirname(__FILE__) . '/CairoContext__arcNegative.png'); -?> -]]> - - - - - - &style.procedural; - - 0; $r -= 10) { - cairo_arc_negative($c, 50, 50, $r, 2 * M_PI, 0); - cairo_stroke($c); - cairo_fill($c); -} - -cairo_surface_write_to_png($s, dirname(__FILE__) . '/cairo_arc_negative.png'); -?> -]]> - - - - - - - &reftitle.seealso; - - - CairoContext::arc - - - - - - - diff --git a/reference/cairo/cairocontext/clip.xml b/reference/cairo/cairocontext/clip.xml deleted file mode 100644 index 2b7f977b185e..000000000000 --- a/reference/cairo/cairocontext/clip.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - CairoContext::clip - cairo_clip - Establishes a new clip region - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::clip - - - &style.procedural;: - - voidcairo_clip - CairoContextcontext - - - Establishes a new clip region by intersecting the current clip region with the current path as it - would be filled by CairoContext::fill or cairo_fill - and according to the current fill rule (see CairoContext::setFillRule - or cairo_set_fill_rule). - - - After CairoContext::clip or cairo_clip, - the current path will be cleared from the cairo context. - - - The current clip region affects all drawing operations by effectively masking out any changes - to the surface that are outside the current clip region. - - - Calling CairoContext::clip or cairo_clip - can only make the clip region smaller, never larger. But the current clip is part of the - graphics state, so a temporary restriction of the clip region can be achieved by calling - CairoContext::clip or cairo_clip within a - CairoContext::save/CairoContext::restore or - cairo_save/cairo_restore pair. - The only other means of increasing the size of the clip region is - CairoContext::resetClip or procedural cairo_reset_clip. - - - - - - &reftitle.parameters; - - - - context - - - A valid CairoContext object - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - &style.oop; - -clip(); - -?> -]]> - - - - - - &style.procedural; - - -]]> - - - - - - - &reftitle.seealso; - - - CairoContext::resetClip - cairo_reset_clip - - - - - - - diff --git a/reference/cairo/cairocontext/clipextents.xml b/reference/cairo/cairocontext/clipextents.xml deleted file mode 100644 index b4f93bece7dd..000000000000 --- a/reference/cairo/cairocontext/clipextents.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - CairoContext::clipExtents - cairo_clip_extents - Computes the area inside the current clip - - - - &reftitle.description; - &style.oop; (method): - - public arrayCairoContext::clipExtents - - - &style.procedural;: - - arraycairo_clip_extents - CairoContextcontext - - - Computes a bounding box in user coordinates covering the area inside the current clip. - - - - - - &reftitle.parameters; - - - - context - - - A valid CairoContext object - - - - - - - - - &reftitle.returnvalues; - - An array containing the (float)x1, (float)y1, (float)x2, (float)y2, coordinates covering the area inside the current clip - - - - - &reftitle.examples; - - - &style.oop; - -clipExtents()); -?> -]]> - - &example.outputs.similar; - - - float(0) - [1]=> - float(0) - [2]=> - float(50) - [3]=> - float(50) -} -]]> - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - float(0) - [1]=> - float(0) - [2]=> - float(50) - [3]=> - float(50) -} -]]> - - - - - - - &reftitle.seealso; - - - CairoContext::clip - - - - - - - diff --git a/reference/cairo/cairocontext/clippreserve.xml b/reference/cairo/cairocontext/clippreserve.xml deleted file mode 100644 index 84c01592119e..000000000000 --- a/reference/cairo/cairocontext/clippreserve.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - CairoContext::clipPreserve - cairo_clip_preserve - Establishes a new clip region from the current clip - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::clipPreserve - - - &style.procedural;: - - voidcairo_clip_preserve - CairoContextcontext - - - Establishes a new clip region by intersecting the current clip region with the current path as - it would be filled by Context.fill and according to the current - FILL RULE (see CairoContext::setFillRule or - cairo_set_fill_rule). - - - Unlike CairoContext::clip, CairoContext::clipPreserve - preserves the path within the Context. - The current clip region affects all drawing operations by effectively masking out any changes - to the surface that are outside the current clip region. - - - Calling CairoContext::clipPreserve can only make the clip region smaller, - never larger. But the current clip is part of the graphics state, so a temporary restriction of the clip - region can be achieved by calling CairoContext::clipPreserve within a - CairoContext::save/CairoContext::restore pair. - The only other means of increasing the size of the clip region is CairoContext::resetClip. - - - - - - &reftitle.parameters; - - - - context - - - A valid CairoContext object - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - &style.oop; - -clipPreserve(); - -?> -]]> - - - - - - &style.procedural; - - -]]> - - - - - - - &reftitle.seealso; - - - CairoContext::save - CairoContext::restore - CairoContext::resetClip - - - - - - - diff --git a/reference/cairo/cairocontext/cliprectanglelist.xml b/reference/cairo/cairocontext/cliprectanglelist.xml deleted file mode 100644 index 30997cb9f5a4..000000000000 --- a/reference/cairo/cairocontext/cliprectanglelist.xml +++ /dev/null @@ -1,163 +0,0 @@ - - - - - - CairoContext::clipRectangleList - cairo_clip_rectangle_list - Retrieves the current clip as a list of rectangles - - - - &reftitle.description; - &style.oop; (method): - - public arrayCairoContext::clipRectangleList - - - &style.procedural;: - - arraycairo_clip_rectangle_list - CairoContextcontext - - - Returns a list-type array with the current clip region as a list of rectangles in user coordinates - - - - - &reftitle.parameters; - - - - context - - - A valid CairoContext object created with CairoContext::__construct or - cairo_create - - - - - - - - - &reftitle.returnvalues; - - 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.) - - - - - &reftitle.examples; - - - &style.oop; - -clipRectangleList()); - -?> -]]> - - &example.outputs.similar; - - - array(4) { - ["x"]=> - float(0) - ["y"]=> - float(0) - ["width"]=> - float(50) - ["height"]=> - float(50) - } -} -]]> - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - array(4) { - ["x"]=> - float(0) - ["y"]=> - float(0) - ["width"]=> - float(50) - ["height"]=> - float(50) - } -} -]]> - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/closepath.xml b/reference/cairo/cairocontext/closepath.xml deleted file mode 100644 index b52d3f91cb53..000000000000 --- a/reference/cairo/cairocontext/closepath.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - CairoContext::closePath - cairo_close_path - Closes the current path - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::closePath - - - &style.procedural;: - - voidcairo_close_path - CairoContextcontext - - - Adds a line segment to the path from the current point to the beginning of the current sub-path, - (the most recent point passed to CairoContext::moveTo), - and closes this sub-path. After this call the current point will be at the joined endpoint - of the sub-path. - - - - The behavior of close_path() is distinct from simply calling - CairoContext::lineTo with the equivalent coordinate in the case of - stroking. When a closed sub-path is stroked, there are no caps on the ends of the sub-path. - Instead, there is a line join connecting the final and initial segments of the sub-path. - - - If there is no current point before the call to CairoContext::closePath, - this function will have no effect. - - - - - - &reftitle.parameters; - - - - context - - - A valid CairoContext object created with - CairoContext::__construct or cairo_create - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - &style.oop; - -closePath(); - -?> -]]> - - - - - - &style.procedural; - - -]]> - - - - - - - &reftitle.seealso; - - - CairoContext::copyPath - - - - - - - diff --git a/reference/cairo/cairocontext/construct.xml b/reference/cairo/cairocontext/construct.xml deleted file mode 100644 index 588ec1178556..000000000000 --- a/reference/cairo/cairocontext/construct.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - CairoContext::__construct - Creates a new CairoContext - - - - &reftitle.description; - - public CairoContext::__construct - CairoSurfacesurface - - - Creates a new CairoContext object to draw - - - - - - &reftitle.parameters; - - - - surface - - - A valid CairoSurface like CairoImageSurface or - CairoPdfSurface - - - - - - - - - &reftitle.returnvalues; - - A CairoContext - - - - - &reftitle.examples; - - - <methodname>CairoContext::__construct</methodname> example - - -]]> - - - - - - - &reftitle.seealso; - - - Cairo::Method - - - - - - - diff --git a/reference/cairo/cairocontext/copypage.xml b/reference/cairo/cairocontext/copypage.xml deleted file mode 100644 index cf79f64896fc..000000000000 --- a/reference/cairo/cairocontext/copypage.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - CairoContext::copyPage - cairo_copy_page - Emits the current page - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::copyPage - - - &style.procedural;: - - voidcairo_copy_page - CairoContextcontext - - - Emits the current page for backends that support multiple pages, but doesn’t clear it, so, - the contents of the current page will be retained for the next page too. - Use CairoContext::showPage if you want to get an empty page after the emission. - - - - This is a convenience function that simply calls CairoSurface::copyPage - on CairoContext’s target. - - - - - - - &reftitle.parameters; - - - - context - - - A valid CairoContext object created with CairoContext::__construct or - cairo_create - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - &style.oop; - -copyPage(); - -?> -]]> - - - - - - &style.procedural; - - -]]> - - - - - - - &reftitle.seealso; - - - CairoContext::showPage - CairoSurface::copyPage - - - - - - - diff --git a/reference/cairo/cairocontext/copypath.xml b/reference/cairo/cairocontext/copypath.xml deleted file mode 100644 index f1c6afca28bd..000000000000 --- a/reference/cairo/cairocontext/copypath.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - CairoContext::copyPath - cairo_copy_path - Creates a copy of the current path - - - - &reftitle.description; - &style.oop; (method): - - public CairoPathCairoContext::copyPath - - - &style.procedural;: - - CairoPathcairo_copy_path - CairoContextcontext - - - Creates a copy of the current path and returns it to the user as a CairoPath. - See CairoPath for hints on how to iterate over the returned data structure. - - - This function will always return a valid CairoPath object, - but the result will have no data, if either of the following conditions hold: - - 1. If there is insufficient memory to copy the path. In this case CairoPath->status will - be set to CAIRO_STATUS_NO_MEMORY. - 2. If context is already in an error state. - In this case CairoPath->status will contain the same status that would be returned by - cairo_status. - - - In either case, CairoPath->status will be set to CAIRO_STATUS_NO_MEMORY - (regardless of what the error status in cr might have been). - - - - - - - &reftitle.parameters; - - - - context - - - A valid CairoContext object created with - CairoContext::__construct or cairo_create - - - - - - - - - &reftitle.returnvalues; - - A copy of the current CairoPath in the context - - - - - &reftitle.examples; - - - &style.oop; - -copyPath()) - -?> -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - CairoContext::closePath - - - - - - - diff --git a/reference/cairo/cairocontext/copypathflat.xml b/reference/cairo/cairocontext/copypathflat.xml deleted file mode 100644 index 949d533859b0..000000000000 --- a/reference/cairo/cairocontext/copypathflat.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - CairoContext::copyPathFlat - cairo_copy_path_flat - Gets a flattened copy of the current path - - - - &reftitle.description; - &style.oop; (method): - - public CairoPathCairoContext::copyPathFlat - - - &style.procedural;: - - CairoPathcairo_copy_path_flat - CairoContextcontext - - - Gets a flattened copy of the current path and returns it to the user as a CairoPath. - - - This function is like CairoContext::copyPath except that any curves - in the path will be approximated with piecewise-linear approximations, - (accurate to within the current tolerance value). That is, the result is guaranteed to not - have any elements of type CAIRO_PATH_CURVE_TO which will instead be replaced by a series of - CAIRO_PATH_LINE_TO elements. - - - - - &reftitle.parameters; - - - - context - - - A CairoContext object - - - - - - - - - &reftitle.returnvalues; - - A copy of the current path - - - - - &reftitle.examples; - - - &style.oop; - -copyPathFlat()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - CairoContext::copyPath - CairoContext::closePath - - - - - - - diff --git a/reference/cairo/cairocontext/curveto.xml b/reference/cairo/cairocontext/curveto.xml deleted file mode 100644 index 8dea67be336c..000000000000 --- a/reference/cairo/cairocontext/curveto.xml +++ /dev/null @@ -1,205 +0,0 @@ - - - - - - CairoContext::curveTo - cairo_curve_to - Adds a curve - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::curveTo - floatx1 - floaty1 - floatx2 - floaty2 - floatx3 - floaty3 - - &style.procedural;: - - voidcairo_curve_to - CairoContextcontext - floatx1 - floaty1 - floatx2 - floaty2 - floatx3 - floaty3 - - - Adds a cubic Bezier spline to the path from the current point to position x3 - ,y3 in user-space coordinates, using x1, - y1 and x2, y2 as the control - points. After this call the current point will be x3, y3. - - - If there is no current point before the call to CairoContext::curveTo - this function will behave as if preceded by a call to CairoContext::moveTo - (x1, y1). - - - - - - &reftitle.parameters; - - - - context - - - A valid CairoContext object created with - CairoContext::__construct or cairo_create - - - - - x1 - - - First control point in the x axis for the curve - - - - - y1 - - - First control point in the y axis for the curve - - - - - x2 - - - Second control point in x axis for the curve - - - - - y2 - - - Second control point in y axis for the curve - - - - - x3 - - - Final point in the x axis for the curve - - - - - y3 - - - Final point in the y axis for the curve - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - &style.oop; - -setSourceRgb(0, 0, 0); - -$c->paint(); - -$c->moveTo(10, 50); -$c->setLineWidth(5); -$c->setSourceRgb(.1, 0, 1); -$c->curveTo(20, 80, 80, 20, 90, 50); -$c->stroke(); - -$s->writeToPng(dirname(__FILE__) . '/curveTo.png'); -?> -]]> - - - - - - &style.procedural; - - -]]> - - - - - - - &reftitle.seealso; - - - CairoContext::moveTo - - - - - - - diff --git a/reference/cairo/cairocontext/devicetouser.xml b/reference/cairo/cairocontext/devicetouser.xml deleted file mode 100644 index c765011690a7..000000000000 --- a/reference/cairo/cairocontext/devicetouser.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - CairoContext::deviceToUser - cairo_device_to_user - Transform a coordinate - - - - &reftitle.description; - &style.oop; (method): - - public arrayCairoContext::deviceToUser - floatx - floaty - - &style.procedural;: - - arraycairo_device_to_user - CairoContextcontext - floatx - floaty - - - Transform a coordinate from device space to user space by multiplying the given point by the - inverse of the current transformation matrix (CTM). - - - - - - &reftitle.parameters; - - - - context - - - A valid CairoContext object created with - CairoContext::__construct or cairo_create - - - - - x - - - x value of the coordinate - - - - - y - - - y value of the coordinate - - - - - - - - - &reftitle.returnvalues; - - An array containing the x and y coordinates in the user-space - - - - - &reftitle.seealso; - - - CairoContext::deviceToUserDistance - - - - - - - diff --git a/reference/cairo/cairocontext/devicetouserdistance.xml b/reference/cairo/cairocontext/devicetouserdistance.xml deleted file mode 100644 index 5a8e41af06be..000000000000 --- a/reference/cairo/cairocontext/devicetouserdistance.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - CairoContext::deviceToUserDistance - cairo_device_to_user_distance - Transform a distance - - - - &reftitle.description; - &style.oop; (method): - - public arrayCairoContext::deviceToUserDistance - floatx - floaty - - &style.procedural;: - - arraycairo_device_to_user_distance - CairoContextcontext - floatx - floaty - - - Transform a distance vector from device space to user space. This function is similar to - CairoContext::deviceToUser or cairo_device_to_user - except that the translation components of the inverse Cairo Transformation Matrix will be - ignored when transforming (x,y). - - - - - - &reftitle.parameters; - - - - context - - - A valid CairoContext object created with - CairoContext::__construct or cairo_create - - - - - x - - - X component of a distance vector - - - - - y - - - Y component of a distance vector - - - - - - - - - &reftitle.returnvalues; - - Returns an array with the x and y values of a distance vector in the user-space - - - - - &reftitle.seealso; - - - CairoContext::deviceToUser - - - - - - - diff --git a/reference/cairo/cairocontext/fill.xml b/reference/cairo/cairocontext/fill.xml deleted file mode 100644 index d01d37185886..000000000000 --- a/reference/cairo/cairocontext/fill.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - CairoContext::fill - cairo_fill - Fills the current path - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::fill - - - &style.procedural;: - - voidcairo_fill - CairoContextcontext - - - A drawing operator that fills the current path according to the current - CairoFillRule, (each sub-path is implicitly closed before being filled). - After CairoContext::fill or cairo_fill, the - current path will be cleared from the CairoContext. - - - - - - &reftitle.parameters; - - - - context - - - A valid CairoContext object created with - CairoContext::__construct or cairo_create - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - &style.oop; - -setSourceRgb(0, 0, 0); -$c->paint(); - -$c->setSourceRgb(1, 1, 1); -$c->rectangle(0, 0, 50, 50); -$c->fill(); -$c->setSourceRgb(0, 1, 0); -$c->rectangle(50, 50, 50, 50); -$c->fill(); - -$s->writeToPng(dirname(__FILE__) . '/CairoContext_fill.png'); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - CairoContext::setFillRule - ContextContext::fillPreserve - CairoFillRule - - - - - - - diff --git a/reference/cairo/cairocontext/fillextents.xml b/reference/cairo/cairocontext/fillextents.xml deleted file mode 100644 index 65a0d30cda8e..000000000000 --- a/reference/cairo/cairocontext/fillextents.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - CairoContext::fillExtents - cairo_fill_extents - Computes the filled area - - - - &reftitle.description; - &style.oop; (method): - - public arrayCairoContext::fillExtents - - - &style.procedural;: - - arraycairo_fill_extents - CairoContextcontext - - - Computes a bounding box in user coordinates covering the area that would be affected, - (the “inked” area), by a CairoContext::fill operation given the - current path and fill parameters. If the current path is empty, - returns an empty rectangle (0,0,0,0). Surface dimensions and clipping are not taken into account. - - - Contrast with CairoContext::pathExtents, which is similar, but returns - non-zero extents for some paths with no inked area, (such as a simple line segment). - - - Note that CairoContext::fillExtents must necessarily do more work to - compute the precise inked areas in light of the fill rule, so - CairoContext::pathExtents may be more desirable for sake of - performance if the non-inked path extents are desired. - - - - - &reftitle.parameters; - - - - context - - - A valid CairoContext object created with - CairoContext::__construct or cairo_create - - - - - - - - - &reftitle.returnvalues; - - An array with the coordinates of the afected area - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - CairoContext::fill - CairoContext::setFillRule - CairoContext::fillPreserve - - - - - - - diff --git a/reference/cairo/cairocontext/fillpreserve.xml b/reference/cairo/cairocontext/fillpreserve.xml deleted file mode 100644 index f58a5d484fb9..000000000000 --- a/reference/cairo/cairocontext/fillpreserve.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - CairoContext::fillPreserve - cairo_fill_preserve - Fills and preserve the current path - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::fillPreserve - - - &style.procedural;: - - voidcairo_fill_preserve - CairoContextcontext - - - A drawing operator that fills the current path according to the current CairoFillRule, - (each sub-path is implicitly closed before being filled). - Unlike CairoContext::fill, CairoContext::fillPreserve - (Procedural cairo_fill, cairo_fill_preserve, respectively) - preserves the path within the Context. - - - - - - &reftitle.parameters; - - - - context - - - A valid CairoContext object created with - CairoContext::__construct or cairo_create - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - CairoContext::setFillRule - CairoContext::fill - - - - - - - diff --git a/reference/cairo/cairocontext/fontextents.xml b/reference/cairo/cairocontext/fontextents.xml deleted file mode 100644 index a9be07c785e9..000000000000 --- a/reference/cairo/cairocontext/fontextents.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - CairoContext::fontExtents - cairo_font_extents - Get the font extents - - - - &reftitle.description; - &style.oop; (method): - - public arrayCairoContext::fontExtents - - - &style.procedural;: - - arraycairo_font_extents - CairoContextcontext - - - Gets the font extents for the currently selected font. - - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - An array containing the font extents for the current font. - - - - - &reftitle.examples; - - - &style.oop; - -fontExtents()); - -?> -]]> - - &example.outputs.similar; - - - float(10) - ["descent"]=> - float(3) - ["height"]=> - float(13.3125) - ["max_x_advance"]=> - float(26.65625) - ["max_y_advance"]=> - float(0) -} -]]> - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - float(10) - ["descent"]=> - float(3) - ["height"]=> - float(13.3125) - ["max_x_advance"]=> - float(26.65625) - ["max_y_advance"]=> - float(0) -} -]]> - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/getantialias.xml b/reference/cairo/cairocontext/getantialias.xml deleted file mode 100644 index ae2f30891efe..000000000000 --- a/reference/cairo/cairocontext/getantialias.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - - CairoContext::getAntialias - cairo_get_antialias - Retrieves the current antialias mode - - - - &reftitle.description; - &style.oop; (method): - - public intCairoContext::getAntialias - - - &style.procedural;: - - intcairo_get_antialias - CairoContextcontext - - - Returns the current CairoAntialias mode, as set by - CairoContext::setAntialias. - - - - - &reftitle.parameters; - - - - context - - - A valid CairoContext object created with - CairoContext::__construct or cairo_create - - - - - - - - - &reftitle.returnvalues; - - The current CairoAntialias mode. - - - - - &reftitle.examples; - - - &style.oop; - -setAntialias(CairoAntialias::MODE_SUBPIXEL); - -var_dump($context->getAntialias()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - CairoContext::setAntialias - CairoAntialias - - - - - - - diff --git a/reference/cairo/cairocontext/getcurrentpoint.xml b/reference/cairo/cairocontext/getcurrentpoint.xml deleted file mode 100644 index 98ee6477c863..000000000000 --- a/reference/cairo/cairocontext/getcurrentpoint.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - CairoContext::getCurrentPoint - cairo_get_current_point - The getCurrentPoint purpose - - - - &reftitle.description; - &style.oop; - - public arrayCairoContext::getCurrentPoint - - - &style.procedural; - - arraycairo_get_current_point - CairoContextcontext - - - Gets the current point of the current path, which is conceptually the final point reached by the path so far. - - - The current point is returned in the user-space coordinate system. If there is no defined current point or if cr is in an error status, x and y will both be set to 0.0. It is possible to check this in advance with CairoContext::hasCurrentPoint. - - - Most path construction functions alter the current point. See the following for details on how they affect the current point: CairoContext::newPath, - CairoContext::newSubPath, CairoContext::appendPath, CairoContext::closePath, CairoContext::moveTo, - CairoContext::lineTo, CairoContext::curveTo, CairoContext::relMoveTo, - CairoContext::relLineTo, CairoContext::relCurveTo, - CairoContext::arc, CairoContext::arcNegative, CairoContext::rectangle, - CairoContext::textPath, CairoContext::glyphPath. - - - Some functions use and alter the current point but do not otherwise change current path: CairoContext::showText. - - - Some functions unset the current path and as a result, current point: CairoContext::fill, CairoContext::stroke. - - - - - - &reftitle.parameters; - - - - context - - - A valid CairoContext object. - - - - - - - - - &reftitle.returnvalues; - - An array containing the x (index 0) and y (index 1) coordinates of the current point. - - - - - &reftitle.examples; - - - &style.oop; - -moveTo(10, 10); - -var_dump($c->getCurrentPoint()); - -?> -]]> - - &example.outputs.similar; - - - float(10) - [1]=> - float(10) -} -]]> - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - float(10) - [1]=> - float(10) -} -]]> - - - - - - - &reftitle.seealso; - - - CairoContext::moveTo - CairoContext::hasCurrentPoint - - - - - - - diff --git a/reference/cairo/cairocontext/getdash.xml b/reference/cairo/cairocontext/getdash.xml deleted file mode 100644 index 183cfd3ba709..000000000000 --- a/reference/cairo/cairocontext/getdash.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::getDash - cairo_get_dash - The getDash purpose - - - - &reftitle.description; - &style.oop; (method): - - public arrayCairoContext::getDash - - - &style.procedural;: - - arraycairo_get_dash - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/getdashcount.xml b/reference/cairo/cairocontext/getdashcount.xml deleted file mode 100644 index c50e92cb3a63..000000000000 --- a/reference/cairo/cairocontext/getdashcount.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::getDashCount - cairo_get_dash_count - The getDashCount purpose - - - - &reftitle.description; - &style.oop; (method): - - public intCairoContext::getDashCount - - - &style.procedural;: - - intcairo_get_dash_count - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/getfillrule.xml b/reference/cairo/cairocontext/getfillrule.xml deleted file mode 100644 index 8ce901c3eaeb..000000000000 --- a/reference/cairo/cairocontext/getfillrule.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::getFillRule - cairo_get_fill_rule - The getFillRule purpose - - - - &reftitle.description; - &style.oop; (method): - - public intCairoContext::getFillRule - - - &style.procedural;: - - intcairo_get_fill_rule - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/getfontface.xml b/reference/cairo/cairocontext/getfontface.xml deleted file mode 100644 index d1fb388dd601..000000000000 --- a/reference/cairo/cairocontext/getfontface.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::getFontFace - cairo_get_font_face - The getFontFace purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::getFontFace - - - &style.procedural;: - - voidcairo_get_font_face - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/getfontmatrix.xml b/reference/cairo/cairocontext/getfontmatrix.xml deleted file mode 100644 index d7d166dce6e7..000000000000 --- a/reference/cairo/cairocontext/getfontmatrix.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::getFontMatrix - cairo_get_font_matrix - The getFontMatrix purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::getFontMatrix - - - &style.procedural;: - - voidcairo_get_font_matrix - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/getfontoptions.xml b/reference/cairo/cairocontext/getfontoptions.xml deleted file mode 100644 index cffe6e7688d1..000000000000 --- a/reference/cairo/cairocontext/getfontoptions.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::getFontOptions - cairo_get_font_options - The getFontOptions purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::getFontOptions - - - &style.procedural;: - - voidcairo_get_font_options - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/getgrouptarget.xml b/reference/cairo/cairocontext/getgrouptarget.xml deleted file mode 100644 index bd8e9b414e9f..000000000000 --- a/reference/cairo/cairocontext/getgrouptarget.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::getGroupTarget - cairo_get_group_target - The getGroupTarget purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::getGroupTarget - - - &style.procedural;: - - voidcairo_get_group_target - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/getlinecap.xml b/reference/cairo/cairocontext/getlinecap.xml deleted file mode 100644 index 612963fa66ee..000000000000 --- a/reference/cairo/cairocontext/getlinecap.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::getLineCap - cairo_get_line_cap - The getLineCap purpose - - - - &reftitle.description; - &style.oop; (method): - - public intCairoContext::getLineCap - - - &style.procedural;: - - intcairo_get_line_cap - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/getlinejoin.xml b/reference/cairo/cairocontext/getlinejoin.xml deleted file mode 100644 index bb626a5894e3..000000000000 --- a/reference/cairo/cairocontext/getlinejoin.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::getLineJoin - cairo_get_line_join - The getLineJoin purpose - - - - &reftitle.description; - &style.oop; (method): - - public intCairoContext::getLineJoin - - - &style.procedural;: - - intcairo_get_line_join - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/getlinewidth.xml b/reference/cairo/cairocontext/getlinewidth.xml deleted file mode 100644 index 1714a9082209..000000000000 --- a/reference/cairo/cairocontext/getlinewidth.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::getLineWidth - cairo_get_line_width - The getLineWidth purpose - - - - &reftitle.description; - &style.oop; (method): - - public floatCairoContext::getLineWidth - - - &style.procedural;: - - floatcairo_get_line_width - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/getmatrix.xml b/reference/cairo/cairocontext/getmatrix.xml deleted file mode 100644 index cb9e41dfe381..000000000000 --- a/reference/cairo/cairocontext/getmatrix.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::getMatrix - cairo_get_matrix - The getMatrix purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::getMatrix - - - &style.procedural;: - - voidcairo_get_matrix - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/getmiterlimit.xml b/reference/cairo/cairocontext/getmiterlimit.xml deleted file mode 100644 index f6d35eb295cc..000000000000 --- a/reference/cairo/cairocontext/getmiterlimit.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::getMiterLimit - cairo_get_miter_limit - The getMiterLimit purpose - - - - &reftitle.description; - &style.oop; (method): - - public floatCairoContext::getMiterLimit - - - &style.procedural;: - - floatcairo_get_miter_limit - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/getoperator.xml b/reference/cairo/cairocontext/getoperator.xml deleted file mode 100644 index 8ebe4a7fb8e4..000000000000 --- a/reference/cairo/cairocontext/getoperator.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::getOperator - cairo_get_operator - The getOperator purpose - - - - &reftitle.description; - &style.oop; (method): - - public intCairoContext::getOperator - - - &style.procedural;: - - intcairo_get_operator - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/getscaledfont.xml b/reference/cairo/cairocontext/getscaledfont.xml deleted file mode 100644 index 6671cd0d9972..000000000000 --- a/reference/cairo/cairocontext/getscaledfont.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::getScaledFont - cairo_get_scaled_font - The getScaledFont purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::getScaledFont - - - &style.procedural;: - - voidcairo_get_scaled_font - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/getsource.xml b/reference/cairo/cairocontext/getsource.xml deleted file mode 100644 index 712759cdd71c..000000000000 --- a/reference/cairo/cairocontext/getsource.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::getSource - cairo_get_source - The getSource purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::getSource - - - &style.procedural;: - - voidcairo_get_source - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/gettarget.xml b/reference/cairo/cairocontext/gettarget.xml deleted file mode 100644 index bdfca5dec006..000000000000 --- a/reference/cairo/cairocontext/gettarget.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::getTarget - cairo_get_target - The getTarget purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::getTarget - - - &style.procedural;: - - voidcairo_get_target - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/gettolerance.xml b/reference/cairo/cairocontext/gettolerance.xml deleted file mode 100644 index 9efe76fd855b..000000000000 --- a/reference/cairo/cairocontext/gettolerance.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::getTolerance - cairo_get_tolerance - The getTolerance purpose - - - - &reftitle.description; - &style.oop; (method): - - public floatCairoContext::getTolerance - - - &style.procedural;: - - floatcairo_get_tolerance - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/glyphpath.xml b/reference/cairo/cairocontext/glyphpath.xml deleted file mode 100644 index 33c5d5275bb3..000000000000 --- a/reference/cairo/cairocontext/glyphpath.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - CairoContext::glyphPath - cairo_glyph_path - The glyphPath purpose - - - - &reftitle.description; - &style.oop; - - public voidCairoContext::glyphPath - arrayglyphs - - &style.procedural; - - voidcairo_glyph_path - CairoContextcontext - arrayglyphs - - - Adds closed paths for the glyphs to the current path. - The generated path if filled, achieves an effect similar - to that of CairoContext::showGlyphs. - - - - - &reftitle.parameters; - - - - context - - - A CairoContext object - - - - - glyphs - - - Array of glyphs - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/cairo/cairocontext/hascurrentpoint.xml b/reference/cairo/cairocontext/hascurrentpoint.xml deleted file mode 100644 index 1e2151cf3323..000000000000 --- a/reference/cairo/cairocontext/hascurrentpoint.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - CairoContext::hasCurrentPoint - cairo_has_current_point - The hasCurrentPoint purpose - - - - &reftitle.description; - &style.oop; (method): - - public boolCairoContext::hasCurrentPoint - - - &style.procedural;: - - boolcairo_has_current_point - CairoContextcontext - - - Returns whether a current point is defined on the current path. See CairoContext::getCurrentPoint for details on the current point. - - - - - - &reftitle.parameters; - - - - context - - - A valid CairoContext object. - - - - - - - - - &reftitle.returnvalues; - - Whether a current point is defined - - - - - &reftitle.examples; - - - &style.oop; - -hasCurrentPoint()); - -$c->moveTo(10, 10); - -var_dump($c->hasCurrentPoint()); - -?> -]]> - - &example.outputs; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - CairoContext::getCurrentPoint - - - - - - - diff --git a/reference/cairo/cairocontext/identitymatrix.xml b/reference/cairo/cairocontext/identitymatrix.xml deleted file mode 100644 index 9dab1cffb636..000000000000 --- a/reference/cairo/cairocontext/identitymatrix.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::identityMatrix - cairo_identity_matrix - The identityMatrix purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::identityMatrix - - - &style.procedural;: - - voidcairo_identity_matrix - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/infill.xml b/reference/cairo/cairocontext/infill.xml deleted file mode 100644 index ffd2e88861dd..000000000000 --- a/reference/cairo/cairocontext/infill.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - CairoContext::inFill - cairo_in_fill - The inFill purpose - - - - &reftitle.description; - &style.oop; (method): - - public boolCairoContext::inFill - floatx - floaty - - &style.procedural;: - - boolcairo_in_fill - CairoContextcontext - floatx - floaty - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - x - - - Description... - - - - - y - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/instroke.xml b/reference/cairo/cairocontext/instroke.xml deleted file mode 100644 index 028a2728b520..000000000000 --- a/reference/cairo/cairocontext/instroke.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - CairoContext::inStroke - cairo_in_stroke - The inStroke purpose - - - - &reftitle.description; - &style.oop; (method): - - public boolCairoContext::inStroke - floatx - floaty - - &style.procedural;: - - boolcairo_in_stroke - CairoContextcontext - floatx - floaty - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - x - - - Description... - - - - - y - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/lineto.xml b/reference/cairo/cairocontext/lineto.xml deleted file mode 100644 index cbc0fe190140..000000000000 --- a/reference/cairo/cairocontext/lineto.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - CairoContext::lineTo - cairo_line_to - The lineTo purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::lineTo - floatx - floaty - - &style.procedural;: - - voidcairo_line_to - CairoContextcontext - floatx - floaty - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - x - - - Description... - - - - - y - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/mask.xml b/reference/cairo/cairocontext/mask.xml deleted file mode 100644 index df07449bd73f..000000000000 --- a/reference/cairo/cairocontext/mask.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - CairoContext::mask - cairo_mask - The mask purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::mask - CairoPatternpattern - - &style.procedural;: - - voidcairo_mask - CairoContextcontext - CairoPatternpattern - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - pattern - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/masksurface.xml b/reference/cairo/cairocontext/masksurface.xml deleted file mode 100644 index 10f07eb43e76..000000000000 --- a/reference/cairo/cairocontext/masksurface.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - CairoContext::maskSurface - cairo_mask_surface - The maskSurface purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::maskSurface - CairoSurfacesurface - floatx - floaty - - &style.procedural;: - - voidcairo_mask_surface - CairoContextcontext - CairoSurfacesurface - floatx - floaty - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - surface - - - Description... - - - - - x - - - Description... - - - - - y - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/moveto.xml b/reference/cairo/cairocontext/moveto.xml deleted file mode 100644 index eae13a7a5f2b..000000000000 --- a/reference/cairo/cairocontext/moveto.xml +++ /dev/null @@ -1,183 +0,0 @@ - - - - - - CairoContext::moveTo - cairo_move_to - The moveTo purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::moveTo - floatx - floaty - - &style.procedural;: - - voidcairo_move_to - CairoContextcontext - floatx - floaty - - - Begin a new sub-path. After this call the current point will be (x, y). - - - - - - &reftitle.parameters; - - - - context - - - A valid CairoContext object. - - - - - x - - - The x coordinate of the new position. - - - - - y - - - The y coordinate of the new position - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - &style.oop; - -setSourceRgb(0, 0, 0); -$c->paint(); - -// Move 10 pixels across, and 10 pixels down -$c->moveTo(10, 10); -$c->lineTo(90, 90); -$c->setLineWidth(2); -$c->setSourceRgb(1, 1, 1); -$c->stroke(); - -// Move 90 pixels across, and 10 pixels down -$c->moveTo(90, 10); -$c->lineTo(10, 90); -$c->setLineWidth(2); -$c->setSourceRgb(1, 1, 1); -$c->stroke(); - -$s->writeToPng(dirname(__FILE__) . '/CairoContext_moveTo.png'); -?> -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/newpath.xml b/reference/cairo/cairocontext/newpath.xml deleted file mode 100644 index d052ffeae682..000000000000 --- a/reference/cairo/cairocontext/newpath.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - CairoContext::newPath - cairo_new_path - The newPath purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::newPath - - - &style.procedural;: - - voidcairo_new_path - CairoContextcontext - - - Clears the current path. After this call there will be no path and no current point. - - - - - - &reftitle.parameters; - - - - context - - - A valid CairoContext object. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - - - - - &style.procedural; - - -]]> - - - - - - - &reftitle.seealso; - - - CairoContext::appendPath - CairoContext::closePath - - - - - - - diff --git a/reference/cairo/cairocontext/newsubpath.xml b/reference/cairo/cairocontext/newsubpath.xml deleted file mode 100644 index e582c9c6393a..000000000000 --- a/reference/cairo/cairocontext/newsubpath.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::newSubPath - cairo_new_sub_path - The newSubPath purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::newSubPath - - - &style.procedural;: - - voidcairo_new_sub_path - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/paint.xml b/reference/cairo/cairocontext/paint.xml deleted file mode 100644 index 11a8b861c4d1..000000000000 --- a/reference/cairo/cairocontext/paint.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::paint - cairo_paint - The paint purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::paint - - - &style.procedural;: - - voidcairo_paint - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/paintwithalpha.xml b/reference/cairo/cairocontext/paintwithalpha.xml deleted file mode 100644 index 1182181989bb..000000000000 --- a/reference/cairo/cairocontext/paintwithalpha.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - CairoContext::paintWithAlpha - cairo_paint_with_alpha - The paintWithAlpha purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::paintWithAlpha - floatalpha - - &style.procedural;: - - voidcairo_paint_with_alpha - CairoContextcontext - floatalpha - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - alpha - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/pathextents.xml b/reference/cairo/cairocontext/pathextents.xml deleted file mode 100644 index 318a1f7ceb7e..000000000000 --- a/reference/cairo/cairocontext/pathextents.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::pathExtents - cairo_path_extents - The pathExtents purpose - - - - &reftitle.description; - &style.oop; (method): - - public arrayCairoContext::pathExtents - - - &style.procedural;: - - arraycairo_path_extents - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/popgroup.xml b/reference/cairo/cairocontext/popgroup.xml deleted file mode 100644 index e7a0e79d8576..000000000000 --- a/reference/cairo/cairocontext/popgroup.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::popGroup - cairo_pop_group - The popGroup purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::popGroup - - - &style.procedural;: - - voidcairo_pop_group - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/popgrouptosource.xml b/reference/cairo/cairocontext/popgrouptosource.xml deleted file mode 100644 index 10ed0d4fd2d3..000000000000 --- a/reference/cairo/cairocontext/popgrouptosource.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::popGroupToSource - cairo_pop_group_to_source - The popGroupToSource purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::popGroupToSource - - - &style.procedural;: - - voidcairo_pop_group_to_source - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/pushgroup.xml b/reference/cairo/cairocontext/pushgroup.xml deleted file mode 100644 index 981a668e9cdc..000000000000 --- a/reference/cairo/cairocontext/pushgroup.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::pushGroup - cairo_push_group - The pushGroup purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::pushGroup - - - &style.procedural;: - - voidcairo_push_group - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/pushgroupwithcontent.xml b/reference/cairo/cairocontext/pushgroupwithcontent.xml deleted file mode 100644 index cb260b8be5d2..000000000000 --- a/reference/cairo/cairocontext/pushgroupwithcontent.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - CairoContext::pushGroupWithContent - cairo_push_group_with_content - The pushGroupWithContent purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::pushGroupWithContent - intcontent - - &style.procedural;: - - voidcairo_push_group_with_content - CairoContextcontext - intcontent - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - content - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/rectangle.xml b/reference/cairo/cairocontext/rectangle.xml deleted file mode 100644 index d8a9ae410e85..000000000000 --- a/reference/cairo/cairocontext/rectangle.xml +++ /dev/null @@ -1,163 +0,0 @@ - - - - - - CairoContext::rectangle - cairo_rectangle - The rectangle purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::rectangle - floatx - floaty - floatwidth - floatheight - - &style.procedural;: - - voidcairo_rectangle - CairoContextcontext - floatx - floaty - floatwidth - floatheight - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - x - - - Description... - - - - - y - - - Description... - - - - - width - - - Description... - - - - - height - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/relcurveto.xml b/reference/cairo/cairocontext/relcurveto.xml deleted file mode 100644 index dca3eab31e5d..000000000000 --- a/reference/cairo/cairocontext/relcurveto.xml +++ /dev/null @@ -1,183 +0,0 @@ - - - - - - CairoContext::relCurveTo - cairo_rel_curve_to - The relCurveTo purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::relCurveTo - floatx1 - floaty1 - floatx2 - floaty2 - floatx3 - floaty3 - - &style.procedural;: - - voidcairo_rel_curve_to - CairoContextcontext - floatx1 - floaty1 - floatx2 - floaty2 - floatx3 - floaty3 - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - x1 - - - Description... - - - - - y1 - - - Description... - - - - - x2 - - - Description... - - - - - y2 - - - Description... - - - - - x3 - - - Description... - - - - - y3 - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/rellineto.xml b/reference/cairo/cairocontext/rellineto.xml deleted file mode 100644 index b033531a7d4f..000000000000 --- a/reference/cairo/cairocontext/rellineto.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - CairoContext::relLineTo - cairo_rel_line_to - The relLineTo purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::relLineTo - floatx - floaty - - &style.procedural;: - - voidcairo_rel_line_to - CairoContextcontext - floatx - floaty - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - x - - - Description... - - - - - y - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/relmoveto.xml b/reference/cairo/cairocontext/relmoveto.xml deleted file mode 100644 index 8be3600eefc1..000000000000 --- a/reference/cairo/cairocontext/relmoveto.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - CairoContext::relMoveTo - cairo_rel_move_to - The relMoveTo purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::relMoveTo - floatx - floaty - - &style.procedural;: - - voidcairo_rel_move_to - CairoContextcontext - floatx - floaty - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - x - - - Description... - - - - - y - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/resetclip.xml b/reference/cairo/cairocontext/resetclip.xml deleted file mode 100644 index 24e1abfe418d..000000000000 --- a/reference/cairo/cairocontext/resetclip.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::resetClip - cairo_reset_clip - The resetClip purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::resetClip - - - &style.procedural;: - - voidcairo_reset_clip - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/restore.xml b/reference/cairo/cairocontext/restore.xml deleted file mode 100644 index d6943c6fd49b..000000000000 --- a/reference/cairo/cairocontext/restore.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::restore - cairo_restore - The restore purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::restore - - - &style.procedural;: - - voidcairo_restore - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/rotate.xml b/reference/cairo/cairocontext/rotate.xml deleted file mode 100644 index ddaece67723b..000000000000 --- a/reference/cairo/cairocontext/rotate.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - CairoContext::rotate - cairo_rotate - The rotate purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::rotate - floatangle - - &style.procedural;: - - voidcairo_rotate - CairoContextcontext - floatangle - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - angle - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/save.xml b/reference/cairo/cairocontext/save.xml deleted file mode 100644 index 0b597b6f7295..000000000000 --- a/reference/cairo/cairocontext/save.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::save - cairo_save - The save purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::save - - - &style.procedural;: - - voidcairo_save - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/scale.xml b/reference/cairo/cairocontext/scale.xml deleted file mode 100644 index 8d919172dfed..000000000000 --- a/reference/cairo/cairocontext/scale.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - CairoContext::scale - cairo_scale - The scale purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::scale - floatx - floaty - - &style.procedural;: - - voidcairo_scale - CairoContextcontext - floatx - floaty - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - x - - - Description... - - - - - y - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/selectfontface.xml b/reference/cairo/cairocontext/selectfontface.xml deleted file mode 100644 index 140686bf6aee..000000000000 --- a/reference/cairo/cairocontext/selectfontface.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - CairoContext::selectFontFace - cairo_select_font_face - The selectFontFace purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::selectFontFace - stringfamily - intslant - intweight - - &style.procedural;: - - voidcairo_select_font_face - CairoContextcontext - stringfamily - intslant - intweight - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - family - - - Description... - - - - - slant - - - Description... - - - - - weight - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/setantialias.xml b/reference/cairo/cairocontext/setantialias.xml deleted file mode 100644 index 930760456224..000000000000 --- a/reference/cairo/cairocontext/setantialias.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - CairoContext::setAntialias - cairo_set_antialias - The setAntialias purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::setAntialias - intantialias - - &style.procedural;: - - voidcairo_set_antialias - CairoContextcontext - intantialias - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - antialias - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/setdash.xml b/reference/cairo/cairocontext/setdash.xml deleted file mode 100644 index 5cd8a82b0fb1..000000000000 --- a/reference/cairo/cairocontext/setdash.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - CairoContext::setDash - cairo_set_dash - The setDash purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::setDash - arraydashes - floatoffset - - &style.procedural;: - - voidcairo_set_dash - CairoContextcontext - arraydashes - floatoffset - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - dashes - - - Description... - - - - - offset - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/setfillrule.xml b/reference/cairo/cairocontext/setfillrule.xml deleted file mode 100644 index 62c529cfd70c..000000000000 --- a/reference/cairo/cairocontext/setfillrule.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - CairoContext::setFillRule - cairo_set_fill_rule - The setFillRule purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::setFillRule - intsetting - - &style.procedural;: - - voidcairo_set_fill_rule - CairoContextcontext - intsetting - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - setting - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/setfontface.xml b/reference/cairo/cairocontext/setfontface.xml deleted file mode 100644 index dc203c441dca..000000000000 --- a/reference/cairo/cairocontext/setfontface.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - CairoContext::setFontFace - cairo_set_font_face - The setFontFace purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::setFontFace - CairoFontFacefontface - - &style.procedural;: - - voidcairo_set_font_face - CairoContextcontext - CairoFontFacefontface - - - Sets the font-face for a given context. - - - - - - &reftitle.parameters; - - - - context - - - A CairoContext object to change the font-face for. - - - - - fontface - - - A CairoFontFace object - - - - - - - - - &reftitle.returnvalues; - - No value is returned - - - - - &reftitle.examples; - - - &style.oop; - -setSourceRgb(1, 1, 1); -$c->paint(); - -// Draw some text -$c->setSourceRgb(0, 0, 0); -$c->moveTo(10, 60); -// Create a new font face -$f = new CairoToyFontFace("sans-serif", CairoFontSlant::NORMAL, CairoFontWeight::NORMAL); -$c->setFontFace($f); -$c->setFontSize(30); -$c->showText('Hello, World!'); -$s->writeToPng(dirname(__FILE__) . '/setFontFace.png'); -?> -]]> - - - - - - &style.procedural; - - -]]> - - - - - - - &reftitle.seealso; - - - CairoContext::setFontSize - CairoContext::showText - - - - - - - diff --git a/reference/cairo/cairocontext/setfontmatrix.xml b/reference/cairo/cairocontext/setfontmatrix.xml deleted file mode 100644 index 9038d0fcb810..000000000000 --- a/reference/cairo/cairocontext/setfontmatrix.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - CairoContext::setFontMatrix - cairo_set_font_matrix - The setFontMatrix purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::setFontMatrix - CairoMatrixmatrix - - &style.procedural;: - - voidcairo_set_font_matrix - CairoContextcontext - CairoMatrixmatrix - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - matrix - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/setfontoptions.xml b/reference/cairo/cairocontext/setfontoptions.xml deleted file mode 100644 index 8581821f0d7e..000000000000 --- a/reference/cairo/cairocontext/setfontoptions.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - CairoContext::setFontOptions - cairo_set_font_options - The setFontOptions purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::setFontOptions - CairoFontOptionsfontoptions - - &style.procedural;: - - voidcairo_set_font_options - CairoContextcontext - CairoFontOptionsfontoptions - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - fontoptions - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/setfontsize.xml b/reference/cairo/cairocontext/setfontsize.xml deleted file mode 100644 index add32ecdcc25..000000000000 --- a/reference/cairo/cairocontext/setfontsize.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - CairoContext::setFontSize - cairo_set_font_size - The setFontSize purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::setFontSize - floatsize - - &style.procedural;: - - voidcairo_set_font_size - CairoContextcontext - floatsize - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - size - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/setlinecap.xml b/reference/cairo/cairocontext/setlinecap.xml deleted file mode 100644 index d702cecd4b64..000000000000 --- a/reference/cairo/cairocontext/setlinecap.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - CairoContext::setLineCap - cairo_set_line_cap - The setLineCap purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::setLineCap - intsetting - - &style.procedural;: - - voidcairo_set_line_cap - CairoContextcontext - intsetting - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - setting - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/setlinejoin.xml b/reference/cairo/cairocontext/setlinejoin.xml deleted file mode 100644 index 3f8eb4f1c806..000000000000 --- a/reference/cairo/cairocontext/setlinejoin.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - CairoContext::setLineJoin - cairo_set_line_join - The setLineJoin purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::setLineJoin - intsetting - - &style.procedural;: - - voidcairo_set_line_join - CairoContextcontext - intsetting - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - setting - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/setlinewidth.xml b/reference/cairo/cairocontext/setlinewidth.xml deleted file mode 100644 index a9eaea73eab9..000000000000 --- a/reference/cairo/cairocontext/setlinewidth.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - CairoContext::setLineWidth - cairo_set_line_width - The setLineWidth purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::setLineWidth - floatwidth - - &style.procedural;: - - voidcairo_set_line_width - CairoContextcontext - floatwidth - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - width - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/setmatrix.xml b/reference/cairo/cairocontext/setmatrix.xml deleted file mode 100644 index ca5710326bdf..000000000000 --- a/reference/cairo/cairocontext/setmatrix.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - CairoContext::setMatrix - cairo_set_matrix - The setMatrix purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::setMatrix - CairoMatrixmatrix - - &style.procedural;: - - voidcairo_set_matrix - CairoContextcontext - CairoMatrixmatrix - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - matrix - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/setmiterlimit.xml b/reference/cairo/cairocontext/setmiterlimit.xml deleted file mode 100644 index 8a92f58cb82f..000000000000 --- a/reference/cairo/cairocontext/setmiterlimit.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - CairoContext::setMiterLimit - cairo_set_miter_limit - The setMiterLimit purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::setMiterLimit - floatlimit - - &style.procedural;: - - voidcairo_set_miter_limit - CairoContextcontext - floatlimit - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - limit - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/setoperator.xml b/reference/cairo/cairocontext/setoperator.xml deleted file mode 100644 index 5735e3ae2a1b..000000000000 --- a/reference/cairo/cairocontext/setoperator.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - CairoContext::setOperator - cairo_set_operator - The setOperator purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::setOperator - intsetting - - &style.procedural;: - - voidcairo_set_operator - CairoContextcontext - intsetting - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - setting - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/setscaledfont.xml b/reference/cairo/cairocontext/setscaledfont.xml deleted file mode 100644 index f11002706b9d..000000000000 --- a/reference/cairo/cairocontext/setscaledfont.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - CairoContext::setScaledFont - cairo_set_scaled_font - The setScaledFont purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::setScaledFont - CairoScaledFontscaledfont - - &style.procedural;: - - voidcairo_set_scaled_font - CairoContextcontext - CairoScaledFontscaledfont - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - scaledfont - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/setsource.xml b/reference/cairo/cairocontext/setsource.xml deleted file mode 100644 index 2eff5787685e..000000000000 --- a/reference/cairo/cairocontext/setsource.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - CairoContext::setSource - cairo_set_source - The setSource purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::setSource - CairoPatternpattern - - &style.procedural;: - - voidcairo_set_source - CairoContextcontext - CairoPatternpattern - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - pattern - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/setsourcergb.xml b/reference/cairo/cairocontext/setsourcergb.xml deleted file mode 100644 index d3e5e82ee4f7..000000000000 --- a/reference/cairo/cairocontext/setsourcergb.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - CairoContext::setSourceRGB - cairo_set_source - The setSourceRGB purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::setSourceRGB - floatred - floatgreen - floatblue - - &style.procedural;: - - voidcairo_set_source - CairoContextcontext - floatred - floatgreen - floatblue - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - red - - - Description... - - - - - green - - - Description... - - - - - blue - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/setsourcergba.xml b/reference/cairo/cairocontext/setsourcergba.xml deleted file mode 100644 index 46876e79c6c6..000000000000 --- a/reference/cairo/cairocontext/setsourcergba.xml +++ /dev/null @@ -1,163 +0,0 @@ - - - - - - CairoContext::setSourceRGBA - cairo_set_source - The setSourceRGBA purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::setSourceRGBA - floatred - floatgreen - floatblue - floatalpha - - &style.procedural;: - - voidcairo_set_source - CairoContextcontext - floatred - floatgreen - floatblue - floatalpha - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - red - - - Description... - - - - - green - - - Description... - - - - - blue - - - Description... - - - - - alpha - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/setsourcesurface.xml b/reference/cairo/cairocontext/setsourcesurface.xml deleted file mode 100644 index 31142696233c..000000000000 --- a/reference/cairo/cairocontext/setsourcesurface.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - - CairoContext::setSourceSurface - cairo_set_source_surface - The setSourceSurface purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::setSourceSurface - CairoSurfacesurface - floatx - floaty - - &style.procedural;: - - voidcairo_set_source_surface - CairoContextcontext - CairoSurfacesurface - floatx - floaty - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - surface - - - Description... - - - - - x - - - Description... - - - - - y - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/settolerance.xml b/reference/cairo/cairocontext/settolerance.xml deleted file mode 100644 index 2b7bc341feae..000000000000 --- a/reference/cairo/cairocontext/settolerance.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - CairoContext::setTolerance - cairo_set_tolerance - The setTolerance purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::setTolerance - floattolerance - - &style.procedural;: - - voidcairo_set_tolerance - CairoContextcontext - floattolerance - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - tolerance - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/showpage.xml b/reference/cairo/cairocontext/showpage.xml deleted file mode 100644 index 9f99c5311ba7..000000000000 --- a/reference/cairo/cairocontext/showpage.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::showPage - cairo_show_page - The showPage purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::showPage - - - &style.procedural;: - - voidcairo_show_page - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/showtext.xml b/reference/cairo/cairocontext/showtext.xml deleted file mode 100644 index ba3539494740..000000000000 --- a/reference/cairo/cairocontext/showtext.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - CairoContext::showText - cairo_show_text - The showText purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::showText - stringtext - - &style.procedural;: - - voidcairo_show_text - CairoContextcontext - stringtext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - text - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/status.xml b/reference/cairo/cairocontext/status.xml deleted file mode 100644 index 27705d2b2a32..000000000000 --- a/reference/cairo/cairocontext/status.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::status - cairo_status - The status purpose - - - - &reftitle.description; - &style.oop; (method): - - public intCairoContext::status - - - &style.procedural;: - - intcairo_status - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/stroke.xml b/reference/cairo/cairocontext/stroke.xml deleted file mode 100644 index b74f0e3dbe4a..000000000000 --- a/reference/cairo/cairocontext/stroke.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::stroke - cairo_stroke - The stroke purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::stroke - - - &style.procedural;: - - voidcairo_stroke - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/strokeextents.xml b/reference/cairo/cairocontext/strokeextents.xml deleted file mode 100644 index bbe3d779cd35..000000000000 --- a/reference/cairo/cairocontext/strokeextents.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::strokeExtents - cairo_stroke_extents - The strokeExtents purpose - - - - &reftitle.description; - &style.oop; (method): - - public arrayCairoContext::strokeExtents - - - &style.procedural;: - - arraycairo_stroke_extents - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/strokepreserve.xml b/reference/cairo/cairocontext/strokepreserve.xml deleted file mode 100644 index 2e224e47fe5e..000000000000 --- a/reference/cairo/cairocontext/strokepreserve.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoContext::strokePreserve - cairo_stroke_preserve - The strokePreserve purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::strokePreserve - - - &style.procedural;: - - voidcairo_stroke_preserve - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/textextents.xml b/reference/cairo/cairocontext/textextents.xml deleted file mode 100644 index e84230b16fcc..000000000000 --- a/reference/cairo/cairocontext/textextents.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - CairoContext::textExtents - cairo_text_extents - The textExtents purpose - - - - &reftitle.description; - &style.oop; (method): - - public arrayCairoContext::textExtents - stringtext - - &style.procedural;: - - arraycairo_text_extents - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - text - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/textpath.xml b/reference/cairo/cairocontext/textpath.xml deleted file mode 100644 index 97383409b1c9..000000000000 --- a/reference/cairo/cairocontext/textpath.xml +++ /dev/null @@ -1,161 +0,0 @@ - - - - - - CairoContext::textPath - cairo_text_path - The textPath purpose - - - - &reftitle.description; - &style.oop; - - public voidCairoContext::textPath - stringstring - - &style.procedural; - - voidcairo_text_path - CairoContextcontext - stringtext - - - Adds closed paths for text to the current path. The generated path, if filled, - achieves an effect similar to that of CairoContext::showText. - - - Text conversion and positioning is done similar to - CairoContext::showText. - - - Like CairoContext::showText, - after this call the current point is moved to the origin of where - the next glyph would be placed in this same progression. - That is, the current point will be at the origin of the final - glyph offset by its advance values. This allows for chaining multiple - calls to CairoContext::showText - without having to set current point in between. - - - Note: The CairoContext::textPath function - call is part of what the cairo designers call the "toy" text API. - It is convenient for short demos and simple programs, - but it is not expected to be adequate for serious text-using applications. - See CairoContext::glyphPath for the "real" - text path API in cairo. - - - - - - &reftitle.parameters; - - - - context - - - A CairoContext object - - - - - text - - - Description... - - - - - string - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/transform.xml b/reference/cairo/cairocontext/transform.xml deleted file mode 100644 index 83fc0410df60..000000000000 --- a/reference/cairo/cairocontext/transform.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - CairoContext::transform - cairo_transform - The transform purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::transform - CairoMatrixmatrix - - &style.procedural;: - - voidcairo_transform - CairoContextcontext - CairoMatrixmatrix - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - matrix - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/translate.xml b/reference/cairo/cairocontext/translate.xml deleted file mode 100644 index e1271abdc4b1..000000000000 --- a/reference/cairo/cairocontext/translate.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - CairoContext::translate - cairo_translate - The translate purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoContext::translate - floatx - floaty - - &style.procedural;: - - voidcairo_translate - CairoContextcontext - floatx - floaty - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - x - - - Description... - - - - - y - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/usertodevice.xml b/reference/cairo/cairocontext/usertodevice.xml deleted file mode 100644 index d4d9a03e1b67..000000000000 --- a/reference/cairo/cairocontext/usertodevice.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - CairoContext::userToDevice - cairo_user_to_device - The userToDevice purpose - - - - &reftitle.description; - &style.oop; (method): - - public arrayCairoContext::userToDevice - floatx - floaty - - &style.procedural;: - - arraycairo_user_to_device - CairoContextcontext - floatx - floaty - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - x - - - Description... - - - - - y - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairocontext/usertodevicedistance.xml b/reference/cairo/cairocontext/usertodevicedistance.xml deleted file mode 100644 index bd1d9405c96f..000000000000 --- a/reference/cairo/cairocontext/usertodevicedistance.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - CairoContext::userToDeviceDistance - cairo_user_to_device_distance - The userToDeviceDistance purpose - - - - &reftitle.description; - &style.oop; (method): - - public arrayCairoContext::userToDeviceDistance - floatx - floaty - - &style.procedural;: - - arraycairo_user_to_device_distance - CairoContextcontext - floatx - floaty - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - x - - - Description... - - - - - y - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairoexception.xml b/reference/cairo/cairoexception.xml deleted file mode 100644 index 41be64ec7cea..000000000000 --- a/reference/cairo/cairoexception.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - The CairoException class - CairoException - - - - -
- &reftitle.intro; - - Exception class thrown by Cairo functions and methods - -
- - -
- &reftitle.classsynopsis; - - - - CairoException - - - - - CairoException - - - - extends - Exception - - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- - - - - - - - - diff --git a/reference/cairo/cairoextend.xml b/reference/cairo/cairoextend.xml deleted file mode 100644 index 7f1de0f1ef10..000000000000 --- a/reference/cairo/cairoextend.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - The CairoExtend class - CairoExtend - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - CairoExtend - - - - - CairoExtend - - - - &Constants; - - const - integer - CairoExtend::NONE - 0 - - - const - integer - CairoExtend::REPEAT - 1 - - - const - integer - CairoExtend::REFLECT - 2 - - - const - integer - CairoExtend::PAD - 3 - - - - - -
- - -
- &reftitle.constants; - - - - CairoExtend::NONE - - Description here... - - - - - CairoExtend::REPEAT - - Description here... - - - - - CairoExtend::REFLECT - - Description here... - - - - - CairoExtend::PAD - - Description here... - - - - -
- - - - - - - - - - diff --git a/reference/cairo/cairofillrule.xml b/reference/cairo/cairofillrule.xml deleted file mode 100644 index fa27549091b3..000000000000 --- a/reference/cairo/cairofillrule.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - The CairoFillRule class - CairoFillRule - - - - -
- &reftitle.intro; - - A CairoFillRule is used to select how paths are filled. For both fill rules, whether or not a - point is included in the fill is determined by taking a ray from that point to infinity and looking at intersections - with the path. The ray can be in any direction, as long as it doesn't pass through the end point of a segment or have - a tricky intersection such as intersecting tangent to the path. (Note that filling is not actually implemented in - this way. This is just a description of the rule that is applied.) - - - The default fill rule is CairoFillRule::WINDING. - -
- - -
- &reftitle.classsynopsis; - - - - CairoFillRule - - - - - CairoFillRule - - - - &Constants; - - const - integer - CairoFillRule::WINDING - 0 - - - const - integer - CairoFillRule::EVEN_ODD - 1 - - - - - -
- - -
- &reftitle.constants; - - - - CairoFillRule::WINDING - - If the path crosses the ray from left-to-right, counts +1. If the path crosses the ray from right to left, - counts -1. (Left and right are determined from the perspective of looking along the ray from the starting point.) - If the total count is non-zero, the point will be filled. - - - - - - CairoFillRule::EVEN_ODD - - Counts the total number of intersections, without regard to the orientation of the contour. - If the total number of intersections is odd, the point will be filled. - - - - -
- - - - - - - - - - diff --git a/reference/cairo/cairofilter.xml b/reference/cairo/cairofilter.xml deleted file mode 100644 index 521ddcc1e506..000000000000 --- a/reference/cairo/cairofilter.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - The CairoFilter class - CairoFilter - - - - -
- &reftitle.intro; - - A CairoFilter is used to indicate what filtering should be applied when reading pixel values - from patterns. See CairoPattern::setSource or cairo_pattern_set_source - for indicating the desired filter to be used with a particular pattern. - -
- - -
- &reftitle.classsynopsis; - - - - CairoFilter - - - - - CairoFilter - - - - &Constants; - - const - integer - CairoFilter::FAST - 0 - - - const - integer - CairoFilter::GOOD - 1 - - - const - integer - CairoFilter::BEST - 2 - - - const - integer - CairoFilter::NEAREST - 3 - - - const - integer - CairoFilter::BILINEAR - 4 - - - const - integer - CairoFilter::GAUSSIAN - 5 - - - - - -
- - -
- &reftitle.constants; - - - - CairoFilter::FAST - - A high-performance filter, with quality similar to CairoFilter::NEAREST - - - - - CairoFilter::GOOD - - A reasonable-performance filter, with quality similar to CairoFilter::BILINEAR - - - - - CairoFilter::BEST - - The highest-quality available, performance may not be suitable for interactive use. - - - - - CairoFilter::NEAREST - - Nearest-neighbor filtering - - - - - CairoFilter::BILINEAR - - Linear interpolation in two dimensions - - - - - CairoFilter::GAUSSIAN - - This filter value is currently unimplemented, and should not be used in current code. - - - - -
- - - - - - - - - - diff --git a/reference/cairo/cairofontface.xml b/reference/cairo/cairofontface.xml deleted file mode 100644 index 79090275fcf6..000000000000 --- a/reference/cairo/cairofontface.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - The CairoFontFace class - CairoFontFace - - - - -
- &reftitle.intro; - - CairoFontFace abstract class represents a particular font at a particular weight, slant, and - other characteristic but no transformation or size. - - - Note: This class can not be instantiated directly, it is created by - CairoContext::getFontFace or cairo_scaled_font_get_font_face. - -
- - -
- &reftitle.classsynopsis; - - - - CairoFontFace - - - - - CairoFontFace - - - - - &Methods; - - - - -
- - - - &reference.cairo.entities.cairofontface; - - - - diff --git a/reference/cairo/cairofontface/construct.xml b/reference/cairo/cairofontface/construct.xml deleted file mode 100644 index 1b5f9eca4499..000000000000 --- a/reference/cairo/cairofontface/construct.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - CairoFontFace::__construct - Creates a new CairoFontFace object - - - - &reftitle.description; - - public CairoFontFace::__construct - - - - CairoFontFace class represents a particular font at a particular weight, - slant, and other characteristic but no transformation or size. - - - Note: This class can't be instantiated directly it is created by - CairoContext::getFontFace or cairo_scaled_font_get_font_face - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - CairoFontFace - - - - - &reftitle.examples; - - - <methodname>CairoFontFace::__construct</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Class::Method - - - - - - - diff --git a/reference/cairo/cairofontface/gettype.xml b/reference/cairo/cairofontface/gettype.xml deleted file mode 100644 index 277cb9c25082..000000000000 --- a/reference/cairo/cairofontface/gettype.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - CairoFontFace::getType - cairo_font_face_get_type - Retrieves the font face type - - - - &reftitle.description; - &style.oop; (method): - - public intCairoFontFace::getType - - - &style.procedural;: - - intcairo_font_face_get_type - CairoFontFacefontface - - - This function returns the type of the backend used to create a font face. - See CairoFontType class constants for available types. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - A font type that can be any one defined in CairoFontType - - - - - &reftitle.examples; - - - <methodname>CairoFontFace::getType</methodname> example - -getType()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairofontface/status.xml b/reference/cairo/cairofontface/status.xml deleted file mode 100644 index 814859a720ae..000000000000 --- a/reference/cairo/cairofontface/status.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - CairoFontFace::status - cairo_font_face_status - Check for CairoFontFace errors - - - - &reftitle.description; - &style.oop; (method): - - public intCairoFontFace::status - - - &style.procedural;: - - intcairo_font_face_status - CairoFontFacefontface - - - Checks whether an error has previously occurred for this font face - - - - - - &reftitle.parameters; - - - - fontface - - - A valid CairoFontFace object - - - - - - - - - &reftitle.returnvalues; - - CAIRO_STATUS_SUCCESS or another error such as CAIRO_STATUS_NO_MEMORY. - - - - - &reftitle.examples; - - - &style.oop; - -status()); // should be the value of CAIRO_STATUS_SUCCESS - -?> -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairofontoptions.xml b/reference/cairo/cairofontoptions.xml deleted file mode 100644 index 3dbb86e69e01..000000000000 --- a/reference/cairo/cairofontoptions.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - The CairoFontOptions class - CairoFontOptions - - - - -
- &reftitle.intro; - - An opaque structure holding all options that are used when rendering fonts. - - - Individual features of a cairo_font_options_t can be set or accessed using functions named - cairo_font_options_set_feature_name and cairo_font_options_get_feature_name, like - cairo_font_options_set_antialias() and cairo_font_options_get_antialias(). - - - New features may be added to CairoFontOptions in the future. For this reason - CairoFontOptions::copy, CairoFontOptions::equal, - CairoFontOptions::merge, CairoFontOptions::hash - (cairo_font_options_copy(), cairo_font_options_equal(), cairo_font_options_merge(), and cairo_font_options_hash() - in procedural way) should be used to copy, check for equality, merge, or compute a hash value of - CairoFontOptions objects. - -
- - -
- &reftitle.classsynopsis; - - - - CairoFontOptions - - - - - CairoFontOptions - - - - - &Methods; - - - - -
- - - - &reference.cairo.entities.cairofontoptions; - - - - diff --git a/reference/cairo/cairofontoptions/construct.xml b/reference/cairo/cairofontoptions/construct.xml deleted file mode 100644 index f0c8bd51db6c..000000000000 --- a/reference/cairo/cairofontoptions/construct.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoFontOptions::__construct - The __construct purpose - - - - &reftitle.description; - - public CairoFontOptions::__construct - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoFontOptions::__construct</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairofontoptions/equal.xml b/reference/cairo/cairofontoptions/equal.xml deleted file mode 100644 index 23f5443037c9..000000000000 --- a/reference/cairo/cairofontoptions/equal.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - CairoFontOptions::equal - The equal purpose - - - - &reftitle.description; - - public boolCairoFontOptions::equal - CairoFontOptionsother - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - other - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoFontOptions::equal</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairofontoptions/getantialias.xml b/reference/cairo/cairofontoptions/getantialias.xml deleted file mode 100644 index 14240a79b109..000000000000 --- a/reference/cairo/cairofontoptions/getantialias.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoFontOptions::getAntialias - cairo_get_antialias - The getAntialias purpose - - - - &reftitle.description; - &style.oop; (method): - - public intCairoFontOptions::getAntialias - - - &style.procedural;: - - intcairo_get_antialias - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairofontoptions/gethintmetrics.xml b/reference/cairo/cairofontoptions/gethintmetrics.xml deleted file mode 100644 index c4b078664583..000000000000 --- a/reference/cairo/cairofontoptions/gethintmetrics.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoFontOptions::getHintMetrics - The getHintMetrics purpose - - - - &reftitle.description; - - public intCairoFontOptions::getHintMetrics - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoFontOptions::getHintMetrics</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairofontoptions/gethintstyle.xml b/reference/cairo/cairofontoptions/gethintstyle.xml deleted file mode 100644 index 5fad6b4116bb..000000000000 --- a/reference/cairo/cairofontoptions/gethintstyle.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoFontOptions::getHintStyle - The getHintStyle purpose - - - - &reftitle.description; - - public intCairoFontOptions::getHintStyle - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoFontOptions::getHintStyle</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairofontoptions/getsubpixelorder.xml b/reference/cairo/cairofontoptions/getsubpixelorder.xml deleted file mode 100644 index 0f001a840334..000000000000 --- a/reference/cairo/cairofontoptions/getsubpixelorder.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoFontOptions::getSubpixelOrder - The getSubpixelOrder purpose - - - - &reftitle.description; - - public intCairoFontOptions::getSubpixelOrder - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoFontOptions::getSubpixelOrder</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairofontoptions/hash.xml b/reference/cairo/cairofontoptions/hash.xml deleted file mode 100644 index 12ce0d827d87..000000000000 --- a/reference/cairo/cairofontoptions/hash.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoFontOptions::hash - The hash purpose - - - - &reftitle.description; - - public intCairoFontOptions::hash - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoFontOptions::hash</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairofontoptions/merge.xml b/reference/cairo/cairofontoptions/merge.xml deleted file mode 100644 index 336a3c62415b..000000000000 --- a/reference/cairo/cairofontoptions/merge.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - CairoFontOptions::merge - The merge purpose - - - - &reftitle.description; - - public voidCairoFontOptions::merge - CairoFontOptionsother - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - other - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoFontOptions::merge</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairofontoptions/setantialias.xml b/reference/cairo/cairofontoptions/setantialias.xml deleted file mode 100644 index 0ca44b94e212..000000000000 --- a/reference/cairo/cairofontoptions/setantialias.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - CairoFontOptions::setAntialias - cairo_set_antialias - The setAntialias purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoFontOptions::setAntialias - intantialias - - &style.procedural;: - - voidcairo_set_antialias - CairoContextcontext - intantialias - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - antialias - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairofontoptions/sethintmetrics.xml b/reference/cairo/cairofontoptions/sethintmetrics.xml deleted file mode 100644 index 2fdaa3a53607..000000000000 --- a/reference/cairo/cairofontoptions/sethintmetrics.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - CairoFontOptions::setHintMetrics - The setHintMetrics purpose - - - - &reftitle.description; - - public voidCairoFontOptions::setHintMetrics - inthint_metrics - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - hint_metrics - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoFontOptions::setHintMetrics</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairofontoptions/sethintstyle.xml b/reference/cairo/cairofontoptions/sethintstyle.xml deleted file mode 100644 index c45373edb3ba..000000000000 --- a/reference/cairo/cairofontoptions/sethintstyle.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - CairoFontOptions::setHintStyle - The setHintStyle purpose - - - - &reftitle.description; - - public voidCairoFontOptions::setHintStyle - inthint_style - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - hint_style - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoFontOptions::setHintStyle</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairofontoptions/setsubpixelorder.xml b/reference/cairo/cairofontoptions/setsubpixelorder.xml deleted file mode 100644 index 46eb53d6cd4f..000000000000 --- a/reference/cairo/cairofontoptions/setsubpixelorder.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - CairoFontOptions::setSubpixelOrder - The setSubpixelOrder purpose - - - - &reftitle.description; - - public voidCairoFontOptions::setSubpixelOrder - intsubpixel_order - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - subpixel_order - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoFontOptions::setSubpixelOrder</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairofontoptions/status.xml b/reference/cairo/cairofontoptions/status.xml deleted file mode 100644 index 087f332899d2..000000000000 --- a/reference/cairo/cairofontoptions/status.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoFontOptions::status - cairo_status - The status purpose - - - - &reftitle.description; - &style.oop; (method): - - public intCairoFontOptions::status - - - &style.procedural;: - - intcairo_status - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairofontslant.xml b/reference/cairo/cairofontslant.xml deleted file mode 100644 index 5219e2433ed7..000000000000 --- a/reference/cairo/cairofontslant.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - The CairoFontSlant class - CairoFontSlant - - - - -
- &reftitle.intro; - - Specifies variants of a font face based on their slant. - -
- - -
- &reftitle.classsynopsis; - - - - CairoFontSlant - - - - - CairoFontSlant - - - - &Constants; - - const - integer - CairoFontSlant::NORMAL - 0 - - - const - integer - CairoFontSlant::ITALIC - 1 - - - const - integer - CairoFontSlant::OBLIQUE - 2 - - - - - -
- - -
- &reftitle.constants; - - - - CairoFontSlant::NORMAL - - Upright font style - - - - - CairoFontSlant::ITALIC - - Italic font style - - - - - CairoFontSlant::OBLIQUE - - Oblique font style - - - - -
- - - - - - - - - - diff --git a/reference/cairo/cairofonttype.xml b/reference/cairo/cairofonttype.xml deleted file mode 100644 index 36a48285e92e..000000000000 --- a/reference/cairo/cairofonttype.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - - The CairoFontType class - CairoFontType - - - - -
- &reftitle.intro; - - CairoFontType class is an abstract final class that contains constants used to describe the type - of a given CairoFontFace or CairoScaledFont. - The font types are also known as "font backends" within cairo. - - - The type of a CairoFontFace is determined by the how it is created, an example would be the - CairoToyFontFace::__construct. - The CairoFontFace type can be queried with - CairoFontFace::getType or cairo_font_face_get_type - - - The various CairoFontFace functions can be used with a font face of any type. - - - The type of a CairoScaledFont is determined by the type of the - CairoFontFace passed to - CairoScaledFont::__construct or - cairo_scaled_font_create. - The scaled font type can be queried with CairoScaledFont::getType or - cairo_scaled_font_get_type. - -
- - -
- &reftitle.classsynopsis; - - - - CairoFontType - - - - - CairoFontType - - - - &Constants; - - const - integer - CairoFontType::TOY - 0 - - - const - integer - CairoFontType::FT - 1 - - - const - integer - CairoFontType::WIN32 - 2 - - - const - integer - CairoFontType::QUARTZ - 3 - - - - - -
- - -
- &reftitle.constants; - - - - CairoFontType::TOY - - The font was created using CairoToyFont api - - - - - CairoFontType::FT - - The font is of type CairoFreeType - - - - - CairoFontType::WIN32 - - The font is of type Win32 - - - - - CairoFontType::QUARTZ - - The font is of type Quartz - - - - - CairoFontType::USER - - The font was create using cairo's user font api - - - - -
- - - - - - - - - - diff --git a/reference/cairo/cairofontweight.xml b/reference/cairo/cairofontweight.xml deleted file mode 100644 index bb8a38536400..000000000000 --- a/reference/cairo/cairofontweight.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - The CairoFontWeight class - CairoFontWeight - - - - -
- &reftitle.intro; - - Specifies variants of a font face based on their weight. - -
- - -
- &reftitle.classsynopsis; - - - - CairoFontWeight - - - - - CairoFontWeight - - - - &Constants; - - const - integer - CairoFontWeight::NORMAL - 0 - - - const - integer - CairoFontWeight::BOLD - 1 - - - - - -
- - -
- &reftitle.constants; - - - - CairoFontWeight::NORMAL - - Normal font weight - - - - - CairoFontWeight::BOLD - - Bold font weight - - - - -
- - - - - - - - - - diff --git a/reference/cairo/cairoformat.xml b/reference/cairo/cairoformat.xml deleted file mode 100644 index 8235e129dafd..000000000000 --- a/reference/cairo/cairoformat.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - The CairoFormat class - CairoFormat - - - - -
- &reftitle.intro; - - CairoFormat enums are used to identify the memory format of the image data. - -
- - -
- &reftitle.classsynopsis; - - - - CairoFormat - - - - - CairoFormat - - - - &Constants; - - const - integer - CairoFormat::ARGB32 - 0 - - - const - integer - CairoFormat::RGB24 - 1 - - - const - integer - CairoFormat::A8 - 2 - - - const - integer - CairoFormat::A1 - 3 - - - &Methods; - - - - -
- - -
- &reftitle.constants; - - - - CairoFormat::ARGB32 - - Each pixel is a 32-bit quantity, with alpha in the upper 8 bits, then red, then green, then blue. - The 32-bit quantities are stored native-endian. - Pre-multiplied alpha is used. (That is, 50% transparent red is 0x80800000, not 0x80ff0000.) - - - - - - CairoFormat::RGB24 - - Each pixel is a 32-bit quantity, with the upper 8 bits unused. - Red, Green, and Blue are stored in the remaining 24 bits in that order. - - - - - - CairoFormat::A8 - - Each pixel is a 8-bit quantity holding an alpha value. - - - - - CairoFormat::A1 - - Each pixel is a 1-bit quantity holding an alpha value. - Pixels are packed together into 32-bit quantities. - The ordering of the bits matches the endianness of the platform. - On a big-endian machine, the first pixel is in the uppermost bit, - on a little-endian machine the first pixel is in the least-significant bit. - - - - - -
- - - - - - &reference.cairo.entities.cairoformat; - - - - diff --git a/reference/cairo/cairoformat/strideforwidth.xml b/reference/cairo/cairoformat/strideforwidth.xml deleted file mode 100644 index be4a3f98ba42..000000000000 --- a/reference/cairo/cairoformat/strideforwidth.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - CairoFormat::strideForWidth - Provides an appropriate stride to use - - - - &reftitle.description; - - public static intCairoFormat::strideForWidth - intformat - intwidth - - - This method provides a stride value that will respect all alignment requirements of the - accelerated image-rendering code within cairo. - - - - - - &reftitle.parameters; - - - - format - - - The desired CairoFormat to use - - - - - width - - - The width of the image - - - - - - - - - &reftitle.returnvalues; - - The appropriate stride to use given the desired format and width, - or -1 if either the format is invalid or the width too large. - - - - - &reftitle.examples; - - - <methodname>CairoFormat::strideForWidth</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairogradientpattern.xml b/reference/cairo/cairogradientpattern.xml deleted file mode 100644 index 93c4e746a1d7..000000000000 --- a/reference/cairo/cairogradientpattern.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - The CairoGradientPattern class - CairoGradientPattern - - - - -
- &reftitle.intro; - - CairoGradientPattern is an abstract base class from which other Pattern classes derive. - It cannot be instantiated directly. - -
- - -
- &reftitle.classsynopsis; - - - - CairoGradientPattern - - - - - CairoGradientPattern - - - - extends - CairoPattern - - - - - &Methods; - - - &InheritedMethods; - - - - - -
- - - - &reference.cairo.entities.cairogradientpattern; - - - - diff --git a/reference/cairo/cairogradientpattern/addcolorstoprgb.xml b/reference/cairo/cairogradientpattern/addcolorstoprgb.xml deleted file mode 100644 index 4491e26e72c5..000000000000 --- a/reference/cairo/cairogradientpattern/addcolorstoprgb.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - CairoGradientPattern::addColorStopRgb - The addColorStopRgb purpose - - - - &reftitle.description; - - public voidCairoGradientPattern::addColorStopRgb - floatoffset - floatred - floatgreen - floatblue - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - offset - - - Description... - - - - - red - - - Description... - - - - - green - - - Description... - - - - - blue - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoGradientPattern::addColorStopRgb</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairogradientpattern/addcolorstoprgba.xml b/reference/cairo/cairogradientpattern/addcolorstoprgba.xml deleted file mode 100644 index 7d92284b5ac0..000000000000 --- a/reference/cairo/cairogradientpattern/addcolorstoprgba.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - CairoGradientPattern::addColorStopRgba - The addColorStopRgba purpose - - - - &reftitle.description; - - public voidCairoGradientPattern::addColorStopRgba - floatoffset - floatred - floatgreen - floatblue - floatalpha - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - offset - - - Description... - - - - - red - - - Description... - - - - - green - - - Description... - - - - - blue - - - Description... - - - - - alpha - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoGradientPattern::addColorStopRgba</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairogradientpattern/getcolorstopcount.xml b/reference/cairo/cairogradientpattern/getcolorstopcount.xml deleted file mode 100644 index e0410114076c..000000000000 --- a/reference/cairo/cairogradientpattern/getcolorstopcount.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoGradientPattern::getColorStopCount - The getColorStopCount purpose - - - - &reftitle.description; - - public intCairoGradientPattern::getColorStopCount - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoGradientPattern::getColorStopCount</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairogradientpattern/getcolorstoprgba.xml b/reference/cairo/cairogradientpattern/getcolorstoprgba.xml deleted file mode 100644 index ec978c112818..000000000000 --- a/reference/cairo/cairogradientpattern/getcolorstoprgba.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - CairoGradientPattern::getColorStopRgba - The getColorStopRgba purpose - - - - &reftitle.description; - - public arrayCairoGradientPattern::getColorStopRgba - intindex - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - index - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoGradientPattern::getColorStopRgba</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairogradientpattern/getextend.xml b/reference/cairo/cairogradientpattern/getextend.xml deleted file mode 100644 index d2a1f5246e89..000000000000 --- a/reference/cairo/cairogradientpattern/getextend.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoGradientPattern::getExtend - The getExtend purpose - - - - &reftitle.description; - - public intCairoGradientPattern::getExtend - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoGradientPattern::getExtend</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairogradientpattern/setextend.xml b/reference/cairo/cairogradientpattern/setextend.xml deleted file mode 100644 index 10a513ed2c1b..000000000000 --- a/reference/cairo/cairogradientpattern/setextend.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - CairoGradientPattern::setExtend - The setExtend purpose - - - - &reftitle.description; - - public voidCairoGradientPattern::setExtend - intextend - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - extend - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoGradientPattern::setExtend</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairohintmetrics.xml b/reference/cairo/cairohintmetrics.xml deleted file mode 100644 index 2454744b6f18..000000000000 --- a/reference/cairo/cairohintmetrics.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - The CairoHintMetrics class - CairoHintMetrics - - - - -
- &reftitle.intro; - - Specifies whether to hint font metrics; hinting font metrics means quantizing them so that they are integer values - in device space. Doing this improves the consistency of letter and line spacing, however it also means that text - will be laid out differently at different zoom factors. - -
- - -
- &reftitle.classsynopsis; - - - - CairoHintMetrics - - - - - CairoHintMetrics - - - - &Constants; - - const - integer - CairoHintMetrics::METRICS_DEFAULT - 0 - - - const - integer - CairoHintMetrics::METRICS_OFF - 1 - - - const - integer - CairoHintMetrics::METRICS_ON - 2 - - - - - -
- - -
- &reftitle.constants; - - - - CairoHintMetrics::METRICS_DEFAULT - - Hint metrics in the default manner for the font backend and target device - - - - - CairoHintMetrics::METRICS_OFF - - Do not hint font metrics - - - - - CairoHintMetrics::METRICS_ON - - Hint font metrics - - - - -
- - - - - - - - - - diff --git a/reference/cairo/cairohintstyle.xml b/reference/cairo/cairohintstyle.xml deleted file mode 100644 index 7d325c8186b2..000000000000 --- a/reference/cairo/cairohintstyle.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - The CairoHintStyle class - CairoHintStyle - - - - -
- &reftitle.intro; - - Specifies the type of hinting to do on font outlines. Hinting is the process of fitting outlines to the pixel grid - in order to improve the appearance of the result. Since hinting outlines involves distorting them, it also reduces - the faithfulness to the original outline shapes. Not all of the outline hinting styles are supported by all font - backends. - -
- - -
- &reftitle.classsynopsis; - - - - CairoHintStyle - - - - - CairoHintStyle - - - - &Constants; - - const - integer - CairoHintStyle::STYLE_DEFAULT - 0 - - - const - integer - CairoHintStyle::STYLE_NONE - 1 - - - const - integer - CairoHintStyle::STYLE_SLIGHT - 2 - - - const - integer - CairoHintStyle::STYLE_MEDIUM - 3 - - - const - integer - CairoHintStyle::STYLE_FULL - 4 - - - - - -
- - -
- &reftitle.constants; - - - - CairoHintStyle::STYLE_DEFAULT - - Use the default hint style for font backend and target device - - - - - CairoHintStyle::STYLE_NONE - - Do not hint outlines - - - - - CairoHintStyle::STYLE_SLIGHT - - Hint outlines slightly to improve contrast while retaining good fidelity to the original shapes. - - - - - CairoHintStyle::STYLE_MEDIUM - - Hint outlines with medium strength giving a compromise between fidelity to the original shapes and contrast - - - - - CairoHintStyle::STYLE_FULL - - Hint outlines to maximize contrast - - - - -
- - - - - - - - - - diff --git a/reference/cairo/cairoimagesurface.xml b/reference/cairo/cairoimagesurface.xml deleted file mode 100644 index dffda6e0edeb..000000000000 --- a/reference/cairo/cairoimagesurface.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - The CairoImageSurface class - CairoImageSurface - - - - -
- &reftitle.intro; - - CairoImageSurface provide the ability to render to memory buffers either allocated by cairo or - by the calling code. The supported image formats are those defined in CairoFormat. - -
- - -
- &reftitle.classsynopsis; - - - - CairoImageSurface - - - - - CairoImageSurface - - - - extends - CairoSurface - - - - - &Methods; - - - &InheritedMethods; - - - - - -
- - - - &reference.cairo.entities.cairoimagesurface; - - - - diff --git a/reference/cairo/cairoimagesurface/construct.xml b/reference/cairo/cairoimagesurface/construct.xml deleted file mode 100644 index f50cd3c737ed..000000000000 --- a/reference/cairo/cairoimagesurface/construct.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - CairoImageSurface::__construct - Creates a new CairoImageSurface - - - - &reftitle.description; - - public CairoImageSurface::__construct - intformat - intwidth - intheight - - - Creates a new CairoImageSuface object of type format - - - - - - &reftitle.parameters; - - - - format - - - Can be any defined in CairoFormat - - - - - width - - - The width of the image surface - - - - - height - - - The height of the image surface - - - - - - - - - &reftitle.returnvalues; - - A new CairoImageSurface - - - - - &reftitle.examples; - - - <methodname>CairoImageSurface::__construct</methodname> example - - -]]> - - - - - - - &reftitle.seealso; - - - CairoContext::__construct - - - - - - - diff --git a/reference/cairo/cairoimagesurface/createfordata.xml b/reference/cairo/cairoimagesurface/createfordata.xml deleted file mode 100644 index 48f206cc242a..000000000000 --- a/reference/cairo/cairoimagesurface/createfordata.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - CairoImageSurface::createForData - The createForData purpose - - - - &reftitle.description; - - public static voidCairoImageSurface::createForData - stringdata - intformat - intwidth - intheight - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - data - - - Description... - - - - - format - - - Description... - - - - - width - - - Description... - - - - - height - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoImageSurface::createForData</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairoimagesurface/createfrompng.xml b/reference/cairo/cairoimagesurface/createfrompng.xml deleted file mode 100644 index 77f27ec78052..000000000000 --- a/reference/cairo/cairoimagesurface/createfrompng.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - CairoImageSurface::createFromPng - Creates a new CairoImageSurface form a png image file - - - - &reftitle.description; - - public static CairoImageSurfaceCairoImageSurface::createFromPng - stringfile - - - Creates a new CairoImageSurface form a png image file - - - This method should be called static - - - - - - &reftitle.parameters; - - - - file - - - Path to PNG image file - - - - - - - - - &reftitle.returnvalues; - - CairoImageSurface object - - - - - &reftitle.examples; - - - <methodname>CairoImageSurface::createFromPng</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - CairoImageSurface::__construct - - - - - - - diff --git a/reference/cairo/cairoimagesurface/getdata.xml b/reference/cairo/cairoimagesurface/getdata.xml deleted file mode 100644 index 3173d10d612f..000000000000 --- a/reference/cairo/cairoimagesurface/getdata.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoImageSurface::getData - Gets the image data as string - - - - &reftitle.description; - - public stringCairoImageSurface::getData - - - - Returns the image data of this surface or NULL if surface is not an image surface, - or if CairoContext::finish, procedural : - cairo_surface_finish, has been called. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The image data as string - - - - - &reftitle.examples; - - - <methodname>CairoImageSurface::getData</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - CairoImageSurface::getStride - - - - - - - diff --git a/reference/cairo/cairoimagesurface/getformat.xml b/reference/cairo/cairoimagesurface/getformat.xml deleted file mode 100644 index 868a7a63f634..000000000000 --- a/reference/cairo/cairoimagesurface/getformat.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - CairoImageSurface::getFormat - Get the image format - - - - &reftitle.description; - - public intCairoImageSurface::getFormat - - - - Retrieves the image format, as one of the CairoFormat defined - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - One of the CairoFormat enums - - - - - &reftitle.examples; - - - <methodname>CairoImageSurface::getFormat</methodname> example - -getFormat()); // 0 - -$surface2 = new CairoImageSurface(CairoFormat::A8, 50, 50); - -var_dump($surface2->getFormat()); // 2 - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - CairoImageSurface::getHeight - CairoImageSurface::getWidth - - - - - - - diff --git a/reference/cairo/cairoimagesurface/getheight.xml b/reference/cairo/cairoimagesurface/getheight.xml deleted file mode 100644 index 5228fcb8e817..000000000000 --- a/reference/cairo/cairoimagesurface/getheight.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - CairoImageSurface::getHeight - Retrieves the height of the CairoImageSurface - - - - &reftitle.description; - - public intCairoImageSurface::getHeight - - - - This methods returns the CairoImageSurface height. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - CairoImageSurface object height - - - - - &reftitle.examples; - - - <methodname>CairoImageSurface::getHeight</methodname> example - -getHeight()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - CairoImageSurface::getWidth - - - - - - - diff --git a/reference/cairo/cairoimagesurface/getstride.xml b/reference/cairo/cairoimagesurface/getstride.xml deleted file mode 100644 index a1d66980b5ee..000000000000 --- a/reference/cairo/cairoimagesurface/getstride.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoImageSurface::getStride - The getStride purpose - - - - &reftitle.description; - - public intCairoImageSurface::getStride - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoImageSurface::getStride</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairoimagesurface/getwidth.xml b/reference/cairo/cairoimagesurface/getwidth.xml deleted file mode 100644 index 4992e016a8d9..000000000000 --- a/reference/cairo/cairoimagesurface/getwidth.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - CairoImageSurface::getWidth - Retrieves the width of the CairoImageSurface - - - - &reftitle.description; - - public intCairoImageSurface::getWidth - - - - Gets the width of the CairoImageSurface - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the width of the CairoImageSurface object - - - - - &reftitle.examples; - - - <methodname>CairoImageSurface::getWidth</methodname> example - -getWidth()); - -?> -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - CairoImageSurface::getHeight - - - - - - - diff --git a/reference/cairo/cairolineargradient.xml b/reference/cairo/cairolineargradient.xml deleted file mode 100644 index 3eb51c949f76..000000000000 --- a/reference/cairo/cairolineargradient.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - The CairoLinearGradient class - CairoLinearGradient - - - - -
- &reftitle.intro; - - Create a new CairoLinearGradient along the line defined - -
- - -
- &reftitle.classsynopsis; - - - - CairoLinearGradient - - - - - CairoLinearGradient - - - - extends - CairoGradientPattern - - - - - &Methods; - - - &InheritedMethods; - - - - - -
- - - - &reference.cairo.entities.cairolineargradient; - - - - diff --git a/reference/cairo/cairolineargradient/construct.xml b/reference/cairo/cairolineargradient/construct.xml deleted file mode 100644 index 005d1a454991..000000000000 --- a/reference/cairo/cairolineargradient/construct.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - CairoLinearGradient::__construct - The __construct purpose - - - - &reftitle.description; - - public CairoLinearGradient::__construct - floatx0 - floaty0 - floatx1 - floaty1 - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - x0 - - - Description... - - - - - y0 - - - Description... - - - - - x1 - - - Description... - - - - - y1 - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoLinearGradient::__construct</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairolineargradient/getpoints.xml b/reference/cairo/cairolineargradient/getpoints.xml deleted file mode 100644 index 343cc138dd30..000000000000 --- a/reference/cairo/cairolineargradient/getpoints.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoLinearGradient::getPoints - The getPoints purpose - - - - &reftitle.description; - - public arrayCairoLinearGradient::getPoints - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoLinearGradient::getPoints</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairolinecap.xml b/reference/cairo/cairolinecap.xml deleted file mode 100644 index e7235090d4d6..000000000000 --- a/reference/cairo/cairolinecap.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - The CairoLineCap class - CairoLineCap - - - - -
- &reftitle.intro; - - Specifies how to render the endpoints of the path when stroking. - - - The default line cap style is CairoLineCap::BUTT. - -
- - -
- &reftitle.classsynopsis; - - - - CairoLineCap - - - - - CairoLineCap - - - - &Constants; - - const - integer - CairoLineCap::BUTT - 0 - - - const - integer - CairoLineCap::ROUND - 1 - - - const - integer - CairoLineCap::SQUARE - 2 - - - - - -
- - -
- &reftitle.constants; - - - - CairoLineCap::BUTT - - Start(stop) the line exactly at the start(end) point - - - - - CairoLineCap::ROUND - - Use a round ending, the center of the circle is the end point - - - - - CairoLineCap::SQUARE - - Use squared ending, the center of the square is the end point - - - - -
- - - - - - - - - - diff --git a/reference/cairo/cairolinejoin.xml b/reference/cairo/cairolinejoin.xml deleted file mode 100644 index de9ba3eea812..000000000000 --- a/reference/cairo/cairolinejoin.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - The CairoLineJoin class - CairoLineJoin - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - CairoLineJoin - - - - - CairoLineJoin - - - - &Constants; - - const - integer - CairoLineJoin::MITER - 0 - - - const - integer - CairoLineJoin::ROUND - 1 - - - const - integer - CairoLineJoin::BEVEL - 2 - - - - - -
- - -
- &reftitle.constants; - - - - CairoLineJoin::MITER - - Description here... - - - - - CairoLineJoin::ROUND - - Description here... - - - - - CairoLineJoin::BEVEL - - Description here... - - - - -
- - - - - - - - - - diff --git a/reference/cairo/cairomatrix.xml b/reference/cairo/cairomatrix.xml deleted file mode 100644 index 93a1e046948e..000000000000 --- a/reference/cairo/cairomatrix.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The CairoMatrix class - CairoMatrix - - - - -
- &reftitle.intro; - - Matrices are used throughout cairo to convert between different coordinate spaces. - -
- - -
- &reftitle.classsynopsis; - - - - CairoMatrix - - - - - CairoMatrix - - - - - &Methods; - - - - -
- - - - &reference.cairo.entities.cairomatrix; - - - - diff --git a/reference/cairo/cairomatrix/construct.xml b/reference/cairo/cairomatrix/construct.xml deleted file mode 100644 index e810d6f7585b..000000000000 --- a/reference/cairo/cairomatrix/construct.xml +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - CairoMatrix::__construct - cairo_matrix_init - Creates a new CairoMatrix object - - - - &reftitle.description; - &style.oop; (method): - - public CairoMatrix::__construct - floatxx1.0 - floatyx0.0 - floatxy0.0 - floatyy1.0 - floatx00.0 - floaty00.0 - - &style.procedural;: - - objectcairo_matrix_init - floatxx1.0 - floatyx0.0 - floatxy0.0 - floatyy1.0 - floatx00.0 - floaty00.0 - - - Returns new CairoMatrix object. Matrices are used throughout cairo to convert between different coordinate spaces. - Sets matrix to be the affine transformation given by xx, yx, xy, yy, x0, y0. The transformation is given by: - x_new = xx * x + xy * y + x0; and y_new = yx * x + yy * y + y0; - - - - - - &reftitle.parameters; - - - - xx - - - xx component of the affine transformation - - - - - yx - - - yx component of the affine transformation - - - - - xy - - - xy component of the affine transformation - - - - - yy - - - yy component of the affine transformation - - - - - x0 - - - X translation component of the affine transformation - - - - - y0 - - - Y translation component of the affine transformation - - - - - - - - - &reftitle.returnvalues; - - Returns a new CairoMatrix object that can be used with surfaces, contexts, and patterns. - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - - - - - &style.procedural; - - -]]> - - - - - - - - &reftitle.seealso; - - - CairoMatrix::initIdentity - CairoMatrix::initRotate - CairoMatrix::initScale - CairoMatrix::initTranslate - - - - - - - diff --git a/reference/cairo/cairomatrix/initidentity.xml b/reference/cairo/cairomatrix/initidentity.xml deleted file mode 100644 index e8c9198952dd..000000000000 --- a/reference/cairo/cairomatrix/initidentity.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - - CairoMatrix::initIdentity - cairo_matrix_init_identity - Creates a new identity matrix - - - - &reftitle.description; - &style.oop; (method): - - public static voidCairoMatrix::initIdentity - - - &style.procedural;: - - objectcairo_matrix_init_identity - - - - Creates a new matrix that is an identity transformation. An identity - transformation means the source data is copied into the destination data - without change - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a new CairoMatrix object that can be used with surfaces, contexts, and patterns. - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - - - - - &style.procedural; - - -]]> - - - - - - - &reftitle.seealso; - - - CairoMatrix::__construct - CairoMatrix::initRotate - CairoMatrix::initScale - CairoMatrix::initTranslate - - - - - - - diff --git a/reference/cairo/cairomatrix/initrotate.xml b/reference/cairo/cairomatrix/initrotate.xml deleted file mode 100644 index 1fcdaf685b21..000000000000 --- a/reference/cairo/cairomatrix/initrotate.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - - CairoMatrix::initRotate - cairo_matrix_init_rotate - Creates a new rotated matrix - - - - &reftitle.description; - &style.oop; (method): - - public static voidCairoMatrix::initRotate - floatradians - - &style.procedural;: - - objectcairo_matrix_init_rotate - floatradians - - - Creates a new matrix to a transformation that rotates by radians provided - - - - - - &reftitle.parameters; - - - - radians - - - angle of rotation, in radians. The direction of rotation is defined such - that positive angles rotate in the direction from the positive X axis - toward the positive Y axis. With the default axis orientation of cairo, - positive angles rotate in a clockwise direction. - - - - - - - - - &reftitle.returnvalues; - - Returns a new CairoMatrix object that can be used with surfaces, contexts, and patterns. - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - - - - - &style.procedural; - - -]]> - - - - - - - &reftitle.seealso; - - - CairoMatrix::__construct - CairoMatrix::initIdentity - CairoMatrix::initScale - CairoMatrix::initTranslate - - - - - - - diff --git a/reference/cairo/cairomatrix/initscale.xml b/reference/cairo/cairomatrix/initscale.xml deleted file mode 100644 index 29ea997fe71b..000000000000 --- a/reference/cairo/cairomatrix/initscale.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - CairoMatrix::initScale - cairo_matrix_init_scale - Creates a new scaling matrix - - - - &reftitle.description; - &style.oop; (method): - - public static voidCairoMatrix::initScale - floatsx - floatsy - - &style.procedural;: - - objectcairo_matrix_init_scale - floatsx - floatsy - - - Creates a new matrix to a transformation that scales by sx and sy in the X - and Y dimensions, respectively. - - - - - - &reftitle.parameters; - - - - sx - - - scale factor in the X direction - - - - - sy - - - scale factor in the Y direction - - - - - - - - - &reftitle.returnvalues; - - Returns a new CairoMatrix object that can be used with surfaces, contexts, and patterns. - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - - - - - &style.procedural; - - -]]> - - - - - - - &reftitle.seealso; - - - CairoMatrix::__construct - CairoMatrix::initIdentity - CairoMatrix::initRotate - CairoMatrix::initTranslate - - - - - - - diff --git a/reference/cairo/cairomatrix/inittranslate.xml b/reference/cairo/cairomatrix/inittranslate.xml deleted file mode 100644 index a92520e84aee..000000000000 --- a/reference/cairo/cairomatrix/inittranslate.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - CairoMatrix::initTranslate - cairo_matrix_init_translate - Creates a new translation matrix - - - - &reftitle.description; - &style.oop; (method): - - public static voidCairoMatrix::initTranslate - floattx - floatty - - &style.procedural;: - - objectcairo_matrix_init_translate - floattx - floatty - - - Creates a new matrix to a transformation that translates by tx and ty in the X - and Y dimensions, respectively. - - - - - - &reftitle.parameters; - - - - tx - - - amount to translate in the X direction - - - - - ty - - - amount to translate in the Y direction - - - - - - - - - &reftitle.returnvalues; - - Returns a new CairoMatrix object that can be used with surfaces, contexts, and patterns. - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - - - - - &style.procedural; - - -]]> - - - - - - - &reftitle.seealso; - - - CairoMatrix::__construct - CairoMatrix::initIdentity - CairoMatrix::initRotate - CairoMatrix::initScale - - - - - - - diff --git a/reference/cairo/cairomatrix/invert.xml b/reference/cairo/cairomatrix/invert.xml deleted file mode 100644 index 2419ee71f189..000000000000 --- a/reference/cairo/cairomatrix/invert.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoMatrix::invert - The invert purpose - - - - &reftitle.description; - - public voidCairoMatrix::invert - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoMatrix::invert</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairomatrix/multiply.xml b/reference/cairo/cairomatrix/multiply.xml deleted file mode 100644 index 879f24f25e7a..000000000000 --- a/reference/cairo/cairomatrix/multiply.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - CairoMatrix::multiply - The multiply purpose - - - - &reftitle.description; - - public static CairoMatrixCairoMatrix::multiply - CairoMatrixmatrix1 - CairoMatrixmatrix2 - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - matrix1 - - - Description... - - - - - matrix2 - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoMatrix::multiply</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairomatrix/rotate.xml b/reference/cairo/cairomatrix/rotate.xml deleted file mode 100644 index a2b791d02c1a..000000000000 --- a/reference/cairo/cairomatrix/rotate.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - CairoMatrix::rotate - cairo_matrix_rotate - The rotate purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoMatrix::rotate - floatradians - - &style.procedural;: - - voidcairo_matrix_rotate - CairoContextcontext - stringradians - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - radians - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairomatrix/scale.xml b/reference/cairo/cairomatrix/scale.xml deleted file mode 100644 index 17e95e5a068c..000000000000 --- a/reference/cairo/cairomatrix/scale.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - CairoMatrix::scale - cairo_matrix_scale - Applies scaling to a matrix - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoMatrix::scale - floatsx - floatsy - - &style.procedural;: - - voidcairo_matrix_scale - CairoContextcontext - floatsx - floatsy - - - Applies scaling by sx, sy to the transformation in the matrix. The effect of - the new transformation is to first scale the coordinates by sx and sy, then - apply the original transformation to the coordinates. - - - - - - &reftitle.parameters; - - - - matrix - - - Procedural only - CairoMatrix instance - - - - - sx - - - scale factor in the X direction - - - - - sy - - - scale factor in the Y direction - - - - - - - - - &reftitle.examples; - - - &style.oop; - -scale(0.2, 2.0); -?> -]]> - - - - - - &style.procedural; - - -]]> - - - - - - - &reftitle.seealso; - - - CairoMatrix::initScale - - - - - - - diff --git a/reference/cairo/cairomatrix/transformdistance.xml b/reference/cairo/cairomatrix/transformdistance.xml deleted file mode 100644 index 372b7e491adb..000000000000 --- a/reference/cairo/cairomatrix/transformdistance.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - CairoMatrix::transformDistance - The transformDistance purpose - - - - &reftitle.description; - - public arrayCairoMatrix::transformDistance - floatdx - floatdy - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - dx - - - Description... - - - - - dy - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoMatrix::transformDistance</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairomatrix/transformpoint.xml b/reference/cairo/cairomatrix/transformpoint.xml deleted file mode 100644 index fcec64d3d341..000000000000 --- a/reference/cairo/cairomatrix/transformpoint.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - CairoMatrix::transformPoint - The transformPoint purpose - - - - &reftitle.description; - - public arrayCairoMatrix::transformPoint - floatdx - floatdy - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - dx - - - Description... - - - - - dy - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoMatrix::transformPoint</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairomatrix/translate.xml b/reference/cairo/cairomatrix/translate.xml deleted file mode 100644 index b41a26654c73..000000000000 --- a/reference/cairo/cairomatrix/translate.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - CairoMatrix::translate - cairo_translate - The translate purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoMatrix::translate - floattx - floatty - - &style.procedural;: - - voidcairo_translate - CairoContextcontext - floatx - floaty - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - x - - - Description... - - - - - y - - - Description... - - - - - tx - - - Description... - - - - - ty - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairooperator.xml b/reference/cairo/cairooperator.xml deleted file mode 100644 index be3a9ea61826..000000000000 --- a/reference/cairo/cairooperator.xml +++ /dev/null @@ -1,271 +0,0 @@ - - - - - - The CairoOperator class - CairoOperator - - - - -
- &reftitle.intro; - - This is used to set the compositing operator for all cairo drawing operations. - - - The default operator is CairoOperator::OVER - - - The operators marked as unbounded modify their destination even outside of the mask layer (that is, - their effect is not bound by the mask layer). However, their effect can still be limited by way of clipping. - - - To keep things simple, the operator descriptions here document the behavior for when both source and destination - are either fully transparent or fully opaque. The actual implementation works for translucent layers too. - For a more detailed explanation of the effects of each operator, including the mathematical definitions, - see http://cairographics.org/operators/. - -
- - -
- &reftitle.classsynopsis; - - - - CairoOperator - - - - - CairoOperator - - - - &Constants; - - const - integer - CairoOperator::CLEAR - 0 - - - const - integer - CairoOperator::SOURCE - 1 - - - const - integer - CairoOperator::OVER - 2 - - - const - integer - CairoOperator::IN - 3 - - - const - integer - CairoOperator::OUT - 4 - - - const - integer - CairoOperator::ATOP - 5 - - - const - integer - CairoOperator::DEST - 6 - - - const - integer - CairoOperator::DEST_OVER - 7 - - - const - integer - CairoOperator::DEST_IN - 8 - - - const - integer - CairoOperator::DEST_OUT - 9 - - - const - integer - CairoOperator::DEST_ATOP - 10 - - - const - integer - CairoOperator::XOR - 11 - - - const - integer - CairoOperator::ADD - 12 - - - const - integer - CairoOperator::SATURATE - 13 - - - - - -
- - -
- &reftitle.constants; - - - - CairoOperator::CLEAR - - Clear destination layer (bounded) - - - - - CairoOperator::SOURCE - - Replace destination layer (bounded) - - - - - CairoOperator::OVER - - Draw source layer on top of destination layer (bounded) - - - - - CairoOperator::IN - - Draw source where there was destination content (unbounded) - - - - - CairoOperator::OUT - - Draw source where there was no destination content (unbounded) - - - - - CairoOperator::ATOP - - Draw source on top of destination content and only there - - - - - CairoOperator::DEST - - Ignore the source - - - - - CairoOperator::DEST_OVER - - Draw destination on top of source - - - - - CairoOperator::DEST_IN - - Leave destination only where there was source content (unbounded) - - - - - CairoOperator::DEST_OUT - - Leave destination only where there was no source content - - - - - CairoOperator::DEST_ATOP - - Leave destination on top of source content and only there (unbounded) - - - - - CairoOperator::XOR - - Source and destination are shown where there is only one of them - - - - - CairoOperator::ADD - - Source and destination layers are accumulated - - - - - CairoOperator::SATURATE - - Like CairoOperator::OVER, but assuming source and dest are disjoint geometries - - - - -
- - - - - - - - - - diff --git a/reference/cairo/cairopath.xml b/reference/cairo/cairopath.xml deleted file mode 100644 index a54841cb92b4..000000000000 --- a/reference/cairo/cairopath.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - The CairoPath class - CairoPath - - - - -
- &reftitle.intro; - - - - - Note: CairoPath class cannot be instantiated directly, doing so will result in Fatal Error if used or passed - -
- - -
- &reftitle.classsynopsis; - - - - CairoPath - - - - - CairoPath - - - - - - - -
- - - - - - - - diff --git a/reference/cairo/cairopattern.xml b/reference/cairo/cairopattern.xml deleted file mode 100644 index ad0e70036404..000000000000 --- a/reference/cairo/cairopattern.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - The CairoPattern class - CairoPattern - - - - -
- &reftitle.intro; - - CairoPattern is the abstract base class from which all the other pattern classes derive. - It cannot be instantiated directly - -
- - -
- &reftitle.classsynopsis; - - - - CairoPattern - - - - - CairoPattern - - - - - &Methods; - - - - -
- - - - &reference.cairo.entities.cairopattern; - - - - diff --git a/reference/cairo/cairopattern/construct.xml b/reference/cairo/cairopattern/construct.xml deleted file mode 100644 index aac023e3a444..000000000000 --- a/reference/cairo/cairopattern/construct.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoPattern::__construct - The __construct purpose - - - - &reftitle.description; - - public CairoPattern::__construct - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoPattern::__construct</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairopattern/getmatrix.xml b/reference/cairo/cairopattern/getmatrix.xml deleted file mode 100644 index aa6e4eafe43a..000000000000 --- a/reference/cairo/cairopattern/getmatrix.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoPattern::getMatrix - cairo_get_matrix - The getMatrix purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoPattern::getMatrix - - - &style.procedural;: - - voidcairo_get_matrix - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairopattern/gettype.xml b/reference/cairo/cairopattern/gettype.xml deleted file mode 100644 index e42e96de6c77..000000000000 --- a/reference/cairo/cairopattern/gettype.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoPattern::getType - The getType purpose - - - - &reftitle.description; - - public intCairoPattern::getType - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoPattern::getType</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairopattern/setmatrix.xml b/reference/cairo/cairopattern/setmatrix.xml deleted file mode 100644 index a1028a4982f9..000000000000 --- a/reference/cairo/cairopattern/setmatrix.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - - CairoPattern::setMatrix - cairo_set_matrix - The setMatrix purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoPattern::setMatrix - CairoMatrixmatrix - - &style.procedural;: - - voidcairo_set_matrix - CairoContextcontext - CairoMatrixmatrix - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - matrix - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairopattern/status.xml b/reference/cairo/cairopattern/status.xml deleted file mode 100644 index 2fc11d01853a..000000000000 --- a/reference/cairo/cairopattern/status.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoPattern::status - cairo_status - The status purpose - - - - &reftitle.description; - &style.oop; (method): - - public intCairoPattern::status - - - &style.procedural;: - - intcairo_status - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairopatterntype.xml b/reference/cairo/cairopatterntype.xml deleted file mode 100644 index 0d72e96cddf9..000000000000 --- a/reference/cairo/cairopatterntype.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - The CairoPatternType class - CairoPatternType - - - - -
- &reftitle.intro; - - CairoPatternType is used to describe the type of a given pattern. - - - The type of a pattern is determined by the function used to create it. - The cairo_pattern_create_rgb and cairo_pattern_create_rgba - functions create CairoPatternType::SOLID patterns. The remaining - cairo_pattern_create_* functions map to pattern types in obvious ways. - -
- - -
- &reftitle.classsynopsis; - - - - CairoPatternType - - - - - CairoPatternType - - - - &Constants; - - const - integer - CairoPatternType::SOLID - 0 - - - const - integer - CairoPatternType::SURFACE - 1 - - - const - integer - CairoPatternType::LINEAR - 2 - - - const - integer - CairoPatternType::RADIAL - 3 - - - - - -
- - -
- &reftitle.constants; - - - - CairoPatternType::SOLID - - The pattern is a solid (uniform) color. It may be opaque or translucent. - - - - - CairoPatternType::SURFACE - - The pattern is a based on a surface (an image). - - - - - CairoPatternType::LINEAR - - The pattern is a linear gradient. - - - - - CairoPatternType::RADIAL - - The pattern is a radial gradient. - - - - -
- - - - - - - - - - diff --git a/reference/cairo/cairopdfsurface.xml b/reference/cairo/cairopdfsurface.xml deleted file mode 100644 index 999796fe23fc..000000000000 --- a/reference/cairo/cairopdfsurface.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - The CairoPdfSurface class - CairoPdfSurface - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - CairoPdfSurface - - - - - CairoPdfSurface - - - - extends - CairoSurface - - - - - &Methods; - - - &InheritedMethods; - - - - - -
- - - - &reference.cairo.entities.cairopdfsurface; - - - - diff --git a/reference/cairo/cairopdfsurface/construct.xml b/reference/cairo/cairopdfsurface/construct.xml deleted file mode 100644 index 4f35e3906133..000000000000 --- a/reference/cairo/cairopdfsurface/construct.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - CairoPdfSurface::__construct - The __construct purpose - - - - &reftitle.description; - - public CairoPdfSurface::__construct - stringfile - floatwidth - floatheight - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - file - - - Description... - - - - - width - - - Description... - - - - - height - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoPdfSurface::__construct</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairopdfsurface/setsize.xml b/reference/cairo/cairopdfsurface/setsize.xml deleted file mode 100644 index e0a91be52ae4..000000000000 --- a/reference/cairo/cairopdfsurface/setsize.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - CairoPdfSurface::setSize - The setSize purpose - - - - &reftitle.description; - - public voidCairoPdfSurface::setSize - floatwidth - floatheight - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - width - - - Description... - - - - - height - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoPdfSurface::setSize</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairopslevel.xml b/reference/cairo/cairopslevel.xml deleted file mode 100644 index b845f98703a2..000000000000 --- a/reference/cairo/cairopslevel.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - The CairoPsLevel class - CairoPsLevel - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - CairoPsLevel - - - - - CairoPsLevel - - - - &Constants; - - const - integer - CairoPsLevel::LEVEL_2 - 0 - - - const - integer - CairoPsLevel::LEVEL_3 - 1 - - - - - -
- - -
- &reftitle.constants; - - - - CairoPsLevel::LEVEL_2 - - Description here... - - - - - CairoPsLevel::LEVEL_3 - - Description here... - - - - -
- - - - - - - - - - diff --git a/reference/cairo/cairopssurface.xml b/reference/cairo/cairopssurface.xml deleted file mode 100644 index aa1feaddb06a..000000000000 --- a/reference/cairo/cairopssurface.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - The CairoPsSurface class - CairoPsSurface - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - CairoPsSurface - - - - - CairoPsSurface - - - - extends - CairoSurface - - - - - &Methods; - - - &InheritedMethods; - - - - - -
- - - - &reference.cairo.entities.cairopssurface; - - - - diff --git a/reference/cairo/cairopssurface/construct.xml b/reference/cairo/cairopssurface/construct.xml deleted file mode 100644 index 94acfcdea821..000000000000 --- a/reference/cairo/cairopssurface/construct.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - CairoPsSurface::__construct - The __construct purpose - - - - &reftitle.description; - - public CairoPsSurface::__construct - stringfile - floatwidth - floatheight - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - file - - - Description... - - - - - width - - - Description... - - - - - height - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoPsSurface::__construct</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairopssurface/dscbeginpagesetup.xml b/reference/cairo/cairopssurface/dscbeginpagesetup.xml deleted file mode 100644 index b01838c28cec..000000000000 --- a/reference/cairo/cairopssurface/dscbeginpagesetup.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoPsSurface::dscBeginPageSetup - The dscBeginPageSetup purpose - - - - &reftitle.description; - - public voidCairoPsSurface::dscBeginPageSetup - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoPsSurface::dscBeginPageSetup</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairopssurface/dscbeginsetup.xml b/reference/cairo/cairopssurface/dscbeginsetup.xml deleted file mode 100644 index c7627b4a2bc7..000000000000 --- a/reference/cairo/cairopssurface/dscbeginsetup.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoPsSurface::dscBeginSetup - The dscBeginSetup purpose - - - - &reftitle.description; - - public voidCairoPsSurface::dscBeginSetup - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoPsSurface::dscBeginSetup</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairopssurface/dsccomment.xml b/reference/cairo/cairopssurface/dsccomment.xml deleted file mode 100644 index 196a5ee1a548..000000000000 --- a/reference/cairo/cairopssurface/dsccomment.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - CairoPsSurface::dscComment - The dscComment purpose - - - - &reftitle.description; - - public voidCairoPsSurface::dscComment - stringcomment - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - comment - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoPsSurface::dscComment</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairopssurface/geteps.xml b/reference/cairo/cairopssurface/geteps.xml deleted file mode 100644 index d28a634a97e1..000000000000 --- a/reference/cairo/cairopssurface/geteps.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoPsSurface::getEps - The getEps purpose - - - - &reftitle.description; - - public boolCairoPsSurface::getEps - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoPsSurface::getEps</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairopssurface/getlevels.xml b/reference/cairo/cairopssurface/getlevels.xml deleted file mode 100644 index e6ee0852430a..000000000000 --- a/reference/cairo/cairopssurface/getlevels.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoPsSurface::getLevels - The getLevels purpose - - - - &reftitle.description; - - public static arrayCairoPsSurface::getLevels - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoPsSurface::getLevels</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairopssurface/leveltostring.xml b/reference/cairo/cairopssurface/leveltostring.xml deleted file mode 100644 index 1ac0361ca6a8..000000000000 --- a/reference/cairo/cairopssurface/leveltostring.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - CairoPsSurface::levelToString - The levelToString purpose - - - - &reftitle.description; - - public static stringCairoPsSurface::levelToString - intlevel - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - level - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoPsSurface::levelToString</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairopssurface/restricttolevel.xml b/reference/cairo/cairopssurface/restricttolevel.xml deleted file mode 100644 index 6121bbb5ee89..000000000000 --- a/reference/cairo/cairopssurface/restricttolevel.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - CairoPsSurface::restrictToLevel - The restrictToLevel purpose - - - - &reftitle.description; - - public voidCairoPsSurface::restrictToLevel - intlevel - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - level - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoPsSurface::restrictToLevel</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairopssurface/seteps.xml b/reference/cairo/cairopssurface/seteps.xml deleted file mode 100644 index 0177bab3bdea..000000000000 --- a/reference/cairo/cairopssurface/seteps.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - CairoPsSurface::setEps - The setEps purpose - - - - &reftitle.description; - - public voidCairoPsSurface::setEps - boollevel - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - level - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoPsSurface::setEps</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairopssurface/setsize.xml b/reference/cairo/cairopssurface/setsize.xml deleted file mode 100644 index 6144b45c31b0..000000000000 --- a/reference/cairo/cairopssurface/setsize.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - CairoPsSurface::setSize - The setSize purpose - - - - &reftitle.description; - - public voidCairoPsSurface::setSize - floatwidth - floatheight - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - width - - - Description... - - - - - height - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoPsSurface::setSize</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairoradialgradient.xml b/reference/cairo/cairoradialgradient.xml deleted file mode 100644 index c47435293e76..000000000000 --- a/reference/cairo/cairoradialgradient.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - The CairoRadialGradient class - CairoRadialGradient - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - CairoRadialGradient - - - - - CairoRadialGradient - - - - extends - CairoGradientPattern - - - - - &Methods; - - - &InheritedMethods; - - - - - -
- - - - &reference.cairo.entities.cairoradialgradient; - - - - diff --git a/reference/cairo/cairoradialgradient/construct.xml b/reference/cairo/cairoradialgradient/construct.xml deleted file mode 100644 index 715a0aa0eb4b..000000000000 --- a/reference/cairo/cairoradialgradient/construct.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - CairoRadialGradient::__construct - The __construct purpose - - - - &reftitle.description; - &style.oop;: - - public CairoRadialGradient::__construct - floatx0 - floaty0 - floatr0 - floatx1 - floaty1 - floatr1 - - &style.procedural;: - - Creates a new radial gradient CairoPattern between the two circles defined by (x0, y0, r0) - and (x1, y1, r1). Before using the gradient pattern, a number of color stops should be defined - using CairoRadialGradient::addColorStopRgb - or CairoRadialGradient::addColorStopRgba. - - - - Note: The coordinates here are in pattern space. For a new pattern, pattern space is identical to user - space, but the relationship between the spaces can be changed with CairoRadialGradient::setMatrix. - - - - - - &reftitle.parameters; - - - - x0 - - - x coordinate for the center of the start circle. - - - - - y0 - - - y coordinate for the center of the start circle. - - - - - r0 - - - radius of the start circle. - - - - - x1 - - - x coordinate for the center of the end circle. - - - - - y1 - - - y coordinate for the center of the end circle. - - - - - r1 - - - radius of the end circle. - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoRadialGradient::__construct</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairoradialgradient/getcircles.xml b/reference/cairo/cairoradialgradient/getcircles.xml deleted file mode 100644 index 93333ced0139..000000000000 --- a/reference/cairo/cairoradialgradient/getcircles.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoRadialGradient::getCircles - The getCircles purpose - - - - &reftitle.description; - - public arrayCairoRadialGradient::getCircles - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoRadialGradient::getCircles</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairoscaledfont.xml b/reference/cairo/cairoscaledfont.xml deleted file mode 100644 index 2c027724a55f..000000000000 --- a/reference/cairo/cairoscaledfont.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The CairoScaledFont class - CairoScaledFont - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - CairoScaledFont - - - - - CairoScaledFont - - - - - &Methods; - - - - -
- - - - &reference.cairo.entities.cairoscaledfont; - - - - diff --git a/reference/cairo/cairoscaledfont/construct.xml b/reference/cairo/cairoscaledfont/construct.xml deleted file mode 100644 index 24b5ef6930cd..000000000000 --- a/reference/cairo/cairoscaledfont/construct.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - CairoScaledFont::__construct - The __construct purpose - - - - &reftitle.description; - - public CairoScaledFont::__construct - CairoFontFacefont_face - CairoMatrixmatrix - CairoMatrixctm - CairoFontOptionsoptions - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - font_face - - - Description... - - - - - matrix - - - Description... - - - - - ctm - - - Description... - - - - - options - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoScaledFont::__construct</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairoscaledfont/extents.xml b/reference/cairo/cairoscaledfont/extents.xml deleted file mode 100644 index 2b2711cf4042..000000000000 --- a/reference/cairo/cairoscaledfont/extents.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoScaledFont::extents - The extents purpose - - - - &reftitle.description; - - public arrayCairoScaledFont::extents - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoScaledFont::extents</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairoscaledfont/getctm.xml b/reference/cairo/cairoscaledfont/getctm.xml deleted file mode 100644 index 231135de3dee..000000000000 --- a/reference/cairo/cairoscaledfont/getctm.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoScaledFont::getCtm - The getCtm purpose - - - - &reftitle.description; - - public CairoMatrixCairoScaledFont::getCtm - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoScaledFont::getCtm</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairoscaledfont/getfontface.xml b/reference/cairo/cairoscaledfont/getfontface.xml deleted file mode 100644 index b96dcb3c4ada..000000000000 --- a/reference/cairo/cairoscaledfont/getfontface.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoScaledFont::getFontFace - cairo_get_font_face - The getFontFace purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoScaledFont::getFontFace - - - &style.procedural;: - - voidcairo_get_font_face - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairoscaledfont/getfontmatrix.xml b/reference/cairo/cairoscaledfont/getfontmatrix.xml deleted file mode 100644 index c5ee6f4fd7a3..000000000000 --- a/reference/cairo/cairoscaledfont/getfontmatrix.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoScaledFont::getFontMatrix - cairo_get_font_matrix - The getFontMatrix purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoScaledFont::getFontMatrix - - - &style.procedural;: - - voidcairo_get_font_matrix - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairoscaledfont/getfontoptions.xml b/reference/cairo/cairoscaledfont/getfontoptions.xml deleted file mode 100644 index 57581dd2e1bf..000000000000 --- a/reference/cairo/cairoscaledfont/getfontoptions.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoScaledFont::getFontOptions - cairo_get_font_options - The getFontOptions purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoScaledFont::getFontOptions - - - &style.procedural;: - - voidcairo_get_font_options - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairoscaledfont/getscalematrix.xml b/reference/cairo/cairoscaledfont/getscalematrix.xml deleted file mode 100644 index 4261938916b1..000000000000 --- a/reference/cairo/cairoscaledfont/getscalematrix.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoScaledFont::getScaleMatrix - The getScaleMatrix purpose - - - - &reftitle.description; - - public voidCairoScaledFont::getScaleMatrix - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoScaledFont::getScaleMatrix</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairoscaledfont/gettype.xml b/reference/cairo/cairoscaledfont/gettype.xml deleted file mode 100644 index f9fc45cbd80f..000000000000 --- a/reference/cairo/cairoscaledfont/gettype.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoScaledFont::getType - The getType purpose - - - - &reftitle.description; - - public intCairoScaledFont::getType - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoScaledFont::getType</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairoscaledfont/glyphextents.xml b/reference/cairo/cairoscaledfont/glyphextents.xml deleted file mode 100644 index 4a2952fdfe88..000000000000 --- a/reference/cairo/cairoscaledfont/glyphextents.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - CairoScaledFont::glyphExtents - The glyphExtents purpose - - - - &reftitle.description; - - public arrayCairoScaledFont::glyphExtents - arrayglyphs - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - glyphs - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoScaledFont::glyphExtents</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairoscaledfont/status.xml b/reference/cairo/cairoscaledfont/status.xml deleted file mode 100644 index e0989d5c9a14..000000000000 --- a/reference/cairo/cairoscaledfont/status.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoScaledFont::status - cairo_status - The status purpose - - - - &reftitle.description; - &style.oop; (method): - - public intCairoScaledFont::status - - - &style.procedural;: - - intcairo_status - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairoscaledfont/textextents.xml b/reference/cairo/cairoscaledfont/textextents.xml deleted file mode 100644 index 78dc972dfe4b..000000000000 --- a/reference/cairo/cairoscaledfont/textextents.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - CairoScaledFont::textExtents - cairo_text_extents - The textExtents purpose - - - - &reftitle.description; - &style.oop; (method): - - public arrayCairoScaledFont::textExtents - stringtext - - &style.procedural;: - - arraycairo_text_extents - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - text - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairosolidpattern.xml b/reference/cairo/cairosolidpattern.xml deleted file mode 100644 index 3f47dafe0fc1..000000000000 --- a/reference/cairo/cairosolidpattern.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - The CairoSolidPattern class - CairoSolidPattern - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - CairoSolidPattern - - - - - CairoSolidPattern - - - - extends - CairoPattern - - - - - &Methods; - - - &InheritedMethods; - - - - - -
- - - - &reference.cairo.entities.cairosolidpattern; - - - - diff --git a/reference/cairo/cairosolidpattern/construct.xml b/reference/cairo/cairosolidpattern/construct.xml deleted file mode 100644 index ec5041e55ec9..000000000000 --- a/reference/cairo/cairosolidpattern/construct.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - CairoSolidPattern::__construct - The __construct purpose - - - - &reftitle.description; - - public CairoSolidPattern::__construct - floatred - floatgreen - floatblue - floatalpha0 - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - red - - - Description... - - - - - green - - - Description... - - - - - blue - - - Description... - - - - - alpha - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoSolidPattern::__construct</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairosolidpattern/getrgba.xml b/reference/cairo/cairosolidpattern/getrgba.xml deleted file mode 100644 index 752174f8504b..000000000000 --- a/reference/cairo/cairosolidpattern/getrgba.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoSolidPattern::getRgba - The getRgba purpose - - - - &reftitle.description; - - public arrayCairoSolidPattern::getRgba - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoSolidPattern::getRgba</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairostatus.xml b/reference/cairo/cairostatus.xml deleted file mode 100644 index 6e5ba1d0a23a..000000000000 --- a/reference/cairo/cairostatus.xml +++ /dev/null @@ -1,407 +0,0 @@ - - - - - - The CairoStatus class - CairoStatus - - - - -
- &reftitle.intro; - - CairoStatus is used to indicate errors that can occur when using Cairo. - In some cases it is returned directly by functions. but when using CairoContext, - the last error, if any, is stored in the object and can be retrieved with CairoContext::status - or cairo_status. New entries may be added in future versions. - - Use Cairo::statusToString or cairo_status_to_string to get a - human-readable representation of an error message. - -
- - -
- &reftitle.classsynopsis; - - - - CairoStatus - - - - - CairoStatus - - - - &Constants; - - const - integer - CairoStatus::SUCCESS - 0 - - - const - integer - CairoStatus::NO_MEMORY - 1 - - - const - integer - CairoStatus::INVALID_RESTORE - 2 - - - const - integer - CairoStatus::INVALID_POP_GROUP - 3 - - - const - integer - CairoStatus::NO_CURRENT_POINT - 4 - - - const - integer - CairoStatus::INVALID_MATRIX - 5 - - - const - integer - CairoStatus::INVALID_STATUS - 6 - - - const - integer - CairoStatus::NULL_POINTER - 7 - - - const - integer - CairoStatus::INVALID_STRING - 8 - - - const - integer - CairoStatus::INVALID_PATH_DATA - 9 - - - const - integer - CairoStatus::READ_ERROR - 10 - - - const - integer - CairoStatus::WRITE_ERROR - 11 - - - const - integer - CairoStatus::SURFACE_FINISHED - 12 - - - const - integer - CairoStatus::SURFACE_TYPE_MISMATCH - 13 - - - const - integer - CairoStatus::PATTERN_TYPE_MISMATCH - 14 - - - const - integer - CairoStatus::INVALID_CONTENT - 15 - - - const - integer - CairoStatus::INVALID_FORMAT - 16 - - - const - integer - CairoStatus::INVALID_VISUAL - 17 - - - const - integer - CairoStatus::FILE_NOT_FOUND - 18 - - - const - integer - CairoStatus::INVALID_DASH - 19 - - - const - integer - CairoStatus::INVALID_DSC_COMMENT - 20 - - - const - integer - CairoStatus::INVALID_INDEX - 21 - - - const - integer - CairoStatus::CLIP_NOT_REPRESENTABLE - 22 - - - const - integer - CairoStatus::TEMP_FILE_ERROR - 23 - - - const - integer - CairoStatus::INVALID_STRIDE - 24 - - - - - -
- - -
- &reftitle.constants; - - - - CairoStatus::SUCCESS - - No error has occurred - - - - - CairoStatus::NO_MEMORY - - Out of memory - - - - - CairoStatus::INVALID_RESTORE - - cairo_restore called without matching cairo_save - - - - - CairoStatus::INVALID_POP_GROUP - - No saved group to pop - - - - - CairoStatus::NO_CURRENT_POINT - - No current point defined - - - - - CairoStatus::INVALID_MATRIX - - Invalid matrix (not invertible) - - - - - CairoStatus::INVALID_STATUS - - Invalid value for an input CairoStatus> - - - - - CairoStatus::NULL_POINTER - - Null pointer - - - - - CairoStatus::INVALID_STRING - - Input string not valid UTF-8 string - - - - - CairoStatus::INVALID_PATH_DATA - - Input path data not valid - - - - - CairoStatus::READ_ERROR - - Error while reading from input stream - - - - - CairoStatus::WRITE_ERROR - - Error while writing to output stream - - - - - CairoStatus::SURFACE_FINISHED - - Target surface has been finished - - - - - CairoStatus::SURFACE_TYPE_MISMATCH - - The surface type is not appropriate for the operation - - - - - CairoStatus::PATTERN_TYPE_MISMATCH - - The pattern type is not appropriate for the operation - - - - - CairoStatus::INVALID_CONTENT - - Invalid value for an input CairoContent - - - - - CairoStatus::INVALID_FORMAT - - Invalid value for an input CairoFormat - - - - - CairoStatus::INVALID_VISUAL - - Invalid value for an input Visual - - - - - CairoStatus::FILE_NOT_FOUND - - File not found - - - - - CairoStatus::INVALID_DASH - - Invalid value for a dash setting - - - - - CairoStatus::INVALID_DSC_COMMENT - - Invalid value for a DSC comment - - - - - CairoStatus::INVALID_INDEX - - Invalid index passed to getter - - - - - CairoStatus::CLIP_NOT_REPRESENTABLE - - Clip region not representable in desired format - - - - - CairoStatus::TEMP_FILE_ERROR - - Error creating or writing to a temporary file - - - - - CairoStatus::INVALID_STRIDE - - Invalid value for CairoStride - - - - -
- - - - - - - - - - diff --git a/reference/cairo/cairosubpixelorder.xml b/reference/cairo/cairosubpixelorder.xml deleted file mode 100644 index 6af42e5f1b1d..000000000000 --- a/reference/cairo/cairosubpixelorder.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - The CairoSubpixelOrder class - CairoSubpixelOrder - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - CairoSubpixelOrder - - - - - CairoSubpixelOrder - - - - &Constants; - - const - integer - CairoSubpixelOrder::ORDER_DEFAULT - 0 - - - const - integer - CairoSubpixelOrder::ORDER_RGB - 1 - - - const - integer - CairoSubpixelOrder::ORDER_BGR - 2 - - - const - integer - CairoSubpixelOrder::ORDER_VRGB - 3 - - - const - integer - CairoSubpixelOrder::ORDER_VBGR - 4 - - - - - -
- - -
- &reftitle.constants; - - - - CairoSubpixelOrder::ORDER_DEFAULT - - Description here... - - - - - CairoSubpixelOrder::ORDER_RGB - - Description here... - - - - - CairoSubpixelOrder::ORDER_BGR - - Description here... - - - - - CairoSubpixelOrder::ORDER_VRGB - - Description here... - - - - - CairoSubpixelOrder::ORDER_VBGR - - Description here... - - - - -
- - - - - - - - - - diff --git a/reference/cairo/cairosurface.xml b/reference/cairo/cairosurface.xml deleted file mode 100644 index 34ad47b61098..000000000000 --- a/reference/cairo/cairosurface.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - - The CairoSurface class - CairoSurface - - - - -
- &reftitle.intro; - - This is the base-class for all other Surface types. - - CairoSurface is the abstract type representing all different drawing targets that cairo can render to. The actual drawings are performed using a CairoContext. - -
- - -
- &reftitle.classsynopsis; - - - - CairoSurface - - - - - CairoSurface - - - - - &Methods; - - - - -
- - - - &reference.cairo.entities.cairosurface; - - - - diff --git a/reference/cairo/cairosurface/construct.xml b/reference/cairo/cairosurface/construct.xml deleted file mode 100644 index 85f2a905e603..000000000000 --- a/reference/cairo/cairosurface/construct.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - CairoSurface::__construct - The __construct purpose - - - - &reftitle.description; - - public CairoSurface::__construct - - - - CairoSurface is an abstract type and, as such, should not be instantiated in your PHP scripts. - - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - No return value - - - - - &reftitle.notes; - - - If you're using a PHP version before 5.3, you must destroy the CairoContext - associated with a CairoSurface after you destroy the - CairoSurface. Otherwise, you're left with a Circular-reference memory leak. - - - - - - &reftitle.seealso; - - - CairoImageSurface::__construct - - - - - - - diff --git a/reference/cairo/cairosurface/copypage.xml b/reference/cairo/cairosurface/copypage.xml deleted file mode 100644 index b2bb2c8899c1..000000000000 --- a/reference/cairo/cairosurface/copypage.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - CairoSurface::copyPage - cairo_copy_page - The copyPage purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoSurface::copyPage - - - &style.procedural;: - - voidcairo_copy_page - CairoContextcontext - - - Emits the current page for backends that support multiple pages, but doesn't clear it, so that the contents of the current page will be retained for the next page. Use CairoSurface::showPage() if you want to get an empty page after the emission. - - - - - &reftitle.parameters; - - - - context - - - A CairoContext object - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairosurface/createsimilar.xml b/reference/cairo/cairosurface/createsimilar.xml deleted file mode 100644 index 7462e4f3fcc9..000000000000 --- a/reference/cairo/cairosurface/createsimilar.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - CairoSurface::createSimilar - The createSimilar purpose - - - - &reftitle.description; - - public voidCairoSurface::createSimilar - CairoSurfaceother - intcontent - stringwidth - stringheight - - - Create a new surface that is as compatible as possible with an existing surface. For example the new surface will have the same fallback resolution and font options as other. Generally, the new surface will also use the same backend as other, unless that is not possible for some reason. The type of the returned surface may be examined with CairoSurface::getType(). - - Initially the surface contents are all 0 (transparent if contents have transparency, black otherwise.) - - - - - - &reftitle.parameters; - - - - other - - - An existing surface used to select the backend of the new surface - - - - - content - - - The content for the new surface. See the CairoContent class for possible values. - - - - - width - - - Width of the new surface, (in device-space units). - - - - - height - - - Height of the new surface, (in device-space units). - - - - - - - - - &reftitle.returnvalues; - - A new CairoSurface - - - - - &reftitle.examples; - - - <methodname>CairoSurface::createSimilar</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - CairoContent - - - - - - - diff --git a/reference/cairo/cairosurface/finish.xml b/reference/cairo/cairosurface/finish.xml deleted file mode 100644 index ddc6c9836863..000000000000 --- a/reference/cairo/cairosurface/finish.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoSurface::finish - The finish purpose - - - - &reftitle.description; - - public voidCairoSurface::finish - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoSurface::finish</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairosurface/flush.xml b/reference/cairo/cairosurface/flush.xml deleted file mode 100644 index c53353e1e8c4..000000000000 --- a/reference/cairo/cairosurface/flush.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoSurface::flush - The flush purpose - - - - &reftitle.description; - - public voidCairoSurface::flush - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoSurface::flush</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairosurface/getcontent.xml b/reference/cairo/cairosurface/getcontent.xml deleted file mode 100644 index 4df9a9ddc8ca..000000000000 --- a/reference/cairo/cairosurface/getcontent.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoSurface::getContent - The getContent purpose - - - - &reftitle.description; - - public intCairoSurface::getContent - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoSurface::getContent</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairosurface/getdeviceoffset.xml b/reference/cairo/cairosurface/getdeviceoffset.xml deleted file mode 100644 index f26447a5578c..000000000000 --- a/reference/cairo/cairosurface/getdeviceoffset.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoSurface::getDeviceOffset - The getDeviceOffset purpose - - - - &reftitle.description; - - public arrayCairoSurface::getDeviceOffset - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoSurface::getDeviceOffset</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairosurface/getfontoptions.xml b/reference/cairo/cairosurface/getfontoptions.xml deleted file mode 100644 index 346695aa5ee6..000000000000 --- a/reference/cairo/cairosurface/getfontoptions.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoSurface::getFontOptions - cairo_get_font_options - The getFontOptions purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoSurface::getFontOptions - - - &style.procedural;: - - voidcairo_get_font_options - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairosurface/gettype.xml b/reference/cairo/cairosurface/gettype.xml deleted file mode 100644 index 950077be8c3a..000000000000 --- a/reference/cairo/cairosurface/gettype.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoSurface::getType - The getType purpose - - - - &reftitle.description; - - public intCairoSurface::getType - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoSurface::getType</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairosurface/markdirty.xml b/reference/cairo/cairosurface/markdirty.xml deleted file mode 100644 index bd5926f8afbe..000000000000 --- a/reference/cairo/cairosurface/markdirty.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoSurface::markDirty - The markDirty purpose - - - - &reftitle.description; - - public voidCairoSurface::markDirty - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoSurface::markDirty</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairosurface/markdirtyrectangle.xml b/reference/cairo/cairosurface/markdirtyrectangle.xml deleted file mode 100644 index c1a0538e6353..000000000000 --- a/reference/cairo/cairosurface/markdirtyrectangle.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - CairoSurface::markDirtyRectangle - The markDirtyRectangle purpose - - - - &reftitle.description; - - public voidCairoSurface::markDirtyRectangle - floatx - floaty - floatwidth - floatheight - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - x - - - Description... - - - - - y - - - Description... - - - - - width - - - Description... - - - - - height - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoSurface::markDirtyRectangle</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairosurface/setdeviceoffset.xml b/reference/cairo/cairosurface/setdeviceoffset.xml deleted file mode 100644 index 91688160573e..000000000000 --- a/reference/cairo/cairosurface/setdeviceoffset.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - CairoSurface::setDeviceOffset - The setDeviceOffset purpose - - - - &reftitle.description; - - public voidCairoSurface::setDeviceOffset - floatx - floaty - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - x - - - Description... - - - - - y - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoSurface::setDeviceOffset</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairosurface/setfallbackresolution.xml b/reference/cairo/cairosurface/setfallbackresolution.xml deleted file mode 100644 index c455b1190e31..000000000000 --- a/reference/cairo/cairosurface/setfallbackresolution.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - CairoSurface::setFallbackResolution - The setFallbackResolution purpose - - - - &reftitle.description; - - public voidCairoSurface::setFallbackResolution - floatx - floaty - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - x - - - Description... - - - - - y - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoSurface::setFallbackResolution</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairosurface/showpage.xml b/reference/cairo/cairosurface/showpage.xml deleted file mode 100644 index 178bba01acfc..000000000000 --- a/reference/cairo/cairosurface/showpage.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoSurface::showPage - cairo_show_page - The showPage purpose - - - - &reftitle.description; - &style.oop; (method): - - public voidCairoSurface::showPage - - - &style.procedural;: - - voidcairo_show_page - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairosurface/status.xml b/reference/cairo/cairosurface/status.xml deleted file mode 100644 index 87468788e3cf..000000000000 --- a/reference/cairo/cairosurface/status.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - CairoSurface::status - cairo_status - The status purpose - - - - &reftitle.description; - &style.oop; (method): - - public intCairoSurface::status - - - &style.procedural;: - - intcairo_status - CairoContextcontext - - - Description here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - context - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - &style.oop; - - -]]> - - &example.outputs.similar; - - - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairosurface/writetopng.xml b/reference/cairo/cairosurface/writetopng.xml deleted file mode 100644 index 0725debdbfed..000000000000 --- a/reference/cairo/cairosurface/writetopng.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - CairoSurface::writeToPng - The writeToPng purpose - - - - &reftitle.description; - - public voidCairoSurface::writeToPng - stringfile - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - file - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoSurface::writeToPng</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairosurfacepattern.xml b/reference/cairo/cairosurfacepattern.xml deleted file mode 100644 index b2d26bdcbf05..000000000000 --- a/reference/cairo/cairosurfacepattern.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - The CairoSurfacePattern class - CairoSurfacePattern - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - CairoSurfacePattern - - - - - CairoSurfacePattern - - - - extends - CairoPattern - - - - - &Methods; - - - &InheritedMethods; - - - - - -
- - - - &reference.cairo.entities.cairosurfacepattern; - - - - diff --git a/reference/cairo/cairosurfacepattern/construct.xml b/reference/cairo/cairosurfacepattern/construct.xml deleted file mode 100644 index c8038f183ed0..000000000000 --- a/reference/cairo/cairosurfacepattern/construct.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - CairoSurfacePattern::__construct - The __construct purpose - - - - &reftitle.description; - - public CairoSurfacePattern::__construct - CairoSurfacesurface - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoSurfacePattern::__construct</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairosurfacepattern/getextend.xml b/reference/cairo/cairosurfacepattern/getextend.xml deleted file mode 100644 index ec11e94a9db3..000000000000 --- a/reference/cairo/cairosurfacepattern/getextend.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoSurfacePattern::getExtend - The getExtend purpose - - - - &reftitle.description; - - public intCairoSurfacePattern::getExtend - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoSurfacePattern::getExtend</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairosurfacepattern/getfilter.xml b/reference/cairo/cairosurfacepattern/getfilter.xml deleted file mode 100644 index 4633002b07e3..000000000000 --- a/reference/cairo/cairosurfacepattern/getfilter.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoSurfacePattern::getFilter - The getFilter purpose - - - - &reftitle.description; - - public intCairoSurfacePattern::getFilter - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoSurfacePattern::getFilter</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairosurfacepattern/getsurface.xml b/reference/cairo/cairosurfacepattern/getsurface.xml deleted file mode 100644 index ea3881891887..000000000000 --- a/reference/cairo/cairosurfacepattern/getsurface.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - CairoSurfacePattern::getSurface - The getSurface purpose - - - - &reftitle.description; - - public voidCairoSurfacePattern::getSurface - - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoSurfacePattern::getSurface</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairosurfacepattern/setextend.xml b/reference/cairo/cairosurfacepattern/setextend.xml deleted file mode 100644 index a00f6dda75a8..000000000000 --- a/reference/cairo/cairosurfacepattern/setextend.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - CairoSurfacePattern::setExtend - The setExtend purpose - - - - &reftitle.description; - - public voidCairoSurfacePattern::setExtend - intextend - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - extend - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoSurfacePattern::setExtend</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairosurfacepattern/setfilter.xml b/reference/cairo/cairosurfacepattern/setfilter.xml deleted file mode 100644 index 227b7bf00c98..000000000000 --- a/reference/cairo/cairosurfacepattern/setfilter.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - CairoSurfacePattern::setFilter - The setFilter purpose - - - - &reftitle.description; - - public voidCairoSurfacePattern::setFilter - intfilter - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - filter - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoSurfacePattern::setFilter</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairosurfacetype.xml b/reference/cairo/cairosurfacetype.xml deleted file mode 100644 index cac7cadbb16b..000000000000 --- a/reference/cairo/cairosurfacetype.xml +++ /dev/null @@ -1,258 +0,0 @@ - - - - - - The CairoSurfaceType class - CairoSurfaceType - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - CairoSurfaceType - - - - - CairoSurfaceType - - - - &Constants; - - const - integer - CairoSurfaceType::IMAGE - 0 - - - const - integer - CairoSurfaceType::PDF - 1 - - - const - integer - CairoSurfaceType::PS - 2 - - - const - integer - CairoSurfaceType::XLIB - 3 - - - const - integer - CairoSurfaceType::XCB - 4 - - - const - integer - CairoSurfaceType::GLITZ - 5 - - - const - integer - CairoSurfaceType::QUARTZ - 6 - - - const - integer - CairoSurfaceType::WIN32 - 7 - - - const - integer - CairoSurfaceType::BEOS - 8 - - - const - integer - CairoSurfaceType::DIRECTFB - 9 - - - const - integer - CairoSurfaceType::SVG - 10 - - - const - integer - CairoSurfaceType::OS2 - 11 - - - const - integer - CairoSurfaceType::WIN32_PRINTING - 12 - - - const - integer - CairoSurfaceType::QUARTZ_IMAGE - 13 - - - - - -
- - -
- &reftitle.constants; - - - - CairoSurfaceType::IMAGE - - Description here... - - - - - CairoSurfaceType::PDF - - Description here... - - - - - CairoSurfaceType::PS - - Description here... - - - - - CairoSurfaceType::XLIB - - Description here... - - - - - CairoSurfaceType::XCB - - Description here... - - - - - CairoSurfaceType::GLITZ - - Description here... - - - - - CairoSurfaceType::QUARTZ - - Description here... - - - - - CairoSurfaceType::WIN32 - - Description here... - - - - - CairoSurfaceType::BEOS - - Description here... - - - - - CairoSurfaceType::DIRECTFB - - Description here... - - - - - CairoSurfaceType::SVG - - Description here... - - - - - CairoSurfaceType::OS2 - - Description here... - - - - - CairoSurfaceType::WIN32_PRINTING - - Description here... - - - - - CairoSurfaceType::QUARTZ_IMAGE - - Description here... - - - - -
- - - - - - - - - - diff --git a/reference/cairo/cairosvgsurface.xml b/reference/cairo/cairosvgsurface.xml deleted file mode 100644 index 91485973e8d3..000000000000 --- a/reference/cairo/cairosvgsurface.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - Svg Surface Backend - CairoSvgSurface - - - - -
- &reftitle.intro; - - Svg specific surface class, uses the SVG (standard vector graphics) surface backend. - -
- - -
- &reftitle.classsynopsis; - - - - CairoSvgSurface - - - - - CairoSvgSurface - - - - extends - CairoSurface - - - - - &Methods; - - - &InheritedMethods; - - - - - -
- - - - &reference.cairo.entities.cairosvgsurface; - - - - diff --git a/reference/cairo/cairosvgsurface/construct.xml b/reference/cairo/cairosvgsurface/construct.xml deleted file mode 100644 index 78a2c0302d6b..000000000000 --- a/reference/cairo/cairosvgsurface/construct.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - - CairoSvgSurface::__construct - The __construct purpose - - - - &reftitle.description; - - public CairoSvgSurface::__construct - stringfile - floatwidth - floatheight - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - file - - - Description... - - - - - width - - - Description... - - - - - height - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoSvgSurface::__construct</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairosvgsurface/getversions.xml b/reference/cairo/cairosvgsurface/getversions.xml deleted file mode 100644 index 46dcc8329e19..000000000000 --- a/reference/cairo/cairosvgsurface/getversions.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - CairoSvgSurface::getVersions - cairo_svg_surface_get_versions - Used to retrieve a list of supported SVG versions - - - - &reftitle.description; - &style.oop; (method): - - public static arrayCairoSvgSurface::getVersions - - - &style.procedural;: - - arraycairo_svg_get_versions - - - - Returns a numerically indexed array of currently available - CairoSvgVersion constants. In order to retrieve the - string values for each item, use - CairoSvgSurface::versionToString. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns a numerically indexed array of integer values. - - - - - &reftitle.examples; - - - <methodname>CairoSvgSurface::getVersions</methodname> example - - -]]> - - &example.outputs.similar; - - - int(0) - [1]=> - int(1) -} -SVG 1.1 -SVG 1.2 -]]> - - - - - - &style.procedural; - - -]]> - - &example.outputs.similar; - - - int(0) - [1]=> - int(1) -} -SVG 1.1 -SVG 1.2 -]]> - - - - - - - &reftitle.seealso; - - - CairoSvgSurface::versionToString - - - - - - - diff --git a/reference/cairo/cairosvgsurface/restricttoversion.xml b/reference/cairo/cairosvgsurface/restricttoversion.xml deleted file mode 100644 index cabe258519d3..000000000000 --- a/reference/cairo/cairosvgsurface/restricttoversion.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - CairoSvgSurface::restrictToVersion - The restrictToVersion purpose - - - - &reftitle.description; - - public voidCairoSvgSurface::restrictToVersion - intversion - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - version - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoSvgSurface::restrictToVersion</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairosvgsurface/versiontostring.xml b/reference/cairo/cairosvgsurface/versiontostring.xml deleted file mode 100644 index f30320cd2df5..000000000000 --- a/reference/cairo/cairosvgsurface/versiontostring.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - CairoSvgSurface::versionToString - The versionToString purpose - - - - &reftitle.description; - - public static stringCairoSvgSurface::versionToString - intversion - - - The method description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - version - - - Description... - - - - - - - - - &reftitle.returnvalues; - - Description... - - - - - &reftitle.examples; - - - <methodname>CairoSvgSurface::versionToString</methodname> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - Classname::Method - - - - - - - diff --git a/reference/cairo/cairosvgversion.xml b/reference/cairo/cairosvgversion.xml deleted file mode 100644 index 525569a325dd..000000000000 --- a/reference/cairo/cairosvgversion.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - The CairoSvgVersion class - CairoSvgVersion - - - - -
- &reftitle.intro; - - - -
- - -
- &reftitle.classsynopsis; - - - - CairoSvgVersion - - - - - CairoSvgVersion - - - - &Constants; - - const - integer - CairoSvgVersion::VERSION_1_1 - 0 - - - const - integer - CairoSvgVersion::VERSION_1_2 - 1 - - - - - -
- - -
- &reftitle.constants; - - - - CairoSvgVersion::VERSION_1_1 - - Description here... - - - - - CairoSvgVersion::VERSION_1_2 - - Description here... - - - - -
- - - - - - - - - - diff --git a/reference/cairo/cairotoyfontface.xml b/reference/cairo/cairotoyfontface.xml deleted file mode 100644 index f09e9954a519..000000000000 --- a/reference/cairo/cairotoyfontface.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - The CairoToyFontFace class - CairoToyFontFace - - - - -
- &reftitle.intro; - - The CairoToyFontFace class can be used instead of - CairoContext::selectFontFace to create a toy font independently of a context. - -
- - -
- &reftitle.classsynopsis; - - - - CairoToyFontFace - - - - - CairoToyFontFace - - - - extends - CairoFontFace - - - - - - &InheritedMethods; - - - - -
- - - - - - - - diff --git a/reference/cairo/constants.xml b/reference/cairo/constants.xml deleted file mode 100644 index 38611608714d..000000000000 --- a/reference/cairo/constants.xml +++ /dev/null @@ -1,1153 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - - CAIRO_STATUS_SUCCESS - (integer) - - - - - - - - - CAIRO_STATUS_NO_MEMORY - (integer) - - - - - - - - - CAIRO_STATUS_INVALID_RESTORE - (integer) - - - - - - - - - CAIRO_STATUS_INVALID_POP_GROUP - (integer) - - - - - - - - - CAIRO_STATUS_NO_CURRENT_POINT - (integer) - - - - - - - - - CAIRO_STATUS_INVALID_MATRIX - (integer) - - - - - - - - - CAIRO_STATUS_INVALID_STATUS - (integer) - - - - - - - - - CAIRO_STATUS_NULL_POINTER - (integer) - - - - - - - - - CAIRO_STATUS_INVALID_STRING - (integer) - - - - - - - - - CAIRO_STATUS_INVALID_PATH_DATA - (integer) - - - - - - - - - CAIRO_STATUS_READ_ERROR - (integer) - - - - - - - - - CAIRO_STATUS_WRITE_ERROR - (integer) - - - - - - - - - CAIRO_STATUS_SURFACE_FINISHED - (integer) - - - - - - - - - CAIRO_STATUS_SURFACE_TYPE_MISMATCH - (integer) - - - - - - - - - CAIRO_STATUS_PATTERN_TYPE_MISMATCH - (integer) - - - - - - - - - CAIRO_STATUS_INVALID_CONTENT - (integer) - - - - - - - - - CAIRO_STATUS_INVALID_FORMAT - (integer) - - - - - - - - - CAIRO_STATUS_INVALID_VISUAL - (integer) - - - - - - - - - CAIRO_STATUS_FILE_NOT_FOUND - (integer) - - - - - - - - - CAIRO_STATUS_INVALID_DASH - (integer) - - - - - - - - - CAIRO_STATUS_INVALID_DSC_COMMENT - (integer) - - - - - - - - - CAIRO_STATUS_INVALID_INDEX - (integer) - - - - - - - - - CAIRO_STATUS_CLIP_NOT_REPRESENTABLE - (integer) - - - - - - - - - CAIRO_STATUS_TEMP_FILE_ERROR - (integer) - - - - - - - - - CAIRO_STATUS_INVALID_STRIDE - (integer) - - - - - - - - - CAIRO_ANTIALIAS_DEFAULT - (integer) - - - - - - - - - CAIRO_ANTIALIAS_NONE - (integer) - - - - - - - - - CAIRO_ANTIALIAS_GRAY - (integer) - - - - - - - - - CAIRO_ANTIALIAS_SUBPIXEL - (integer) - - - - - - - - - CAIRO_SUBPIXEL_ORDER_DEFAULT - (integer) - - - - - - - - - CAIRO_SUBPIXEL_ORDER_RGB - (integer) - - - - - - - - - CAIRO_SUBPIXEL_ORDER_BGR - (integer) - - - - - - - - - CAIRO_SUBPIXEL_ORDER_VRGB - (integer) - - - - - - - - - CAIRO_SUBPIXEL_ORDER_VBGR - (integer) - - - - - - - - - CAIRO_FILL_RULE_WINDING - (integer) - - - - - - - - - CAIRO_FILL_RULE_EVEN_ODD - (integer) - - - - - - - - - CAIRO_LINE_CAP_BUTT - (integer) - - - - - - - - - CAIRO_LINE_CAP_ROUND - (integer) - - - - - - - - - CAIRO_LINE_CAP_SQUARE - (integer) - - - - - - - - - CAIRO_LINE_JOIN_MITER - (integer) - - - - - - - - - CAIRO_LINE_JOIN_ROUND - (integer) - - - - - - - - - CAIRO_LINE_JOIN_BEVEL - (integer) - - - - - - - - - CAIRO_OPERATOR_CLEAR - (integer) - - - - - - - - - CAIRO_OPERATOR_SOURCE - (integer) - - - - - - - - - CAIRO_OPERATOR_OVER - (integer) - - - - - - - - - CAIRO_OPERATOR_IN - (integer) - - - - - - - - - CAIRO_OPERATOR_OUT - (integer) - - - - - - - - - CAIRO_OPERATOR_ATOP - (integer) - - - - - - - - - CAIRO_OPERATOR_DEST - (integer) - - - - - - - - - CAIRO_OPERATOR_DEST_OVER - (integer) - - - - - - - - - CAIRO_OPERATOR_DEST_IN - (integer) - - - - - - - - - CAIRO_OPERATOR_DEST_OUT - (integer) - - - - - - - - - CAIRO_OPERATOR_DEST_ATOP - (integer) - - - - - - - - - CAIRO_OPERATOR_XOR - (integer) - - - - - - - - - CAIRO_OPERATOR_ADD - (integer) - - - - - - - - - CAIRO_OPERATOR_SATURATE - (integer) - - - - - - - - - CAIRO_PATTERN_TYPE_SOLID - (integer) - - - - - - - - - CAIRO_PATTERN_TYPE_SURFACE - (integer) - - - - - - - - - CAIRO_PATTERN_TYPE_LINEAR - (integer) - - - - - - - - - CAIRO_PATTERN_TYPE_RADIAL - (integer) - - - - - - - - - CAIRO_EXTEND_NONE - (integer) - - - - - - - - - CAIRO_EXTEND_REPEAT - (integer) - - - - - - - - - CAIRO_EXTEND_REFLECT - (integer) - - - - - - - - - CAIRO_EXTEND_PAD - (integer) - - - - - - - - - CAIRO_FILTER_FAST - (integer) - - - - - - - - - CAIRO_FILTER_GOOD - (integer) - - - - - - - - - CAIRO_FILTER_BEST - (integer) - - - - - - - - - CAIRO_FILTER_NEAREST - (integer) - - - - - - - - - CAIRO_FILTER_BILINEAR - (integer) - - - - - - - - - CAIRO_FILTER_GAUSSIAN - (integer) - - - - - - - - - CAIRO_HINT_STYLE_DEFAULT - (integer) - - - - - - - - - CAIRO_HINT_STYLE_NONE - (integer) - - - - - - - - - CAIRO_HINT_STYLE_SLIGHT - (integer) - - - - - - - - - CAIRO_HINT_STYLE_MEDIUM - (integer) - - - - - - - - - CAIRO_HINT_STYLE_FULL - (integer) - - - - - - - - - CAIRO_HINT_METRICS_DEFAULT - (integer) - - - - - - - - - CAIRO_HINT_METRICS_OFF - (integer) - - - - - - - - - CAIRO_HINT_METRICS_ON - (integer) - - - - - - - - - CAIRO_FONT_TYPE_TOY - (integer) - - - - - - - - - CAIRO_FONT_TYPE_FT - (integer) - - - - - - - - - CAIRO_FONT_TYPE_WIN32 - (integer) - - - - - - - - - CAIRO_FONT_TYPE_QUARTZ - (integer) - - - - - - - - - CAIRO_FONT_SLANT_NORMAL - (integer) - - - - - - - - - CAIRO_FONT_SLANT_ITALIC - (integer) - - - - - - - - - CAIRO_FONT_SLANT_OBLIQUE - (integer) - - - - - - - - - CAIRO_FONT_WEIGHT_NORMAL - (integer) - - - - - - - - - CAIRO_FONT_WEIGHT_BOLD - (integer) - - - - - - - - - CAIRO_CONTENT_COLOR - (integer) - - - - - - - - - CAIRO_CONTENT_ALPHA - (integer) - - - - - - - - - CAIRO_CONTENT_COLOR_ALPHA - (integer) - - - - - - - - - CAIRO_SURFACE_TYPE_IMAGE - (integer) - - - - - - - - - CAIRO_SURFACE_TYPE_PDF - (integer) - - - - - - - - - CAIRO_SURFACE_TYPE_PS - (integer) - - - - - - - - - CAIRO_SURFACE_TYPE_XLIB - (integer) - - - - - - - - - CAIRO_SURFACE_TYPE_XCB - (integer) - - - - - - - - - CAIRO_SURFACE_TYPE_GLITZ - (integer) - - - - - - - - - CAIRO_SURFACE_TYPE_QUARTZ - (integer) - - - - - - - - - CAIRO_SURFACE_TYPE_WIN32 - (integer) - - - - - - - - - CAIRO_SURFACE_TYPE_BEOS - (integer) - - - - - - - - - CAIRO_SURFACE_TYPE_DIRECTFB - (integer) - - - - - - - - - CAIRO_SURFACE_TYPE_SVG - (integer) - - - - - - - - - CAIRO_SURFACE_TYPE_OS2 - (integer) - - - - - - - - - CAIRO_SURFACE_TYPE_WIN32_PRINTING - (integer) - - - - - - - - - CAIRO_SURFACE_TYPE_QUARTZ_IMAGE - (integer) - - - - - - - - - CAIRO_FORMAT_ARGB32 - (integer) - - - - - - - - - CAIRO_FORMAT_RGB24 - (integer) - - - - - - - - - CAIRO_FORMAT_A8 - (integer) - - - - - - - - - CAIRO_FORMAT_A1 - (integer) - - - - - - - - - CAIRO_PS_LEVEL_2 - (integer) - - - - - - - - - CAIRO_PS_LEVEL_3 - (integer) - - - - - - - - - CAIRO_SVG_VERSION_1_1 - (integer) - - - - - - - - - CAIRO_SVG_VERSION_1_2 - (integer) - - - - - - - - - - - - diff --git a/reference/cairo/examples.xml b/reference/cairo/examples.xml deleted file mode 100644 index a250fae230e1..000000000000 --- a/reference/cairo/examples.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - &reftitle.examples; - - Description here... - - - Cairo Example - - -]]> - - &example.outputs.similar; - - - - - - - - diff --git a/reference/cairo/functions/cairo-create.xml b/reference/cairo/functions/cairo-create.xml deleted file mode 100644 index 249a2fe42cc9..000000000000 --- a/reference/cairo/functions/cairo-create.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_create - Returns a new CairoContext object on the requested surface - - - - &reftitle.description; - - CairoContextcairo_create - CairoSurfacesurface - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_create</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-font-options-create.xml b/reference/cairo/functions/cairo-font-options-create.xml deleted file mode 100644 index a63a318b58f9..000000000000 --- a/reference/cairo/functions/cairo-font-options-create.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - cairo_font_options_create - Description - - - - &reftitle.description; - - CairoFontOptionscairo_font_options_create - - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_font_options_create</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-font-options-equal.xml b/reference/cairo/functions/cairo-font-options-equal.xml deleted file mode 100644 index 39b2dbad395b..000000000000 --- a/reference/cairo/functions/cairo-font-options-equal.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - cairo_font_options_equal - Description - - - - &reftitle.description; - - boolcairo_font_options_equal - CairoFontOptionsoptions - CairoFontOptionsother - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - options - - - Description... - - - - - other - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_font_options_equal</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-font-options-get-antialias.xml b/reference/cairo/functions/cairo-font-options-get-antialias.xml deleted file mode 100644 index 9a5b558297f1..000000000000 --- a/reference/cairo/functions/cairo-font-options-get-antialias.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_font_options_get_antialias - Description - - - - &reftitle.description; - - intcairo_font_options_get_antialias - CairoFontOptionsoptions - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - options - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_font_options_get_antialias</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-font-options-get-hint-metrics.xml b/reference/cairo/functions/cairo-font-options-get-hint-metrics.xml deleted file mode 100644 index b7cc10c01fda..000000000000 --- a/reference/cairo/functions/cairo-font-options-get-hint-metrics.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_font_options_get_hint_metrics - Description - - - - &reftitle.description; - - intcairo_font_options_get_hint_metrics - CairoFontOptionsoptions - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - options - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_font_options_get_hint_metrics</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-font-options-get-hint-style.xml b/reference/cairo/functions/cairo-font-options-get-hint-style.xml deleted file mode 100644 index ed22e9d2fb6d..000000000000 --- a/reference/cairo/functions/cairo-font-options-get-hint-style.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_font_options_get_hint_style - Description - - - - &reftitle.description; - - intcairo_font_options_get_hint_style - CairoFontOptionsoptions - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - options - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_font_options_get_hint_style</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-font-options-get-subpixel-order.xml b/reference/cairo/functions/cairo-font-options-get-subpixel-order.xml deleted file mode 100644 index c5c04ea6397b..000000000000 --- a/reference/cairo/functions/cairo-font-options-get-subpixel-order.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_font_options_get_subpixel_order - Description - - - - &reftitle.description; - - intcairo_font_options_get_subpixel_order - CairoFontOptionsoptions - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - options - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_font_options_get_subpixel_order</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-font-options-hash.xml b/reference/cairo/functions/cairo-font-options-hash.xml deleted file mode 100644 index 49fc5786e753..000000000000 --- a/reference/cairo/functions/cairo-font-options-hash.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_font_options_hash - Description - - - - &reftitle.description; - - intcairo_font_options_hash - CairoFontOptionsoptions - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - options - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_font_options_hash</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-font-options-merge.xml b/reference/cairo/functions/cairo-font-options-merge.xml deleted file mode 100644 index 5dce52d378d2..000000000000 --- a/reference/cairo/functions/cairo-font-options-merge.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - cairo_font_options_merge - Description - - - - &reftitle.description; - - voidcairo_font_options_merge - CairoFontOptionsoptions - CairoFontOptionsother - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - options - - - Description... - - - - - other - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_font_options_merge</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-font-options-set-antialias.xml b/reference/cairo/functions/cairo-font-options-set-antialias.xml deleted file mode 100644 index 5f1aba3d4b38..000000000000 --- a/reference/cairo/functions/cairo-font-options-set-antialias.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - cairo_font_options_set_antialias - Description - - - - &reftitle.description; - - voidcairo_font_options_set_antialias - CairoFontOptionsoptions - intantialias - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - options - - - Description... - - - - - antialias - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_font_options_set_antialias</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-font-options-set-hint-metrics.xml b/reference/cairo/functions/cairo-font-options-set-hint-metrics.xml deleted file mode 100644 index 4b1c46713ef6..000000000000 --- a/reference/cairo/functions/cairo-font-options-set-hint-metrics.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - cairo_font_options_set_hint_metrics - Description - - - - &reftitle.description; - - voidcairo_font_options_set_hint_metrics - CairoFontOptionsoptions - inthint_metrics - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - options - - - Description... - - - - - hint_metrics - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_font_options_set_hint_metrics</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-font-options-set-hint-style.xml b/reference/cairo/functions/cairo-font-options-set-hint-style.xml deleted file mode 100644 index 49589cdfb6ce..000000000000 --- a/reference/cairo/functions/cairo-font-options-set-hint-style.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - cairo_font_options_set_hint_style - Description - - - - &reftitle.description; - - voidcairo_font_options_set_hint_style - CairoFontOptionsoptions - inthint_style - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - options - - - Description... - - - - - hint_style - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_font_options_set_hint_style</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-font-options-set-subpixel-order.xml b/reference/cairo/functions/cairo-font-options-set-subpixel-order.xml deleted file mode 100644 index 47829b48e7df..000000000000 --- a/reference/cairo/functions/cairo-font-options-set-subpixel-order.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - cairo_font_options_set_subpixel_order - Description - - - - &reftitle.description; - - voidcairo_font_options_set_subpixel_order - CairoFontOptionsoptions - intsubpixel_order - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - options - - - Description... - - - - - subpixel_order - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_font_options_set_subpixel_order</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-font-options-status.xml b/reference/cairo/functions/cairo-font-options-status.xml deleted file mode 100644 index d5b50bccd564..000000000000 --- a/reference/cairo/functions/cairo-font-options-status.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_font_options_status - Description - - - - &reftitle.description; - - intcairo_font_options_status - CairoFontOptionsoptions - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - options - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_font_options_status</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-format-stride-for-width.xml b/reference/cairo/functions/cairo-format-stride-for-width.xml deleted file mode 100644 index 57e96c652855..000000000000 --- a/reference/cairo/functions/cairo-format-stride-for-width.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - cairo_format_stride_for_width - Description - - - - &reftitle.description; - - intcairo_format_stride_for_width - intformat - intwidth - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - format - - - Description... - - - - - width - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_format_stride_for_width</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-image-surface-create-for-data.xml b/reference/cairo/functions/cairo-image-surface-create-for-data.xml deleted file mode 100644 index 15be2149d91b..000000000000 --- a/reference/cairo/functions/cairo-image-surface-create-for-data.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - cairo_image_surface_create_for_data - Description - - - - &reftitle.description; - - CairoImageSurfacecairo_image_surface_create_for_data - stringdata - intformat - intwidth - intheight - intstride-1 - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - data - - - Description... - - - - - format - - - Description... - - - - - width - - - Description... - - - - - height - - - Description... - - - - - stride - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_image_surface_create_for_data</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-image-surface-create-from-png.xml b/reference/cairo/functions/cairo-image-surface-create-from-png.xml deleted file mode 100644 index 7f3cc9597225..000000000000 --- a/reference/cairo/functions/cairo-image-surface-create-from-png.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_image_surface_create_from_png - Description - - - - &reftitle.description; - - CairoImageSurfacecairo_image_surface_create_from_png - mixedfile - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - file - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_image_surface_create_from_png</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-image-surface-create.xml b/reference/cairo/functions/cairo-image-surface-create.xml deleted file mode 100644 index c86dfc299fe3..000000000000 --- a/reference/cairo/functions/cairo-image-surface-create.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - cairo_image_surface_create - Description - - - - &reftitle.description; - - CairoImageSurfacecairo_image_surface_create - intformat - intwidth - intheight - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - format - - - Description... - - - - - width - - - Description... - - - - - height - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_image_surface_create</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-image-surface-get-data.xml b/reference/cairo/functions/cairo-image-surface-get-data.xml deleted file mode 100644 index 866ec6d26921..000000000000 --- a/reference/cairo/functions/cairo-image-surface-get-data.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_image_surface_get_data - Description - - - - &reftitle.description; - - stringcairo_image_surface_get_data - CairoImageSurfacesurface - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_image_surface_get_data</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-image-surface-get-format.xml b/reference/cairo/functions/cairo-image-surface-get-format.xml deleted file mode 100644 index a0d43d4b7e98..000000000000 --- a/reference/cairo/functions/cairo-image-surface-get-format.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_image_surface_get_format - Description - - - - &reftitle.description; - - intcairo_image_surface_get_format - CairoImageSurfacesurface - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_image_surface_get_format</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-image-surface-get-height.xml b/reference/cairo/functions/cairo-image-surface-get-height.xml deleted file mode 100644 index ae6615c2d690..000000000000 --- a/reference/cairo/functions/cairo-image-surface-get-height.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_image_surface_get_height - Description - - - - &reftitle.description; - - intcairo_image_surface_get_height - CairoImageSurfacesurface - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_image_surface_get_height</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-image-surface-get-stride.xml b/reference/cairo/functions/cairo-image-surface-get-stride.xml deleted file mode 100644 index 6704a1218e8b..000000000000 --- a/reference/cairo/functions/cairo-image-surface-get-stride.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_image_surface_get_stride - Description - - - - &reftitle.description; - - intcairo_image_surface_get_stride - CairoImageSurfacesurface - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_image_surface_get_stride</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-image-surface-get-width.xml b/reference/cairo/functions/cairo-image-surface-get-width.xml deleted file mode 100644 index 05d163d2e4ec..000000000000 --- a/reference/cairo/functions/cairo-image-surface-get-width.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_image_surface_get_width - Description - - - - &reftitle.description; - - intcairo_image_surface_get_width - CairoImageSurfacesurface - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_image_surface_get_width</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-matrix-create-scale.xml b/reference/cairo/functions/cairo-matrix-create-scale.xml deleted file mode 100644 index e71690b15ea7..000000000000 --- a/reference/cairo/functions/cairo-matrix-create-scale.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - cairo_matrix_create_scale - &Alias; CairoMatrix::initScale - - - - &reftitle.description; - - &info.function.alias; - CairoMatrix::initScale. - - &info.function.alias.deprecated; - - - - - diff --git a/reference/cairo/functions/cairo-matrix-create-translate.xml b/reference/cairo/functions/cairo-matrix-create-translate.xml deleted file mode 100644 index 7d8f27facb5e..000000000000 --- a/reference/cairo/functions/cairo-matrix-create-translate.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - cairo_matrix_create_translate - &Alias; CairoMatrix::initTranslate - - - - &reftitle.description; - - &info.function.alias; - CairoMatrix::initTranslate. - - &info.function.alias.deprecated; - - - - - diff --git a/reference/cairo/functions/cairo-matrix-invert.xml b/reference/cairo/functions/cairo-matrix-invert.xml deleted file mode 100644 index 4725a81f87e5..000000000000 --- a/reference/cairo/functions/cairo-matrix-invert.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_matrix_invert - Description - - - - &reftitle.description; - - voidcairo_matrix_invert - CairoMatrixmatrix - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - matrix - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_matrix_invert</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-matrix-multiply.xml b/reference/cairo/functions/cairo-matrix-multiply.xml deleted file mode 100644 index 02116358154b..000000000000 --- a/reference/cairo/functions/cairo-matrix-multiply.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - cairo_matrix_multiply - Description - - - - &reftitle.description; - - CairoMatrixcairo_matrix_multiply - CairoMatrixmatrix1 - CairoMatrixmatrix2 - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - matrix1 - - - Description... - - - - - matrix2 - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_matrix_multiply</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-matrix-transform-distance.xml b/reference/cairo/functions/cairo-matrix-transform-distance.xml deleted file mode 100644 index 4eed9f3b9915..000000000000 --- a/reference/cairo/functions/cairo-matrix-transform-distance.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - cairo_matrix_transform_distance - Description - - - - &reftitle.description; - - arraycairo_matrix_transform_distance - CairoMatrixmatrix - floatdx - floatdy - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - matrix - - - Description... - - - - - dx - - - Description... - - - - - dy - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_matrix_transform_distance</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-matrix-transform-point.xml b/reference/cairo/functions/cairo-matrix-transform-point.xml deleted file mode 100644 index 8cc6d8ed58e0..000000000000 --- a/reference/cairo/functions/cairo-matrix-transform-point.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - cairo_matrix_transform_point - Description - - - - &reftitle.description; - - arraycairo_matrix_transform_point - CairoMatrixmatrix - floatdx - floatdy - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - matrix - - - Description... - - - - - dx - - - Description... - - - - - dy - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_matrix_transform_point</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-matrix-translate.xml b/reference/cairo/functions/cairo-matrix-translate.xml deleted file mode 100644 index e3977bdee7a8..000000000000 --- a/reference/cairo/functions/cairo-matrix-translate.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - cairo_matrix_translate - Description - - - - &reftitle.description; - - voidcairo_matrix_translate - CairoMatrixmatrix - floattx - floatty - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - matrix - - - Description... - - - - - tx - - - Description... - - - - - ty - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_matrix_translate</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-pattern-add-color-stop-rgb.xml b/reference/cairo/functions/cairo-pattern-add-color-stop-rgb.xml deleted file mode 100644 index c04f0e7da378..000000000000 --- a/reference/cairo/functions/cairo-pattern-add-color-stop-rgb.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - cairo_pattern_add_color_stop_rgb - Description - - - - &reftitle.description; - - voidcairo_pattern_add_color_stop_rgb - CairoGradientPatternpattern - floatoffset - floatred - floatgreen - floatblue - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - pattern - - - Description... - - - - - offset - - - Description... - - - - - red - - - Description... - - - - - green - - - Description... - - - - - blue - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_pattern_add_color_stop_rgb</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-pattern-add-color-stop-rgba.xml b/reference/cairo/functions/cairo-pattern-add-color-stop-rgba.xml deleted file mode 100644 index 5fa07e47e3e7..000000000000 --- a/reference/cairo/functions/cairo-pattern-add-color-stop-rgba.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - cairo_pattern_add_color_stop_rgba - Description - - - - &reftitle.description; - - voidcairo_pattern_add_color_stop_rgba - CairoGradientPatternpattern - floatoffset - floatred - floatgreen - floatblue - floatalpha - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - pattern - - - Description... - - - - - offset - - - Description... - - - - - red - - - Description... - - - - - green - - - Description... - - - - - blue - - - Description... - - - - - alpha - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_pattern_add_color_stop_rgba</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-pattern-create-for-surface.xml b/reference/cairo/functions/cairo-pattern-create-for-surface.xml deleted file mode 100644 index c307ce591da4..000000000000 --- a/reference/cairo/functions/cairo-pattern-create-for-surface.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_pattern_create_for_surface - Description - - - - &reftitle.description; - - CairoPatterncairo_pattern_create_for_surface - CairoSurfacesurface - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_pattern_create_for_surface</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-pattern-create-linear.xml b/reference/cairo/functions/cairo-pattern-create-linear.xml deleted file mode 100644 index b448a9b7e3de..000000000000 --- a/reference/cairo/functions/cairo-pattern-create-linear.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - cairo_pattern_create_linear - Description - - - - &reftitle.description; - - CairoPatterncairo_pattern_create_linear - floatx0 - floaty0 - floatx1 - floaty1 - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - x0 - - - Description... - - - - - y0 - - - Description... - - - - - x1 - - - Description... - - - - - y1 - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_pattern_create_linear</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-pattern-create-radial.xml b/reference/cairo/functions/cairo-pattern-create-radial.xml deleted file mode 100644 index f8b9b3861b14..000000000000 --- a/reference/cairo/functions/cairo-pattern-create-radial.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - cairo_pattern_create_radial - Description - - - - &reftitle.description; - - CairoPatterncairo_pattern_create_radial - floatx0 - floaty0 - floatr0 - floatx1 - floaty1 - floatr1 - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - x0 - - - Description... - - - - - y0 - - - Description... - - - - - r0 - - - Description... - - - - - x1 - - - Description... - - - - - y1 - - - Description... - - - - - r1 - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_pattern_create_radial</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-pattern-create-rgb.xml b/reference/cairo/functions/cairo-pattern-create-rgb.xml deleted file mode 100644 index 5183b6acbe7d..000000000000 --- a/reference/cairo/functions/cairo-pattern-create-rgb.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - cairo_pattern_create_rgb - Description - - - - &reftitle.description; - - CairoPatterncairo_pattern_create_rgb - floatred - floatgreen - floatblue - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - red - - - Description... - - - - - green - - - Description... - - - - - blue - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_pattern_create_rgb</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-pattern-create-rgba.xml b/reference/cairo/functions/cairo-pattern-create-rgba.xml deleted file mode 100644 index 7456d0959d92..000000000000 --- a/reference/cairo/functions/cairo-pattern-create-rgba.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - cairo_pattern_create_rgba - Description - - - - &reftitle.description; - - CairoPatterncairo_pattern_create_rgba - floatred - floatgreen - floatblue - floatalpha - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - red - - - Description... - - - - - green - - - Description... - - - - - blue - - - Description... - - - - - alpha - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_pattern_create_rgba</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-pattern-get-color-stop-count.xml b/reference/cairo/functions/cairo-pattern-get-color-stop-count.xml deleted file mode 100644 index 6f5b0f692b6a..000000000000 --- a/reference/cairo/functions/cairo-pattern-get-color-stop-count.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_pattern_get_color_stop_count - Description - - - - &reftitle.description; - - intcairo_pattern_get_color_stop_count - CairoGradientPatternpattern - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - pattern - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_pattern_get_color_stop_count</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-pattern-get-color-stop-rgba.xml b/reference/cairo/functions/cairo-pattern-get-color-stop-rgba.xml deleted file mode 100644 index bf52c94fa5f3..000000000000 --- a/reference/cairo/functions/cairo-pattern-get-color-stop-rgba.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - cairo_pattern_get_color_stop_rgba - Description - - - - &reftitle.description; - - arraycairo_pattern_get_color_stop_rgba - CairoGradientPatternpattern - intindex - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - pattern - - - Description... - - - - - index - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_pattern_get_color_stop_rgba</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-pattern-get-extend.xml b/reference/cairo/functions/cairo-pattern-get-extend.xml deleted file mode 100644 index 52a5b00a8fac..000000000000 --- a/reference/cairo/functions/cairo-pattern-get-extend.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_pattern_get_extend - Description - - - - &reftitle.description; - - intcairo_pattern_get_extend - stringpattern - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - pattern - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_pattern_get_extend</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-pattern-get-filter.xml b/reference/cairo/functions/cairo-pattern-get-filter.xml deleted file mode 100644 index e1ef9e9380c2..000000000000 --- a/reference/cairo/functions/cairo-pattern-get-filter.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_pattern_get_filter - Description - - - - &reftitle.description; - - intcairo_pattern_get_filter - CairoSurfacePatternpattern - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - pattern - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_pattern_get_filter</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-pattern-get-linear-points.xml b/reference/cairo/functions/cairo-pattern-get-linear-points.xml deleted file mode 100644 index a6c1d795173c..000000000000 --- a/reference/cairo/functions/cairo-pattern-get-linear-points.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_pattern_get_linear_points - Description - - - - &reftitle.description; - - arraycairo_pattern_get_linear_points - CairoLinearGradientpattern - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - pattern - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_pattern_get_linear_points</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-pattern-get-matrix.xml b/reference/cairo/functions/cairo-pattern-get-matrix.xml deleted file mode 100644 index 3ac814d1553c..000000000000 --- a/reference/cairo/functions/cairo-pattern-get-matrix.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_pattern_get_matrix - Description - - - - &reftitle.description; - - CairoMatrixcairo_pattern_get_matrix - CairoPatternpattern - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - pattern - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_pattern_get_matrix</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-pattern-get-radial-circles.xml b/reference/cairo/functions/cairo-pattern-get-radial-circles.xml deleted file mode 100644 index 6cb728acbca8..000000000000 --- a/reference/cairo/functions/cairo-pattern-get-radial-circles.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_pattern_get_radial_circles - Description - - - - &reftitle.description; - - arraycairo_pattern_get_radial_circles - CairoRadialGradientpattern - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - pattern - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_pattern_get_radial_circles</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-pattern-get-rgba.xml b/reference/cairo/functions/cairo-pattern-get-rgba.xml deleted file mode 100644 index cd98f0053073..000000000000 --- a/reference/cairo/functions/cairo-pattern-get-rgba.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_pattern_get_rgba - Description - - - - &reftitle.description; - - arraycairo_pattern_get_rgba - CairoSolidPatternpattern - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - pattern - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_pattern_get_rgba</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-pattern-get-surface.xml b/reference/cairo/functions/cairo-pattern-get-surface.xml deleted file mode 100644 index 2e6ca69eca8b..000000000000 --- a/reference/cairo/functions/cairo-pattern-get-surface.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_pattern_get_surface - Description - - - - &reftitle.description; - - CairoSurfacecairo_pattern_get_surface - CairoSurfacePatternpattern - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - pattern - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_pattern_get_surface</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-pattern-get-type.xml b/reference/cairo/functions/cairo-pattern-get-type.xml deleted file mode 100644 index 9067218f8d8a..000000000000 --- a/reference/cairo/functions/cairo-pattern-get-type.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_pattern_get_type - Description - - - - &reftitle.description; - - intcairo_pattern_get_type - CairoPatternpattern - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - pattern - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_pattern_get_type</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-pattern-set-extend.xml b/reference/cairo/functions/cairo-pattern-set-extend.xml deleted file mode 100644 index dedf00960461..000000000000 --- a/reference/cairo/functions/cairo-pattern-set-extend.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - cairo_pattern_set_extend - Description - - - - &reftitle.description; - - voidcairo_pattern_set_extend - stringpattern - stringextend - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - pattern - - - Description... - - - - - extend - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_pattern_set_extend</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-pattern-set-filter.xml b/reference/cairo/functions/cairo-pattern-set-filter.xml deleted file mode 100644 index 7c02f4227bfe..000000000000 --- a/reference/cairo/functions/cairo-pattern-set-filter.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - cairo_pattern_set_filter - Description - - - - &reftitle.description; - - voidcairo_pattern_set_filter - CairoSurfacePatternpattern - intfilter - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - pattern - - - Description... - - - - - filter - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_pattern_set_filter</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-pattern-set-matrix.xml b/reference/cairo/functions/cairo-pattern-set-matrix.xml deleted file mode 100644 index 9920a337beca..000000000000 --- a/reference/cairo/functions/cairo-pattern-set-matrix.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - cairo_pattern_set_matrix - Description - - - - &reftitle.description; - - voidcairo_pattern_set_matrix - CairoPatternpattern - CairoMatrixmatrix - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - pattern - - - Description... - - - - - matrix - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_pattern_set_matrix</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-pattern-status.xml b/reference/cairo/functions/cairo-pattern-status.xml deleted file mode 100644 index e5778bb3a60b..000000000000 --- a/reference/cairo/functions/cairo-pattern-status.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_pattern_status - Description - - - - &reftitle.description; - - intcairo_pattern_status - CairoPatternpattern - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - pattern - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_pattern_status</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-pdf-surface-create.xml b/reference/cairo/functions/cairo-pdf-surface-create.xml deleted file mode 100644 index 623f0c21e8e4..000000000000 --- a/reference/cairo/functions/cairo-pdf-surface-create.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - cairo_pdf_surface_create - Description - - - - &reftitle.description; - - CairoPdfSurfacecairo_pdf_surface_create - stringfile - floatwidth - floatheight - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - file - - - Description... - - - - - width - - - Description... - - - - - height - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_pdf_surface_create</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-pdf-surface-set-size.xml b/reference/cairo/functions/cairo-pdf-surface-set-size.xml deleted file mode 100644 index 3bfa752c7707..000000000000 --- a/reference/cairo/functions/cairo-pdf-surface-set-size.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - cairo_pdf_surface_set_size - Description - - - - &reftitle.description; - - voidcairo_pdf_surface_set_size - CairoPdfSurfacesurface - floatwidth - floatheight - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - width - - - Description... - - - - - height - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_pdf_surface_set_size</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-ps-get-levels.xml b/reference/cairo/functions/cairo-ps-get-levels.xml deleted file mode 100644 index 9a926d7311e7..000000000000 --- a/reference/cairo/functions/cairo-ps-get-levels.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - cairo_ps_get_levels - Description - - - - &reftitle.description; - - arraycairo_ps_get_levels - - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_ps_get_levels</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-ps-level-to-string.xml b/reference/cairo/functions/cairo-ps-level-to-string.xml deleted file mode 100644 index aebc5f5295aa..000000000000 --- a/reference/cairo/functions/cairo-ps-level-to-string.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_ps_level_to_string - Description - - - - &reftitle.description; - - stringcairo_ps_level_to_string - intlevel - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - level - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_ps_level_to_string</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-ps-surface-create.xml b/reference/cairo/functions/cairo-ps-surface-create.xml deleted file mode 100644 index 3b14d5a3dd98..000000000000 --- a/reference/cairo/functions/cairo-ps-surface-create.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - cairo_ps_surface_create - Description - - - - &reftitle.description; - - CairoPsSurfacecairo_ps_surface_create - stringfile - floatwidth - floatheight - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - file - - - Description... - - - - - width - - - Description... - - - - - height - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_ps_surface_create</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-ps-surface-dsc-begin-page-setup.xml b/reference/cairo/functions/cairo-ps-surface-dsc-begin-page-setup.xml deleted file mode 100644 index 29a272d16a8a..000000000000 --- a/reference/cairo/functions/cairo-ps-surface-dsc-begin-page-setup.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_ps_surface_dsc_begin_page_setup - Description - - - - &reftitle.description; - - voidcairo_ps_surface_dsc_begin_page_setup - CairoPsSurfacesurface - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_ps_surface_dsc_begin_page_setup</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-ps-surface-dsc-begin-setup.xml b/reference/cairo/functions/cairo-ps-surface-dsc-begin-setup.xml deleted file mode 100644 index d09963a1bb99..000000000000 --- a/reference/cairo/functions/cairo-ps-surface-dsc-begin-setup.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_ps_surface_dsc_begin_setup - Description - - - - &reftitle.description; - - voidcairo_ps_surface_dsc_begin_setup - CairoPsSurfacesurface - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_ps_surface_dsc_begin_setup</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-ps-surface-dsc-comment.xml b/reference/cairo/functions/cairo-ps-surface-dsc-comment.xml deleted file mode 100644 index 2646c67b7e5f..000000000000 --- a/reference/cairo/functions/cairo-ps-surface-dsc-comment.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - cairo_ps_surface_dsc_comment - Description - - - - &reftitle.description; - - voidcairo_ps_surface_dsc_comment - CairoPsSurfacesurface - stringcomment - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - comment - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_ps_surface_dsc_comment</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-ps-surface-get-eps.xml b/reference/cairo/functions/cairo-ps-surface-get-eps.xml deleted file mode 100644 index e5318349e879..000000000000 --- a/reference/cairo/functions/cairo-ps-surface-get-eps.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_ps_surface_get_eps - Description - - - - &reftitle.description; - - boolcairo_ps_surface_get_eps - CairoPsSurfacesurface - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_ps_surface_get_eps</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-ps-surface-restrict-to-level.xml b/reference/cairo/functions/cairo-ps-surface-restrict-to-level.xml deleted file mode 100644 index beae3913743e..000000000000 --- a/reference/cairo/functions/cairo-ps-surface-restrict-to-level.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - cairo_ps_surface_restrict_to_level - Description - - - - &reftitle.description; - - voidcairo_ps_surface_restrict_to_level - CairoPsSurfacesurface - intlevel - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - level - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_ps_surface_restrict_to_level</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-ps-surface-set-eps.xml b/reference/cairo/functions/cairo-ps-surface-set-eps.xml deleted file mode 100644 index 80105aeb729a..000000000000 --- a/reference/cairo/functions/cairo-ps-surface-set-eps.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - cairo_ps_surface_set_eps - Description - - - - &reftitle.description; - - voidcairo_ps_surface_set_eps - CairoPsSurfacesurface - boollevel - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - level - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_ps_surface_set_eps</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-ps-surface-set-size.xml b/reference/cairo/functions/cairo-ps-surface-set-size.xml deleted file mode 100644 index 6b0339f113f8..000000000000 --- a/reference/cairo/functions/cairo-ps-surface-set-size.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - cairo_ps_surface_set_size - Description - - - - &reftitle.description; - - voidcairo_ps_surface_set_size - CairoPsSurfacesurface - floatwidth - floatheight - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - width - - - Description... - - - - - height - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_ps_surface_set_size</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-scaled-font-create.xml b/reference/cairo/functions/cairo-scaled-font-create.xml deleted file mode 100644 index 30e8408e195c..000000000000 --- a/reference/cairo/functions/cairo-scaled-font-create.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - cairo_scaled_font_create - Description - - - - &reftitle.description; - - CairoScaledFontcairo_scaled_font_create - CairoFontFacefontface - CairoMatrixmatrix - CairoMatrixctm - CairoFontOptionsfontoptions - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - fontface - - - Description... - - - - - matrix - - - Description... - - - - - ctm - - - Description... - - - - - fontoptions - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_scaled_font_create</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-scaled-font-extents.xml b/reference/cairo/functions/cairo-scaled-font-extents.xml deleted file mode 100644 index 7444ddde3a07..000000000000 --- a/reference/cairo/functions/cairo-scaled-font-extents.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_scaled_font_extents - Description - - - - &reftitle.description; - - arraycairo_scaled_font_extents - CairoScaledFontscaledfont - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - scaledfont - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_scaled_font_extents</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-scaled-font-get-ctm.xml b/reference/cairo/functions/cairo-scaled-font-get-ctm.xml deleted file mode 100644 index 2e4d96174e20..000000000000 --- a/reference/cairo/functions/cairo-scaled-font-get-ctm.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_scaled_font_get_ctm - Description - - - - &reftitle.description; - - CairoMatrixcairo_scaled_font_get_ctm - CairoScaledFontscaledfont - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - scaledfont - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_scaled_font_get_ctm</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-scaled-font-get-font-face.xml b/reference/cairo/functions/cairo-scaled-font-get-font-face.xml deleted file mode 100644 index 29cc9ff92578..000000000000 --- a/reference/cairo/functions/cairo-scaled-font-get-font-face.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_scaled_font_get_font_face - Description - - - - &reftitle.description; - - CairoFontFacecairo_scaled_font_get_font_face - CairoScaledFontscaledfont - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - scaledfont - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_scaled_font_get_font_face</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-scaled-font-get-font-matrix.xml b/reference/cairo/functions/cairo-scaled-font-get-font-matrix.xml deleted file mode 100644 index 4be605d47d4f..000000000000 --- a/reference/cairo/functions/cairo-scaled-font-get-font-matrix.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_scaled_font_get_font_matrix - Description - - - - &reftitle.description; - - CairoFontOptionscairo_scaled_font_get_font_matrix - CairoScaledFontscaledfont - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - scaledfont - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_scaled_font_get_font_matrix</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-scaled-font-get-font-options.xml b/reference/cairo/functions/cairo-scaled-font-get-font-options.xml deleted file mode 100644 index aba0f871a88b..000000000000 --- a/reference/cairo/functions/cairo-scaled-font-get-font-options.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_scaled_font_get_font_options - Description - - - - &reftitle.description; - - CairoFontOptionscairo_scaled_font_get_font_options - CairoScaledFontscaledfont - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - scaledfont - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_scaled_font_get_font_options</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-scaled-font-get-scale-matrix.xml b/reference/cairo/functions/cairo-scaled-font-get-scale-matrix.xml deleted file mode 100644 index 0083127554fc..000000000000 --- a/reference/cairo/functions/cairo-scaled-font-get-scale-matrix.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_scaled_font_get_scale_matrix - Description - - - - &reftitle.description; - - CairoMatrixcairo_scaled_font_get_scale_matrix - CairoScaledFontscaledfont - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - scaledfont - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_scaled_font_get_scale_matrix</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-scaled-font-get-type.xml b/reference/cairo/functions/cairo-scaled-font-get-type.xml deleted file mode 100644 index 4342a59727b7..000000000000 --- a/reference/cairo/functions/cairo-scaled-font-get-type.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_scaled_font_get_type - Description - - - - &reftitle.description; - - intcairo_scaled_font_get_type - CairoScaledFontscaledfont - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - scaledfont - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_scaled_font_get_type</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-scaled-font-glyph-extents.xml b/reference/cairo/functions/cairo-scaled-font-glyph-extents.xml deleted file mode 100644 index eb4235b7038f..000000000000 --- a/reference/cairo/functions/cairo-scaled-font-glyph-extents.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - cairo_scaled_font_glyph_extents - Description - - - - &reftitle.description; - - arraycairo_scaled_font_glyph_extents - CairoScaledFontscaledfont - arrayglyphs - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - scaledfont - - - Description... - - - - - glyphs - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_scaled_font_glyph_extents</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-scaled-font-status.xml b/reference/cairo/functions/cairo-scaled-font-status.xml deleted file mode 100644 index a8301d22922d..000000000000 --- a/reference/cairo/functions/cairo-scaled-font-status.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_scaled_font_status - Description - - - - &reftitle.description; - - intcairo_scaled_font_status - CairoScaledFontscaledfont - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - scaledfont - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_scaled_font_status</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-scaled-font-text-extents.xml b/reference/cairo/functions/cairo-scaled-font-text-extents.xml deleted file mode 100644 index 83c8024c5b7c..000000000000 --- a/reference/cairo/functions/cairo-scaled-font-text-extents.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - cairo_scaled_font_text_extents - Description - - - - &reftitle.description; - - arraycairo_scaled_font_text_extents - CairoScaledFontscaledfont - stringtext - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - scaledfont - - - Description... - - - - - text - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_scaled_font_text_extents</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-surface-copy-page.xml b/reference/cairo/functions/cairo-surface-copy-page.xml deleted file mode 100644 index bd65b1a7b360..000000000000 --- a/reference/cairo/functions/cairo-surface-copy-page.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_surface_copy_page - Description - - - - &reftitle.description; - - voidcairo_surface_copy_page - CairoSurfacesurface - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_surface_copy_page</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-surface-create-similar.xml b/reference/cairo/functions/cairo-surface-create-similar.xml deleted file mode 100644 index be6b54bbeed8..000000000000 --- a/reference/cairo/functions/cairo-surface-create-similar.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - - cairo_surface_create_similar - Description - - - - &reftitle.description; - - CairoSurfacecairo_surface_create_similar - CairoSurfacesurface - intcontent - floatwidth - floatheight - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - content - - - Description... - - - - - width - - - Description... - - - - - height - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_surface_create_similar</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-surface-finish.xml b/reference/cairo/functions/cairo-surface-finish.xml deleted file mode 100644 index 8bbd72496532..000000000000 --- a/reference/cairo/functions/cairo-surface-finish.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_surface_finish - Description - - - - &reftitle.description; - - voidcairo_surface_finish - CairoSurfacesurface - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_surface_finish</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-surface-flush.xml b/reference/cairo/functions/cairo-surface-flush.xml deleted file mode 100644 index 5355d5203eb6..000000000000 --- a/reference/cairo/functions/cairo-surface-flush.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_surface_flush - Description - - - - &reftitle.description; - - voidcairo_surface_flush - CairoSurfacesurface - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_surface_flush</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-surface-get-content.xml b/reference/cairo/functions/cairo-surface-get-content.xml deleted file mode 100644 index 72c219fe10c7..000000000000 --- a/reference/cairo/functions/cairo-surface-get-content.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_surface_get_content - Description - - - - &reftitle.description; - - intcairo_surface_get_content - CairoSurfacesurface - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_surface_get_content</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-surface-get-device-offset.xml b/reference/cairo/functions/cairo-surface-get-device-offset.xml deleted file mode 100644 index e85b272b86ee..000000000000 --- a/reference/cairo/functions/cairo-surface-get-device-offset.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_surface_get_device_offset - Description - - - - &reftitle.description; - - arraycairo_surface_get_device_offset - CairoSurfacesurface - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_surface_get_device_offset</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-surface-get-font-options.xml b/reference/cairo/functions/cairo-surface-get-font-options.xml deleted file mode 100644 index 5b171014c67b..000000000000 --- a/reference/cairo/functions/cairo-surface-get-font-options.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_surface_get_font_options - Description - - - - &reftitle.description; - - CairoFontOptionscairo_surface_get_font_options - CairoSurfacesurface - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_surface_get_font_options</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-surface-get-type.xml b/reference/cairo/functions/cairo-surface-get-type.xml deleted file mode 100644 index f8b4bc8a77a5..000000000000 --- a/reference/cairo/functions/cairo-surface-get-type.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_surface_get_type - Description - - - - &reftitle.description; - - intcairo_surface_get_type - CairoSurfacesurface - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_surface_get_type</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-surface-mark-dirty-rectangle.xml b/reference/cairo/functions/cairo-surface-mark-dirty-rectangle.xml deleted file mode 100644 index 5f51106ae238..000000000000 --- a/reference/cairo/functions/cairo-surface-mark-dirty-rectangle.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - cairo_surface_mark_dirty_rectangle - Description - - - - &reftitle.description; - - voidcairo_surface_mark_dirty_rectangle - CairoSurfacesurface - floatx - floaty - floatwidth - floatheight - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - x - - - Description... - - - - - y - - - Description... - - - - - width - - - Description... - - - - - height - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_surface_mark_dirty_rectangle</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-surface-mark-dirty.xml b/reference/cairo/functions/cairo-surface-mark-dirty.xml deleted file mode 100644 index c0be3d3b157b..000000000000 --- a/reference/cairo/functions/cairo-surface-mark-dirty.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_surface_mark_dirty - Description - - - - &reftitle.description; - - voidcairo_surface_mark_dirty - CairoSurfacesurface - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_surface_mark_dirty</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-surface-set-device-offset.xml b/reference/cairo/functions/cairo-surface-set-device-offset.xml deleted file mode 100644 index 772bdb93620c..000000000000 --- a/reference/cairo/functions/cairo-surface-set-device-offset.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - cairo_surface_set_device_offset - Description - - - - &reftitle.description; - - voidcairo_surface_set_device_offset - CairoSurfacesurface - floatx - floaty - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - x - - - Description... - - - - - y - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_surface_set_device_offset</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-surface-set-fallback-resolution.xml b/reference/cairo/functions/cairo-surface-set-fallback-resolution.xml deleted file mode 100644 index 227ba21e2285..000000000000 --- a/reference/cairo/functions/cairo-surface-set-fallback-resolution.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - cairo_surface_set_fallback_resolution - Description - - - - &reftitle.description; - - voidcairo_surface_set_fallback_resolution - CairoSurfacesurface - floatx - floaty - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - x - - - Description... - - - - - y - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_surface_set_fallback_resolution</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-surface-show-page.xml b/reference/cairo/functions/cairo-surface-show-page.xml deleted file mode 100644 index f55b19406aa5..000000000000 --- a/reference/cairo/functions/cairo-surface-show-page.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_surface_show_page - Description - - - - &reftitle.description; - - voidcairo_surface_show_page - CairoSurfacesurface - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_surface_show_page</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-surface-status.xml b/reference/cairo/functions/cairo-surface-status.xml deleted file mode 100644 index c0d97f8c4426..000000000000 --- a/reference/cairo/functions/cairo-surface-status.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_surface_status - Description - - - - &reftitle.description; - - intcairo_surface_status - CairoSurfacesurface - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_surface_status</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-surface-write-to-png.xml b/reference/cairo/functions/cairo-surface-write-to-png.xml deleted file mode 100644 index 58965ed999b0..000000000000 --- a/reference/cairo/functions/cairo-surface-write-to-png.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - cairo_surface_write_to_png - Description - - - - &reftitle.description; - - voidcairo_surface_write_to_png - CairoSurfacesurface - resourcestream - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - stream - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_surface_write_to_png</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-svg-surface-create.xml b/reference/cairo/functions/cairo-svg-surface-create.xml deleted file mode 100644 index e01c993566f8..000000000000 --- a/reference/cairo/functions/cairo-svg-surface-create.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - cairo_svg_surface_create - Description - - - - &reftitle.description; - - CairoSvgSurfacecairo_svg_surface_create - stringfile - floatwidth - floatheight - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - file - - - Description... - - - - - width - - - Description... - - - - - height - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_svg_surface_create</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-svg-surface-restrict-to-version.xml b/reference/cairo/functions/cairo-svg-surface-restrict-to-version.xml deleted file mode 100644 index 74c4f8f31e00..000000000000 --- a/reference/cairo/functions/cairo-svg-surface-restrict-to-version.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - - cairo_svg_surface_restrict_to_version - Description - - - - &reftitle.description; - - voidcairo_svg_surface_restrict_to_version - CairoSvgSurfacesurface - intversion - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - surface - - - Description... - - - - - version - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_svg_surface_restrict_to_version</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/functions/cairo-svg-version-to-string.xml b/reference/cairo/functions/cairo-svg-version-to-string.xml deleted file mode 100644 index de759c330ee9..000000000000 --- a/reference/cairo/functions/cairo-svg-version-to-string.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - - cairo_svg_version_to_string - Description - - - - &reftitle.description; - - stringcairo_svg_version_to_string - intversion - - - The function description goes here. - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - version - - - Description... - - - - - - - - - &reftitle.returnvalues; - - - What is returned on success and failure - - - - - &reftitle.errors; - - When does this function issue E_* level errors, and/or throw exceptions. - - - - - &reftitle.examples; - - - <function>cairo_svg_version_to_string</function> example - - Any text that describes the purpose of the example, or what - goes on in the example should be here. - - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - related function name here - - - - - - - diff --git a/reference/cairo/reference.xml b/reference/cairo/reference.xml deleted file mode 100644 index e70553ae220b..000000000000 --- a/reference/cairo/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - Cairo &Functions; - - &reference.cairo.entities.functions; - - - - - diff --git a/reference/cairo/setup.xml b/reference/cairo/setup.xml deleted file mode 100644 index 3fbd27cc0213..000000000000 --- a/reference/cairo/setup.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.required; - - Cairo is only available for PHP 5.2+ and PHP 5.3+ The extension also requires - the cairo graphics library version 1.4 or higher. The cairo graphics library - uses an even and odd numbering scheme to denote stable and unstable library - versions. Both unstable and stable versions can be used with the extension, - but conditional support for new features is determined by the stable version - below the unstable version in use. The latest cairo release can be found at - &url.cairo;. - - - The binary files used for the windows compiles can be found at - &url.cairo.dl; along with the project - files used to create them. - -
- -
- &reftitle.install; - - &pecl.info; - &url.pecl.package;cairo. - - - &pecl.windows.download; - - - Notes specific to installation on Windows - - - Binary builds of the extension can be found at - &url.cairo.dl;. - Download the correct zip file, place php_cairo.dll in the extensions - directory, and enable it via the php.ini file in use. Please be sure the PHP - minor version (5.2, 5.3) match, the thread safety (Thread Safe TS or - Non-Thread Safe NTS), the architecture (x86 or x64), and the compiler - version (VC6 or VC9) match or the extension will not load. - -
- - -
- &reftitle.runtime; - &no.config; -
- - -
- &reftitle.resources; - &no.resource; -
- - - - - diff --git a/reference/cairo/versions.xml b/reference/cairo/versions.xml deleted file mode 100644 index e13f744dae49..000000000000 --- a/reference/cairo/versions.xml +++ /dev/null @@ -1,580 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/chdb/book.xml b/reference/chdb/book.xml deleted file mode 100644 index 454b5429aeea..000000000000 --- a/reference/chdb/book.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - Constant hash database - chdb - - - &reftitle.intro; - - CHDB (constant hash database) is a fast key-value database for constant data, - realized by using a memory-mapped file and thus providing the following - functionalities: - - - - Extremely fast initial load, regardless of the size of the database. - - - - - Only the pages of the file which are actually used are loaded from the - disk. - - - - - Once a page is loaded it is shared across multiple processes. - - - - - Loaded pages are cached across multiple requests and even process recycling. - - - - - - A typical use of CHDB is as a faster alternative to defining many PHP - constants. - - - CHDB is internally implemented as a hash-table using a - perfect hashing - function, thus guaranteeing worst case O(1) lookup time. - - - - &reference.chdb.setup; - &reference.chdb.constants; - &reference.chdb.examples; - &reference.chdb.chdb; - &reference.chdb.reference; - - - - diff --git a/reference/chdb/chdb.xml b/reference/chdb/chdb.xml deleted file mode 100644 index feca19bab359..000000000000 --- a/reference/chdb/chdb.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - The chdb class - chdb - - - - -
- &reftitle.intro; - - Represents a loaded chdb file. - -
- - -
- &reftitle.classsynopsis; - - - - chdb - - - - - chdb - - - - - Methods - - - - -
- - - - &reference.chdb.entities.chdb; - - - - diff --git a/reference/chdb/chdb/construct.xml b/reference/chdb/chdb/construct.xml deleted file mode 100644 index 3219d8b92f39..000000000000 --- a/reference/chdb/chdb/construct.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - chdb::__construct - Creates a chdb instance - - - - &reftitle.description; - - public chdb::__construct - stringpathname - - - Loads a chdb file, by mapping it into memory. - - - While some validity checks are performed on the specified file, they are - mostly there to avoid the possibility of common mistakes (for example, - loading a file which is not a chdb database, or that is somehow - incompatible with the current system). A maliciously crafted chdb file can - thus be dangerous if loaded, so chdb files should be trusted and treated - with the same security protections used for PHP shared libraries. - - - - - - - &reftitle.parameters; - - - pathname - - - The name of the file to load. - - - - - - - - &reftitle.errors; - - Throws an exception in case the chdb file hasn't been successfully loaded. - - - - A valid chdb file might fail to load in case it was created on an - architecture with a different endianness, with a different version of chdb, - or if the file is too big to be mapped into memory (mostly in case of huge - files and 32-bit architectures). In these cases the load will fail by - throwing an exception, but otherwise not performing any illegal operation. - - - - - - - - diff --git a/reference/chdb/chdb/get.xml b/reference/chdb/chdb/get.xml deleted file mode 100644 index 3fbf4d1b952f..000000000000 --- a/reference/chdb/chdb/get.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - - chdb::get - Gets the value associated with a key - - - - &reftitle.description; - - public stringchdb::get - stringkey - - - Gets the value associated with a key from a chdb database. - - - - - &reftitle.parameters; - - - key - - - The key for which to get the value. - - - - - - - - &reftitle.returnvalues; - - Returns a string containing the value associated with the given - key, or &null; if not found. - - - - - &reftitle.examples; - - <function>chdb::get</function> example - - 'value1', - 'key2' => 'value2', - // ... -); -chdb_create('data.chdb', $data); - -$chdb = new chdb('data.chdb'); -$value1 = $chdb->get('key1'); -$value2 = $chdb->get('key2'); - -echo $value1, PHP_EOL; -echo $value2, PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/chdb/configure.xml b/reference/chdb/configure.xml deleted file mode 100644 index 7e99b8391b42..000000000000 --- a/reference/chdb/configure.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;chdb - - - - cmph (version 0.9) is required - for installing this extension. If cmph is installed in a - non-standard directory, use the - switch, - where DIR is the cmph install prefix. - - -
- - - diff --git a/reference/chdb/constants.xml b/reference/chdb/constants.xml deleted file mode 100644 index 16367ed0a23e..000000000000 --- a/reference/chdb/constants.xml +++ /dev/null @@ -1,28 +0,0 @@ - - - - - &reftitle.constants; - &no.constants; - - - diff --git a/reference/chdb/examples.xml b/reference/chdb/examples.xml deleted file mode 100644 index ecf489a5988a..000000000000 --- a/reference/chdb/examples.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - &reftitle.examples; - - Creating a chdb file - - 'value1', - 'key2' => 'value2', - // ... -); -chdb_create('data.chdb', $data); - -?> -]]> - - - The above example will generate a chdb file named - data.chdb and containing the key-value pairs defined in - $data. - - - - Loading and looking up a chdb file - -get('key1'); -$value2 = $chdb->get('key2'); - -echo $value1, PHP_EOL; -echo $value2, PHP_EOL; - -?> -]]> - - &example.outputs.similar; - - - - - - - diff --git a/reference/chdb/functions/chdb-create.xml b/reference/chdb/functions/chdb-create.xml deleted file mode 100644 index 2eaab41439da..000000000000 --- a/reference/chdb/functions/chdb-create.xml +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - chdb_create - Creates a chdb file - - - - &reftitle.description; - - boolchdb_create - stringpathname - arraydata - - - chdb_create creates a chdb file containing the - specified key-value pairs. - - - - chdb files are not portable across little-endian and big-endian - environments. Except for that, they are portable across different - architectures. Also compatibility across different versions of chdb is not - guaranteed. - - - - - - &reftitle.parameters; - - - pathname - - - The name of the file to create. - - - If a file with the same name already exists, it is overwritten. - - - - - data - - - An array containing the key-value pairs to store in the chdb file. - - - Keys and values are converted to strings before being written to the file, - as chdb only support the string type. Note that binary strings are - supported as well, both as keys and values. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Throws an exception in case the chdb file hasn't been successfully created. - - - - - &reftitle.examples; - - <function>chdb_create</function> example - - 'value1', - 'key2' => 'value2', - // ... -); -chdb_create('data.chdb', $data); - -?> -]]> - - - The above example will generate a chdb file named - data.chdb and containing the key-value pairs defined in - $data. - - - - - - - - diff --git a/reference/chdb/reference.xml b/reference/chdb/reference.xml deleted file mode 100644 index 40be8987070b..000000000000 --- a/reference/chdb/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - chdb &Functions; - - &reference.chdb.entities.functions; - - - - diff --git a/reference/chdb/setup.xml b/reference/chdb/setup.xml deleted file mode 100644 index 07ec69052b5c..000000000000 --- a/reference/chdb/setup.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.required; - - This module uses cmph (version 0.9) for - providing the perfect hashing - function. - - - cmph 0.9 is required to install this module. - -
- - - &reference.chdb.configure; - - -
- &reftitle.runtime; - &no.config; -
- -
- &reftitle.resources; - &no.resource; -
- - - - diff --git a/reference/chdb/versions.xml b/reference/chdb/versions.xml deleted file mode 100644 index 61dd33e792f4..000000000000 --- a/reference/chdb/versions.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/reference/classkit/book.xml b/reference/classkit/book.xml index 4faf207f7a1b..58d5ab32d98e 100644 --- a/reference/classkit/book.xml +++ b/reference/classkit/book.xml @@ -12,7 +12,7 @@ This extension has been replaced by - runkit, which is not limited to class + runkit, which is not limited to class manipulation but has function manipulation, as well. diff --git a/reference/classobj/functions/class-exists.xml b/reference/classobj/functions/class-exists.xml index 79615bc8e2c8..4c0d2d83e9da 100644 --- a/reference/classobj/functions/class-exists.xml +++ b/reference/classobj/functions/class-exists.xml @@ -46,30 +46,6 @@ &false; otherwise. - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.0.2 - - No longer returns &true; for defined interfaces. Use - interface_exists. - - - - - - - &reftitle.examples; diff --git a/reference/classobj/functions/get-class-vars.xml b/reference/classobj/functions/get-class-vars.xml index 8c93204dd7d8..9f388a281b92 100644 --- a/reference/classobj/functions/get-class-vars.xml +++ b/reference/classobj/functions/get-class-vars.xml @@ -40,46 +40,6 @@ In case of an error, it returns &false;. - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.0.3 - - get_class_vars will - only return the properties that can be accessed from the current - scope. - - - - 5.0.2 - - Calling get_class_vars will now expose - all the properties as an array, unlike previous behaviour where - protected and private properties were prefixed with nul bytes. - - - - 5.0.1 - - Calling get_class_vars will expose all - properties, as when converting an object to a class. - - - - - - - &reftitle.examples; diff --git a/reference/classobj/functions/get-class.xml b/reference/classobj/functions/get-class.xml index b1af2bf97ff9..e997c57f9a32 100644 --- a/reference/classobj/functions/get-class.xml +++ b/reference/classobj/functions/get-class.xml @@ -79,18 +79,12 @@ 7.2.0 - &null; was removed as the default value for object, + Prior to this version the default value for object + was &null; and it had the same effect as not passing any value. Now + &null; has been removed as the default value for object, and is no longer a valid input. - - 5.3.0 - - &null; became the default value for object, - so passing &null; to object now has the same - result as not passing any value. - - diff --git a/reference/classobj/functions/get-object-vars.xml b/reference/classobj/functions/get-object-vars.xml index 21950c1cb494..8c9c274c10a5 100644 --- a/reference/classobj/functions/get-object-vars.xml +++ b/reference/classobj/functions/get-object-vars.xml @@ -38,30 +38,6 @@ for the specified object in scope. - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function now returns &null; if the - object isn't an object. Previously &false; was returned. - - - - - - - &reftitle.examples; diff --git a/reference/classobj/functions/get-parent-class.xml b/reference/classobj/functions/get-parent-class.xml index 9149b1765ad8..1902372643d1 100644 --- a/reference/classobj/functions/get-parent-class.xml +++ b/reference/classobj/functions/get-parent-class.xml @@ -46,30 +46,6 @@ If called without parameter outside object, this function returns &false;. - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.0 - - If called without parameter outside object, this function would have - returned &null; with a warning, but now returns &false;. - - - - - - - &reftitle.examples; diff --git a/reference/classobj/functions/is-a.xml b/reference/classobj/functions/is-a.xml index 16dbd9376206..c9ef39f4fe4c 100644 --- a/reference/classobj/functions/is-a.xml +++ b/reference/classobj/functions/is-a.xml @@ -57,45 +57,6 @@ its parents, &false; otherwise. - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.9 - - Added allow_string parameter - - - - 5.3.0 - - This function is no longer deprecated, and will therefore - no longer throw E_STRICT warnings. - - - - 5.0.0 - - This function became deprecated in favour of the - instanceof - operator. Calling this function will result in an - E_STRICT warning. - - - - - - - &reftitle.examples; diff --git a/reference/classobj/functions/is-subclass-of.xml b/reference/classobj/functions/is-subclass-of.xml index b76bff7da3a0..5f35b4e76041 100644 --- a/reference/classobj/functions/is-subclass-of.xml +++ b/reference/classobj/functions/is-subclass-of.xml @@ -58,43 +58,6 @@ class_name, &false; otherwise. - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.9 - - Added allow_string parameter - - - - 5.3.7 - - Added support for class_name to work with - interfaces - - - - 5.0.3 - - You may also specify the object parameter as a - string (the name of the class) - - - - - - - &reftitle.examples; diff --git a/reference/classobj/functions/property-exists.xml b/reference/classobj/functions/property-exists.xml index fbb75e65acec..9933874fb8db 100644 --- a/reference/classobj/functions/property-exists.xml +++ b/reference/classobj/functions/property-exists.xml @@ -70,30 +70,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function checks the existence of a property independent of - accessibility. - - - - - - - &reftitle.examples; diff --git a/reference/crack/book.xml b/reference/crack/book.xml deleted file mode 100644 index 79897638372e..000000000000 --- a/reference/crack/book.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - Cracklib - Crack - - - - &reftitle.intro; - - These functions allow you to use the CrackLib library to test the - 'strength' of a password. The 'strength' of a password is tested by that - checks length, use of upper and lower case and checked against the - specified CrackLib dictionary. CrackLib will also give helpful diagnostic - messages that will help 'strengthen' the password. - - - - &pecl.moved-ver;5.0.0. - - - - - - &reference.crack.setup; - &reference.crack.constants; - &reference.crack.examples; - &reference.crack.reference; - - - - - diff --git a/reference/crack/configure.xml b/reference/crack/configure.xml deleted file mode 100644 index 5145faa10191..000000000000 --- a/reference/crack/configure.xml +++ /dev/null @@ -1,41 +0,0 @@ - - -
- &reftitle.install; - - &pecl.moved; - &pecl.info; - &url.pecl.package;crack. - - - In order to use these functions you must compile PHP with Crack support - by using the - configuration option. - - - Windows users will enable php_crack.dll inside - of &php.ini; in order to use these functions. - &pecl.windows.download; - -
- - diff --git a/reference/crack/constants.xml b/reference/crack/constants.xml deleted file mode 100644 index 8bf39a77db67..000000000000 --- a/reference/crack/constants.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - &reftitle.constants; - &no.constants; - - - - diff --git a/reference/crack/examples.xml b/reference/crack/examples.xml deleted file mode 100644 index 58d5c507c09b..000000000000 --- a/reference/crack/examples.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - &reftitle.examples; - - This example shows how to open a CrackLib dictionary, test a given - password, retrieve any diagnostic messages, and close the dictionary. - - CrackLib example - - -]]> - - - - - - If crack_check returns &true;, - crack_getlastmessage will return - 'strong password'. - - - - - - diff --git a/reference/crack/functions/crack-check.xml b/reference/crack/functions/crack-check.xml deleted file mode 100644 index 92df149ec30b..000000000000 --- a/reference/crack/functions/crack-check.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - crack_check - Performs an obscure check with the given password - - - &reftitle.description; - - boolcrack_check - resourcedictionary - stringpassword - - - boolcrack_check - stringpassword - stringusername"" - stringgecos"" - resourcedictionary&null; - - - Performs an obscure check with the given password on the specified - dictionary. The alternative signature also takes into account the username - and the GECOS information. - - &warn.experimental.func; - - - &reftitle.parameters; - - - - dictionary - - - The crack lib dictionary. If not specified, the last opened dictionary - is used. - - - - - password - - - The password to be checked. - - - - - username - - - The username of the account with the password. - - - - - gecos - - - The GECOS information associated with the user account. - - - - - - - - &reftitle.returnvalues; - - Returns &true; if password is strong, or &false; otherwise. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 0.3 - - The username, gecos and - dictionary parameters were added to the - alternative signature. - - - - - - - - - - - diff --git a/reference/crack/functions/crack-closedict.xml b/reference/crack/functions/crack-closedict.xml deleted file mode 100644 index fa4c0984bbf8..000000000000 --- a/reference/crack/functions/crack-closedict.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - crack_closedict - Closes an open CrackLib dictionary - - - &reftitle.description; - - boolcrack_closedict - resourcedictionary - - - crack_closedict closes the specified - dictionary identifier. - - &warn.experimental.func; - - - &reftitle.parameters; - - - - dictionary - - - The dictionary to close. If not specified, the current dictionary is - closed. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - crack_opendict - - - - - - diff --git a/reference/crack/functions/crack-getlastmessage.xml b/reference/crack/functions/crack-getlastmessage.xml deleted file mode 100644 index 68c8688c18b9..000000000000 --- a/reference/crack/functions/crack-getlastmessage.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - crack_getlastmessage - Returns the message from the last obscure check - - - &reftitle.description; - - stringcrack_getlastmessage - - - - crack_getlastmessage returns the message from the - last obscure check. - - &warn.experimental.func; - - - &reftitle.returnvalues; - - The message from the last obscure check or &false; if there was no obscure - checks made so far. - - - The returned message is one of: - - - - it's WAY too short - - - - - it is too short - - - - - it does not contain enough DIFFERENT characters - - - - - it is all whitespace - - - - - it is too simplistic/systematic - - - - - it looks like a National Insurance number. - - - - - it is based on a dictionary word - - - - - it is based on a (reversed) dictionary word - - - - - strong password - - - - - - - &reftitle.seealso; - - - crack_check - - - - - - diff --git a/reference/crack/functions/crack-opendict.xml b/reference/crack/functions/crack-opendict.xml deleted file mode 100644 index bceeb802d00c..000000000000 --- a/reference/crack/functions/crack-opendict.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - crack_opendict - Opens a new CrackLib dictionary - - - &reftitle.description; - - resourcecrack_opendict - stringdictionary - - - crack_opendict opens the specified CrackLib - dictionary for use with - crack_check. - - &warn.experimental.func; - - - Only one dictionary may be open at a time. - - - - - &reftitle.parameters; - - - - dictionary - - - The path to the Cracklib dictionary. - - - - - - - - &reftitle.returnvalues; - - Returns a dictionary resource identifier on success&return.falseforfailure;. - - - - &reftitle.seealso; - - - crack_check - crack_closedict - - - - - - diff --git a/reference/crack/reference.xml b/reference/crack/reference.xml deleted file mode 100644 index d46c70af2bf4..000000000000 --- a/reference/crack/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - Crack &Functions; - - &reference.crack.entities.functions; - - - - diff --git a/reference/crack/setup.xml b/reference/crack/setup.xml deleted file mode 100644 index 946e1fa9cbfa..000000000000 --- a/reference/crack/setup.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - &reftitle.setup; - - -
- &reftitle.required; - - More information regarding CrackLib along with the library can be found at - &url.crack;. - -
- - - - &reference.crack.configure; - - - -
- &reftitle.runtime; - &no.config; -
- - - -
- &reftitle.resources; - - The CrackLib extension defines a dictionary resource identifier returned - by crack_opendict. - -
- - - - - - diff --git a/reference/crack/versions.xml b/reference/crack/versions.xml deleted file mode 100644 index f45353e156f3..000000000000 --- a/reference/crack/versions.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - - - - - \ No newline at end of file diff --git a/reference/ctype/functions/ctype-digit.xml b/reference/ctype/functions/ctype-digit.xml index 22cac78835d7..ed943b957b80 100644 --- a/reference/ctype/functions/ctype-digit.xml +++ b/reference/ctype/functions/ctype-digit.xml @@ -43,31 +43,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.0 - - Before PHP 5.1.0, this function returned &true; - when text was an empty string. - - - - - - - - &reftitle.examples; diff --git a/reference/curl/functions/curl-getinfo.xml b/reference/curl/functions/curl-getinfo.xml index 830fb1468e20..61d66de6bc46 100644 --- a/reference/curl/functions/curl-getinfo.xml +++ b/reference/curl/functions/curl-getinfo.xml @@ -529,59 +529,6 @@ CURLINFO_TOTAL_TIME_T. - - 5.5.0 - - Introduced CURLINFO_RESPONSE_CODE, - CURLINFO_HTTP_CONNECTCODE, - CURLINFO_HTTPAUTH_AVAIL, - CURLINFO_PROXYAUTH_AVAIL, - CURLINFO_OS_ERRNO, - CURLINFO_NUM_CONNECTS, - CURLINFO_SSL_ENGINES, - CURLINFO_COOKIELIST, - CURLINFO_FTP_ENTRY_PATH, - CURLINFO_APPCONNECT_TIME, - CURLINFO_CONDITION_UNMET, - CURLINFO_RTSP_CLIENT_CSEQ, - CURLINFO_RTSP_CSEQ_RECV, - CURLINFO_RTSP_SERVER_CSEQ and - CURLINFO_RTSP_SESSION_ID. - - - - 5.4.7 - - Introduced CURLINFO_PRIMARY_IP, - CURLINFO_PRIMARY_PORT, - CURLINFO_LOCAL_IP and - CURLINFO_LOCAL_PORT. - - - - 5.3.7 - - Introduced CURLINFO_REDIRECT_URL. - - - - 5.3.0 - - Introduced CURLINFO_CERTINFO. - - - - 5.2.4 - - Introduced CURLINFO_PRIVATE. - - - - 5.1.3 - - Introduced CURLINFO_HEADER_OUT. - - diff --git a/reference/curl/functions/curl-multi-info-read.xml b/reference/curl/functions/curl-multi-info-read.xml index dbd1841fa458..1132daeaec1f 100644 --- a/reference/curl/functions/curl-multi-info-read.xml +++ b/reference/curl/functions/curl-multi-info-read.xml @@ -162,30 +162,6 @@ bool(false) - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.0 - - msgs_in_queue was added. - - - - - - - - &reftitle.seealso; diff --git a/reference/curl/functions/curl-setopt.xml b/reference/curl/functions/curl-setopt.xml index 4e8e84b8c758..496bb51baafe 100644 --- a/reference/curl/functions/curl-setopt.xml +++ b/reference/curl/functions/curl-setopt.xml @@ -2361,81 +2361,6 @@ CURLSSLOPT_NO_REVOKE. - - 7.0.0 - - Support for disabling the CURLOPT_SAFE_UPLOAD option has been removed. - All curl file uploads must use CURLFile. - - - - 5.6.0 - - CURLOPT_SAFE_UPLOAD is now &true; by default. - - - - 5.6.0 - - Removed CURLOPT_CLOSEPOLICY and associated values. - - - - 5.5.0 - - Added the cURL resource as the first argument to the - CURLOPT_PROGRESSFUNCTION callback. - - - - 5.5.0 - - Introduced CURLOPT_SHARE. - - - - 5.3.0 - - Introduced CURLOPT_PROGRESSFUNCTION. - - - - 5.2.10 - - Introduced CURLOPT_PROTOCOLS, and - CURLOPT_REDIR_PROTOCOLS. - - - - 5.2.4 - - Introduced CURLOPT_PRIVATE. - - - - 5.1.0 - - Introduced CURLOPT_AUTOREFERER, - CURLOPT_BINARYTRANSFER, - CURLOPT_FTPSSLAUTH, - CURLOPT_PROXYAUTH, and - CURLOPT_TIMECONDITION. - - - - 5.0.0 - - Introduced CURLOPT_FTP_USE_EPRT, - CURLOPT_NOSIGNAL, - CURLOPT_UNRESTRICTED_AUTH, - CURLOPT_BUFFERSIZE, - CURLOPT_HTTPAUTH, - CURLOPT_PROXYPORT, - CURLOPT_PROXYTYPE, - CURLOPT_SSLCERTTYPE, and - CURLOPT_HTTP200ALIASES. - - diff --git a/reference/cyrus/book.xml b/reference/cyrus/book.xml deleted file mode 100644 index 9f0c367c5191..000000000000 --- a/reference/cyrus/book.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - Cyrus IMAP administration - Cyrus - - - - &reftitle.intro; - - ¬e.no-windows.extension; - - - - &pecl.moved-ver;5.0.0. - - - - - - &reference.cyrus.setup; - &reference.cyrus.constants; - &reference.cyrus.reference; - - - - - diff --git a/reference/cyrus/configure.xml b/reference/cyrus/configure.xml deleted file mode 100644 index 82740015c1f5..000000000000 --- a/reference/cyrus/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - -
- &reftitle.install; - - To enable Cyrus IMAP support and to use these functions you have to compile - PHP with the option. - - - &warn.imaprecodeyaz; - -
- - diff --git a/reference/cyrus/constants.xml b/reference/cyrus/constants.xml deleted file mode 100644 index 33e98c46ae75..000000000000 --- a/reference/cyrus/constants.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - CYRUS_CONN_NONSYNCLITERAL - (integer) - - - - - - - - - - CYRUS_CONN_INITIALRESPONSE - (integer) - - - - - - - - - - CYRUS_CALLBACK_NUMBERED - (integer) - - - - - - - - - - CYRUS_CALLBACK_NOLITERAL - (integer) - - - - - - - - - - - diff --git a/reference/cyrus/functions/cyrus-authenticate.xml b/reference/cyrus/functions/cyrus-authenticate.xml deleted file mode 100644 index 498c6718e8c3..000000000000 --- a/reference/cyrus/functions/cyrus-authenticate.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - cyrus_authenticate - Authenticate against a Cyrus IMAP server - - - &reftitle.description; - - voidcyrus_authenticate - resourceconnection - stringmechlist - stringservice - stringuser - intminssf - intmaxssf - stringauthname - stringpassword - - &warn.undocumented.func; - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/cyrus/functions/cyrus-bind.xml b/reference/cyrus/functions/cyrus-bind.xml deleted file mode 100644 index 6ab1caba2025..000000000000 --- a/reference/cyrus/functions/cyrus-bind.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - cyrus_bind - Bind callbacks to a Cyrus IMAP connection - - - &reftitle.description; - - boolcyrus_bind - resourceconnection - arraycallbacks - - - Binds callbacks to a Cyrus IMAP connection. - - - - &reftitle.parameters; - - - - connection - - - The connection handle. - - - - - callbacks - - - An array of callbacks. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/cyrus/functions/cyrus-close.xml b/reference/cyrus/functions/cyrus-close.xml deleted file mode 100644 index 8b568e4c901b..000000000000 --- a/reference/cyrus/functions/cyrus-close.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - cyrus_close - Close connection to a Cyrus IMAP server - - - &reftitle.description; - - boolcyrus_close - resourceconnection - - - Closes the connection to a Cyrus IMAP server. - - - - &reftitle.parameters; - - - - connection - - - The connection handle. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/cyrus/functions/cyrus-connect.xml b/reference/cyrus/functions/cyrus-connect.xml deleted file mode 100644 index aa4bfcf0ddc8..000000000000 --- a/reference/cyrus/functions/cyrus-connect.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - cyrus_connect - Connect to a Cyrus IMAP server - - - &reftitle.description; - - resourcecyrus_connect - stringhost - stringport - intflags - - - Connects to a Cyrus IMAP server. - - - - &reftitle.parameters; - - - - host - - - The Cyrus IMAP host name. - - - - - port - - - The port number. - - - - - flags - - - - - - - - - - &reftitle.returnvalues; - - Returns a connection handler on success&return.falseforfailure;. - - - - - diff --git a/reference/cyrus/functions/cyrus-query.xml b/reference/cyrus/functions/cyrus-query.xml deleted file mode 100644 index 7bd5e82e016b..000000000000 --- a/reference/cyrus/functions/cyrus-query.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - cyrus_query - Send a query to a Cyrus IMAP server - - - &reftitle.description; - - arraycyrus_query - resourceconnection - stringquery - - - Sends a query to a Cyrus IMAP server. - - - - &reftitle.parameters; - - - - connection - - - The connection handle. - - - - - query - - - The query string. - - - - - - - - &reftitle.returnvalues; - - Returns an associative array with the following keys: - text, msgno, - and keyword. - - - - - diff --git a/reference/cyrus/functions/cyrus-unbind.xml b/reference/cyrus/functions/cyrus-unbind.xml deleted file mode 100644 index 3d81a58bd77c..000000000000 --- a/reference/cyrus/functions/cyrus-unbind.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - cyrus_unbind - Unbind ... - - - &reftitle.description; - - boolcyrus_unbind - resourceconnection - stringtrigger_name - - &warn.undocumented.func; - - - &reftitle.parameters; - - - - connection - - - The connection handle. - - - - - trigger_name - - - The trigger name. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/cyrus/reference.xml b/reference/cyrus/reference.xml deleted file mode 100644 index 89816b430148..000000000000 --- a/reference/cyrus/reference.xml +++ /dev/null @@ -1,28 +0,0 @@ - - - - - Cyrus &Functions; - - &reference.cyrus.entities.functions; - - - - - diff --git a/reference/cyrus/setup.xml b/reference/cyrus/setup.xml deleted file mode 100644 index c71cf9e6b7d2..000000000000 --- a/reference/cyrus/setup.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - &reftitle.setup; - - -
- &reftitle.required; - &no.requirement; -
- - - - &reference.cyrus.configure; - - - -
- &reftitle.runtime; - &no.config; -
- - - -
- &reftitle.resources; - - This extension defines a Cyrus IMAP connection identifier returned by - cyrus_connect. - -
- - - - - - diff --git a/reference/cyrus/versions.xml b/reference/cyrus/versions.xml deleted file mode 100644 index efdad16c6bf9..000000000000 --- a/reference/cyrus/versions.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/datetime/datetime/construct.xml b/reference/datetime/datetime/construct.xml index ee9499349e44..8c0c0a7fd89f 100644 --- a/reference/datetime/datetime/construct.xml +++ b/reference/datetime/datetime/construct.xml @@ -94,17 +94,9 @@ - 7.1 + 7.1.0 From now on microseconds are filled with actual value. Not with '00000'. - - 5.3.0 - - If datetime contains an invalid - date/time format, then an - exception is now thrown. Previously an error was emitted. - - diff --git a/reference/datetime/datetime/createfromformat.xml b/reference/datetime/datetime/createfromformat.xml index 49fdcf6ef17f..4378ce456386 100644 --- a/reference/datetime/datetime/createfromformat.xml +++ b/reference/datetime/datetime/createfromformat.xml @@ -369,12 +369,6 @@ The v format specifier has been added. - - 5.3.9 - - The + format specifier has been added. - - diff --git a/reference/datetime/datetime/modify.xml b/reference/datetime/datetime/modify.xml index 9f157e992945..247c5b2f5e04 100644 --- a/reference/datetime/datetime/modify.xml +++ b/reference/datetime/datetime/modify.xml @@ -47,30 +47,6 @@ - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 5.3.6 - - Absolute date/time statements now take effect. - Previously, only relative parts were used. - - - &date.datetime.retval.changelog; - - - - - &reftitle.examples; diff --git a/reference/datetime/datetime/setdate.xml b/reference/datetime/datetime/setdate.xml index 8a07bd68478e..5dd3abfd514b 100644 --- a/reference/datetime/datetime/setdate.xml +++ b/reference/datetime/datetime/setdate.xml @@ -68,23 +68,6 @@ - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &date.datetime.retval.changelog; - - - - - &reftitle.examples; diff --git a/reference/datetime/datetime/setisodate.xml b/reference/datetime/datetime/setisodate.xml index c8cb45be184f..a6dcca71816e 100644 --- a/reference/datetime/datetime/setisodate.xml +++ b/reference/datetime/datetime/setisodate.xml @@ -69,23 +69,6 @@ - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &date.datetime.retval.changelog; - - - - - &reftitle.examples; diff --git a/reference/datetime/datetime/settime.xml b/reference/datetime/datetime/settime.xml index 757a598e187f..cfa1b2bc07da 100644 --- a/reference/datetime/datetime/settime.xml +++ b/reference/datetime/datetime/settime.xml @@ -93,7 +93,6 @@ 7.1.0 The microsecond parameter was added. - &date.datetime.retval.changelog; diff --git a/reference/datetime/datetime/settimezone.xml b/reference/datetime/datetime/settimezone.xml index 41f76320187a..2aee180e9b7c 100644 --- a/reference/datetime/datetime/settimezone.xml +++ b/reference/datetime/datetime/settimezone.xml @@ -49,23 +49,6 @@ - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - &date.datetime.retval.changelog; - - - - - &reftitle.examples; diff --git a/reference/datetime/datetimezone/gettransitions.xml b/reference/datetime/datetimezone/gettransitions.xml index 6b534d058e38..90f4a782e47a 100644 --- a/reference/datetime/datetimezone/gettransitions.xml +++ b/reference/datetime/datetimezone/gettransitions.xml @@ -57,31 +57,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - The optional timestampBegin and timestampEnd - were added. - - - - - - - - &reftitle.examples; diff --git a/reference/datetime/datetimezone/listidentifiers.xml b/reference/datetime/datetimezone/listidentifiers.xml index 4095a902d44f..8e3a110e0a77 100644 --- a/reference/datetime/datetimezone/listidentifiers.xml +++ b/reference/datetime/datetimezone/listidentifiers.xml @@ -59,31 +59,6 @@ Returns array on success&return.falseforfailure;. - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - Added the optional timezoneGroup and - countryCode parameters. - - - - - - - &reftitle.examples; diff --git a/reference/datetime/functions/date-default-timezone-get.xml b/reference/datetime/functions/date-default-timezone-get.xml index fea1c001ca95..a96fbb8d4e15 100644 --- a/reference/datetime/functions/date-default-timezone-get.xml +++ b/reference/datetime/functions/date-default-timezone-get.xml @@ -59,38 +59,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - The TZ environment variable is no longer used to - guess the timezone. - - - - 5.4.0 - - The timezone is no longer guessed from information available through the - operating system as the guessed timezone can not be relied on. - - - - - - - - &reftitle.examples; diff --git a/reference/datetime/functions/date-default-timezone-set.xml b/reference/datetime/functions/date-default-timezone-set.xml index c3d111b3da4b..7edb6d78038a 100644 --- a/reference/datetime/functions/date-default-timezone-set.xml +++ b/reference/datetime/functions/date-default-timezone-set.xml @@ -86,38 +86,6 @@ if (strcmp($script_tz, ini_get('date.timezone'))){ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - Now throws E_WARNING rather than - E_STRICT. - - - - 5.1.2 - - The function started to validate the - timezoneID parameter. - - - - - - - - &reftitle.seealso; diff --git a/reference/datetime/functions/date-sun-info.xml b/reference/datetime/functions/date-sun-info.xml index d6f16b993337..840c194fb479 100644 --- a/reference/datetime/functions/date-sun-info.xml +++ b/reference/datetime/functions/date-sun-info.xml @@ -141,29 +141,6 @@ - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 5.2.2 - - The order of latitude and - longitude has been swapped. - - - - - - - &reftitle.examples; diff --git a/reference/datetime/functions/date-sunrise.xml b/reference/datetime/functions/date-sunrise.xml index 2d846af9712f..f21fe230d003 100644 --- a/reference/datetime/functions/date-sunrise.xml +++ b/reference/datetime/functions/date-sunrise.xml @@ -161,27 +161,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - &date.timezone.errors.changelog; - - - - - - - &reftitle.examples; diff --git a/reference/datetime/functions/date-sunset.xml b/reference/datetime/functions/date-sunset.xml index e5419c7d9e24..d95d0710e047 100644 --- a/reference/datetime/functions/date-sunset.xml +++ b/reference/datetime/functions/date-sunset.xml @@ -153,27 +153,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - &date.timezone.errors.changelog; - - - - - - - &reftitle.returnvalues; diff --git a/reference/datetime/functions/date.xml b/reference/datetime/functions/date.xml index 77c8ce7d9181..ea96767cc351 100644 --- a/reference/datetime/functions/date.xml +++ b/reference/datetime/functions/date.xml @@ -54,44 +54,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.1 - - There are useful constants - of standard date/time formats that can be used to specify the - format parameter. - - - - 5.1.0 - - The valid range of a timestamp is typically from Fri, 13 Dec - 1901 20:45:54 GMT to Tue, 19 Jan 2038 03:14:07 GMT. (These are - the dates that correspond to the minimum and maximum values for - a 32-bit signed integer). However, before PHP 5.1.0 this range was limited - from 01-01-1970 to 19-01-2038 on some systems (e.g. Windows). - - - - &date.timezone.errors.changelog; - - - - - - &reftitle.examples; diff --git a/reference/datetime/functions/gettimeofday.xml b/reference/datetime/functions/gettimeofday.xml index 42c8b6206d00..30b2e3a6f6fa 100644 --- a/reference/datetime/functions/gettimeofday.xml +++ b/reference/datetime/functions/gettimeofday.xml @@ -68,30 +68,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.0 - - The returnFloat parameter was added. - - - - - - - - &reftitle.examples; diff --git a/reference/datetime/functions/gmdate.xml b/reference/datetime/functions/gmdate.xml index c8c168d053bc..ccbed97c379e 100644 --- a/reference/datetime/functions/gmdate.xml +++ b/reference/datetime/functions/gmdate.xml @@ -46,42 +46,6 @@ timestamp, &false; is returned and an E_WARNING level error is emitted. - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.1 - - There are useful constants - of standard date/time formats that can be used to specify the - format parameter. - - - - 5.1.0 - - The valid range of a timestamp is typically from Fri, 13 Dec - 1901 20:45:54 GMT to Tue, 19 Jan 2038 03:14:07 GMT. (These are - the dates that correspond to the minimum and maximum values for - a 32-bit signed integer). However, before PHP 5.1.0 this range was limited - from 01-01-1970 to 19-01-2038 on some systems (e.g. Windows). - - - - - - diff --git a/reference/datetime/functions/gmmktime.xml b/reference/datetime/functions/gmmktime.xml index 1d46769d6c5e..366146979ff2 100644 --- a/reference/datetime/functions/gmmktime.xml +++ b/reference/datetime/functions/gmmktime.xml @@ -120,38 +120,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 7.0.0 - - isDST parameter has been removed. - - - - 5.1.0 - - As of PHP 5.1.0, the isDST parameter became - deprecated. As a result, the new timezone handling features should be used - instead. - - - - - - - - &reftitle.examples; diff --git a/reference/datetime/functions/idate.xml b/reference/datetime/functions/idate.xml index 322e8cdc6c97..b3a9d9a34b14 100644 --- a/reference/datetime/functions/idate.xml +++ b/reference/datetime/functions/idate.xml @@ -148,27 +148,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - &date.timezone.errors.changelog; - - - - - - - &reftitle.examples; diff --git a/reference/datetime/functions/localtime.xml b/reference/datetime/functions/localtime.xml index 52b4ba47f947..b072c8c6a3d8 100644 --- a/reference/datetime/functions/localtime.xml +++ b/reference/datetime/functions/localtime.xml @@ -103,27 +103,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - &date.timezone.errors.changelog; - - - - - - - &reftitle.examples; diff --git a/reference/datetime/functions/mktime.xml b/reference/datetime/functions/mktime.xml index 11b3fd63264d..c5e0de1402db 100644 --- a/reference/datetime/functions/mktime.xml +++ b/reference/datetime/functions/mktime.xml @@ -160,58 +160,6 @@ &date.timezone.errors.description; - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 7.0.0 - - isDST parameter has been removed. - - - - 5.3.0 - - mktime now throws E_DEPRECATED notice - if the isDST parameter is used. - - - - 5.1.0 - - The isDST parameter became deprecated. - Made the function return &false; on error, instead of - -1. - Fixed the function to accept the year, month and day to be all passed - as zero. - - - - 5.1.0 - - When called with no arguments, mktime throws - E_STRICT notice. Use the - time function instead. - - - - &date.timezone.errors.changelog; - - - - - - - &reftitle.examples; diff --git a/reference/datetime/functions/strftime.xml b/reference/datetime/functions/strftime.xml index 94793c617275..d811e4f5deef 100644 --- a/reference/datetime/functions/strftime.xml +++ b/reference/datetime/functions/strftime.xml @@ -372,27 +372,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - &date.timezone.errors.changelog; - - - - - - - &reftitle.examples; diff --git a/reference/datetime/functions/strtotime.xml b/reference/datetime/functions/strtotime.xml index 5ba5f524ea5b..582eecd8876b 100644 --- a/reference/datetime/functions/strtotime.xml +++ b/reference/datetime/functions/strtotime.xml @@ -21,7 +21,7 @@ now is not supplied. - + The Unix timestamp that this function returns does not contain information about time zones. In order to do calculations with date/time information, you should use the more capable DateTimeImmutable. @@ -74,77 +74,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - Prior to PHP 5.3.0, relative time formats supplied to the - datetime argument of strtotime - such as this week, previous week, - last week, and next week were - interpreted to mean a 7 day period relative to the current date/time, rather - than a week period of Monday through Sunday. - - - - 5.3.0 - - Prior to PHP 5.3.0, 24:00 was not a valid format and - strtotime returned &false;. - - - - 5.2.7 - - In PHP 5 prior to 5.2.7, requesting a given occurrence of a - given weekday in a month where that weekday was the first day - of the month would incorrectly add one week to the returned - timestamp. This has been corrected in 5.2.7 and later - versions. - - - - 5.1.0 - - Now returns &false; on failure, instead - of -1. - - - - &date.timezone.errors.changelog; - - - 5.0.2 - - In PHP 5 up to 5.0.2, "now" and other - relative times are wrongly computed from today's - midnight. This differs from other versions where it is - correctly computed from current time. - - - - 5.0.0 - - Microseconds began to be allowed, but they are ignored. - - - - - - - - &reftitle.examples; diff --git a/reference/dbx/setup.xml b/reference/dbx/setup.xml index 40f8168bfb80..7a0c81b15c86 100644 --- a/reference/dbx/setup.xml +++ b/reference/dbx/setup.xml @@ -18,11 +18,6 @@ FrontBase - - - Microsoft SQL Server - - MySQL @@ -38,11 +33,6 @@ PostgreSQL - - - Sybase-CT - - Oracle (oci8) diff --git a/reference/dir/functions/scandir.xml b/reference/dir/functions/scandir.xml index 183cedd8d6df..254908dfcd6c 100644 --- a/reference/dir/functions/scandir.xml +++ b/reference/dir/functions/scandir.xml @@ -69,34 +69,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - sorting_order constants - were added. Any nonzero value caused descending order in previous versions. So - for all PHP versions, use 0 for ascending order, and 1 - for descending order. An option for SCANDIR_SORT_NONE behavior did not - exist prior to PHP 5.4.0. - - - - - - - - &reftitle.examples; diff --git a/reference/dom/domdocument/loadhtml.xml b/reference/dom/domdocument/loadhtml.xml index da6fce11a844..338b311f34c7 100644 --- a/reference/dom/domdocument/loadhtml.xml +++ b/reference/dom/domdocument/loadhtml.xml @@ -82,31 +82,7 @@ echo $doc->saveHTML(); - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - Added options parameter. - - - - - - - - + &reftitle.seealso; diff --git a/reference/dom/domdocument/loadhtmlfile.xml b/reference/dom/domdocument/loadhtmlfile.xml index 553efce4e152..137d307cba8b 100644 --- a/reference/dom/domdocument/loadhtmlfile.xml +++ b/reference/dom/domdocument/loadhtmlfile.xml @@ -81,31 +81,7 @@ echo $doc->saveHTML(); - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - Added options parameter. - - - - - - - - + &reftitle.seealso; diff --git a/reference/dom/domdocument/registernodeclass.xml b/reference/dom/domdocument/registernodeclass.xml index 17fdc3dff4aa..7dd5b5e747fa 100644 --- a/reference/dom/domdocument/registernodeclass.xml +++ b/reference/dom/domdocument/registernodeclass.xml @@ -56,40 +56,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.2 - - Prior to 5.2.2, a previously registered extendedclass - had to be unregistered before being able to register a new class extending - the same baseclass. - - - - - - - - - &reftitle.examples; diff --git a/reference/dom/domdocument/save.xml b/reference/dom/domdocument/save.xml index b39bdd50eb5c..afd84c641321 100644 --- a/reference/dom/domdocument/save.xml +++ b/reference/dom/domdocument/save.xml @@ -52,30 +52,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.0 - - Added the options parameter - - - - - - - - &reftitle.examples; diff --git a/reference/dom/domdocument/savehtml.xml b/reference/dom/domdocument/savehtml.xml index 7f8dd061b1e5..6894339015ce 100644 --- a/reference/dom/domdocument/savehtml.xml +++ b/reference/dom/domdocument/savehtml.xml @@ -42,30 +42,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.6 - - The node parameter was added. - - - - - - - - &reftitle.examples; diff --git a/reference/dom/domdocument/savexml.xml b/reference/dom/domdocument/savexml.xml index cbb9d832d488..571c044becc4 100644 --- a/reference/dom/domdocument/savexml.xml +++ b/reference/dom/domdocument/savexml.xml @@ -68,30 +68,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.0 - - Added the options parameter - - - - - - - - &reftitle.examples; diff --git a/reference/dom/domxpath/evaluate.xml b/reference/dom/domxpath/evaluate.xml index c100e72674c3..44dc84f52875 100644 --- a/reference/dom/domxpath/evaluate.xml +++ b/reference/dom/domxpath/evaluate.xml @@ -66,29 +66,6 @@ DOMXPath::evaluate returns &false;. - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.3 - - The registerNodeNS parameter was added. - - - - - - - &reftitle.examples; diff --git a/reference/dom/domxpath/query.xml b/reference/dom/domxpath/query.xml index aeee5dea2ecd..fb0d938d84a1 100644 --- a/reference/dom/domxpath/query.xml +++ b/reference/dom/domxpath/query.xml @@ -67,29 +67,6 @@ DOMXPath::query returns &false;. - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.3 - - The registerNodeNS parameter was added. - - - - - - - &reftitle.examples; diff --git a/reference/errorfunc/functions/debug-backtrace.xml b/reference/errorfunc/functions/debug-backtrace.xml index 0806ef15ddbf..7160b83b8814 100644 --- a/reference/errorfunc/functions/debug-backtrace.xml +++ b/reference/errorfunc/functions/debug-backtrace.xml @@ -143,50 +143,7 @@ - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - Added the optional parameter limit. - - - - 5.3.6 - - The parameter provide_object changed to options and additional option - DEBUG_BACKTRACE_IGNORE_ARGS is added. - - - - 5.2.5 - - Added the optional parameter provide_object. - - - - 5.1.1 - - Added the current object as a possible return element. - - - - - - - - + &reftitle.examples; diff --git a/reference/errorfunc/functions/debug-print-backtrace.xml b/reference/errorfunc/functions/debug-print-backtrace.xml index 2010904a71a5..9322fa2e6b57 100644 --- a/reference/errorfunc/functions/debug-print-backtrace.xml +++ b/reference/errorfunc/functions/debug-print-backtrace.xml @@ -68,36 +68,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - Added the optional parameter limit. - - - - 5.3.6 - - Added the optional parameter options. - - - - - - - - &reftitle.examples; diff --git a/reference/errorfunc/functions/error-log.xml b/reference/errorfunc/functions/error-log.xml index 54b2e1279483..67425071ec3b 100644 --- a/reference/errorfunc/functions/error-log.xml +++ b/reference/errorfunc/functions/error-log.xml @@ -163,30 +163,6 @@ error_log("You messed up!", 3, "/var/tmp/my-errors.log"); - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.7 - - The possible value of 4 was added to message_type. - - - - - - - - - - - File Alteration Monitor - FAM - - - - &reftitle.intro; - - FAM monitors files and directories, notifying interested applications of - changes. More information about FAM is available at - &url.fam;. - - - A PHP script may specify a list of files for FAM to monitor - using the functions provided by this extension. - - - The FAM process is started when the first connection - from any application to it is opened. It exits after all - connections to it have been closed. - - - - &pecl.moved-ver;5.1.0. - - - ¬e.no-windows.extension; - - - - &reference.fam.setup; - &reference.fam.constants; - &reference.fam.reference; - - - - - diff --git a/reference/fam/configure.xml b/reference/fam/configure.xml deleted file mode 100644 index 82706ad05b92..000000000000 --- a/reference/fam/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - -
- &reftitle.install; - - &pecl.info.dead; - &url.pecl.vcs;fam. - - - &pecl.moved-ver;5.1.0 - -
- - diff --git a/reference/fam/constants.xml b/reference/fam/constants.xml deleted file mode 100644 index d0fc76c3d92f..000000000000 --- a/reference/fam/constants.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - FAM event constants - - - - Constant - Description - - - - - - FAMChanged (integer) - - - Some value which can be obtained with fstat(1) changed for a - file or directory. - - - - - FAMDeleted (integer) - - A file or directory was deleted or renamed. - - - - FAMStartExecuting (integer) - - An executable file started executing. - - - - FAMStopExecuting (integer) - - An executable file that was running finished. - - - - FAMCreated (integer) - - A file was created in a directory. - - - - FAMMoved (integer) - - This event never occurs. - - - - FAMAcknowledge (integer) - - - An event in response to fam_cancel_monitor. - - - - - FAMExists (integer) - - - An event upon request to monitor a file or directory. When a - directory is monitored, an event for that directory and every file - contained in that directory is issued. - - - - - FAMEndExist (integer) - - Event after the last FAMEExists event. - - - -
- - - diff --git a/reference/fam/functions/fam-cancel-monitor.xml b/reference/fam/functions/fam-cancel-monitor.xml deleted file mode 100644 index b441e84c35ac..000000000000 --- a/reference/fam/functions/fam-cancel-monitor.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - fam_cancel_monitor - Terminate monitoring - - - &reftitle.description; - - boolfam_cancel_monitor - resourcefam - resourcefam_monitor - - - Terminates monitoring on a resource. - - - In addition an FAMAcknowledge event occurs. - - - - &reftitle.parameters; - - - - fam - - - A resource representing a connection to the FAM service returned by - fam_open - - - - - fam_monitor - - - A resource returned by one of the fam_monitor_XXX - functions - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - fam_monitor_file - fam_monitor_directory - fam_monitor_collection - fam_suspend_monitor - - - - - - diff --git a/reference/fam/functions/fam-close.xml b/reference/fam/functions/fam-close.xml deleted file mode 100644 index 37892829945f..000000000000 --- a/reference/fam/functions/fam-close.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - fam_close - Close FAM connection - - - &reftitle.description; - - voidfam_close - resourcefam - - - Closes a connection to the FAM service. - - - - &reftitle.parameters; - - - - fam - - - A resource representing a connection to the FAM service returned by - fam_open - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.seealso; - - - fam_monitor_open - - - - - - diff --git a/reference/fam/functions/fam-monitor-collection.xml b/reference/fam/functions/fam-monitor-collection.xml deleted file mode 100644 index 34249d8e84f8..000000000000 --- a/reference/fam/functions/fam-monitor-collection.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - fam_monitor_collection - Monitor a collection of files in a directory for changes - - - &reftitle.description; - - resourcefam_monitor_collection - resourcefam - stringdirname - intdepth - stringmask - - - Requests monitoring for a collection of files within a directory. - - - A FAM event will be generated whenever the status of the files change. - The possible event codes are described in detail in the - constants part of this section. - - - - &reftitle.parameters; - - - - fam - - - A resource representing a connection to the FAM service returned by - fam_open - - - - - dirname - - - Directory path to the monitored files - - - - - depth - - - The maximum search depth starting from this - directory - - - - - mask - - - A shell pattern mask restricting the file names - to look for - - - - - - - - &reftitle.returnvalues; - - Returns a monitoring resource or &false; on errors. - - - - &reftitle.seealso; - - - fam_monitor_file - fam_monitor_directory - fam_cancel_monitor - fam_suspend_monitor - fam_resume_monitor - - - - - - diff --git a/reference/fam/functions/fam-monitor-directory.xml b/reference/fam/functions/fam-monitor-directory.xml deleted file mode 100644 index efb976ccf5bd..000000000000 --- a/reference/fam/functions/fam-monitor-directory.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - fam_monitor_directory - Monitor a directory for changes - - - &reftitle.description; - - resourcefam_monitor_directory - resourcefam - stringdirname - - - Requests monitoring for a directory and all contained files. - - - A FAM event will be generated whenever the status of the directory (i.e. - the result of function stat on that directory) or its - content (i.e. the results of readdir) changes. - - - The possible event codes are described in detail in the - constants part of this section. - - - - &reftitle.parameters; - - - - fam - - - A resource representing a connection to the FAM service returned by - fam_open - - - - - dirname - - - Path to the monitored directory - - - - - - - - &reftitle.returnvalues; - - Returns a monitoring resource or &false; on errors. - - - - &reftitle.seealso; - - - fam_monitor_file - fam_monitor_collection - fam_cancel_monitor - fam_suspend_monitor - fam_resume_monitor - - - - - - diff --git a/reference/fam/functions/fam-monitor-file.xml b/reference/fam/functions/fam-monitor-file.xml deleted file mode 100644 index bfcc51401612..000000000000 --- a/reference/fam/functions/fam-monitor-file.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - fam_monitor_file - Monitor a regular file for changes - - - &reftitle.description; - - resourcefam_monitor_file - resourcefam - stringfilename - - - Requests monitoring for a single file. A FAM event will be generated - whenever the file status changes (i.e. the result of function - stat on that file). - - - The possible event codes are described in detail in the - constants part of this section. - - - - &reftitle.parameters; - - - - fam - - - A resource representing a connection to the FAM service returned by - fam_open - - - - - filename - - - Path to the monitored file - - - - - - - - &reftitle.returnvalues; - - Returns a monitoring resource or &false; on errors. - - - - &reftitle.seealso; - - - fam_monitor_directory - fam_monitor_collection - fam_cancel_monitor - fam_suspend_monitor - fam_resume_monitor - - - - - - diff --git a/reference/fam/functions/fam-next-event.xml b/reference/fam/functions/fam-next-event.xml deleted file mode 100644 index a7b45ffb6e84..000000000000 --- a/reference/fam/functions/fam-next-event.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - fam_next_event - Get next pending FAM event - - - &reftitle.description; - - arrayfam_next_event - resourcefam - - - Returns the next pending FAM event. - - - The function will block until an event is available which can be checked - for using fam_pending. - - - - &reftitle.parameters; - - - - fam - - - A resource representing a connection to the FAM service returned by - fam_open - - - - - - - - &reftitle.returnvalues; - - 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. - - - - &reftitle.seealso; - - - fam_pending - - - - - - diff --git a/reference/fam/functions/fam-open.xml b/reference/fam/functions/fam-open.xml deleted file mode 100644 index 59c099b11328..000000000000 --- a/reference/fam/functions/fam-open.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - fam_open - Open connection to FAM daemon - - - &reftitle.description; - - resourcefam_open - stringappname - - - Opens a connection to the FAM service daemon. - - - - &reftitle.parameters; - - - - appname - - - A string identifying the application for logging reasons - - - - - - - - &reftitle.returnvalues; - - Returns a resource representing a connection to the FAM service on success - or &false; on errors. - - - - &reftitle.seealso; - - - fam_close - - - - - - diff --git a/reference/fam/functions/fam-pending.xml b/reference/fam/functions/fam-pending.xml deleted file mode 100644 index 588ae544dfb1..000000000000 --- a/reference/fam/functions/fam-pending.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - fam_pending - Check for pending FAM events - - - &reftitle.description; - - intfam_pending - resourcefam - - - Checks for pending FAM events. - - - - &reftitle.parameters; - - - - fam - - - A resource representing a connection to the FAM service returned by - fam_open - - - - - - - - &reftitle.returnvalues; - - Returns non-zero if events are available to be fetched using - fam_next_event, zero otherwise. - - - - &reftitle.seealso; - - - fam_next_event - - - - - - diff --git a/reference/fam/functions/fam-resume-monitor.xml b/reference/fam/functions/fam-resume-monitor.xml deleted file mode 100644 index ab2f0da56b99..000000000000 --- a/reference/fam/functions/fam-resume-monitor.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - fam_resume_monitor - Resume suspended monitoring - - - &reftitle.description; - - boolfam_resume_monitor - resourcefam - resourcefam_monitor - - - Resumes monitoring of a resource previously suspended using - fam_suspend_monitor. - - - - &reftitle.parameters; - - - - fam - - - A resource representing a connection to the FAM service returned by - fam_open - - - - - fam_monitor - - - A resource returned by one of the fam_monitor_XXX - functions - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - fam_suspend_monitor - - - - - - diff --git a/reference/fam/functions/fam-suspend-monitor.xml b/reference/fam/functions/fam-suspend-monitor.xml deleted file mode 100644 index a78f2b220294..000000000000 --- a/reference/fam/functions/fam-suspend-monitor.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - fam_suspend_monitor - Temporarily suspend monitoring - - - &reftitle.description; - - boolfam_suspend_monitor - resourcefam - resourcefam_monitor - - - fam_suspend_monitor temporarily suspend monitoring - of a resource. - - - Monitoring can later be continued using fam_resume_monitor - without the need of requesting a complete new monitor. - - - - &reftitle.parameters; - - - - fam - - - A resource representing a connection to the FAM service returned by - fam_open - - - - - fam_monitor - - - A resource returned by one of the fam_monitor_XXX - functions - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.seealso; - - - fam_cancel_monitor - fam_resume_monitor - - - - - - diff --git a/reference/fam/reference.xml b/reference/fam/reference.xml deleted file mode 100644 index 44e02116dcca..000000000000 --- a/reference/fam/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - FAM &Functions; - - &reference.fam.entities.functions; - - - diff --git a/reference/fam/setup.xml b/reference/fam/setup.xml deleted file mode 100644 index 6aff82e45e53..000000000000 --- a/reference/fam/setup.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - &reftitle.setup; - - -
- &reftitle.required; - - This extension uses the functions of the - FAM library, developed by SGI. Therefore you have to download and - install the FAM library. - -
- - - - &reference.fam.configure; - - - -
- &reftitle.runtime; - &no.config; -
- - - -
- &reftitle.resources; - - There are two resource types used in the FAM module. The first one is - the connection to the FAM service returned by - fam_open, the second a monitoring resource returned - by the fam_monitor_XXX functions. - -
- - - - - - diff --git a/reference/fam/versions.xml b/reference/fam/versions.xml deleted file mode 100644 index 10f5f7f9d8e5..000000000000 --- a/reference/fam/versions.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/filesystem/functions/clearstatcache.xml b/reference/filesystem/functions/clearstatcache.xml index 3d333b0f3e32..c83b181d47d8 100644 --- a/reference/filesystem/functions/clearstatcache.xml +++ b/reference/filesystem/functions/clearstatcache.xml @@ -94,31 +94,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - Added optional clear_realpath_cache - and filename parameters. - - - - - - - - &reftitle.examples; diff --git a/reference/filesystem/functions/copy.xml b/reference/filesystem/functions/copy.xml index b7159f060819..987fd0b7327b 100644 --- a/reference/filesystem/functions/copy.xml +++ b/reference/filesystem/functions/copy.xml @@ -70,37 +70,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.4 - - Changed the context parameter to actually have an effect. - Previously, any context was ignored. - - - - 5.3.0 - - Added context support. - - - - - - - - &reftitle.examples; diff --git a/reference/filesystem/functions/fgetcsv.xml b/reference/filesystem/functions/fgetcsv.xml index 799d9507d718..7dc65c968911 100644 --- a/reference/filesystem/functions/fgetcsv.xml +++ b/reference/filesystem/functions/fgetcsv.xml @@ -141,24 +141,6 @@ string to disable the proprietary escape mechanism. - - 5.3.0 - - The escape parameter was added - - - - 5.1.0 - - The length is now optional. - Default is 0, meaning no length limit. - - - diff --git a/reference/filesystem/functions/file-get-contents.xml b/reference/filesystem/functions/file-get-contents.xml index 0ee75ad5ebd3..450762650673 100644 --- a/reference/filesystem/functions/file-get-contents.xml +++ b/reference/filesystem/functions/file-get-contents.xml @@ -206,13 +206,6 @@ $file = file_get_contents('http://www.example.com/', false, $context); Support for negative offsets has been added. - - 5.1.0 - - Added the offset and - maxlen parameters. - - diff --git a/reference/filesystem/functions/file-put-contents.xml b/reference/filesystem/functions/file-put-contents.xml index 742d10f0b09a..cf5dcdeabaff 100644 --- a/reference/filesystem/functions/file-put-contents.xml +++ b/reference/filesystem/functions/file-put-contents.xml @@ -174,31 +174,6 @@ file_put_contents($file, $person, FILE_APPEND | LOCK_EX); - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.0 - - Added support for LOCK_EX and the ability to pass - a stream resource to the data parameter - - - - - - - &reftitle.notes; diff --git a/reference/filesystem/functions/flock.xml b/reference/filesystem/functions/flock.xml index 7dc06c764102..13730f19dd06 100644 --- a/reference/filesystem/functions/flock.xml +++ b/reference/filesystem/functions/flock.xml @@ -91,39 +91,7 @@ &return.success; - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.5.22, 5.6.6 - - Added support for the wouldblock parameter on - Windows. - - - - 5.3.2 - - The automatic unlocking when the file's resource handle is closed was - removed. Unlocking now always has to be done manually. - - - - - - - - + &reftitle.examples; diff --git a/reference/filesystem/functions/fnmatch.xml b/reference/filesystem/functions/fnmatch.xml index a3713b7f3a58..d109ff45e5ee 100644 --- a/reference/filesystem/functions/fnmatch.xml +++ b/reference/filesystem/functions/fnmatch.xml @@ -109,30 +109,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function is now available on Windows platforms. - - - - - - - - &reftitle.examples; diff --git a/reference/filesystem/functions/fopen.xml b/reference/filesystem/functions/fopen.xml index 4bfe83c8532a..c12e54b538b2 100644 --- a/reference/filesystem/functions/fopen.xml +++ b/reference/filesystem/functions/fopen.xml @@ -297,13 +297,6 @@ $handle = fopen("c:\\folder\\resource.txt", "r"); The 'e' option was added. - - 5.2.6 - - The 'c' and 'c+' options were - added - - diff --git a/reference/filesystem/functions/glob.xml b/reference/filesystem/functions/glob.xml index cea861061b9a..6c47628deb69 100644 --- a/reference/filesystem/functions/glob.xml +++ b/reference/filesystem/functions/glob.xml @@ -131,30 +131,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.0 - - GLOB_ERR was added - - - - - - - - &reftitle.examples; diff --git a/reference/filesystem/functions/link.xml b/reference/filesystem/functions/link.xml index f22daa758d5d..1088d822c9f3 100644 --- a/reference/filesystem/functions/link.xml +++ b/reference/filesystem/functions/link.xml @@ -49,31 +49,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function is now available on Windows platforms (Vista, Server - 2008 or greater). - - - - - - - - &reftitle.examples; diff --git a/reference/filesystem/functions/linkinfo.xml b/reference/filesystem/functions/linkinfo.xml index 7cfa7b40e122..7a6532edbc9b 100644 --- a/reference/filesystem/functions/linkinfo.xml +++ b/reference/filesystem/functions/linkinfo.xml @@ -48,31 +48,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function is now available on Windows platforms (Vista, Server - 2008 or greater). - - - - - - - - &reftitle.examples; diff --git a/reference/filesystem/functions/parse-ini-file.xml b/reference/filesystem/functions/parse-ini-file.xml index e1d7b6e60cc5..c1d80cf8fd9e 100644 --- a/reference/filesystem/functions/parse-ini-file.xml +++ b/reference/filesystem/functions/parse-ini-file.xml @@ -70,62 +70,6 @@ - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 7.0.0 - - Hash marks (#) are no longer recognized as comments. - - - - 5.6.1 - - Added new INI_SCANNER_TYPED mode. - - - - 5.3.0 - - Added optional scanner_mode parameter. - Single quotes may now be used around variable assignments. - Hash marks (#) should no longer be used as comments - and will throw a deprecation warning if used. - - - - 5.2.7 - - On syntax error this function will return &false; rather than an empty - array. - - - - 5.2.4 - - Keys and section names consisting of numbers are now evaluated as PHP - integers thus numbers - starting by 0 are evaluated as octals and numbers starting by 0x are - evaluated as hexadecimals. - - - - - - - - &reftitle.examples; diff --git a/reference/filesystem/functions/pathinfo.xml b/reference/filesystem/functions/pathinfo.xml index 6c49beb0f62a..c6ea18818ad0 100644 --- a/reference/filesystem/functions/pathinfo.xml +++ b/reference/filesystem/functions/pathinfo.xml @@ -103,30 +103,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.0 - - The PATHINFO_FILENAME constant was added. - - - - - - - - &reftitle.examples; diff --git a/reference/filesystem/functions/readlink.xml b/reference/filesystem/functions/readlink.xml index f43b89e3ef22..3d1adeee339c 100644 --- a/reference/filesystem/functions/readlink.xml +++ b/reference/filesystem/functions/readlink.xml @@ -46,31 +46,7 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function is now available on Windows platforms (Vista, Server - 2008 or greater). - - - - - - - - + &reftitle.examples; diff --git a/reference/filesystem/functions/realpath.xml b/reference/filesystem/functions/realpath.xml index a92e91424a96..686af228b482 100644 --- a/reference/filesystem/functions/realpath.xml +++ b/reference/filesystem/functions/realpath.xml @@ -75,40 +75,6 @@ &fs.file.32bit; - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - Prior to this release, if only the last path - component did not exist, realpath would not fail on - *BSD systems. realpath now fails in this case. - - - - 5.2.1 - - Prior to this version, realpath returned &false; - if path is an empty string or &null;. - - - - - - - - - &reftitle.examples; diff --git a/reference/filesystem/functions/rename.xml b/reference/filesystem/functions/rename.xml index 0c827adbf674..0732ac947740 100644 --- a/reference/filesystem/functions/rename.xml +++ b/reference/filesystem/functions/rename.xml @@ -68,31 +68,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.1 - - rename can now rename files across drives in - Windows. - - - - - - - - &reftitle.examples; diff --git a/reference/filesystem/functions/symlink.xml b/reference/filesystem/functions/symlink.xml index fc1aa87ba67b..f7982dfd9983 100644 --- a/reference/filesystem/functions/symlink.xml +++ b/reference/filesystem/functions/symlink.xml @@ -51,31 +51,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function is now available on Windows platforms (Vista, Server - 2008 or greater). - - - - - - - - &reftitle.examples; diff --git a/reference/filesystem/functions/touch.xml b/reference/filesystem/functions/touch.xml index e689021d9bae..0d91f6095a62 100644 --- a/reference/filesystem/functions/touch.xml +++ b/reference/filesystem/functions/touch.xml @@ -69,31 +69,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - It became possible to change the modification time of a directory - under Windows. - - - - - - - - &reftitle.examples; diff --git a/reference/filter/functions/filter-input-array.xml b/reference/filter/functions/filter-input-array.xml index 55e881cfa2f3..13144c2ac817 100644 --- a/reference/filter/functions/filter-input-array.xml +++ b/reference/filter/functions/filter-input-array.xml @@ -161,30 +161,6 @@ array(6) { - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - Added add_empty parameter. - - - - - - - - &reftitle.notes; diff --git a/reference/filter/functions/filter-var-array.xml b/reference/filter/functions/filter-var-array.xml index 48126012ed14..61e5ad41617e 100644 --- a/reference/filter/functions/filter-var-array.xml +++ b/reference/filter/functions/filter-var-array.xml @@ -143,30 +143,6 @@ array(6) { - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - Added add_empty parameter. - - - - - - - - &reftitle.seealso; diff --git a/reference/fribidi/book.xml b/reference/fribidi/book.xml deleted file mode 100644 index 321c1da3a271..000000000000 --- a/reference/fribidi/book.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - FriBiDi - - - - &reftitle.intro; - - FriBiDi is a free implementation of the - Unicode Bidirectional Algorithm. - - - - - &reference.fribidi.setup; - &reference.fribidi.constants; - &reference.fribidi.reference; - - - - - diff --git a/reference/fribidi/configure.xml b/reference/fribidi/configure.xml deleted file mode 100644 index b0aa73fddb5f..000000000000 --- a/reference/fribidi/configure.xml +++ /dev/null @@ -1,41 +0,0 @@ - - -
- &reftitle.install; - - &pecl.moved; - &pecl.info; - &url.pecl.package;fribidi. - - - In order to use these functions you must compile PHP with Fribidi support - by using the - configure option. - - - Windows users will enable php_fribidi.dll inside - of &php.ini; in order to use these functions. - &pecl.windows.download; - -
- - diff --git a/reference/fribidi/constants.xml b/reference/fribidi/constants.xml deleted file mode 100644 index a769b33ade6c..000000000000 --- a/reference/fribidi/constants.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - FRIBIDI_CHARSET_UTF8 - (integer) - - - - Unicode - - - - - - FRIBIDI_CHARSET_8859_6 - (integer) - - - - Arabic - - - - - - FRIBIDI_CHARSET_8859_8 - (integer) - - - - Hebrew - - - - - - FRIBIDI_CHARSET_CP1255 - (integer) - - - - Hebrew/Yiddish - - - - - - FRIBIDI_CHARSET_CP1256 - (integer) - - - - Arabic - - - - - - FRIBIDI_CHARSET_ISIRI_3342 - (integer) - - - - Persian - - - - - - FRIBIDI_CHARSET_CAP_RTL - (integer) - - - - Used for test purposes, will treat CAPS as non-English letters - - - - - - FRIBIDI_RTL - (integer) - - - - Right to left - - - - - - FRIBIDI_LTR - (integer) - - - - Left to right - - - - - - FRIBIDI_AUTO - (integer) - - - - Autodetect the base direction - - - - - - - diff --git a/reference/fribidi/functions/fribidi-log2vis.xml b/reference/fribidi/functions/fribidi-log2vis.xml deleted file mode 100644 index c9a3b8aebc00..000000000000 --- a/reference/fribidi/functions/fribidi-log2vis.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - fribidi_log2vis - Convert a logical string to a visual one - - - &reftitle.description; - - stringfribidi_log2vis - stringstr - stringdirection - intcharset - - - Converts a logical string to a visual one. - - - - &reftitle.parameters; - - - - str - - - The logical string. - - - - - direction - - - One of FRIBIDI_RTL, - FRIBIDI_LTR or FRIBIDI_AUTO. - - - - - charset - - - One of the FRIBIDI_CHARSET_XXX constants. - - - - - - - - &reftitle.returnvalues; - - Returns the visual string on success&return.falseforfailure;. - - - - - diff --git a/reference/fribidi/reference.xml b/reference/fribidi/reference.xml deleted file mode 100644 index d03c2af3cfb0..000000000000 --- a/reference/fribidi/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - FriBiDi &Functions; - - &reference.fribidi.entities.functions; - - - - - diff --git a/reference/fribidi/setup.xml b/reference/fribidi/setup.xml deleted file mode 100644 index f210b4cf0d6e..000000000000 --- a/reference/fribidi/setup.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - &reftitle.setup; - - -
- &reftitle.required; - - You must download and install the - FriBiDi package. - -
- - - - &reference.fribidi.configure; - - - -
- &reftitle.runtime; - &no.config; -
- - - -
- &reftitle.resources; - &no.resource; -
- - - - - - diff --git a/reference/fribidi/versions.xml b/reference/fribidi/versions.xml deleted file mode 100644 index fdc793684e49..000000000000 --- a/reference/fribidi/versions.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - - - - \ No newline at end of file diff --git a/reference/ftp/functions/ftp-ssl-connect.xml b/reference/ftp/functions/ftp-ssl-connect.xml index 06b076551441..3f1c2b735e5c 100644 --- a/reference/ftp/functions/ftp-ssl-connect.xml +++ b/reference/ftp/functions/ftp-ssl-connect.xml @@ -82,31 +82,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.2 - - The function was changed to return &false; when it can't use an SSL - connection, instead of falling back to a non-SSL one as previously. - - - - - - - - &reftitle.examples; diff --git a/reference/funchand/functions/call-user-func-array.xml b/reference/funchand/functions/call-user-func-array.xml index cc6936f50972..e9c387d9ecce 100644 --- a/reference/funchand/functions/call-user-func-array.xml +++ b/reference/funchand/functions/call-user-func-array.xml @@ -50,33 +50,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - The interpretation of object oriented keywords like parent - and self has changed. Previously, calling them using the - double colon syntax would emit an E_STRICT warning because - they were interpreted as static. - - - - - - - - &reftitle.examples; diff --git a/reference/funchand/functions/call-user-func.xml b/reference/funchand/functions/call-user-func.xml index 53efce78fb7d..de09fe39be4e 100644 --- a/reference/funchand/functions/call-user-func.xml +++ b/reference/funchand/functions/call-user-func.xml @@ -86,40 +86,6 @@ Warning: Parameter 1 to increment() expected to be a reference, value given in - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - The interpretation of object oriented keywords like parent - and self has changed. Previously, calling them using the - double colon syntax would emit an E_STRICT warning because - they were interpreted as static. - - - - 5.3.0 - - If the called function expects a parameter to be passed by reference, an - E_WARNING is now issued. - - - - - - - - &reftitle.examples; diff --git a/reference/funchand/functions/func-get-arg.xml b/reference/funchand/functions/func-get-arg.xml index a43a95babecf..47719b43a6e3 100644 --- a/reference/funchand/functions/func-get-arg.xml +++ b/reference/funchand/functions/func-get-arg.xml @@ -46,39 +46,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function can now be used in parameter lists. - - - - 5.3.0 - - If this function is called from the outermost scope of a file - which has been included by calling include - or require from within a function in the - calling file, it now generates a warning and returns &false;. - - - - - - - - &reftitle.errors; diff --git a/reference/funchand/functions/func-get-args.xml b/reference/funchand/functions/func-get-args.xml index afedbc733742..836161877835 100644 --- a/reference/funchand/functions/func-get-args.xml +++ b/reference/funchand/functions/func-get-args.xml @@ -30,39 +30,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function can now be used in parameter lists. - - - - 5.3.0 - - If this function is called from the outermost scope of a file - which has been included by calling include - or require from within a function in the - calling file, it now generates a warning and returns &false;. - - - - - - - - &reftitle.errors; diff --git a/reference/funchand/functions/func-num-args.xml b/reference/funchand/functions/func-num-args.xml index b2a2a35aad35..73ea8fc25329 100644 --- a/reference/funchand/functions/func-num-args.xml +++ b/reference/funchand/functions/func-num-args.xml @@ -30,39 +30,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function can now be used in parameter lists. - - - - 5.3.0 - - If this function is called from the outermost scope of a file - which has been included by calling include - or require from within a function in the - calling file, it now generates a warning and returns -1. - - - - - - - - &reftitle.errors; diff --git a/reference/funchand/functions/register-tick-function.xml b/reference/funchand/functions/register-tick-function.xml index a425d2e17b8c..0f9609bc29f3 100644 --- a/reference/funchand/functions/register-tick-function.xml +++ b/reference/funchand/functions/register-tick-function.xml @@ -72,30 +72,6 @@ register_tick_function(array(&$object, 'my_method'), true); - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - Ticks are now supported on threaded web server modules. - - - - - - - - &reftitle.notes; diff --git a/reference/gmp/functions/gmp-init.xml b/reference/gmp/functions/gmp-init.xml index 9eb41bc3a48f..fbb2785b8c00 100644 --- a/reference/gmp/functions/gmp-init.xml +++ b/reference/gmp/functions/gmp-init.xml @@ -57,31 +57,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.2 - - The base was extended from 2 to 36, to - 2 to 62 and -2 to -36. - - - - - - - - &reftitle.notes; diff --git a/reference/gmp/functions/gmp-strval.xml b/reference/gmp/functions/gmp-strval.xml index d8318f1f6e4d..406b9593f217 100644 --- a/reference/gmp/functions/gmp-strval.xml +++ b/reference/gmp/functions/gmp-strval.xml @@ -52,31 +52,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.2 - - The base was extended from 2 to 36, to - 2 to 62 and -2 to -36. - - - - - - - - &reftitle.notes; diff --git a/reference/gupnp/book.xml b/reference/gupnp/book.xml deleted file mode 100644 index 6ce16f74090c..000000000000 --- a/reference/gupnp/book.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - Gupnp - Gupnp - - - &reftitle.intro; - - GUPnP is an object-oriented open source framework for creating UPnP devices and control points, written in C using GObject and libsoup. This extension wraps GUPnP and provides similar API. All sources and additional documentation can be obtained from the - official site - - - - &reference.gupnp.setup; - &reference.gupnp.constants; - &reference.gupnp.examples; - &reference.gupnp.reference; - - - - - diff --git a/reference/gupnp/configure.xml b/reference/gupnp/configure.xml deleted file mode 100644 index 0dadc79665c0..000000000000 --- a/reference/gupnp/configure.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;gupnp - - - - - If ./configure is having trouble finding the - libgupnp files (for example, it was installed into a custom - prefix directory), use ./configure - --with-gupnp=$PREFIX, where $PREFIX is installation prefix of - libgupnp. - - -
- - - diff --git a/reference/gupnp/constants.xml b/reference/gupnp/constants.xml deleted file mode 100644 index c891a3c37ff7..000000000000 --- a/reference/gupnp/constants.xml +++ /dev/null @@ -1,203 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - - GUPNP_TYPE_BOOLEAN - (integer) - - - - - - - - - GUPNP_TYPE_INT - (integer) - - - - - - - - - GUPNP_TYPE_LONG - (integer) - - - - - - - - - GUPNP_TYPE_DOUBLE - (integer) - - - - - - - - - GUPNP_TYPE_FLOAT - (integer) - - - - - - - - - GUPNP_TYPE_STRING - (integer) - - - - - - - - - GUPNP_SIGNAL_DEVICE_PROXY_AVAILABLE - (integer) - - - - - - - - - GUPNP_SIGNAL_DEVICE_PROXY_UNAVAILABLE - (integer) - - - - - - - - - GUPNP_SIGNAL_SERVICE_PROXY_AVAILABLE - (integer) - - - - - - - - - GUPNP_SIGNAL_SERVICE_PROXY_UNAVAILABLE - (integer) - - - - - - - - - GUPNP_SIGNAL_ACTION_INVOKED - (integer) - - - - - - - - - GUPNP_SIGNAL_NOTIFY_FAILED - (integer) - - - - - - - - - GUPNP_SIGNAL_SUBSCRIPTION_LOST - (integer) - - - - - - - - - GUPNP_CONTROL_ERROR_INVALID_ACTION - (integer) - - - - - - - - - GUPNP_CONTROL_ERROR_INVALID_ARGS - (integer) - - - - - - - - - GUPNP_CONTROL_ERROR_OUT_OF_SYNC - (integer) - - - - - - - - - GUPNP_CONTROL_ERROR_ACTION_FAILED - (integer) - - - - - - - - - - - - diff --git a/reference/gupnp/examples.xml b/reference/gupnp/examples.xml deleted file mode 100644 index cb0c76f48782..000000000000 --- a/reference/gupnp/examples.xml +++ /dev/null @@ -1,282 +0,0 @@ - - - - - &reftitle.examples; -
- Browsing devices and services - - This example shows how to obtain information about all devices and - services. It starts an infinite loop (use CLI), and if any of - available devices or services are found, the proper callback - function will be invoked. - - - - Search for all UPnP devices and services. - - -]]> - - - -
- -
- Implementing the BinaryLight device - - This is an example of UPnP device/service, implementing the BinaryLight - device and SwitchPower services to emulate a light switch. - - - The user interface was purposely simplified in order to show basic - concepts and methods. - - - - Implementing light server - - -]]> - - - - Implementing light client - - $mode, 'cp' => $cp); -gupnp_control_point_callback_set($cp, GUPNP_SIGNAL_SERVICE_PROXY_AVAILABLE, $cb, $arg); - -/* Start for browsing */ -gupnp_control_point_browse_start($cp); - -?> -]]> - - - -
- - - - - diff --git a/reference/gupnp/functions/gupnp-context-get-host-ip.xml b/reference/gupnp/functions/gupnp-context-get-host-ip.xml deleted file mode 100644 index 4782c732eced..000000000000 --- a/reference/gupnp/functions/gupnp-context-get-host-ip.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - gupnp_context_get_host_ip - Get the IP address - - - - &reftitle.description; - - stringgupnp_context_get_host_ip - resourcecontext - - - Get the IP address we advertise ourselves as using. - - - - - &reftitle.parameters; - - - - context - - - A context identifier, returned by gupnp_context_new. - - - - - - - - - &reftitle.returnvalues; - - Returns the IP address for the current context and &false; on error. - - - - - &reftitle.examples; - - - Create new UPnP context and get IP address of the host - - -]]> - - - - - - - &reftitle.seealso; - - - gupnp_context_new - gupnp_context_get_port - - - - - - - diff --git a/reference/gupnp/functions/gupnp-context-get-port.xml b/reference/gupnp/functions/gupnp-context-get-port.xml deleted file mode 100644 index 8728cbbce80f..000000000000 --- a/reference/gupnp/functions/gupnp-context-get-port.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - - gupnp_context_get_port - Get the port - - - - &reftitle.description; - - intgupnp_context_get_port - resourcecontext - - - Get the port that the SOAP server is running on. - - - - - &reftitle.parameters; - - - - context - - - A context identifier, returned by gupnp_context_new. - - - - - - - - - &reftitle.returnvalues; - - Returns the port number for the current context and &false; on error. - - - - - &reftitle.examples; - - - Create new UPnP context and get port number - - -]]> - - - - - - - &reftitle.seealso; - - - gupnp_context_new - gupnp_context_get_host_ip - - - - - - - diff --git a/reference/gupnp/functions/gupnp-context-get-subscription-timeout.xml b/reference/gupnp/functions/gupnp-context-get-subscription-timeout.xml deleted file mode 100644 index 1b125e88b7da..000000000000 --- a/reference/gupnp/functions/gupnp-context-get-subscription-timeout.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - gupnp_context_get_subscription_timeout - Get the event subscription timeout - - - - &reftitle.description; - - intgupnp_context_get_subscription_timeout - resourcecontext - - - Get the event subscription timeout (in seconds), or 0 meaning there is no timeout. - - - - - &reftitle.parameters; - - - - context - - - A context identifier, returned by gupnp_context_new. - - - - - - - - - &reftitle.returnvalues; - - The event subscription timeout in seconds. - - - - - &reftitle.seealso; - - - gupnp_context_new - gupnp_context_set_subscription_timeout - - - - - - - diff --git a/reference/gupnp/functions/gupnp-context-host-path.xml b/reference/gupnp/functions/gupnp-context-host-path.xml deleted file mode 100644 index 6281c3312c29..000000000000 --- a/reference/gupnp/functions/gupnp-context-host-path.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - - gupnp_context_host_path - Start hosting - - - - &reftitle.description; - - boolgupnp_context_host_path - resourcecontext - stringlocal_path - stringserver_path - - - Start hosting local_path at server_path. Files with the path local_path.LOCALE (if they exist) - will be served up when LOCALE is specified in the request's Accept-Language header. - - - - - &reftitle.parameters; - - - - context - - - A context identifier, returned by gupnp_context_new. - - - - - local_path - - - Path to the local file or folder to be hosted. - - - - - server_path - - - Web server path where local_path should be hosted. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Create new UPnP context and set host path - - -]]> - - - - - - - &reftitle.seealso; - - - gupnp_context_new - gupnp_context_unhost_path - - - - - - - diff --git a/reference/gupnp/functions/gupnp-context-new.xml b/reference/gupnp/functions/gupnp-context-new.xml deleted file mode 100644 index 31ef07386a87..000000000000 --- a/reference/gupnp/functions/gupnp-context-new.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - gupnp_context_new - Create a new context - - - - &reftitle.description; - - resourcegupnp_context_new - stringhost_ip - intport0 - - - Create a new context with the specified host_ip and port. - - - - - &reftitle.parameters; - - - - host_ip - - - The local host's IP address, or NULL to use the IP address of the first non-loopback network interface. - - - - - port - - - Port to run on, or 0 if you don't care what port is used. - - - - - - - - - &reftitle.returnvalues; - - A context identifier. - - - - - &reftitle.examples; - - - Create new UPnP context - - -]]> - - - - - - - &reftitle.errors; - - Issues E_WARNING with unable to create context. - - - - - - diff --git a/reference/gupnp/functions/gupnp-context-set-subscription-timeout.xml b/reference/gupnp/functions/gupnp-context-set-subscription-timeout.xml deleted file mode 100644 index 615be738e808..000000000000 --- a/reference/gupnp/functions/gupnp-context-set-subscription-timeout.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - gupnp_context_set_subscription_timeout - Sets the event subscription timeout - - - - &reftitle.description; - - voidgupnp_context_set_subscription_timeout - resourcecontext - inttimeout - - - Sets the event subscription timeout (in seconds) to time out. - Note that any client side subscriptions will automatically be renewed. - - - - - &reftitle.parameters; - - - - context - - - A context identifier, returned by gupnp_context_new. - - - - - timeout - - - The event subscription timeout in seconds. - Use 0 if you don't want subscriptions to time out. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - gupnp_context_new - gupnp_context_get_subscription_timeout - - - - - - - diff --git a/reference/gupnp/functions/gupnp-context-timeout-add.xml b/reference/gupnp/functions/gupnp-context-timeout-add.xml deleted file mode 100644 index dfe5c6373253..000000000000 --- a/reference/gupnp/functions/gupnp-context-timeout-add.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - gupnp_context_timeout_add - Sets a function to be called at regular intervals - - - - &reftitle.description; - - boolgupnp_context_timeout_add - resourcecontext - inttimeout - mixedcallback - mixedarg - - - Sets a function to be called at regular intervals. - - - - - &reftitle.parameters; - - - - context - - - A context identifier, returned by gupnp_context_new. - - - - - timeout - - - A timeout in miliseconds. - - - - - callback - - - The callback function calling every timeout period of time. - Typically, callback function takes on arg parameter. - - - - - arg - - - User data for callback. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Create new UPnP context and set callback - - -]]> - - - - - - - &reftitle.errors; - - Issues E_WARNING with not valid callback function. - - - - - &reftitle.seealso; - - - gupnp_context_new - - - - - - - diff --git a/reference/gupnp/functions/gupnp-context-unhost-path.xml b/reference/gupnp/functions/gupnp-context-unhost-path.xml deleted file mode 100644 index 7135468e4daf..000000000000 --- a/reference/gupnp/functions/gupnp-context-unhost-path.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - gupnp_context_unhost_path - Stop hosting - - - - &reftitle.description; - - boolgupnp_context_unhost_path - resourcecontext - stringserver_path - - - Stop hosting the file or folder at server_path. - - - - - &reftitle.parameters; - - - - context - - - A context identifier, returned by gupnp_context_new. - - - - - server_path - - - Web server path where the file or folder is hosted. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - gupnp_context_new - gupnp_context_host_path - - - - - - - diff --git a/reference/gupnp/functions/gupnp-control-point-browse-start.xml b/reference/gupnp/functions/gupnp-control-point-browse-start.xml deleted file mode 100644 index 4ba776eba5fd..000000000000 --- a/reference/gupnp/functions/gupnp-control-point-browse-start.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - - gupnp_control_point_browse_start - Start browsing - - - - &reftitle.description; - - boolgupnp_control_point_browse_start - resourcecpoint - - - Start the search and calls user-defined callback. - - - - - &reftitle.parameters; - - - - cpoint - - - A control point identifier, returned by gupnp_control_point_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Create new UPnP context and start browsing - - -]]> - - - - - - - &reftitle.seealso; - - - gupnp_control_point_new - gupnp_control_point_browse_stop - - - - - - - diff --git a/reference/gupnp/functions/gupnp-control-point-browse-stop.xml b/reference/gupnp/functions/gupnp-control-point-browse-stop.xml deleted file mode 100644 index d2457f918378..000000000000 --- a/reference/gupnp/functions/gupnp-control-point-browse-stop.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - gupnp_control_point_browse_stop - Stop browsing - - - - &reftitle.description; - - boolgupnp_control_point_browse_stop - resourcecpoint - - - Stop the search and calls user-defined callback. - - - - - &reftitle.parameters; - - - - cpoint - - - A control point identifier, returned by gupnp_control_point_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - gupnp_control_point_new - gupnp_control_point_browse_start - - - - - - - diff --git a/reference/gupnp/functions/gupnp-control-point-callback-set.xml b/reference/gupnp/functions/gupnp-control-point-callback-set.xml deleted file mode 100644 index d485752fb9f7..000000000000 --- a/reference/gupnp/functions/gupnp-control-point-callback-set.xml +++ /dev/null @@ -1,190 +0,0 @@ - - - - - - gupnp_control_point_callback_set - Set control point callback - - - - &reftitle.description; - - boolgupnp_control_point_callback_set - resourcecpoint - intsignal - mixedcallback - mixedarg - - - Set control point callback function for signal. - - - - - &reftitle.parameters; - - - - cpoint - - - A control point identifier, returned by gupnp_control_point_new. - - - - - signal - - - The value of signal. Signal can be one of the following values: - - - GUPNP_SIGNAL_DEVICE_PROXY_AVAILABLE - - - Emitted whenever a new device has become available. - - - - - GUPNP_SIGNAL_DEVICE_PROXY_UNAVAILABLE - - - Emitted whenever a device is not available any more. - - - - - GUPNP_SIGNAL_SERVICE_PROXY_AVAILABLE - - - Emitted whenever a new service has become available. - - - - - GUPNP_SIGNAL_SERVICE_PROXY_UNAVAILABLE - - - Emitted whenever a service is not available any more. - - - - - - - - - callback - - - The callback function for the certain signal. Typically, callback function - takes on two parameters. The proxy parameter's - identifier being the first, and the arg second. - - - - - arg - - - User data for callback. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Create new UPnP context and start browsing - - -]]> - - - - - - - - &reftitle.errors; - - Issues E_WARNING with not valid callback function. - - - - - &reftitle.seealso; - - - gupnp_control_point_new - gupnp_control_point_browse_start - - - - - - - diff --git a/reference/gupnp/functions/gupnp-control-point-new.xml b/reference/gupnp/functions/gupnp-control-point-new.xml deleted file mode 100644 index 3b918e453f4f..000000000000 --- a/reference/gupnp/functions/gupnp-control-point-new.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - gupnp_control_point_new - Create a new control point - - - - &reftitle.description; - - resourcegupnp_control_point_new - resourcecontext - stringtarget - - - Create a new control point with the specified target. - - - - - &reftitle.parameters; - - - - context - - - A context identifier, returned by gupnp_context_new. - - - - - target - - - The search target. target should be a service - or device name, such as urn:schemas-upnp-org:service:WANIPConnection:1 or - urn:schemas-upnp-org:device:MediaRenderer:1. - - - - - - - - - &reftitle.returnvalues; - - A control point identifier. - - - - - - diff --git a/reference/gupnp/functions/gupnp-device-action-callback-set.xml b/reference/gupnp/functions/gupnp-device-action-callback-set.xml deleted file mode 100644 index 7e8384946f75..000000000000 --- a/reference/gupnp/functions/gupnp-device-action-callback-set.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - gupnp_device_action_callback_set - Set device callback function - - - - &reftitle.description; - - boolgupnp_device_action_callback_set - resourceroot_device - intsignal - stringaction_name - mixedcallback - mixedarg - - - Set device callback function for signal and action. - - - - - &reftitle.parameters; - - - - root_device - - - A root device identifier, returned by gupnp_root_device_new. - - - - - signal - - - The value of signal. Signal can be one of the following values: - - - GUPNP_SIGNAL_ACTION_INVOKED - - - Emitted whenever an action is invoked. Handler should process action - and must call either gupnp_service_action_return - or gupnp_service_action_return_error. - - - - - GUPNP_SIGNAL_NOTIFY_FAILED - - - Emitted whenever notification of a client fails. - - - - - - - - - action_name - - - The name of action. - - - - - callback - - - The callback function for the certain signal. Typically, callback function - takes on three parameters. The service parameter's - identifier being the first, action parameter's - identifier (in case GUPNP_SIGNAL_ACTION_INVOKED signal) or - error parameter's message (in case GUPNP_SIGNAL_NOTIFY_FAILED - signal) being the second, and the arg is third. - - - - - arg - - - User data for callback. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Issues E_WARNING either with not valid callback function or with not valid signal. - - - - - &reftitle.seealso; - - - gupnp_root_device_new - - - - - - - diff --git a/reference/gupnp/functions/gupnp-device-info-get-service.xml b/reference/gupnp/functions/gupnp-device-info-get-service.xml deleted file mode 100644 index 5979fb03c670..000000000000 --- a/reference/gupnp/functions/gupnp-device-info-get-service.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - gupnp_device_info_get_service - Get the service with type - - - - &reftitle.description; - - resourcegupnp_device_info_get_service - resourceroot_device - stringtype - - - Get the service with type or false if no such device was found. - - - - - &reftitle.parameters; - - - - root_device - - - A root device identifier, returned by gupnp_root_device_new. - - - - - type - - - The type of the service to be retrieved. - - - - - - - - - &reftitle.returnvalues; - - A service identifier. - - - - - &reftitle.examples; - - - Create new UPnP context and get device info service - - -]]> - - - - - - - - diff --git a/reference/gupnp/functions/gupnp-device-info-get.xml b/reference/gupnp/functions/gupnp-device-info-get.xml deleted file mode 100644 index 597f46436462..000000000000 --- a/reference/gupnp/functions/gupnp-device-info-get.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - gupnp_device_info_get - Get info of root device - - - - &reftitle.description; - - arraygupnp_device_info_get - resourceroot_device - - - Get info of root device. - - - - - &reftitle.parameters; - - - - root_device - - - A root device identifier, returned by gupnp_root_device_new. - - - - - - - - - &reftitle.returnvalues; - - Return array wich contains the information of the root device (like location, url, udn and etc). - - - - - - diff --git a/reference/gupnp/functions/gupnp-root-device-get-available.xml b/reference/gupnp/functions/gupnp-root-device-get-available.xml deleted file mode 100644 index a2dcc56b6178..000000000000 --- a/reference/gupnp/functions/gupnp-root-device-get-available.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - gupnp_root_device_get_available - Check whether root device is available - - - - &reftitle.description; - - boolgupnp_root_device_get_available - resourceroot_device - - - Get whether or not root_device is available (announcing its presence). - - - - - &reftitle.parameters; - - - - root_device - - - A root device identifier, returned by gupnp_root_device_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - gupnp_root_device_set_available - - - - - - - diff --git a/reference/gupnp/functions/gupnp-root-device-get-relative-location.xml b/reference/gupnp/functions/gupnp-root-device-get-relative-location.xml deleted file mode 100644 index 91effb0b967f..000000000000 --- a/reference/gupnp/functions/gupnp-root-device-get-relative-location.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - gupnp_root_device_get_relative_location - Get the relative location of root device - - - - &reftitle.description; - - stringgupnp_root_device_get_relative_location - resourceroot_device - - - Get the relative location of root device. - - - - - &reftitle.parameters; - - - - root_device - - - A root device identifier, returned by gupnp_root_device_new. - - - - - - - - - &reftitle.returnvalues; - - The relative location of root device - - - - - - diff --git a/reference/gupnp/functions/gupnp-root-device-new.xml b/reference/gupnp/functions/gupnp-root-device-new.xml deleted file mode 100644 index 251343492474..000000000000 --- a/reference/gupnp/functions/gupnp-root-device-new.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - gupnp_root_device_new - Create a new root device - - - - &reftitle.description; - - resourcegupnp_root_device_new - resourcecontext - stringlocation - stringdescription_dir - - - Create a new root device, automatically downloading and parsing location. - - - - - &reftitle.parameters; - - - - context - - - A context identifier, returned by gupnp_context_new. - - - - - location - - - Location of the description file for this device, relative to the HTTP root - - - - - - - - - &reftitle.returnvalues; - - A root device identifier. - - - - - - &reftitle.examples; - - - Create new UPnP context and get device info service - - -]]> - - - - - - - &reftitle.seealso; - - - gupnp_root_device_set_available - gupnp_root_device_start - gupnp_root_device_stop - - - - - - - diff --git a/reference/gupnp/functions/gupnp-root-device-set-available.xml b/reference/gupnp/functions/gupnp-root-device-set-available.xml deleted file mode 100644 index 7f8ec96f0f77..000000000000 --- a/reference/gupnp/functions/gupnp-root-device-set-available.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - gupnp_root_device_set_available - Set whether or not root_device is available - - - - &reftitle.description; - - boolgupnp_root_device_set_available - resourceroot_device - boolavailable - - - Controls whether or not root_device is available (announcing its presence). - - - - - &reftitle.parameters; - - - - root_device - - - A root device identifier, returned by gupnp_root_device_new. - - - - - available - - - Set &true; if root_device should be available. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - gupnp_root_device_get_available - - - - - - - diff --git a/reference/gupnp/functions/gupnp-root-device-start.xml b/reference/gupnp/functions/gupnp-root-device-start.xml deleted file mode 100644 index d22ef106ea67..000000000000 --- a/reference/gupnp/functions/gupnp-root-device-start.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - gupnp_root_device_start - Start main loop - - - - &reftitle.description; - - boolgupnp_root_device_start - resourceroot_device - - - Start root server's main loop. - - - - - &reftitle.parameters; - - - - root_device - - - A root device identifier, returned by gupnp_root_device_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - gupnp_root_device_stop - - - - - - - diff --git a/reference/gupnp/functions/gupnp-root-device-stop.xml b/reference/gupnp/functions/gupnp-root-device-stop.xml deleted file mode 100644 index a922ad2207e3..000000000000 --- a/reference/gupnp/functions/gupnp-root-device-stop.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - gupnp_root_device_stop - Stop main loop - - - - &reftitle.description; - - boolgupnp_root_device_stop - resourceroot_device - - - Stop root server's main loop. - - - - - &reftitle.parameters; - - - - root_device - - - A root device identifier, returned by gupnp_root_device_new. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - gupnp_root_device_start - - - - - - - diff --git a/reference/gupnp/functions/gupnp-service-action-get.xml b/reference/gupnp/functions/gupnp-service-action-get.xml deleted file mode 100644 index 8d95e462397f..000000000000 --- a/reference/gupnp/functions/gupnp-service-action-get.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - gupnp_service_action_get - Retrieves the specified action arguments - - - - &reftitle.description; - - mixedgupnp_service_action_get - resourceaction - stringname - inttype - - - Retrieves the specified action arguments. - - - - - &reftitle.parameters; - - - - action - - - A service action identifier. - - - - - name - - - The name of the variable to retrieve. - - - - - type - - - The type of the variable to retrieve. Type can be one of the following values: - - - GUPNP_TYPE_BOOLEAN - - - Type of the variable is boolean. - - - - - GUPNP_TYPE_INT - - - Type of the variable is integer. - - - - - GUPNP_TYPE_LONG - - - Type of the variable is long. - - - - - GUPNP_TYPE_DOUBLE - - - Type of the variable is double. - - - - - GUPNP_TYPE_FLOAT - - - Type of the variable is float. - - - - - GUPNP_TYPE_STRING - - - Type of the variable is string. - - - - - - - - - - - - - &reftitle.returnvalues; - - The value of the variable. - - - - - &reftitle.errors; - - Issues E_WARNING with not correctly defined type of the variable. - - - - - &reftitle.seealso; - - - gupnp_service_action_set - - - - - - - diff --git a/reference/gupnp/functions/gupnp-service-action-return-error.xml b/reference/gupnp/functions/gupnp-service-action-return-error.xml deleted file mode 100644 index a41d22e20e9a..000000000000 --- a/reference/gupnp/functions/gupnp-service-action-return-error.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - - gupnp_service_action_return_error - Return error code - - - - &reftitle.description; - - boolgupnp_service_action_return_error - resourceaction - interror_code - stringerror_description - - - Return error code. - - - - - &reftitle.parameters; - - - - action - - - A service action identifier. - - - - - error_code - - - The error code. Signal can be one of the following values or user defined: - - - GUPNP_CONTROL_ERROR_INVALID_ACTION - - - The action name was invalid. - - - - - GUPNP_CONTROL_ERROR_INVALID_ARGS - - - The action arguments were invalid. - - - - - GUPNP_CONTROL_ERROR_OUT_OF_SYNC - - - Out of sync (deprecated). - - - - - GUPNP_CONTROL_ERROR_ACTION_FAILED - - - The action failed. - - - - - - - - - error_description - - - The error description. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - gupnp_service_action_return - - - - - - - diff --git a/reference/gupnp/functions/gupnp-service-action-return.xml b/reference/gupnp/functions/gupnp-service-action-return.xml deleted file mode 100644 index bd68a5208022..000000000000 --- a/reference/gupnp/functions/gupnp-service-action-return.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - gupnp_service_action_return - Return successfully - - - - &reftitle.description; - - boolgupnp_service_action_return - resourceaction - - - Return successfully. - - - - - &reftitle.parameters; - - - - action - - - A service action identifier. - - - - - - - - - &reftitle.returnvalues; - - - &return.success; - - - - - &reftitle.seealso; - - - gupnp_service_action_return_error - - - - - - - diff --git a/reference/gupnp/functions/gupnp-service-action-set.xml b/reference/gupnp/functions/gupnp-service-action-set.xml deleted file mode 100644 index b9c408dad9c5..000000000000 --- a/reference/gupnp/functions/gupnp-service-action-set.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - - gupnp_service_action_set - Sets the specified action return values - - - - &reftitle.description; - - boolgupnp_service_action_set - resourceaction - stringname - inttype - mixedvalue - - - Sets the specified action return values. - - - - - &reftitle.parameters; - - - - action - - - A service action identifier. - - - - - name - - - The name of the variable to retrieve. - - - - - type - - - The type of the variable to retrieve. Type can be one of the following values: - - - GUPNP_TYPE_BOOLEAN - - - Type of the variable is boolean. - - - - - GUPNP_TYPE_INT - - - Type of the variable is integer. - - - - - GUPNP_TYPE_LONG - - - Type of the variable is long. - - - - - GUPNP_TYPE_DOUBLE - - - Type of the variable is double. - - - - - GUPNP_TYPE_FLOAT - - - Type of the variable is float. - - - - - GUPNP_TYPE_STRING - - - Type of the variable is string. - - - - - - - - - value - - - The value of the variable to retrieve. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Issues E_WARNING with neither not correctly defined type of the variable or the value is not corresponding to the defined type. - - - - - &reftitle.seealso; - - - gupnp_service_action_get - - - - - - - diff --git a/reference/gupnp/functions/gupnp-service-freeze-notify.xml b/reference/gupnp/functions/gupnp-service-freeze-notify.xml deleted file mode 100644 index c37f6d00b4f2..000000000000 --- a/reference/gupnp/functions/gupnp-service-freeze-notify.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - gupnp_service_freeze_notify - Freeze new notifications - - - - &reftitle.description; - - boolgupnp_service_freeze_notify - resourceservice - - - Causes new notifications to be queued up until gupnp_service_thaw_notify is called. - - - - - &reftitle.parameters; - - - - service - - - A service identifier. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - gupnp_service_notify - gupnp_service_thaw_notify - - - - - - - diff --git a/reference/gupnp/functions/gupnp-service-info-get-introspection.xml b/reference/gupnp/functions/gupnp-service-info-get-introspection.xml deleted file mode 100644 index 25858e10a5e6..000000000000 --- a/reference/gupnp/functions/gupnp-service-info-get-introspection.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - gupnp_service_info_get_introspection - Get resource introspection of service - - - - &reftitle.description; - - mixedgupnp_service_info_get_introspection - resourceproxy - mixedcallback - mixedarg - - - Get resource introspection of service or register callback if corresponding parameter was passed. - - - - - &reftitle.parameters; - - - - proxy - - - A service proxy identifier. - - - - - callback - - - The callback function to be called when introspection object is ready. - Typically, callback function takes on three parameters. The introspection - parameter's identifier being the first, error parameter's message - being the second, and the arg is third. - - - - - arg - - - User data for callback. - - - - - - - - - &reftitle.returnvalues; - - Return true if callback function was defined. - Return introspection identifier if callback function was omited. - - - - - &reftitle.errors; - - Issues E_WARNING with not valid callback function. - - - - - - diff --git a/reference/gupnp/functions/gupnp-service-info-get.xml b/reference/gupnp/functions/gupnp-service-info-get.xml deleted file mode 100644 index b86d5dff6edc..000000000000 --- a/reference/gupnp/functions/gupnp-service-info-get.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - gupnp_service_info_get - Get full info of service - - - - &reftitle.description; - - arraygupnp_service_info_get - resourceproxy - - - Get full info of service. - - - - - &reftitle.parameters; - - - - proxy - - - A service proxy identifier. - - - - - - - - - &reftitle.returnvalues; - - Return array wich contains the information of the service (like location, url, udn and etc). - - - - - - diff --git a/reference/gupnp/functions/gupnp-service-introspection-get-state-variable.xml b/reference/gupnp/functions/gupnp-service-introspection-get-state-variable.xml deleted file mode 100644 index a1d98e93836f..000000000000 --- a/reference/gupnp/functions/gupnp-service-introspection-get-state-variable.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - gupnp_service_introspection_get_state_variable - Returns the state variable data - - - - &reftitle.description; - - arraygupnp_service_introspection_get_state_variable - resourceintrospection - stringvariable_name - - - Returns the state variable data by the name variable_name in this service. - - - - - &reftitle.parameters; - - - - introspection - - - A introspection identifier. - - - - - variable_name - - - The name of the variable to retreive. - - - - - - - - - &reftitle.returnvalues; - - Return the state variable data or &false;. - - - - - - diff --git a/reference/gupnp/functions/gupnp-service-notify.xml b/reference/gupnp/functions/gupnp-service-notify.xml deleted file mode 100644 index 8184a77e5b4c..000000000000 --- a/reference/gupnp/functions/gupnp-service-notify.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - gupnp_service_notify - Notifies listening clients - - - - &reftitle.description; - - boolgupnp_service_notify - resourceservice - stringname - inttype - mixedvalue - - - Notifies listening clients that the property have changed to the specified values. - - - - - &reftitle.parameters; - - - - service - - - A service identifier. - - - - - name - - - The name of the variable. - - - - - type - - - The type of the variable. Type can be one of the following values: - - - GUPNP_TYPE_BOOLEAN - - - Type of the variable is boolean. - - - - - GUPNP_TYPE_INT - - - Type of the variable is integer. - - - - - GUPNP_TYPE_LONG - - - Type of the variable is long. - - - - - GUPNP_TYPE_DOUBLE - - - Type of the variable is double. - - - - - GUPNP_TYPE_FLOAT - - - Type of the variable is float. - - - - - GUPNP_TYPE_STRING - - - Type of the variable is string. - - - - - - - - - value - - - The value of the variable. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Issues E_WARNING with either not correctly defined type of the variable or the value is not corresponding to the defined type. - - - - - &reftitle.seealso; - - - gupnp_service_freeze_notify - gupnp_service_thaw_notify - - - - - - - diff --git a/reference/gupnp/functions/gupnp-service-proxy-action-get.xml b/reference/gupnp/functions/gupnp-service-proxy-action-get.xml deleted file mode 100644 index 59cd94effbb3..000000000000 --- a/reference/gupnp/functions/gupnp-service-proxy-action-get.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - gupnp_service_proxy_action_get - Send action to the service and get value - - - - &reftitle.description; - - mixedgupnp_service_proxy_action_get - resourceproxy - stringaction - stringname - inttype - - - Send action with parameters to the service exposed by proxy synchronously and get value. - - - - - &reftitle.parameters; - - - - proxy - - - A service proxy identifier. - - - - - action - - - An action. - - - - - name - - - The action name. - - - - - type - - - The type of the variable to retrieve. Type can be one of the following values: - - - GUPNP_TYPE_BOOLEAN - - - Type of the variable is boolean. - - - - - GUPNP_TYPE_INT - - - Type of the variable is integer. - - - - - GUPNP_TYPE_LONG - - - Type of the variable is long. - - - - - GUPNP_TYPE_DOUBLE - - - Type of the variable is double. - - - - - GUPNP_TYPE_FLOAT - - - Type of the variable is float. - - - - - GUPNP_TYPE_STRING - - - Type of the variable is string. - - - - - - - - - - - - - &reftitle.returnvalues; - - Return value of the action. - - - - - &reftitle.errors; - - Issues E_WARNING with either not correctly defined type of the action or unable to send action. - - - - - &reftitle.seealso; - - - gupnp_service_proxy_action_set - gupnp_service_proxy_send_action - - - - - - - diff --git a/reference/gupnp/functions/gupnp-service-proxy-action-set.xml b/reference/gupnp/functions/gupnp-service-proxy-action-set.xml deleted file mode 100644 index 858334531737..000000000000 --- a/reference/gupnp/functions/gupnp-service-proxy-action-set.xml +++ /dev/null @@ -1,168 +0,0 @@ - - - - - - gupnp_service_proxy_action_set - Send action to the service and set value - - - - &reftitle.description; - - boolgupnp_service_proxy_action_set - resourceproxy - stringaction - stringname - mixedvalue - inttype - - - Send action with parameters to the service exposed by proxy synchronously and set value. - - - - - &reftitle.parameters; - - - - proxy - - - A service proxy identifier. - - - - - action - - - An action. - - - - - name - - - The action name. - - - - - value - - - The action value. - - - - - type - - - The type of the action. Type can be one of the following values: - - - GUPNP_TYPE_BOOLEAN - - - Type of the variable is boolean. - - - - - GUPNP_TYPE_INT - - - Type of the variable is integer. - - - - - GUPNP_TYPE_LONG - - - Type of the variable is long. - - - - - GUPNP_TYPE_DOUBLE - - - Type of the variable is double. - - - - - GUPNP_TYPE_FLOAT - - - Type of the variable is float. - - - - - GUPNP_TYPE_STRING - - - Type of the variable is string. - - - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Issues E_WARNING with either not correctly defined type of the action or unable to send action. - - - - - &reftitle.seealso; - - - gupnp_service_proxy_action_get - gupnp_service_proxy_send_action - - - - - - - diff --git a/reference/gupnp/functions/gupnp-service-proxy-add-notify.xml b/reference/gupnp/functions/gupnp-service-proxy-add-notify.xml deleted file mode 100644 index b20d9681456c..000000000000 --- a/reference/gupnp/functions/gupnp-service-proxy-add-notify.xml +++ /dev/null @@ -1,163 +0,0 @@ - - - - - - gupnp_service_proxy_add_notify - Sets up callback for variable change notification - - - - &reftitle.description; - - boolgupnp_service_proxy_add_notify - resourceproxy - stringvalue - inttype - mixedcallback - mixedarg - - - Sets up callback to be called whenever a change notification for variable is recieved. - - - - - &reftitle.parameters; - - - - proxy - - - A service proxy identifier. - - - - - value - - - The variable to add notification for. - - - - - type - - - The type of the variable. Type can be one of the following values: - - - GUPNP_TYPE_BOOLEAN - - - Type of the variable is boolean. - - - - - GUPNP_TYPE_INT - - - Type of the variable is integer. - - - - - GUPNP_TYPE_LONG - - - Type of the variable is long. - - - - - GUPNP_TYPE_DOUBLE - - - Type of the variable is double. - - - - - GUPNP_TYPE_FLOAT - - - Type of the variable is float. - - - - - GUPNP_TYPE_STRING - - - Type of the variable is string. - - - - - - - - - callback - - - The callback to call when variable changes. Typically, callback function - takes on three parameters. The variable - parameter being the first, value parameter - being the second, and the arg is third. - - - - - arg - - - User data for callback. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - gupnp_service_proxy_remove_notify - - - - - - - diff --git a/reference/gupnp/functions/gupnp-service-proxy-callback-set.xml b/reference/gupnp/functions/gupnp-service-proxy-callback-set.xml deleted file mode 100644 index 3403f383dadf..000000000000 --- a/reference/gupnp/functions/gupnp-service-proxy-callback-set.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - gupnp_service_proxy_callback_set - Set service proxy callback for signal - - - - &reftitle.description; - - boolgupnp_service_proxy_callback_set - resourceproxy - intsignal - mixedcallback - mixedarg - - - Set service proxy callback for signal. - - - - - &reftitle.parameters; - - - - proxy - - - A service proxy identifier. - - - - - signal - - - The value of signal. - - - GUPNP_SIGNAL_SUBSCRIPTION_LOST - - - Emitted whenever the subscription to this service has been lost due - to an error condition. - - - - - - - - - callback - - - The callback function for the certain signal. Typically, callback function - takes on two parameters. error parameter's message - being the first, and the arg is second. - - - - - arg - - - User data for callback. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.errors; - - Issues E_WARNING either with not valid callback function or with not valid signal. - - - - - - diff --git a/reference/gupnp/functions/gupnp-service-proxy-get-subscribed.xml b/reference/gupnp/functions/gupnp-service-proxy-get-subscribed.xml deleted file mode 100644 index efca00525be8..000000000000 --- a/reference/gupnp/functions/gupnp-service-proxy-get-subscribed.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - gupnp_service_proxy_get_subscribed - Check whether subscription is valid to the service - - - - &reftitle.description; - - boolgupnp_service_proxy_get_subscribed - resourceproxy - - - Check whether subscription is valid to the service. - - - - - &reftitle.parameters; - - - - proxy - - - A service proxy identifier. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - gupnp_service_proxy_set_subscribed - - - - - - - diff --git a/reference/gupnp/functions/gupnp-service-proxy-remove-notify.xml b/reference/gupnp/functions/gupnp-service-proxy-remove-notify.xml deleted file mode 100644 index 2db7368ab1e8..000000000000 --- a/reference/gupnp/functions/gupnp-service-proxy-remove-notify.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - gupnp_service_proxy_remove_notify - Cancels the variable change notification - - - - &reftitle.description; - - boolgupnp_service_proxy_remove_notify - resourceproxy - stringvalue - - - Cancels the variable change notification. - - - - - &reftitle.parameters; - - - - proxy - - - A service proxy identifier. - - - - - value - - - The variable to add notification for. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - gupnp_service_proxy_add_notify - - - - - - - diff --git a/reference/gupnp/functions/gupnp-service-proxy-send-action.xml b/reference/gupnp/functions/gupnp-service-proxy-send-action.xml deleted file mode 100644 index 624b9040f907..000000000000 --- a/reference/gupnp/functions/gupnp-service-proxy-send-action.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - gupnp_service_proxy_send_action - Send action with multiple parameters synchronously - - - - &reftitle.description; - - arraygupnp_service_proxy_send_action - resourceproxy - stringaction - arrayin_params - arrayout_params - - - Send action with parameters in_params to the service exposed by proxy synchronously and return out_params with values or &false; on error. - - - - - &reftitle.parameters; - - - - proxy - - - A service proxy identifier. - - - - - action - - - An action. - - - - - in_params - - - An array of in parameters. Each entry in in_params is supposed to an array containing name, type and value of the parameters. - - - - - out_params - - - An array of out parameters. Each entry in out_params is supposed to an array containing name and type of the parameters. - - - - - - - - - &reftitle.returnvalues; - - Return out_params array with values or &false; on error. - - - - - &reftitle.errors; - - Issues E_WARNING with either not correctly defined in_params and out_params or unable to send action. - - - - - &reftitle.seealso; - - - gupnp_service_proxy_action_get - gupnp_service_proxy_action_set - - - - - - - diff --git a/reference/gupnp/functions/gupnp-service-proxy-set-subscribed.xml b/reference/gupnp/functions/gupnp-service-proxy-set-subscribed.xml deleted file mode 100644 index eab504f4f554..000000000000 --- a/reference/gupnp/functions/gupnp-service-proxy-set-subscribed.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - - gupnp_service_proxy_set_subscribed - (Un)subscribes to the service - - - - &reftitle.description; - - boolgupnp_service_proxy_set_subscribed - resourceproxy - boolsubscribed - - - (Un)subscribes to the service. - - - - - &reftitle.parameters; - - - - proxy - - - A service proxy identifier. - - - - - subscribed - - - Set &true; to subscribe to this service. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - gupnp_service_proxy_get_subscribed - - - - - - - diff --git a/reference/gupnp/functions/gupnp-service-thaw-notify.xml b/reference/gupnp/functions/gupnp-service-thaw-notify.xml deleted file mode 100644 index 5d1aed4ffcc7..000000000000 --- a/reference/gupnp/functions/gupnp-service-thaw-notify.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - gupnp_service_thaw_notify - Sends out any pending notifications and stops queuing of new ones - - - - &reftitle.description; - - boolgupnp_service_thaw_notify - resourceservice - - - Sends out any pending notifications and stops queuing of new ones. - - - - - &reftitle.parameters; - - - - service - - - A service identifier. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - gupnp_service_notify - gupnp_service_freeze_notify - - - - - - - diff --git a/reference/gupnp/reference.xml b/reference/gupnp/reference.xml deleted file mode 100644 index 1d64f6f6e7d7..000000000000 --- a/reference/gupnp/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - Gupnp &Functions; - - &reference.gupnp.entities.functions; - - - - - diff --git a/reference/gupnp/setup.xml b/reference/gupnp/setup.xml deleted file mode 100644 index 60d384e442d1..000000000000 --- a/reference/gupnp/setup.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.required; - - In order to use PECL/Gupnp functions you need to install the - gUPnP library version 0.12.7 or greater. It also requires - glib-2.0, gssdp-1.0, libsoup-2.4 or greater for all of them. - -
- - -&reference.gupnp.configure; - - - -
- &reftitle.runtime; - &no.config; -
- - - -
- &reftitle.resources; - &no.resource; -
- - - - - diff --git a/reference/gupnp/versions.xml b/reference/gupnp/versions.xml deleted file mode 100644 index 230454591ef9..000000000000 --- a/reference/gupnp/versions.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/haru/book.xml b/reference/haru/book.xml deleted file mode 100644 index 9ed59ba6b3f9..000000000000 --- a/reference/haru/book.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - Haru PDF - haru - - - - &reftitle.intro; - - The PECL/haru extension provides bindings to the libHaru library. - libHaru is a free, cross platform, and Open Source library for generating - PDF files. - - - The Haru library (libHaru) may be found here: - &url.haru.lib;. - - &warn.experimental; - - - - &reference.haru.setup; - &reference.haru.constants; - &reference.haru.examples; - &reference.haru.builtin; - - &reference.haru.haruexception; - &reference.haru.harudoc; - &reference.haru.harupage; - &reference.haru.harufont; - &reference.haru.haruimage; - &reference.haru.haruencoder; - &reference.haru.haruoutline; - &reference.haru.haruannotation; - &reference.haru.harudestination; - - - - - diff --git a/reference/haru/builtin.xml b/reference/haru/builtin.xml deleted file mode 100644 index 5490f1d1b153..000000000000 --- a/reference/haru/builtin.xml +++ /dev/null @@ -1,499 +0,0 @@ - - - - Builtin Fonts And Encodings -
- Builtin Fonts - - These Base14 fonts are built-in into PDF and all viewers can display them. - Using these fonts may decrease the size of the result file and make the - processing faster, avoiding loading external fonts. - However the fonts support only latin1 character set and you have to load - external fonts if you need to use an other character set. - - - The Base14 fonts: - - - - Courier - - - - - Courier-Bold - - - - - Courier-Oblique - - - - - Courier-BoldOblique - - - - - Helvetica - - - - - Helvetica-Bold - - - - - Helvetica-Oblique - - - - - Helvetica-BoldOblique - - - - - Times-Roman - - - - - Times-Bold - - - - - Times-Italic - - - - - Times-BoldItalic - - - - - Symbol - - - - - ZapfDingbats - - - - -
-
- Builtin Encodings - - Single-byte character set encodings - - - - Name - Description - - - - - - StandardEncoding - - - The default encoding of PDF. - - - - - MacRomanEncoding - - - The standard encoding of Mac OS. - - - - - WinAnsiEncoding - - - The standard encoding of Windows. - - - - - FontSpecific - - - The font built-in encoding. - - - - - ISO8859-2 - - - Latin2 (East European) - - - - - ISO8859-3 - - - Latin3 (South European) - - - - - ISO8859-4 - - - Latin4 (North European) - - - - - ISO8859-5 - - - Cyrillic - - - - - ISO8859-6 - - - Arabic - - - - - ISO8859-7 - - - Greek - - - - - ISO8859-8 - - - Hebrew - - - - - ISO8859-9 - - - Latin5 (Turkish) - - - - - ISO8859-10 - - - Latin6 (Nordic) - - - - - ISO8859-11 - - - Thai - - - - - ISO8859-13 - - - Latin7 (Baltic Rim) - - - - - ISO8859-14 - - - Latin8 (Celtic) - - - - - ISO8859-15 - - - Latin9 - - - - - ISO8859-16 - - - Latin10 - - - - - CP1250 - - - MS Windows Codepage 1250. - - - - - CP1251 - - - MS Windows Codepage 1251. - - - - - CP1252 - - - MS Windows Codepage 1252. - - - - - CP1253 - - - MS Windows Codepage 1253. - - - - - CP1254 - - - MS Windows Codepage 1254. - - - - - CP1255 - - - MS Windows Codepage 1255. - - - - - CP1256 - - - MS Windows Codepage 1256. - - - - - CP1257 - - - MS Windows Codepage 1257. - - - - - CP1258 - - - MS Windows Codepage 1258. - - - - - KOI8-R - - - Cyrillic character set. - - - - -
- - Multi-byte character set encodings - - - - Name - Description - - - - - - GB-EUC-H - - - EUC-CN encoding. - - - - - GB-EUC-V - - - Vertical writing version of GB-EUC-H. - - - - - GBK-EUC-H - - - Microsoft Code Page 936 (lfCharSet 0x86) GBK - encoding. - - - - - GBK-EUC-V - - - Vertical writing version of GBK-EUC-H. - - - - - ETen-B5-H - - - Microsoft Code Page 950 (lfCharSet 0x88) Big Five - character set with ETen extensions. - - - - - ETen-B5-V - - - Vertical writing version of ETen-B5-H. - - - - - 90ms-RKSJ-H - - - Microsoft Code Page 932, JIS X 0208 character. - - - - - 90ms-RKSJ-V - - - Vertical writing version of 90ms-RKSJ-V. - - - - - 90msp-RKSJ-H - - - Microsoft Code Page 932, JIS X 0208 character - (proportional). - - - - - EUC-H - - - JIS X 0208 character set, EUC-JP encoding. - - - - - EUC-V - - - Vertical writing version of EUC-H. - - - - - KSC-EUC-H - - - KS X 1001:1992 character set, EUC-KR encoding. - - - - - KSC-EUC-V - - - Vertical writing version of KSC-EUC-V. - - - - - KSCms-UHC-H - - - Microsoft Code Page 949 (lfCharSet 0x81), KS X - 1001:1992 character set plus 8822 additional hangul, Unified Hangul - Code (UHC) encoding (proportional). - - - - - KSCms-UHC-HW-H - - - Microsoft Code Page 949 (lfCharSet 0x81), KS X - 1001:1992 character set plus 8822 additional hangul, Unified Hangul - Code (UHC) encoding (fixed width). - - - - - KSCms-UHC-HW-V - - - Vertical writing version of KSCms-UHC-HW-H. - - - - -
-
- - - diff --git a/reference/haru/constants.xml b/reference/haru/constants.xml deleted file mode 100644 index 2e7a4bf1bdf9..000000000000 --- a/reference/haru/constants.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - &reftitle.constants; - &no.constants; - - - - diff --git a/reference/haru/examples.xml b/reference/haru/examples.xml deleted file mode 100644 index fa3d12d8e8d6..000000000000 --- a/reference/haru/examples.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - &reftitle.examples; -
- Basic PECL/haru example - - - Fancy "Hello world" - -setPageMode(HaruDoc::PAGE_MODE_USE_THUMBS); /* show thumbnails */ - -$page = $doc->addPage(); /* add page to the document */ -$page->setSize(HaruPage::SIZE_A4, HaruPage::LANDSCAPE); /* set the page to use A4 landscape format */ - -$courier = $doc->getFont("Courier-Bold"); /* we'll use the bundled font a few lines below */ - -$page->setRGBStroke(0, 0, 0); /* set colors */ -$page->setRGBFill(0.7, 0.8, 0.9); -$page->rectangle(150, 150, 550, 250); /* draw a rectangle */ - -$page->fillStroke(); /* fill and stroke it */ - -$page->setDash(array(3, 3), 0); /* set dash style for lines at this page */ -$page->setFontAndSize($courier, 60); /* set font and size */ - -$page->setRGBStroke(0.5, 0.5, 0.1); /* set line color */ -$page->setRGBFill(1, 1, 1); /* set filling color */ - -$page->setTextRenderingMode(HaruPage::FILL_THEN_STROKE); /* fill and stroke text */ - -/* print the text */ -$page->beginText(); -$page->textOut(210, 270, "Hello World!"); -$page->endText(); - -$doc->save("/tmp/test.pdf"); /* save the document into a file */ - -?> -]]> - - - - - Open the result document in your favourite PDF viewer and you should see a - light-blue rectangle and white "Hello World!" on it. - -
- - - - diff --git a/reference/haru/haruannotation.xml b/reference/haru/haruannotation.xml deleted file mode 100644 index 2bcc5d535dab..000000000000 --- a/reference/haru/haruannotation.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - The HaruAnnotation class - HaruAnnotation - - - - -
- &reftitle.intro; - - Haru PDF Annotation Class. - -
- - -
- &reftitle.classsynopsis; - - - - HaruAnnotation - - - - - HaruAnnotation - - - - - - &Methods; - - - -
- -
- &reftitle.constants; - - - <tgroup cols="3"> - <thead> - <row> - <entry>Type</entry> - <entry>Name</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>int</entry> - <entry>HaruAnnotation::NO_HIGHLIGHT</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruAnnotation::INVERT_BOX</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruAnnotation::INVERT_BORDER</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruAnnotation::DOWN_APPEARANCE</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruAnnotation::ICON_COMMENT</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruAnnotation::ICON_KEY</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruAnnotation::ICON_NOTE</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruAnnotation::ICON_HELP</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruAnnotation::ICON_NEW_PARAGRAPH</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruAnnotation::ICON_PARAGRAPH</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruAnnotation::ICON_INSERT</entry> - <entry></entry> - </row> - </tbody> - </tgroup> - </table> - </section> - - </partintro> - - &reference.haru.entities.haruannotation; - -</phpdoc:classref> -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/haruannotation/setborderstyle.xml b/reference/haru/haruannotation/setborderstyle.xml deleted file mode 100644 index 5bdc60a854fa..000000000000 --- a/reference/haru/haruannotation/setborderstyle.xml +++ /dev/null @@ -1,87 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="haruannotation.setborderstyle" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruAnnotation::setBorderStyle</refname> - <refpurpose>Set the border style of the annotation</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruAnnotation::setBorderStyle</methodname> - <methodparam><type>float</type><parameter>width</parameter></methodparam> - <methodparam><type>int</type><parameter>dash_on</parameter></methodparam> - <methodparam><type>int</type><parameter>dash_off</parameter></methodparam> - </methodsynopsis> - <para> - Defines the style of the border of the annotation. - This function may be used with link annotations only. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>width</parameter></term> - <listitem> - <para> - The width of the border line. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>dash_on</parameter></term> - <listitem> - <para> - The dash style. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>dash_off</parameter></term> - <listitem> - <para> - The dash style. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/haruannotation/sethighlightmode.xml b/reference/haru/haruannotation/sethighlightmode.xml deleted file mode 100644 index c1fbdb1bf934..000000000000 --- a/reference/haru/haruannotation/sethighlightmode.xml +++ /dev/null @@ -1,88 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="haruannotation.sethighlightmode" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruAnnotation::setHighlightMode</refname> - <refpurpose>Set the highlighting mode of the annotation</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruAnnotation::setHighlightMode</methodname> - <methodparam><type>int</type><parameter>mode</parameter></methodparam> - </methodsynopsis> - <para> - Defines the appearance of the annotation when clicked. - This function may be used with link annotations only. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>mode</parameter></term> - <listitem> - <para> - The highlighting mode of the annotation. Can take only these values: - <simplelist> - <member> - <constant>HaruAnnotation::NO_HIGHLIGHT</constant> - no - highlighting. - </member> - <member> - <constant>HaruAnnotation::INVERT_BOX</constant> - invert the contents - of the annotation. - </member> - <member> - <constant>HaruAnnotation::INVERT_BORDER</constant> - invert the - border of the annotation. - </member> - <member> - <constant>HaruAnnotation::DOWN_APPEARANCE</constant> - dent the - annotation. - </member> - </simplelist> - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/haruannotation/seticon.xml b/reference/haru/haruannotation/seticon.xml deleted file mode 100644 index 859d9ee3a229..000000000000 --- a/reference/haru/haruannotation/seticon.xml +++ /dev/null @@ -1,93 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="haruannotation.seticon" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruAnnotation::setIcon</refname> - <refpurpose>Set the icon style of the annotation</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruAnnotation::setIcon</methodname> - <methodparam><type>int</type><parameter>icon</parameter></methodparam> - </methodsynopsis> - <para> - Defines the style of the annotation icon. - This function may be used with text annotations only. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>icon</parameter></term> - <listitem> - <para> - The style of the icon. Can take only these values: - <simplelist> - <member> - <constant>HaruAnnotation::ICON_COMMENT</constant> - </member> - <member> - <constant>HaruAnnotation::ICON_KEY</constant> - </member> - <member> - <constant>HaruAnnotation::ICON_NOTE</constant> - </member> - <member> - <constant>HaruAnnotation::ICON_HELP</constant> - </member> - <member> - <constant>HaruAnnotation::ICON_NEW_PARAGRAPH</constant> - </member> - <member> - <constant>HaruAnnotation::ICON_PARAGRAPH</constant> - </member> - <member> - <constant>HaruAnnotation::ICON_INSERT</constant> - </member> - </simplelist> - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/haruannotation/setopened.xml b/reference/haru/haruannotation/setopened.xml deleted file mode 100644 index eaecb9feff2c..000000000000 --- a/reference/haru/haruannotation/setopened.xml +++ /dev/null @@ -1,71 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="haruannotation.setopened" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruAnnotation::setOpened</refname> - <refpurpose>Set the initial state of the annotation</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruAnnotation::setOpened</methodname> - <methodparam><type>bool</type><parameter>opened</parameter></methodparam> - </methodsynopsis> - <para> - Defines whether the annotation is initially displayed open. - This function may be used with text annotations only. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>opened</parameter></term> - <listitem> - <para> - &true; means the annotation is initially displayed open, &false; - - means it's closed. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harudestination.xml b/reference/haru/harudestination.xml deleted file mode 100644 index 35ebb7bb30f6..000000000000 --- a/reference/haru/harudestination.xml +++ /dev/null @@ -1,64 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.harudestination" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"> - <title>The HaruDestination class - HaruDestination - - - - -
- &reftitle.intro; - - Haru PDF Destination Class. - -
- - -
- &reftitle.classsynopsis; - - - - HaruDestination - - - - - HaruDestination - - - - - - &Methods; - - - -
- - - &reference.haru.entities.harudestination; - - - - diff --git a/reference/haru/harudestination/setfit.xml b/reference/haru/harudestination/setfit.xml deleted file mode 100644 index f2828342d48d..000000000000 --- a/reference/haru/harudestination/setfit.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - HaruDestination::setFit - Set the appearance of the page to fit the window - - - - &reftitle.description; - - boolHaruDestination::setFit - - - - Defines the appearance of the page to fit the window. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - &reftitle.errors; - &haru.error; - - - - diff --git a/reference/haru/harudestination/setfitb.xml b/reference/haru/harudestination/setfitb.xml deleted file mode 100644 index c8e9096ea624..000000000000 --- a/reference/haru/harudestination/setfitb.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - HaruDestination::setFitB - Set the appearance of the page to fit the bounding box of the page within the window - - - - &reftitle.description; - - boolHaruDestination::setFitB - - - - Defines the appearance of the page to fit the bounding box of the page within - the window. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - &reftitle.errors; - &haru.error; - - - - diff --git a/reference/haru/harudestination/setfitbh.xml b/reference/haru/harudestination/setfitbh.xml deleted file mode 100644 index cc34266c2fca..000000000000 --- a/reference/haru/harudestination/setfitbh.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - HaruDestination::setFitBH - Set the appearance of the page to fit the width of the bounding box - - - - &reftitle.description; - - boolHaruDestination::setFitBH - floattop - - - Defines the appearance of the page to magnifying to fit the width of the - bounding box and setting the top position of the page to the value of - top. - - - - - &reftitle.parameters; - - - - top - - - The top coordinates of the page. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/harudestination/setfitbv.xml b/reference/haru/harudestination/setfitbv.xml deleted file mode 100644 index 663feb3675ed..000000000000 --- a/reference/haru/harudestination/setfitbv.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - HaruDestination::setFitBV - Set the appearance of the page to fit the height of the boudning box - - - - &reftitle.description; - - boolHaruDestination::setFitBV - floatleft - - - Defines the appearance of the page to magnifying to fit the height of the - bounding box and setting the left position of the page to the value of - left. - - - - - &reftitle.parameters; - - - - left - - - The left coordinates of the page. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/harudestination/setfith.xml b/reference/haru/harudestination/setfith.xml deleted file mode 100644 index 6f07183978c1..000000000000 --- a/reference/haru/harudestination/setfith.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - HaruDestination::setFitH - Set the appearance of the page to fit the window width - - - - &reftitle.description; - - boolHaruDestination::setFitH - floattop - - - Defines the appearance of the page to fit the window width and sets the top - position of the page to the value of top. - - - - - &reftitle.parameters; - - - - top - - - The top position of the page. - - - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - &reftitle.errors; - &haru.error; - - - - diff --git a/reference/haru/harudestination/setfitr.xml b/reference/haru/harudestination/setfitr.xml deleted file mode 100644 index 6fe562028ae8..000000000000 --- a/reference/haru/harudestination/setfitr.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - HaruDestination::setFitR - Set the appearance of the page to fit the specified rectangle - - - - &reftitle.description; - - boolHaruDestination::setFitR - floatleft - floatbottom - floatright - floattop - - - Defines the appearance of the page to fit the rectangle by the parameters. - - - - - &reftitle.parameters; - - - - left - - - The left coordinates of the page. - - - - - bottom - - - The bottom coordinates of the page. - - - - - right - - - The right coordinates of the page. - - - - - top - - - The top coordinates of the page. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/harudestination/setfitv.xml b/reference/haru/harudestination/setfitv.xml deleted file mode 100644 index 2d2a3b994fd7..000000000000 --- a/reference/haru/harudestination/setfitv.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - HaruDestination::setFitV - Set the appearance of the page to fit the window height - - - - &reftitle.description; - - boolHaruDestination::setFitV - floatleft - - - Defines the appearance of the page to fit the window height. - - - - - &reftitle.parameters; - - - - left - - - The left position of the page. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/harudestination/setxyz.xml b/reference/haru/harudestination/setxyz.xml deleted file mode 100644 index 5ebd1ff58e3e..000000000000 --- a/reference/haru/harudestination/setxyz.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - HaruDestination::setXYZ - Set the appearance of the page - - - - &reftitle.description; - - boolHaruDestination::setXYZ - floatleft - floattop - floatzoom - - - Defines the appearance of the page using three parameters: - left, top and - zoom. - - - - - &reftitle.parameters; - - - - left - - - The left position of the page. - - - - - top - - - The top position of the page. - - - - - zoom - - - The magnification factor. The value must be between 0.08 (8%) and 32 - (3200%). - - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - &reftitle.errors; - &haru.error; - - - - diff --git a/reference/haru/harudoc.xml b/reference/haru/harudoc.xml deleted file mode 100644 index 61f301e10b19..000000000000 --- a/reference/haru/harudoc.xml +++ /dev/null @@ -1,271 +0,0 @@ - - - - The HaruDoc class - HaruDoc - - - - -
- &reftitle.intro; - - Haru PDF Document Class. - -
- - -
- &reftitle.classsynopsis; - - - - HaruDoc - - - - - HaruDoc - - - - - - &Methods; - - - -
-
- &reftitle.constants; -
- - <tgroup cols="3"> - <thead> - <row> - <entry>Type</entry> - <entry>Name</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>int</entry> - <entry>HaruDoc::CS_DEVICE_GRAY</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::CS_DEVICE_RGB</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::CS_DEVICE_CMYK</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::CS_CAL_GRAY</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::CS_CAL_RGB</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::CS_LAB</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::CS_ICC_BASED</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::CS_SEPARATION</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::CS_DEVICE_N</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::CS_INDEXED</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::CS_PATTERN</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::ENABLE_READ</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::ENABLE_PRINT</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::ENABLE_EDIT_ALL</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::ENABLE_COPY</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::ENABLE_EDIT</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::ENCRYPT_R2</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::ENCRYPT_R3</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::INFO_AUTHOR</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::INFO_CREATOR</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::INFO_TITLE</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::INFO_SUBJECT</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::INFO_KEYWORDS</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::INFO_CREATION_DATE</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::INFO_MOD_DATE</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::COMP_NONE</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::COMP_TEXT</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::COMP_IMAGE</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::COMP_METADATA</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::COMP_ALL</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::PAGE_LAYOUT_SINGLE</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::PAGE_LAYOUT_ONE_COLUMN</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::PAGE_LAYOUT_TWO_COLUMN_LEFT</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::PAGE_LAYOUT_TWO_COLUMN_RIGHT</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::PAGE_MODE_USE_NONE</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::PAGE_MODE_USE_OUTLINE</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::PAGE_MODE_USE_THUMBS</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruDoc::PAGE_MODE_FULL_SCREEN</entry> - <entry></entry> - </row> - </tbody> - </tgroup> - </table> - </section> - </partintro> - - &reference.haru.entities.harudoc; - -</phpdoc:classref> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harudoc/addpage.xml b/reference/haru/harudoc/addpage.xml deleted file mode 100644 index 9d475802762c..000000000000 --- a/reference/haru/harudoc/addpage.xml +++ /dev/null @@ -1,67 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harudoc.addpage" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruDoc::addPage</refname> - <refpurpose>Add new page to the document</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>object</type><methodname>HaruDoc::addPage</methodname> - <void/> - </methodsynopsis> - <para> - Adds a new page to the document. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns a new <classname>HaruPage</classname> instance. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruDoc::insertPage</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harudoc/addpagelabel.xml b/reference/haru/harudoc/addpagelabel.xml deleted file mode 100644 index 79a4c8fc753a..000000000000 --- a/reference/haru/harudoc/addpagelabel.xml +++ /dev/null @@ -1,148 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harudoc.addpagelabel" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruDoc::addPageLabel</refname> - <refpurpose>Set the numbering style for the specified range of pages</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruDoc::addPageLabel</methodname> - <methodparam><type>int</type><parameter>first_page</parameter></methodparam> - <methodparam><type>int</type><parameter>style</parameter></methodparam> - <methodparam><type>int</type><parameter>first_num</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>prefix</parameter><initializer>""</initializer></methodparam> - </methodsynopsis> - <para> - Set the numbering style for the specified range of pages. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>first_page</parameter></term> - <listitem> - <para> - The first page included into the labeling range. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>style</parameter></term> - <listitem> - <para> - The numbering style. The following values are allowed: - <simplelist> - <member> - <constant>HaruPage::NUM_STYLE_DECIMAL</constant> - page label is - displayed using decimal numerals. - </member> - <member> - <constant>HaruPage::NUM_STYLE_UPPER_ROMAN</constant> - page label is - displayed using uppercase Roman numerals. - </member> - <member> - <constant>HaruPage::NUM_STYLE_LOWER_ROMAN</constant> - page label is - displayed using lowercase Roman numerals. - </member> - <member> - <constant>HaruPage::NUM_STYLE_UPPER_LETTER</constant> - page label is - displayed using uppercase letters (from A to Z). - </member> - <member> - <constant>HaruPage::NUM_STYLE_LOWER_LETTERS</constant> - page label - is displayed using lowercase letters (from a to z). - </member> - </simplelist> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>first_num</parameter></term> - <listitem> - <para> - The first page number in this range. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>prefix</parameter></term> - <listitem> - <para> - The prefix for the page label. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <!-- Use when examples exist - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title>A <function>HaruDoc::addPageLabel</function> example - - Any text that describes the purpose of the example, or - what goes on in the example should go here (inside the - tag, not out - - - -]]> - - &example.outputs; - - - - - - - --> - - - - diff --git a/reference/haru/harudoc/construct.xml b/reference/haru/harudoc/construct.xml deleted file mode 100644 index 7d19b5ed0748..000000000000 --- a/reference/haru/harudoc/construct.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - HaruDoc::__construct - Construct new HaruDoc instance - - - - &reftitle.description; - - HaruDoc::__construct - - - - Constructs new HaruDoc instance. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/harudoc/createoutline.xml b/reference/haru/harudoc/createoutline.xml deleted file mode 100644 index 1111e48491fc..000000000000 --- a/reference/haru/harudoc/createoutline.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - HaruDoc::createOutline - Create a HaruOutline instance - - - - &reftitle.description; - - objectHaruDoc::createOutline - stringtitle - objectparent_outline - objectencoder - - - Create a HaruOutline instance. - - - - - &reftitle.parameters; - - - - title - - - The caption of new outline object. - - - - - parent_outline - - - A valid HaruOutline instance or &null;. - - - - - encoder - - - A valid HaruEncoder instance or &null;. - - - - - - - - - &reftitle.returnvalues; - - Returns a new HaruOutline instance. - - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/harudoc/getcurrentencoder.xml b/reference/haru/harudoc/getcurrentencoder.xml deleted file mode 100644 index fe57c112328f..000000000000 --- a/reference/haru/harudoc/getcurrentencoder.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - HaruDoc::getCurrentEncoder - Get HaruEncoder currently used in the document - - - - &reftitle.description; - - objectHaruDoc::getCurrentEncoder - - - - Get the HaruEncoder currently used in the document. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns HaruEncoder currently used in the document - or &false; if encoder is not set. - - - - - &reftitle.errors; - &haru.error; - - - &reftitle.seealso; - - - HaruDoc::setCurrentEncoder - - - - - - diff --git a/reference/haru/harudoc/getcurrentpage.xml b/reference/haru/harudoc/getcurrentpage.xml deleted file mode 100644 index 32bd490fb093..000000000000 --- a/reference/haru/harudoc/getcurrentpage.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - HaruDoc::getCurrentPage - Return current page of the document - - - - &reftitle.description; - - objectHaruDoc::getCurrentPage - - - - Get current page of the document. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns HaruPage instance on success or &false; - if there is no current page at the moment. - - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/harudoc/getencoder.xml b/reference/haru/harudoc/getencoder.xml deleted file mode 100644 index 88fccc6253fc..000000000000 --- a/reference/haru/harudoc/getencoder.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - HaruDoc::getEncoder - Get HaruEncoder instance for the specified encoding - - - - &reftitle.description; - - objectHaruDoc::getEncoder - stringencoding - - - Get the HaruEncoder instance for the specified encoding. - - - - - &reftitle.parameters; - - - - encoding - - - The encoding name. See Builtin - Encodings for the list of allowed values. - - - - - - - - - &reftitle.returnvalues; - - Returns a HaruEncoder instance for the specified encoding. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::setCurrentEncoder - HaruDoc::getCurrentEncoder - - - - - - - diff --git a/reference/haru/harudoc/getfont.xml b/reference/haru/harudoc/getfont.xml deleted file mode 100644 index df0703901437..000000000000 --- a/reference/haru/harudoc/getfont.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - HaruDoc::getFont - Get HaruFont instance - - - - &reftitle.description; - - objectHaruDoc::getFont - stringfontname - stringencoding - - - Get a HaruFont instance. - - - - - &reftitle.parameters; - - - - fontname - - - The name of the font. See Builtin - Fonts for the list of builtin fonts. - You can also use the name of a font loaded via - HaruDoc::loadTTF, - HaruDoc::loadTTC and - HaruDoc::loadType1. - - - - - encoding - - - The encoding to use. See Builtin - Encodings for the list of supported encodings. - - - - - - - - - &reftitle.returnvalues; - - Returns a HaruFont instance with the - specified fontname and - encoding. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruPage::setFontAndSize - HaruPage::setCurrentFont - - - - - - - diff --git a/reference/haru/harudoc/getinfoattr.xml b/reference/haru/harudoc/getinfoattr.xml deleted file mode 100644 index 6ed783ee1323..000000000000 --- a/reference/haru/harudoc/getinfoattr.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - HaruDoc::getInfoAttr - Get current value of the specified document attribute - - - - &reftitle.description; - - stringHaruDoc::getInfoAttr - inttype - - - Get the current value of the specified document attribute. - - - - - &reftitle.parameters; - - - - type - - - The type of the attribute. The following values are available: - - - HaruDoc::INFO_AUTHOR - - - HaruDoc::INFO_CREATOR - - - HaruDoc::INFO_TITLE - - - HaruDoc::INFO_SUBJECT - - - HaruDoc::INFO_KEYWORDS - - - HaruDoc::INFO_CREATION_DATE - - - HaruDoc::INFO_MOD_DATE - - - - - - - - - - - &reftitle.returnvalues; - - Returns the string value of the specified document attribute. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::setInfoAttr - HaruDoc::setInfoDateAttr - - - - - - - diff --git a/reference/haru/harudoc/getpagelayout.xml b/reference/haru/harudoc/getpagelayout.xml deleted file mode 100644 index 99673c1ef1db..000000000000 --- a/reference/haru/harudoc/getpagelayout.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - HaruDoc::getPageLayout - Get current page layout - - - - &reftitle.description; - - intHaruDoc::getPageLayout - - - - Get the current page layout. - See HaruDoc::setPageLayout - for the list of possible values. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the page layout currently set in the document or &false; if page - layout was not set. - See HaruDoc::setPageLayout - for the list of possible values. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::setPageLayout - - - - - - - diff --git a/reference/haru/harudoc/getpagemode.xml b/reference/haru/harudoc/getpagemode.xml deleted file mode 100644 index 9197b9462595..000000000000 --- a/reference/haru/harudoc/getpagemode.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - HaruDoc::getPageMode - Get current page mode - - - - &reftitle.description; - - intHaruDoc::getPageMode - - - - Get the current page mode. - See HaruDoc::setPageMode - for the list of possible values. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the page mode currently set in the document. - See HaruDoc::setPageMode for the list of possible values. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::setPageMode - - - - - - - diff --git a/reference/haru/harudoc/getstreamsize.xml b/reference/haru/harudoc/getstreamsize.xml deleted file mode 100644 index 12ecca65ca64..000000000000 --- a/reference/haru/harudoc/getstreamsize.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - HaruDoc::getStreamSize - Get the size of the temporary stream - - - - &reftitle.description; - - intHaruDoc::getStreamSize - - - - Get the size of the temporary stream. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the size of the data in the temporary stream of the document. - The size is zero if the document was not saved to the temporary stream. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::saveToStream - HaruDoc::resetStream - HaruDoc::readFromStream - - - - - - - diff --git a/reference/haru/harudoc/insertpage.xml b/reference/haru/harudoc/insertpage.xml deleted file mode 100644 index 231d91e577f1..000000000000 --- a/reference/haru/harudoc/insertpage.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - HaruDoc::insertPage - Insert new page just before the specified page - - - - &reftitle.description; - - objectHaruDoc::insertPage - objectpage - - - Creates a new page and inserts just before the specified page. - - - - - &reftitle.parameters; - - - - page - - - A valid HaruPage instance. - - - - - - - - - &reftitle.returnvalues; - - Returns a new HaruPage instance. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::addPage - - - - - - - diff --git a/reference/haru/harudoc/loadjpeg.xml b/reference/haru/harudoc/loadjpeg.xml deleted file mode 100644 index 9b7a2ee1f915..000000000000 --- a/reference/haru/harudoc/loadjpeg.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - HaruDoc::loadJPEG - Load a JPEG image - - - - &reftitle.description; - - objectHaruDoc::loadJPEG - stringfilename - - - Loads the specified JPEG image. - - - - - &reftitle.parameters; - - - - filename - - - A valid JPEG image file. - - - - - - - - - &reftitle.returnvalues; - - Returns a new HaruImage instance. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::loadPNG - HaruDoc::loadRAW - - - - - - - diff --git a/reference/haru/harudoc/loadpng.xml b/reference/haru/harudoc/loadpng.xml deleted file mode 100644 index f72f8cf62499..000000000000 --- a/reference/haru/harudoc/loadpng.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - HaruDoc::loadPNG - Load PNG image and return HaruImage instance - - - - &reftitle.description; - - objectHaruDoc::loadPNG - stringfilename - booldeferred&false; - - - Loads a PNG image. - - - Libharu might be built without libpng support, in this case each call to - this function would result in exception. - - - - - &reftitle.parameters; - - - - filename - - - The name of a PNG image file. - - - - - deferred - - - Do not load data immediately. - You can set deferred parameter to &true; for - deferred data loading, in this case only size and color are loaded - immediately. - - - - - - - - - &reftitle.returnvalues; - - Returns a HaruImage instance. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::loadJPEG - HaruDoc::loadRAW - - - - - - - diff --git a/reference/haru/harudoc/loadraw.xml b/reference/haru/harudoc/loadraw.xml deleted file mode 100644 index c74f4a921380..000000000000 --- a/reference/haru/harudoc/loadraw.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - HaruDoc::loadRaw - Load a RAW image - - - - &reftitle.description; - - objectHaruDoc::loadRaw - stringfilename - intwidth - intheight - intcolor_space - - - Loads a RAW image. - - - - - &reftitle.parameters; - - - - filename - - - The name of a RAW image file. - - - - - width - - - The width of the image. - - - - - height - - - The height of the image. - - - - - color_space - - - The color space of the image. Can be one of the following values: - - - HaruDoc::CS_DEVICE_GRAY - - - HaruDoc::CS_DEVICE_RGB - - - HaruDoc::CS_DEVICE_CMYK - - - - - - - - - - - &reftitle.returnvalues; - - Returns a HaruImage instance. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::loadJPEG - HaruDoc::loadPNG - - - - - - - diff --git a/reference/haru/harudoc/loadttc.xml b/reference/haru/harudoc/loadttc.xml deleted file mode 100644 index 8e075a22eaf2..000000000000 --- a/reference/haru/harudoc/loadttc.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - HaruDoc::loadTTC - Load the font with the specified index from TTC file - - - - &reftitle.description; - - stringHaruDoc::loadTTC - stringfontfile - intindex - boolembed&false; - - - Loads the TrueType font with the specified index from a TrueType collection - file. - - - - - &reftitle.parameters; - - - - fontfile - - - The TrueType collection file. - - - - - index - - - The index of the font in the collection file. - - - - - embed - - - When set to &true;, the glyph data of the font is embedded into the PDF - file, otherwise only the matrix data is included. - - - - - - - - - &reftitle.returnvalues; - - Returns the name of the loaded font on success. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::loadTTF - HaruDoc::loadType1 - - - - - - diff --git a/reference/haru/harudoc/loadttf.xml b/reference/haru/harudoc/loadttf.xml deleted file mode 100644 index ac7d8b2d7e60..000000000000 --- a/reference/haru/harudoc/loadttf.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - HaruDoc::loadTTF - Load TTF font file - - - - &reftitle.description; - - stringHaruDoc::loadTTF - stringfontfile - boolembed&false; - - - Loads the given TTF file and (optionally) embed its data into the document. - - - - - &reftitle.parameters; - - - - fontfile - - - The TTF file to load. - - - - - embed - - - When set to &true;, the glyph data of the font is embedded into the PDF - file, otherwise only the matrix data is included. - - - - - - - - - &reftitle.returnvalues; - - Returns the name of the loaded font on success. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::loadTTC - HaruDoc::loadType1 - - - - - - - diff --git a/reference/haru/harudoc/loadtype1.xml b/reference/haru/harudoc/loadtype1.xml deleted file mode 100644 index 18e071099efe..000000000000 --- a/reference/haru/harudoc/loadtype1.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - HaruDoc::loadType1 - Load Type1 font - - - - &reftitle.description; - - stringHaruDoc::loadType1 - stringafmfile - stringpfmfile - - - Loads Type1 font from the given file and registers it in the PDF document. - - - - - &reftitle.parameters; - - - - afmfile - - - Path to an AFM file. - - - - - pfmfile - - - Path to a PFA/PFB file, optional. - If it's not set only the glyph data of the font is embedded into the - PDF document. - - - - - - - - - &reftitle.returnvalues; - - Returns the name of the loaded font on success. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::loadTTC - HaruDoc::loadTTF - - - - - - - diff --git a/reference/haru/harudoc/output.xml b/reference/haru/harudoc/output.xml deleted file mode 100644 index 313a76a64061..000000000000 --- a/reference/haru/harudoc/output.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - HaruDoc::output - Write the document data to the output buffer - - - - &reftitle.description; - - boolHaruDoc::output - - - - Writes the document data into standard output. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::save - - - - - - - diff --git a/reference/haru/harudoc/readfromstream.xml b/reference/haru/harudoc/readfromstream.xml deleted file mode 100644 index 111acc6646a1..000000000000 --- a/reference/haru/harudoc/readfromstream.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - HaruDoc::readFromStream - Read data from the temporary stream - - - - &reftitle.description; - - stringHaruDoc::readFromStream - intbytes - - - Read data from the temporary stream. - - - - - &reftitle.parameters; - - - - bytes - - - The bytes parameter specifies how many bytes - to read, though the stream may contain less bytes than requested. - - - - - - - - - &reftitle.returnvalues; - - Returns data from the temporary stream. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::saveToStream - HaruDoc::resetStream - HaruDoc::getStreamSize - - - - - - - diff --git a/reference/haru/harudoc/reseterror.xml b/reference/haru/harudoc/reseterror.xml deleted file mode 100644 index 467c72b01160..000000000000 --- a/reference/haru/harudoc/reseterror.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - HaruDoc::resetError - Reset error state of the document handle - - - - &reftitle.description; - - boolHaruDoc::resetError - - - - Once an error code is set, most of the operations, including I/O processing - functions cannot be performed. In case if you want to continue after the cause - of the error has been fixed, you have to invoke this function in order to - reset the document error state. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Always succeeds and returns &true;. - - - - - - diff --git a/reference/haru/harudoc/resetstream.xml b/reference/haru/harudoc/resetstream.xml deleted file mode 100644 index fc9491c82825..000000000000 --- a/reference/haru/harudoc/resetstream.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - HaruDoc::resetStream - Rewind the temporary stream - - - - &reftitle.description; - - boolHaruDoc::resetStream - - - - Rewinds the temporary stream of the document. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::saveToStream - HaruDoc::getStreamSize - HaruDoc::readFromStream - - - - - - - diff --git a/reference/haru/harudoc/save.xml b/reference/haru/harudoc/save.xml deleted file mode 100644 index 3161c58a06f4..000000000000 --- a/reference/haru/harudoc/save.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - HaruDoc::save - Save the document into the specified file - - - - &reftitle.description; - - boolHaruDoc::save - stringfile - - - Saves the document into the specified file. - - - - - &reftitle.parameters; - - - - file - - - The file to save the document to. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::output - - - - - - - diff --git a/reference/haru/harudoc/savetostream.xml b/reference/haru/harudoc/savetostream.xml deleted file mode 100644 index 768de0cc4161..000000000000 --- a/reference/haru/harudoc/savetostream.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - HaruDoc::saveToStream - Save the document into a temporary stream - - - - &reftitle.description; - - boolHaruDoc::saveToStream - - - - Saves the document data into a temporary stream. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::resetStream - HaruDoc::getStreamSize - HaruDoc::readFromStream - - - - - - - diff --git a/reference/haru/harudoc/setcompressionmode.xml b/reference/haru/harudoc/setcompressionmode.xml deleted file mode 100644 index a21f8e99cd34..000000000000 --- a/reference/haru/harudoc/setcompressionmode.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - HaruDoc::setCompressionMode - Set compression mode for the document - - - - &reftitle.description; - - boolHaruDoc::setCompressionMode - intmode - - - Defines compression mode for the document. In case when libharu was - compiled without Zlib support this function will always throw - HaruException. - - - - - &reftitle.parameters; - - - - mode - - - The compression mode to use. The value is a combination of the - following flags: - - - HaruDoc::COMP_NONE - all contents is not - compressed. - - - HaruDoc::COMP_TEXT - compress the text data. - - - HaruDoc::COMP_IMAGE - compress the image data. - - - HaruDoc::COMP_METADATA - compress other data (fonts, - cmaps). - - - HaruDoc::COMP_ALL - compress all data. - - - - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/harudoc/setcurrentencoder.xml b/reference/haru/harudoc/setcurrentencoder.xml deleted file mode 100644 index 66d046d97f78..000000000000 --- a/reference/haru/harudoc/setcurrentencoder.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - HaruDoc::setCurrentEncoder - Set the current encoder for the document - - - - &reftitle.description; - - boolHaruDoc::setCurrentEncoder - stringencoding - - - Defines the encoder currently used in the document. - - - - - &reftitle.parameters; - - - - encoding - - - The name of the encoding to use. See Builtin - Encodings for the list of allowed values. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/harudoc/setencryptionmode.xml b/reference/haru/harudoc/setencryptionmode.xml deleted file mode 100644 index b81023df82c7..000000000000 --- a/reference/haru/harudoc/setencryptionmode.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - HaruDoc::setEncryptionMode - Set encryption mode for the document - - - - &reftitle.description; - - boolHaruDoc::setEncryptionMode - intmode - intkey_len5 - - - Defines encryption mode for the document. The encryption mode cannot be set - before setting the password. - - - - - &reftitle.parameters; - - - - mode - - - The encryption mode to use. Can be one of the following: - - - HaruDoc::ENCRYPT_R2 - use "revision2" - algorithm. - - - HaruDoc::ENCRYPT_R3 - use "revision3" - algorithm. Using this value bumps the version of PDF to 1.4. - - - - - - - key_len - - - The encryption key length in bytes. This parameter is optional and used only - when mode is HaruDoc::ENCRYPT_R3. The default - value is 5 (40bit). - - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::setPassword - HaruDoc::setPermission - - - - - - - diff --git a/reference/haru/harudoc/setinfoattr.xml b/reference/haru/harudoc/setinfoattr.xml deleted file mode 100644 index 73aaac7fa85f..000000000000 --- a/reference/haru/harudoc/setinfoattr.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - HaruDoc::setInfoAttr - Set the info attribute of the document - - - - &reftitle.description; - - boolHaruDoc::setInfoAttr - inttype - stringinfo - - - Defines an info attribute. Uses the current encoding of the document. - - - - - &reftitle.parameters; - - - - type - - - The type of the attribute. Can be one of the following: - - - HaruDoc::INFO_AUTHOR - - - HaruDoc::INFO_CREATOR - - - HaruDoc::INFO_TITLE - - - HaruDoc::INFO_SUBJECT - - - HaruDoc::INFO_KEYWORDS - - - - - - - info - - - The value of the attribute. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::setInfoDateAttr - - - - - - - diff --git a/reference/haru/harudoc/setinfodateattr.xml b/reference/haru/harudoc/setinfodateattr.xml deleted file mode 100644 index aaab423380f8..000000000000 --- a/reference/haru/harudoc/setinfodateattr.xml +++ /dev/null @@ -1,169 +0,0 @@ - - - - - HaruDoc::setInfoDateAttr - Set the datetime info attributes of the document - - - - &reftitle.description; - - boolHaruDoc::setInfoDateAttr - inttype - intyear - intmonth - intday - inthour - intmin - intsec - stringind - intoff_hour - intoff_min - - - Sets the datetime info attributes of the document. - - - - - &reftitle.parameters; - - - - type - - - The type of the attribute. Can be one of the following: - - - HaruDoc::INFO_CREATION_DATE - - - HaruDoc::INFO_MOD_DATE - - - - - - - year - - - - - - - - month - - - Between 1 and 12. - - - - - day - - - Between 1 and 31, 30, 29 or 28 (different for each month). - - - - - hour - - - Between 0 and 23. - - - - - min - - - Between 0 and 59. - - - - - sec - - - Between 0 and 59. - - - - - ind - - - The timezone relation to UTC, can be "", " ", "+", "-" and "Z". - - - - - off_hour - - - If ind is not " " or "", values between 0 and - 23 are valid. Otherwise, this parameter is ignored. - - - - - off_min - - - If ind is not " " or "", values between 0 and - 59 are valid. Otherwise, this parameter is ignored. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::setInfoAttr - - - - - - - diff --git a/reference/haru/harudoc/setopenaction.xml b/reference/haru/harudoc/setopenaction.xml deleted file mode 100644 index 97906d8960d2..000000000000 --- a/reference/haru/harudoc/setopenaction.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - HaruDoc::setOpenAction - Define which page is shown when the document is opened - - - - &reftitle.description; - - boolHaruDoc::setOpenAction - objectdestination - - - Defines which page should be shown when the document is opened. - - - - - &reftitle.parameters; - - - - destination - - - A valid HaruDestination instance. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/harudoc/setpagelayout.xml b/reference/haru/harudoc/setpagelayout.xml deleted file mode 100644 index 563dfe55d4cb..000000000000 --- a/reference/haru/harudoc/setpagelayout.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - HaruDoc::setPageLayout - Set how pages should be displayed - - - - &reftitle.description; - - boolHaruDoc::setPageLayout - intlayout - - - Defines how pages should be displayed. - - - - - &reftitle.parameters; - - - - layout - - - The following values are accepted: - - - HaruDoc::PAGE_LAYOUT_SINGLE - only one page is - displayed. - - - HaruDoc::PAGE_LAYOUT_ONE_COLUMN - display the - pages in one column. - - - HaruDoc::PAGE_LAYOUT_TWO_COLUMN_LEFT - display - pages in two columns, first page left. - - - HaruDoc::PAGE_LAYOUT_TWO_COLUMN_RIGHT - display - pages in two columns, first page right. - - - - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::getPageLayout - - - - - - - diff --git a/reference/haru/harudoc/setpagemode.xml b/reference/haru/harudoc/setpagemode.xml deleted file mode 100644 index 4b64db3901f0..000000000000 --- a/reference/haru/harudoc/setpagemode.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - HaruDoc::setPageMode - Set how the document should be displayed - - - - &reftitle.description; - - boolHaruDoc::setPageMode - intmode - - - Defines how the document should be displayed. - - - - - &reftitle.parameters; - - - - mode - - - The following values are accepted: - - - HaruDoc::PAGE_MODE_USE_NONE - display the - document with neither outline nor thumbnail. - - - HaruDoc::PAGE_MODE_USE_OUTLINE - display the - document with outline pane. - - - HaruDoc::PAGE_MODE_USE_THUMBS - display the - document with thumbnail pane. - - - HaruDoc::PAGE_MODE_FULL_SCREEN - display the - document with full screen mode. - - - - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::getPageMode - - - - - - - diff --git a/reference/haru/harudoc/setpagesconfiguration.xml b/reference/haru/harudoc/setpagesconfiguration.xml deleted file mode 100644 index 1855ef2be805..000000000000 --- a/reference/haru/harudoc/setpagesconfiguration.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - HaruDoc::setPagesConfiguration - Set the number of pages per set of pages - - - - &reftitle.description; - - boolHaruDoc::setPagesConfiguration - intpage_per_pages - - - By default the document has one pages object as a root for all pages. - All page objects are create as branches of this object. One pages object - can contain only 8191, therefore the maximum number of pages per document - is 8191. But you can change that fact by setting - page_per_pages parameter, so that the root pages - object contains 8191 more pages (not page) objects, which in turn contain - 8191 pages each. So the maximum number of pages in the document becomes - 8191*page_per_pages. - - - - - &reftitle.parameters; - - - - page_per_pages - - - The numbers of pages that a pages object can contain. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/harudoc/setpassword.xml b/reference/haru/harudoc/setpassword.xml deleted file mode 100644 index 83ebf6d32bad..000000000000 --- a/reference/haru/harudoc/setpassword.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - HaruDoc::setPassword - Set owner and user passwords for the document - - - - &reftitle.description; - - boolHaruDoc::setPassword - stringowner_password - stringuser_password - - - Defines owner and user passwords for the document. - Setting the passwords makes the document contents encrypted. - - - - - &reftitle.parameters; - - - - owner_password - - - The password of the owner, which can change permissions of the - document. Empty password is not accepted. Owner's password cannot be - the same as the user's password. - - - - - user_password - - - The password of the user. Can be empty. - - - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::setEncryptionMode - HaruDoc::setPermission - - - - - - - diff --git a/reference/haru/harudoc/setpermission.xml b/reference/haru/harudoc/setpermission.xml deleted file mode 100644 index c88fc0af6339..000000000000 --- a/reference/haru/harudoc/setpermission.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - HaruDoc::setPermission - Set permissions for the document - - - - &reftitle.description; - - boolHaruDoc::setPermission - intpermission - - - Defines permissions for the document. - - - - - &reftitle.parameters; - - - - permission - - - The values is a combination of these flags: - - - HaruDoc::ENABLE_READ - user can read the - document. - - - HaruDoc::ENABLE_PRINT - user can print the - document. - - - HaruDoc::ENABLE_EDIT_ALL - user can edit the - contents of the document other than annotations and form fields. - - - HaruDoc::ENABLE_COPY - user can copy the text - and the graphics of the document. - - - HaruDoc::ENABLE_EDIT - user can add or modify - the annotations and form fields of the document. - - - - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::setPassword - HaruDoc::setEncryptionMode - - - - - - - diff --git a/reference/haru/harudoc/usecnsencodings.xml b/reference/haru/harudoc/usecnsencodings.xml deleted file mode 100644 index 9be7d8d651c4..000000000000 --- a/reference/haru/harudoc/usecnsencodings.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - HaruDoc::useCNSEncodings - Enable Chinese simplified encodings - - - - &reftitle.description; - - boolHaruDoc::useCNSEncodings - - - - Enables Chinese simplified encodings. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::useCNSFonts - - - - - - - diff --git a/reference/haru/harudoc/usecnsfonts.xml b/reference/haru/harudoc/usecnsfonts.xml deleted file mode 100644 index 90f12f663054..000000000000 --- a/reference/haru/harudoc/usecnsfonts.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - HaruDoc::useCNSFonts - Enable builtin Chinese simplified fonts - - - - &reftitle.description; - - boolHaruDoc::useCNSFonts - - - - Enables builtin Chinese simplified fonts. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::useCNSEncodings - - - - - - - diff --git a/reference/haru/harudoc/usecntencodings.xml b/reference/haru/harudoc/usecntencodings.xml deleted file mode 100644 index 70ede60320b3..000000000000 --- a/reference/haru/harudoc/usecntencodings.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - HaruDoc::useCNTEncodings - Enable Chinese traditional encodings - - - - &reftitle.description; - - boolHaruDoc::useCNTEncodings - - - - Enables Chinese traditional encodings. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::useCNTFonts - - - - - - - diff --git a/reference/haru/harudoc/usecntfonts.xml b/reference/haru/harudoc/usecntfonts.xml deleted file mode 100644 index e1d880f29cb0..000000000000 --- a/reference/haru/harudoc/usecntfonts.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - HaruDoc::useCNTFonts - Enable builtin Chinese traditional fonts - - - - &reftitle.description; - - boolHaruDoc::useCNTFonts - - - - Enables builtin Chinese traditional fonts. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::useCNTEncodings - - - - - - - diff --git a/reference/haru/harudoc/usejpencodings.xml b/reference/haru/harudoc/usejpencodings.xml deleted file mode 100644 index 3fd680c077e8..000000000000 --- a/reference/haru/harudoc/usejpencodings.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - HaruDoc::useJPEncodings - Enable Japanese encodings - - - - &reftitle.description; - - boolHaruDoc::useJPEncodings - - - - Enables Japanese encodings. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::useJPFonts - - - - - - - diff --git a/reference/haru/harudoc/usejpfonts.xml b/reference/haru/harudoc/usejpfonts.xml deleted file mode 100644 index fd4072ba84d4..000000000000 --- a/reference/haru/harudoc/usejpfonts.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - HaruDoc::useJPFonts - Enable builtin Japanese fonts - - - - &reftitle.description; - - boolHaruDoc::useJPFonts - - - - Enables builtin Japanese fonts. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::useJPEncodings - - - - - - - diff --git a/reference/haru/harudoc/usekrencodings.xml b/reference/haru/harudoc/usekrencodings.xml deleted file mode 100644 index e956e1673dd6..000000000000 --- a/reference/haru/harudoc/usekrencodings.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - HaruDoc::useKREncodings - Enable Korean encodings - - - - &reftitle.description; - - boolHaruDoc::useKREncodings - - - - Enables Korean encodings. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::useKRFonts - - - - - - - diff --git a/reference/haru/harudoc/usekrfonts.xml b/reference/haru/harudoc/usekrfonts.xml deleted file mode 100644 index 21ba5467fd1a..000000000000 --- a/reference/haru/harudoc/usekrfonts.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - HaruDoc::useKRFonts - Enable builtin Korean fonts - - - - &reftitle.description; - - boolHaruDoc::useKRFonts - - - - Enables builtin Korean fonts. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - - &reftitle.errors; - &haru.error; - - - - &reftitle.seealso; - - - HaruDoc::useKREncodings - - - - - - - diff --git a/reference/haru/haruencoder.xml b/reference/haru/haruencoder.xml deleted file mode 100644 index 287a0c2ed6e8..000000000000 --- a/reference/haru/haruencoder.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - The HaruEncoder class - HaruEncoder - - - - -
- &reftitle.intro; - - Haru PDF Encoder Class. - -
- - -
- &reftitle.classsynopsis; - - - - HaruEncoder - - - - - HaruEncoder - - - - - - &Methods; - - - -
-
- &reftitle.constants; -
- - <tgroup cols="3"> - <thead> - <row> - <entry>Type</entry> - <entry>Name</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>int</entry> - <entry>HaruEncoder::TYPE_SINGLE_BYTE</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruEncoder::TYPE_DOUBLE_BYTE</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruEncoder::TYPE_UNINITIALIZED</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruEncoder::UNKNOWN</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruEncoder::WMODE_HORIZONTAL</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruEncoder::WMODE_VERTICAL</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruEncoder::BYTE_TYPE_SINGLE</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruEncoder::BYTE_TYPE_LEAD</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruEncoder::BYTE_TYPE_TRAIL</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruEncoder::BYTE_TYPE_UNKNOWN</entry> - <entry></entry> - </row> - </tbody> - </tgroup> - </table> - </section> - </partintro> - - &reference.haru.entities.haruencoder; - -</phpdoc:classref> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/haruencoder/getbytetype.xml b/reference/haru/haruencoder/getbytetype.xml deleted file mode 100644 index 4e1b57f6a207..000000000000 --- a/reference/haru/haruencoder/getbytetype.xml +++ /dev/null @@ -1,97 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="haruencoder.getbytetype" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruEncoder::getByteType</refname> - <refpurpose>Get the type of the byte in the text</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>int</type><methodname>HaruEncoder::getByteType</methodname> - <methodparam><type>string</type><parameter>text</parameter></methodparam> - <methodparam><type>int</type><parameter>index</parameter></methodparam> - </methodsynopsis> - <para> - Get the type of the byte in the text. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>text</parameter></term> - <listitem> - <para> - The text. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>index</parameter></term> - <listitem> - <para> - The position in the text. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the type of the byte in the text on the specified position. - The result is one of the following values: - <simplelist> - <member> - <constant>HaruEncoder::BYTE_TYPE_SINGLE</constant> - single byte - character. - </member> - <member> - <constant>HaruEncoder::BYTE_TYPE_LEAD</constant> - lead byte of a - double-byte character. - </member> - <member> - <constant>HaruEncoder::BYTE_TYPE_TRAIL</constant> - trailing byte of a - double-byte character. - </member> - <member> - <constant>HaruEncoder::BYTE_TYPE_UNKNOWN</constant> - invalid encoder or - cannot detect the byte type. - </member> - </simplelist> - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/haruencoder/gettype.xml b/reference/haru/haruencoder/gettype.xml deleted file mode 100644 index 5b43b9815051..000000000000 --- a/reference/haru/haruencoder/gettype.xml +++ /dev/null @@ -1,75 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="haruencoder.gettype" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruEncoder::getType</refname> - <refpurpose>Get the type of the encoder</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>int</type><methodname>HaruEncoder::getType</methodname> - <void/> - </methodsynopsis> - <para> - Get the type of the encoder. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the type of the encoder. The result is one of the following values: - <simplelist> - <member> - <constant>HaruEncoder::TYPE_SINGLE_BYTE</constant> - the encoder is for single - byte characters. - </member> - <member> - <constant>HaruEncoder::TYPE_DOUBLE_BYTE</constant> - the encoder is for - multibyte characters. - </member> - <member> - <constant>HaruEncoder::TYPE_UNINITIALIZED</constant> - the encoder is - not initialized. - </member> - <member> - <constant>HaruEncoder::UNKNOWN</constant> - the encoder is invalid. - </member> - </simplelist> - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/haruencoder/getunicode.xml b/reference/haru/haruencoder/getunicode.xml deleted file mode 100644 index 58619e3203f8..000000000000 --- a/reference/haru/haruencoder/getunicode.xml +++ /dev/null @@ -1,69 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="haruencoder.getunicode" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruEncoder::getUnicode</refname> - <refpurpose>Convert the specified character to unicode</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>int</type><methodname>HaruEncoder::getUnicode</methodname> - <methodparam><type>int</type><parameter>character</parameter></methodparam> - </methodsynopsis> - <para> - Converts the specified character to unicode. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>character</parameter></term> - <listitem> - <para> - The character code to convert. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - <!-- FIXME --> - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/haruencoder/getwritingmode.xml b/reference/haru/haruencoder/getwritingmode.xml deleted file mode 100644 index be20c9710833..000000000000 --- a/reference/haru/haruencoder/getwritingmode.xml +++ /dev/null @@ -1,68 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="haruencoder.getwritingmode" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruEncoder::getWritingMode</refname> - <refpurpose>Get the writing mode of the encoder</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>int</type><methodname>HaruEncoder::getWritingMode</methodname> - <void/> - </methodsynopsis> - <para> - Get the writing mode of the encoder. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the writing mode of the encoder. The result value is on of the - following: - <simplelist> - <member> - <constant>HaruEncoder::WMODE_HORIZONTAL</constant> - horizontal writing - mode. - </member> - <member> - <constant>HaruEncoder::WMODE_VERTICAL</constant> - vertical writing mode. - </member> - </simplelist> - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/haruexception.xml b/reference/haru/haruexception.xml deleted file mode 100644 index be4b1da8de48..000000000000 --- a/reference/haru/haruexception.xml +++ /dev/null @@ -1,69 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<phpdoc:exceptionref xml:id="class.haruexception" xmlns="http://docbook.org/ns/docbook" - xmlns:xlink="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - xmlns:phpdoc="http://php.net/ns/phpdoc"> - <title>The HaruException class - HaruException - - - - -
- &reftitle.intro; - - Haru PDF Exception Class. - -
- - -
- &reftitle.classsynopsis; - - - - HaruException - - - - - HaruException - - - extends - Exception - - - - - - Inherits - - - - -
- - - - diff --git a/reference/haru/harufont.xml b/reference/haru/harufont.xml deleted file mode 100644 index 64594b325576..000000000000 --- a/reference/haru/harufont.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - The HaruFont class - HaruFont - - - - -
- &reftitle.intro; - - Haru PDF Font Class. - -
- - -
- &reftitle.classsynopsis; - - - - HaruFont - - - - - HaruFont - - - - - - &Methods; - - - -
- - - &reference.haru.entities.harufont; - - - - diff --git a/reference/haru/harufont/getascent.xml b/reference/haru/harufont/getascent.xml deleted file mode 100644 index 41337d9ecc91..000000000000 --- a/reference/haru/harufont/getascent.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - HaruFont::getAscent - Get the vertical ascent of the font - - - - &reftitle.description; - - intHaruFont::getAscent - - - - Get the vertical ascent of the font. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the vertical ascent of the font. - - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/harufont/getcapheight.xml b/reference/haru/harufont/getcapheight.xml deleted file mode 100644 index e50e0f31b399..000000000000 --- a/reference/haru/harufont/getcapheight.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - HaruFont::getCapHeight - Get the distance from the baseline of uppercase letters - - - - &reftitle.description; - - intHaruFont::getCapHeight - - - - Get the distance from the baseline of uppercase letters. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the distance from the baseline of uppercase letters. - - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/harufont/getdescent.xml b/reference/haru/harufont/getdescent.xml deleted file mode 100644 index 6824208aafd8..000000000000 --- a/reference/haru/harufont/getdescent.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - HaruFont::getDescent - Get the vertical descent of the font - - - - &reftitle.description; - - intHaruFont::getDescent - - - - Get the vertical descent of the font. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Return the vertical descent of the font. - - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/harufont/getencodingname.xml b/reference/haru/harufont/getencodingname.xml deleted file mode 100644 index f0cebf72c4b5..000000000000 --- a/reference/haru/harufont/getencodingname.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - HaruFont::getEncodingName - Get the name of the encoding - - - - &reftitle.description; - - stringHaruFont::getEncodingName - - - - Get the name of the font encoding. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the name of the font encoding. - - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/harufont/getfontname.xml b/reference/haru/harufont/getfontname.xml deleted file mode 100644 index 1b5a540f83bf..000000000000 --- a/reference/haru/harufont/getfontname.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - HaruFont::getFontName - Get the name of the font - - - - &reftitle.description; - - stringHaruFont::getFontName - - - - Get the name of the font. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the name of the font. - - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/harufont/gettextwidth.xml b/reference/haru/harufont/gettextwidth.xml deleted file mode 100644 index 3221dc6c840f..000000000000 --- a/reference/haru/harufont/gettextwidth.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - HaruFont::getTextWidth - Get the total width of the text, number of characters, number of words and number of spaces - - - - &reftitle.description; - - arrayHaruFont::getTextWidth - stringtext - - - Get the total width of the text, number of characters, number of words and - number of spaces. - - - - - &reftitle.parameters; - - - - text - - - The text to measure. - - - - - - - - - &reftitle.returnvalues; - - Returns the total width of the text, number of characters, number of words - and number of spaces in the given text. - - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/harufont/getunicodewidth.xml b/reference/haru/harufont/getunicodewidth.xml deleted file mode 100644 index 96b173f5356c..000000000000 --- a/reference/haru/harufont/getunicodewidth.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - HaruFont::getUnicodeWidth - Get the width of the character in the font - - - - &reftitle.description; - - intHaruFont::getUnicodeWidth - intcharacter - - - Get the width of the character in the font. - - - - - &reftitle.parameters; - - - - character - - - The code of the character. - - - - - - - - - &reftitle.returnvalues; - - Returns the width of the character in the font. - - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/harufont/getxheight.xml b/reference/haru/harufont/getxheight.xml deleted file mode 100644 index 3e21d0f28a91..000000000000 --- a/reference/haru/harufont/getxheight.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - HaruFont::getXHeight - Get the distance from the baseline of lowercase letters - - - - &reftitle.description; - - intHaruFont::getXHeight - - - - Gets the distance from the baseline of lowercase letters. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the distance from the baseline of lowercase letters. - - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/harufont/measuretext.xml b/reference/haru/harufont/measuretext.xml deleted file mode 100644 index e4a239837803..000000000000 --- a/reference/haru/harufont/measuretext.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - HaruFont::measureText - Calculate the number of characters which can be included within the specified width - - - - &reftitle.description; - - intHaruFont::measureText - stringtext - floatwidth - floatfont_size - floatchar_space - floatword_space - boolword_wrap&false; - - - Calculate the number of characters which can be included within the - specified width. - - - - - &reftitle.parameters; - - - - text - - - The text to fit the width. - - - - - width - - - The width of the area to put the text to. - - - - - font_size - - - The size of the font. - - - - - char_space - - - The character spacing. - - - - - word_space - - - The word spacing. - - - - - word_wrap - - - When this parameter is set to &true; the function "emulates" word - wrapping and doesn't include the part of the current word if reached - the end of the area. - - - - - - - - - &reftitle.returnvalues; - - Returns the number of characters which can be included within the - specified width. - - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/haruimage.xml b/reference/haru/haruimage.xml deleted file mode 100644 index 2310c1dc7e0b..000000000000 --- a/reference/haru/haruimage.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - The HaruImage class - HaruImage - - - - -
- &reftitle.intro; - - Haru PDF Image Class. - -
- - -
- &reftitle.classsynopsis; - - - - HaruImage - - - - - HaruImage - - - - - - &Methods; - - - -
- - - &reference.haru.entities.haruimage; - - - - diff --git a/reference/haru/haruimage/getbitspercomponent.xml b/reference/haru/haruimage/getbitspercomponent.xml deleted file mode 100644 index b8520dc2e55c..000000000000 --- a/reference/haru/haruimage/getbitspercomponent.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - HaruImage::getBitsPerComponent - Get the number of bits used to describe each color component of the image - - - - &reftitle.description; - - intHaruImage::getBitsPerComponent - - - - Gets the number of bits used to describe each color component of the - image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the number of bits used to describe each color component of the - image. - - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/haruimage/getcolorspace.xml b/reference/haru/haruimage/getcolorspace.xml deleted file mode 100644 index f75cf9126692..000000000000 --- a/reference/haru/haruimage/getcolorspace.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - HaruImage::getColorSpace - Get the name of the color space - - - - &reftitle.description; - - stringHaruImage::getColorSpace - - - - Get the name of the color space. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the name of the color space of the image. The name is one of the - following values: - - - "DeviceGray" - - - "DeviceRGB" - - - "DeviceCMYK" - - - "Indexed" - - - - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/haruimage/getheight.xml b/reference/haru/haruimage/getheight.xml deleted file mode 100644 index e461673fcd80..000000000000 --- a/reference/haru/haruimage/getheight.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - HaruImage::getHeight - Get the height of the image - - - - &reftitle.description; - - intHaruImage::getHeight - - - - Get the height of the image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the height of the image. - - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/haruimage/getsize.xml b/reference/haru/haruimage/getsize.xml deleted file mode 100644 index e01b5ed3ae79..000000000000 --- a/reference/haru/haruimage/getsize.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - HaruImage::getSize - Get size of the image - - - - &reftitle.description; - - arrayHaruImage::getSize - - - - Get the size of the image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns an array with two elements: width and height, which contain - appropriate dimensions of the image. - - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/haruimage/getwidth.xml b/reference/haru/haruimage/getwidth.xml deleted file mode 100644 index 3cea9c343cf4..000000000000 --- a/reference/haru/haruimage/getwidth.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - HaruImage::getWidth - Get the width of the image - - - - &reftitle.description; - - intHaruImage::getWidth - - - - Get the width of the image. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns the width of the image. - - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/haruimage/setcolormask.xml b/reference/haru/haruimage/setcolormask.xml deleted file mode 100644 index 90336783cdb4..000000000000 --- a/reference/haru/haruimage/setcolormask.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - HaruImage::setColorMask - Set the color mask of the image - - - - &reftitle.description; - - boolHaruImage::setColorMask - intrmin - intrmax - intgmin - intgmax - intbmin - intbmax - - - Defines the transparent color of the image using the RGB range values. - The color within the range is displayed as a transparent color. - The color space of the image must be RGB. - - - - - &reftitle.parameters; - - - - rmin - - - The lower limit of red. Must be between 0 and 255. - - - - - rmax - - - The upper limit of red. Must be between 0 and 255. - - - - - gmin - - - The lower limit of green. Must be between 0 and 255. - - - - - gmax - - - The upper limit of green. Must be between 0 and 255. - - - - - bmin - - - The lower limit of blue. Must be between 0 and 255. - - - - - bmax - - - The upper limit of blue. Must be between 0 and 255. - - - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/haruimage/setmaskimage.xml b/reference/haru/haruimage/setmaskimage.xml deleted file mode 100644 index 95e6dc74bba2..000000000000 --- a/reference/haru/haruimage/setmaskimage.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - HaruImage::setMaskImage - Set the image mask - - - - &reftitle.description; - - boolHaruImage::setMaskImage - objectmask_image - - - Sets the image used as image-mask. It must be 1bit gray-scale color image. - - - - - &reftitle.parameters; - - - - mask_image - - - A valid HaruImage instance. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/haruoutline.xml b/reference/haru/haruoutline.xml deleted file mode 100644 index a5150be95322..000000000000 --- a/reference/haru/haruoutline.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - The HaruOutline class - HaruOutline - - - - -
- &reftitle.intro; - - Haru PDF Outline Class. - -
- - -
- &reftitle.classsynopsis; - - - - HaruOutline - - - - - HaruOutline - - - - - - &Methods; - - - -
- - - &reference.haru.entities.haruoutline; - - - - diff --git a/reference/haru/haruoutline/setdestination.xml b/reference/haru/haruoutline/setdestination.xml deleted file mode 100644 index 6c44b848d800..000000000000 --- a/reference/haru/haruoutline/setdestination.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - HaruOutline::setDestination - Set the destination for the outline - - - - &reftitle.description; - - boolHaruOutline::setDestination - objectdestination - - - Sets a destination object which becomes a target to jump to when the - outline is clicked. - - - - - &reftitle.parameters; - - - - destination - - - A valid HaruDestination instance. - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/haruoutline/setopened.xml b/reference/haru/haruoutline/setopened.xml deleted file mode 100644 index d0d8abef5cc4..000000000000 --- a/reference/haru/haruoutline/setopened.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - HaruOutline::setOpened - Set the initial state of the outline - - - - &reftitle.description; - - boolHaruOutline::setOpened - boolopened - - - Defines whether this node is opened or not when the outline is - displayed for the first time. - - - - - &reftitle.parameters; - - - - opened - - - &true; means open, &false; - closed. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success. - - - - &reftitle.errors; - &haru.error; - - - - - diff --git a/reference/haru/harupage.xml b/reference/haru/harupage.xml deleted file mode 100644 index a0f1990dde23..000000000000 --- a/reference/haru/harupage.xml +++ /dev/null @@ -1,389 +0,0 @@ - - - - The HaruPage class - HaruPage - - - - -
- &reftitle.intro; - - Haru PDF Page Class. - -
- - -
- &reftitle.classsynopsis; - - - - HaruPage - - - - - HaruPage - - - - - - &Methods; - - - -
- -
- &reftitle.constants; -
- - <tgroup cols="3"> - <thead> - <row> - <entry>Type</entry> - <entry>Name</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>int</entry> - <entry>HaruPage::GMODE_PAGE_DESCRIPTION</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::GMODE_TEXT_OBJECT</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::GMODE_PATH_OBJECT</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::GMODE_CLIPPING_PATH</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::GMODE_SHADING</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::GMODE_INLINE_IMAGE</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::GMODE_EXTERNAL_OBJECT</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::BUTT_END</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::ROUND_END</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::PROJECTING_SCUARE_END</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::MITER_JOIN</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::ROUND_JOIN</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::BEVEL_JOIN</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::FILL</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::STROKE</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::FILL_THEN_STROKE</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::INVISIBLE</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::FILL_CLIPPING</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::STROKE_CLIPPING</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::FILL_STROKE_CLIPPING</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::CLIPPING</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::TALIGN_LEFT</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::TALIGN_RIGHT</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::TALIGN_CENTER</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::TALIGN_JUSTIFY</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::SIZE_LETTER</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::SIZE_LEGAL</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::SIZE_A3</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::SIZE_A4</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::SIZE_A5</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::SIZE_B4</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::SIZE_B5</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::SIZE_EXECUTIVE</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::SIZE_US4x6</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::SIZE_US4x8</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::SIZE_US5x7</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::SIZE_COMM10</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::PORTRAIT</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::LANDSCAPE</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::TS_WIPE_LIGHT</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::TS_WIPE_UP</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::TS_WIPE_LEFT</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::TS_WIPE_DOWN</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::TS_BARN_DOORS_HORIZONTAL_OUT</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::TS_BARN_DOORS_HORIZONTAL_IN</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::TS_BARN_DOORS_VERTICAL_OUT</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::TS_BARN_DOORS_VERTICAL_IN</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::TS_BOX_OUT</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::TS_BOX_IN</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::TS_BLINDS_HORIZONTAL</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::TS_BLINDS_VERTICAL</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::TS_DISSOLVE</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::TS_GLITTER_RIGHT</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::TS_GLITTER_DOWN</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::TS_GLITTER_TOP_LEFT_TO_BOTTOM_RIGHT</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::TS_REPLACE</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::NUM_STYLE_DECIMAL</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::NUM_STYLE_UPPER_ROMAN</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::NUM_STYLE_LOWER_ROMAN</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::NUM_STYLE_UPPER_LETTERS</entry> - <entry></entry> - </row> - <row> - <entry>int</entry> - <entry>HaruPage::NUM_STYLE_LOWER_LETTERS</entry> - <entry></entry> - </row> - </tbody> - </tgroup> - </table> - </section> - - </partintro> - - &reference.haru.entities.harupage; - -</phpdoc:classref> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> - diff --git a/reference/haru/harupage/arc.xml b/reference/haru/harupage/arc.xml deleted file mode 100644 index 8f357b07f57d..000000000000 --- a/reference/haru/harupage/arc.xml +++ /dev/null @@ -1,105 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.arc" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::arc</refname> - <refpurpose>Append an arc to the current path</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::arc</methodname> - <methodparam><type>float</type><parameter>x</parameter></methodparam> - <methodparam><type>float</type><parameter>y</parameter></methodparam> - <methodparam><type>float</type><parameter>ray</parameter></methodparam> - <methodparam><type>float</type><parameter>ang1</parameter></methodparam> - <methodparam><type>float</type><parameter>ang2</parameter></methodparam> - </methodsynopsis> - <para> - Appends an arc to the current path. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>x</parameter></term> - <listitem> - <para> - Horizontal coordinate of the center. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>y</parameter></term> - <listitem> - <para> - Vertical coordinate of the center. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>ray</parameter></term> - <listitem> - <para> - The ray of the arc. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>ang1</parameter></term> - <listitem> - <para> - The angle of the beginning. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>ang2</parameter></term> - <listitem> - <para> - The angle of the end. Must be greater than <parameter>ang1</parameter>. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/begintext.xml b/reference/haru/harupage/begintext.xml deleted file mode 100644 index 8d85bbb9e5a6..000000000000 --- a/reference/haru/harupage/begintext.xml +++ /dev/null @@ -1,58 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.begintext" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::beginText</refname> - <refpurpose>Begin a text object and set the current text position to (0,0)</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::beginText</methodname> - <void/> - </methodsynopsis> - <para> - Begins new text object and sets the current text position to (0,0). - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/circle.xml b/reference/haru/harupage/circle.xml deleted file mode 100644 index dd9c691594d5..000000000000 --- a/reference/haru/harupage/circle.xml +++ /dev/null @@ -1,87 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.circle" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::circle</refname> - <refpurpose>Append a circle to the current path</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::circle</methodname> - <methodparam><type>float</type><parameter>x</parameter></methodparam> - <methodparam><type>float</type><parameter>y</parameter></methodparam> - <methodparam><type>float</type><parameter>ray</parameter></methodparam> - </methodsynopsis> - <para> - Appends a circle to the current path. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>x</parameter></term> - <listitem> - <para> - Horizontal coordinate of the center point. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>y</parameter></term> - <listitem> - <para> - Vertical coordinate of the center point. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>ray</parameter></term> - <listitem> - <para> - The ray of the circle. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/closepath.xml b/reference/haru/harupage/closepath.xml deleted file mode 100644 index 9150a6cc8883..000000000000 --- a/reference/haru/harupage/closepath.xml +++ /dev/null @@ -1,59 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.closepath" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::closePath</refname> - <refpurpose>Append a straight line from the current point to the start point of the path</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::closePath</methodname> - <void/> - </methodsynopsis> - <para> - Appends a straight line from the current point to the start point of the - path. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/concat.xml b/reference/haru/harupage/concat.xml deleted file mode 100644 index 7b44588c017f..000000000000 --- a/reference/haru/harupage/concat.xml +++ /dev/null @@ -1,116 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.concat" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::concat</refname> - <refpurpose>Concatenate current transformation matrix of the page and the specified matrix</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::concat</methodname> - <methodparam><type>float</type><parameter>a</parameter></methodparam> - <methodparam><type>float</type><parameter>b</parameter></methodparam> - <methodparam><type>float</type><parameter>c</parameter></methodparam> - <methodparam><type>float</type><parameter>d</parameter></methodparam> - <methodparam><type>float</type><parameter>x</parameter></methodparam> - <methodparam><type>float</type><parameter>y</parameter></methodparam> - </methodsynopsis> - <para> - Concatenates current transformation matrix of the page and the specified - matrix. - </para> - </refsect1> - - <!-- FIXME --> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>a</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>b</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>c</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>d</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>x</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>y</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/createdestination.xml b/reference/haru/harupage/createdestination.xml deleted file mode 100644 index 01384353c072..000000000000 --- a/reference/haru/harupage/createdestination.xml +++ /dev/null @@ -1,58 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.createdestination" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::createDestination</refname> - <refpurpose>Create new <classname>HaruDestination</classname> instance</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>object</type><methodname>HaruPage::createDestination</methodname> - <void/> - </methodsynopsis> - <para> - Create a new <classname>HaruDestination</classname> instance. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns a new <classname>HaruDestination</classname> instance. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/createlinkannotation.xml b/reference/haru/harupage/createlinkannotation.xml deleted file mode 100644 index 0e5b5fb996e1..000000000000 --- a/reference/haru/harupage/createlinkannotation.xml +++ /dev/null @@ -1,78 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.createlinkannotation" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::createLinkAnnotation</refname> - <refpurpose>Create new <classname>HaruAnnotation</classname> instance</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>object</type><methodname>HaruPage::createLinkAnnotation</methodname> - <methodparam><type>array</type><parameter>rectangle</parameter></methodparam> - <methodparam><type>object</type><parameter>destination</parameter></methodparam> - </methodsynopsis> - <para> - Creates a new <classname>HaruAnnotation</classname> instance. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>rectangle</parameter></term> - <listitem> - <para> - An array with 4 coordinates of the clickable area. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>destination</parameter></term> - <listitem> - <para> - Valid <classname>HaruDestination</classname> instance. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns a new <classname>HaruAnnotation</classname> instance. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/createtextannotation.xml b/reference/haru/harupage/createtextannotation.xml deleted file mode 100644 index 12224103d18f..000000000000 --- a/reference/haru/harupage/createtextannotation.xml +++ /dev/null @@ -1,87 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.createtextannotation" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::createTextAnnotation</refname> - <refpurpose>Create new <classname>HaruAnnotation</classname> instance</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>object</type><methodname>HaruPage::createTextAnnotation</methodname> - <methodparam><type>array</type><parameter>rectangle</parameter></methodparam> - <methodparam><type>string</type><parameter>text</parameter></methodparam> - <methodparam choice="opt"><type>object</type><parameter>encoder</parameter></methodparam> - </methodsynopsis> - <para> - Creates a new <classname>HaruAnnotation</classname> instance. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>rectangle</parameter></term> - <listitem> - <para> - An array with 4 coordinates of the annotation area. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>text</parameter></term> - <listitem> - <para> - The text to be displayed. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>encoder</parameter></term> - <listitem> - <para> - Optional <classname>HaruEncoder</classname> instance. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns a new <classname>HaruAnnotation</classname> instance. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/createurlannotation.xml b/reference/haru/harupage/createurlannotation.xml deleted file mode 100644 index 4fc22e0cb3d2..000000000000 --- a/reference/haru/harupage/createurlannotation.xml +++ /dev/null @@ -1,78 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.createurlannotation" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::createURLAnnotation</refname> - <refpurpose>Create and return new <classname>HaruAnnotation</classname> instance</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>object</type><methodname>HaruPage::createURLAnnotation</methodname> - <methodparam><type>array</type><parameter>rectangle</parameter></methodparam> - <methodparam><type>string</type><parameter>url</parameter></methodparam> - </methodsynopsis> - <para> - Creates a new <classname>HaruAnnotation</classname> instance. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>rectangle</parameter></term> - <listitem> - <para> - An array with 4 coordinates of the clickable area. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>url</parameter></term> - <listitem> - <para> - The URL to open. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns a new <classname>HaruAnnotation</classname> instance. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/curveto.xml b/reference/haru/harupage/curveto.xml deleted file mode 100644 index 5cb674d42fbf..000000000000 --- a/reference/haru/harupage/curveto.xml +++ /dev/null @@ -1,116 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.curveto" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::curveTo</refname> - <refpurpose>Append a Bezier curve to the current path</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::curveTo</methodname> - <methodparam><type>float</type><parameter>x1</parameter></methodparam> - <methodparam><type>float</type><parameter>y1</parameter></methodparam> - <methodparam><type>float</type><parameter>x2</parameter></methodparam> - <methodparam><type>float</type><parameter>y2</parameter></methodparam> - <methodparam><type>float</type><parameter>x3</parameter></methodparam> - <methodparam><type>float</type><parameter>y3</parameter></methodparam> - </methodsynopsis> - <para> - Append a Bezier curve to the current path. - The point (x1, y1) and the point (x2, y2) are used as the control points - for a Bezier curve and current point is moved to the point (x3, y3). - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>x1</parameter></term> - <listitem> - <para> - A Bezier curve control point. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>y1</parameter></term> - <listitem> - <para> - A Bezier curve control point. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>x2</parameter></term> - <listitem> - <para> - A Bezier curve control point. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>y2</parameter></term> - <listitem> - <para> - A Bezier curve control point. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>x3</parameter></term> - <listitem> - <para> - The current point moves here. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>x3</parameter></term> - <listitem> - <para> - The current point moves here. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/curveto2.xml b/reference/haru/harupage/curveto2.xml deleted file mode 100644 index f40d2190762c..000000000000 --- a/reference/haru/harupage/curveto2.xml +++ /dev/null @@ -1,98 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.curveto2" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::curveTo2</refname> - <refpurpose>Append a Bezier curve to the current path</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::curveTo2</methodname> - <methodparam><type>float</type><parameter>x2</parameter></methodparam> - <methodparam><type>float</type><parameter>y2</parameter></methodparam> - <methodparam><type>float</type><parameter>x3</parameter></methodparam> - <methodparam><type>float</type><parameter>y3</parameter></methodparam> - </methodsynopsis> - <para> - Appends a Bezier curve to the current path. - The current point and the point (x2, y2) are used as the control points for - the Bezier curve and current point is moved to the point (x3, y3). - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>x2</parameter></term> - <listitem> - <para> - A Bezier curve control point. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>y2</parameter></term> - <listitem> - <para> - A Bezier curve control point. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>x3</parameter></term> - <listitem> - <para> - The current point moves here. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>x3</parameter></term> - <listitem> - <para> - The current point moves here. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/curveto3.xml b/reference/haru/harupage/curveto3.xml deleted file mode 100644 index fc54d977d3ea..000000000000 --- a/reference/haru/harupage/curveto3.xml +++ /dev/null @@ -1,98 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.curveto3" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::curveTo3</refname> - <refpurpose>Append a Bezier curve to the current path</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::curveTo3</methodname> - <methodparam><type>float</type><parameter>x1</parameter></methodparam> - <methodparam><type>float</type><parameter>y1</parameter></methodparam> - <methodparam><type>float</type><parameter>x3</parameter></methodparam> - <methodparam><type>float</type><parameter>y3</parameter></methodparam> - </methodsynopsis> - <para> - Appends a Bezier curve to the current path. - The point (x1, y1) and the point (x3, y3) are used as the control points - for a Bezier curve and current point is moved to the point (x3, y3). - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>x1</parameter></term> - <listitem> - <para> - A Bezier curve control point. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>y1</parameter></term> - <listitem> - <para> - A Bezier curve control point. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>x3</parameter></term> - <listitem> - <para> - The current point moves here. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>x3</parameter></term> - <listitem> - <para> - The current point moves here. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/drawimage.xml b/reference/haru/harupage/drawimage.xml deleted file mode 100644 index 3249a7bf6667..000000000000 --- a/reference/haru/harupage/drawimage.xml +++ /dev/null @@ -1,105 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.drawimage" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::drawImage</refname> - <refpurpose>Show image at the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::drawImage</methodname> - <methodparam><type>object</type><parameter>image</parameter></methodparam> - <methodparam><type>float</type><parameter>x</parameter></methodparam> - <methodparam><type>float</type><parameter>y</parameter></methodparam> - <methodparam><type>float</type><parameter>width</parameter></methodparam> - <methodparam><type>float</type><parameter>height</parameter></methodparam> - </methodsynopsis> - <para> - Show image at the page. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>image</parameter></term> - <listitem> - <para> - Valid <classname>HaruImage</classname> instance. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>x</parameter></term> - <listitem> - <para> - The left border of the area where the image is displayed. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>y</parameter></term> - <listitem> - <para> - The lower border of the area where the image is displayed. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>width</parameter></term> - <listitem> - <para> - The width of the image area. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>height</parameter></term> - <listitem> - <para> - The height of the image area. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/ellipse.xml b/reference/haru/harupage/ellipse.xml deleted file mode 100644 index c5e51ec42e3f..000000000000 --- a/reference/haru/harupage/ellipse.xml +++ /dev/null @@ -1,96 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.ellipse" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::ellipse</refname> - <refpurpose>Append an ellipse to the current path</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::ellipse</methodname> - <methodparam><type>float</type><parameter>x</parameter></methodparam> - <methodparam><type>float</type><parameter>y</parameter></methodparam> - <methodparam><type>float</type><parameter>xray</parameter></methodparam> - <methodparam><type>float</type><parameter>yray</parameter></methodparam> - </methodsynopsis> - <para> - Appends an ellipse to the current path. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>x</parameter></term> - <listitem> - <para> - Horizontal coordinate of the center. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>y</parameter></term> - <listitem> - <para> - Vertical coordinate of the center. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>xray</parameter></term> - <listitem> - <para> - The ray of the ellipse in the x direction. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>yray</parameter></term> - <listitem> - <para> - The ray of the ellipse in the y direction. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/endpath.xml b/reference/haru/harupage/endpath.xml deleted file mode 100644 index 5f6261f1bc9f..000000000000 --- a/reference/haru/harupage/endpath.xml +++ /dev/null @@ -1,58 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.endpath" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::endPath</refname> - <refpurpose>End current path object without filling and painting operations</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::endPath</methodname> - <void/> - </methodsynopsis> - <para> - Ends current path object without performing filling and painting operations. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/endtext.xml b/reference/haru/harupage/endtext.xml deleted file mode 100644 index 5d1670998cc5..000000000000 --- a/reference/haru/harupage/endtext.xml +++ /dev/null @@ -1,58 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.endtext" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::endText</refname> - <refpurpose>End current text object</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::endText</methodname> - <void/> - </methodsynopsis> - <para> - Finalizes current text object. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/eofill.xml b/reference/haru/harupage/eofill.xml deleted file mode 100644 index bf7d40440e4b..000000000000 --- a/reference/haru/harupage/eofill.xml +++ /dev/null @@ -1,58 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.eofill" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::eofill</refname> - <refpurpose>Fill current path using even-odd rule</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::eofill</methodname> - <void/> - </methodsynopsis> - <para> - Fills current path using even-odd rule. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/eofillstroke.xml b/reference/haru/harupage/eofillstroke.xml deleted file mode 100644 index 001b0fc9324f..000000000000 --- a/reference/haru/harupage/eofillstroke.xml +++ /dev/null @@ -1,70 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.eofillstroke" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::eoFillStroke</refname> - <refpurpose>Fill current path using even-odd rule, then paint the path</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::eoFillStroke</methodname> - <methodparam choice="opt"><type>bool</type><parameter>close_path</parameter><initializer>&false;</initializer></methodparam> - </methodsynopsis> - <para> - Fills current path using even-odd rule, then paints the path. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>close_path</parameter></term> - <listitem> - <para> - Optional parameter. When set to &true;, the function closes the current - path. Default to &false;. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/fill.xml b/reference/haru/harupage/fill.xml deleted file mode 100644 index 76ddbf05b6a1..000000000000 --- a/reference/haru/harupage/fill.xml +++ /dev/null @@ -1,58 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.fill" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::fill</refname> - <refpurpose>Fill current path using nonzero winding number rule</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::fill</methodname> - <void/> - </methodsynopsis> - <para> - Fills current path using nonzero winding number rule. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/fillstroke.xml b/reference/haru/harupage/fillstroke.xml deleted file mode 100644 index 7b403fba04df..000000000000 --- a/reference/haru/harupage/fillstroke.xml +++ /dev/null @@ -1,70 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.fillstroke" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::fillStroke</refname> - <refpurpose>Fill current path using nonzero winding number rule, then paint the path</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::fillStroke</methodname> - <methodparam choice="opt"><type>bool</type><parameter>close_path</parameter><initializer>&false;</initializer></methodparam> - </methodsynopsis> - <para> - Fills current path using nonzero winding number rule, then paints the path. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>close_path</parameter></term> - <listitem> - <para> - Optional parameter. When set to &true;, the function closes the current - path. Default to &false;. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/getcharspace.xml b/reference/haru/harupage/getcharspace.xml deleted file mode 100644 index 3a70b14557b0..000000000000 --- a/reference/haru/harupage/getcharspace.xml +++ /dev/null @@ -1,58 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.getcharspace" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getCharSpace</refname> - <refpurpose>Get the current value of character spacing</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>float</type><methodname>HaruPage::getCharSpace</methodname> - <void/> - </methodsynopsis> - <para> - Get the current value of character spacing. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the current value of character spacing. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/getcmykfill.xml b/reference/haru/harupage/getcmykfill.xml deleted file mode 100644 index 11124181a600..000000000000 --- a/reference/haru/harupage/getcmykfill.xml +++ /dev/null @@ -1,59 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.getcmykfill" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getCMYKFill</refname> - <refpurpose>Get the current filling color</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>array</type><methodname>HaruPage::getCMYKFill</methodname> - <void/> - </methodsynopsis> - <para> - Returns the current filling color. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the current filling color as an array with 4 elements ("c", "m", - "y" and "k"). - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/getcmykstroke.xml b/reference/haru/harupage/getcmykstroke.xml deleted file mode 100644 index 84652b7c0f2a..000000000000 --- a/reference/haru/harupage/getcmykstroke.xml +++ /dev/null @@ -1,59 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.getcmykstroke" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getCMYKStroke</refname> - <refpurpose>Get the current stroking color</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>array</type><methodname>HaruPage::getCMYKStroke</methodname> - <void/> - </methodsynopsis> - <para> - Get the current stroking color. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the current stroking color as an array with 4 elements ("c", "m", - "y" and "k"). - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/getcurrentfont.xml b/reference/haru/harupage/getcurrentfont.xml deleted file mode 100644 index 709d9f694948..000000000000 --- a/reference/haru/harupage/getcurrentfont.xml +++ /dev/null @@ -1,58 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.getcurrentfont" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getCurrentFont</refname> - <refpurpose>Get the currently used font</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>object</type><methodname>HaruPage::getCurrentFont</methodname> - <void/> - </methodsynopsis> - <para> - Get the currently used font. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the currently used font as an instance of <classname>HaruFont</classname>. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/getcurrentfontsize.xml b/reference/haru/harupage/getcurrentfontsize.xml deleted file mode 100644 index 3ff3e98bafc7..000000000000 --- a/reference/haru/harupage/getcurrentfontsize.xml +++ /dev/null @@ -1,58 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.getcurrentfontsize" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getCurrentFontSize</refname> - <refpurpose>Get the current font size</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>float</type><methodname>HaruPage::getCurrentFontSize</methodname> - <void/> - </methodsynopsis> - <para> - Get the current font size. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the current font size. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/getcurrentpos.xml b/reference/haru/harupage/getcurrentpos.xml deleted file mode 100644 index d2972ccab781..000000000000 --- a/reference/haru/harupage/getcurrentpos.xml +++ /dev/null @@ -1,59 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.getcurrentpos" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getCurrentPos</refname> - <refpurpose>Get the current position for path painting</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>array</type><methodname>HaruPage::getCurrentPos</methodname> - <void/> - </methodsynopsis> - <para> - Get the current position for path painting. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the current position for path painting as an array of with two - elements - "x" and "y". - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/getcurrenttextpos.xml b/reference/haru/harupage/getcurrenttextpos.xml deleted file mode 100644 index fe98c8dad049..000000000000 --- a/reference/haru/harupage/getcurrenttextpos.xml +++ /dev/null @@ -1,59 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.getcurrenttextpos" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getCurrentTextPos</refname> - <refpurpose>Get the current position for text printing</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>array</type><methodname>HaruPage::getCurrentTextPos</methodname> - <void/> - </methodsynopsis> - <para> - Get the current position for text printing. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the current position for text printing as an array with 2 elements - - "x" and "y". - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/getdash.xml b/reference/haru/harupage/getdash.xml deleted file mode 100644 index 18e15f183eb0..000000000000 --- a/reference/haru/harupage/getdash.xml +++ /dev/null @@ -1,70 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.getdash" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getDash</refname> - <refpurpose>Get the current dash pattern</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>array</type><methodname>HaruPage::getDash</methodname> - <void/> - </methodsynopsis> - <para> - Get the current dash pattern. See - <methodname>HaruPage::setDash</methodname> - for more information on dash patterns. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the current dash pattern as an array of two elements - "pattern" - and "phase" or &false; if dash pattern was not set. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::setDash</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/getfillingcolorspace.xml b/reference/haru/harupage/getfillingcolorspace.xml deleted file mode 100644 index 9441c4ced8aa..000000000000 --- a/reference/haru/harupage/getfillingcolorspace.xml +++ /dev/null @@ -1,93 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.getfillingcolorspace" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getFillingColorSpace</refname> - <refpurpose>Get the current filling color space</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>int</type><methodname>HaruPage::getFillingColorSpace</methodname> - <void/> - </methodsynopsis> - <para> - Get the current filling color space. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the current filling color space. The result value is one of the following: - <simplelist> - <member> - <constant>HaruDoc::CS_DEVICE_GRAY</constant> - </member> - <member> - <constant>HaruDoc::CS_DEVICE_RGB</constant> - </member> - <member> - <constant>HaruDoc::CS_DEVICE_CMYK</constant> - </member> - <member> - <constant>HaruDoc::CS_CAL_GRAY</constant> - </member> - <member> - <constant>HaruDoc::CS_CAL_RGB</constant> - </member> - <member> - <constant>HaruDoc::CS_LAB</constant> - </member> - <member> - <constant>HaruDoc::CS_ICC_BASED</constant> - </member> - <member> - <constant>HaruDoc::CS_SEPARATION</constant> - </member> - <member> - <constant>HaruDoc::CS_DEVICE_N</constant> - </member> - <member> - <constant>HaruDoc::CS_INDEXED</constant> - </member> - <member> - <constant>HaruDoc::CS_PATTERN</constant> - </member> - </simplelist> - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/getflatness.xml b/reference/haru/harupage/getflatness.xml deleted file mode 100644 index b881ddf8cd05..000000000000 --- a/reference/haru/harupage/getflatness.xml +++ /dev/null @@ -1,67 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.getflatness" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getFlatness</refname> - <refpurpose>Get the flatness of the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>float</type><methodname>HaruPage::getFlatness</methodname> - <void/> - </methodsynopsis> - <para> - Get the flatness of the page. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the flatness of the page. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::setFlatness</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/getgmode.xml b/reference/haru/harupage/getgmode.xml deleted file mode 100644 index 23f33bd0eb0a..000000000000 --- a/reference/haru/harupage/getgmode.xml +++ /dev/null @@ -1,83 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.getgmode" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getGMode</refname> - <refpurpose>Get the current graphics mode</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>int</type><methodname>HaruPage::getGMode</methodname> - <void/> - </methodsynopsis> - <para> - Get the current graphics mode. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the current graphics mode. The result value is one of the following: - </para> - <para> - <simplelist> - <member> - <constant>HaruPage::GMODE_PAGE_DESCRIPTION</constant> - </member> - <member> - <constant>HaruPage::GMODE_TEXT_OBJECT</constant> - </member> - <member> - <constant>HaruPage::GMODE_PATH_OBJECT</constant> - </member> - <member> - <constant>HaruPage::GMODE_CLIPPING_PATH</constant> - </member> - <member> - <constant>HaruPage::GMODE_SHADING</constant> - </member> - <member> - <constant>HaruPage::GMODE_INLINE_IMAGE</constant> - </member> - <member> - <constant>HaruPage::GMODE_EXTERNAL_OBJECT</constant> - </member> - </simplelist> - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/getgrayfill.xml b/reference/haru/harupage/getgrayfill.xml deleted file mode 100644 index 19bcf6030b42..000000000000 --- a/reference/haru/harupage/getgrayfill.xml +++ /dev/null @@ -1,67 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.getgrayfill" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getGrayFill</refname> - <refpurpose>Get the current filling color</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>float</type><methodname>HaruPage::getGrayFill</methodname> - <void/> - </methodsynopsis> - <para> - Get the current filling color. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the current filling color. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::setGrayFill</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/getgraystroke.xml b/reference/haru/harupage/getgraystroke.xml deleted file mode 100644 index d708898c55ed..000000000000 --- a/reference/haru/harupage/getgraystroke.xml +++ /dev/null @@ -1,67 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.getgraystroke" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getGrayStroke</refname> - <refpurpose>Get the current stroking color</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>float</type><methodname>HaruPage::getGrayStroke</methodname> - <void/> - </methodsynopsis> - <para> - Get the current stroking color. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the current stroking color. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::setGrayStroke</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/getheight.xml b/reference/haru/harupage/getheight.xml deleted file mode 100644 index 1039944b6c94..000000000000 --- a/reference/haru/harupage/getheight.xml +++ /dev/null @@ -1,67 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.getheight" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getHeight</refname> - <refpurpose>Get the height of the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>float</type><methodname>HaruPage::getHeight</methodname> - <void/> - </methodsynopsis> - <para> - Get the height of the page. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the height of the page. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::setHeight</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/gethorizontalscaling.xml b/reference/haru/harupage/gethorizontalscaling.xml deleted file mode 100644 index 6b047b41954e..000000000000 --- a/reference/haru/harupage/gethorizontalscaling.xml +++ /dev/null @@ -1,67 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.gethorizontalscaling" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getHorizontalScaling</refname> - <refpurpose>Get the current value of horizontal scaling</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>float</type><methodname>HaruPage::getHorizontalScaling</methodname> - <void/> - </methodsynopsis> - <para> - Get the current value of the horizontal scaling. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the current value of horizontal scaling. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::setHorizontalScaling</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/getlinecap.xml b/reference/haru/harupage/getlinecap.xml deleted file mode 100644 index 0263e11b24d8..000000000000 --- a/reference/haru/harupage/getlinecap.xml +++ /dev/null @@ -1,78 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.getlinecap" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getLineCap</refname> - <refpurpose>Get the current line cap style</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>int</type><methodname>HaruPage::getLineCap</methodname> - <void/> - </methodsynopsis> - <para> - Get the current line cap style. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the current line cap style. The result value is one of the following: - <simplelist> - <member> - <constant>HaruPage::BUTT_END</constant> - the line is squared off at the endpoint of the path. - </member> - <member> - <constant>HaruPage::ROUND_END</constant> - the end of the line becomes a semicircle with center in the end point of the path. - </member> - <member> - <constant>HaruPage::PROJECTING_SCUARE_END</constant> - the line continues to the point that exceeds half of the stroke width the end point. - </member> - </simplelist> - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::setLineCap</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/getlinejoin.xml b/reference/haru/harupage/getlinejoin.xml deleted file mode 100644 index fe363ea51671..000000000000 --- a/reference/haru/harupage/getlinejoin.xml +++ /dev/null @@ -1,78 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.getlinejoin" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getLineJoin</refname> - <refpurpose>Get the current line join style</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>int</type><methodname>HaruPage::getLineJoin</methodname> - <void/> - </methodsynopsis> - <para> - Get the current line join style. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the current line join style. The result value is one of the following: - <simplelist> - <member> - <constant>HaruPage::MITER_JOIN</constant> - </member> - <member> - <constant>HaruPage::ROUND_JOIN</constant> - </member> - <member> - <constant>HaruPage::BEVEL_JOIN</constant> - </member> - </simplelist> - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::setLineJoin</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/getlinewidth.xml b/reference/haru/harupage/getlinewidth.xml deleted file mode 100644 index 2d20923d716d..000000000000 --- a/reference/haru/harupage/getlinewidth.xml +++ /dev/null @@ -1,67 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.getlinewidth" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getLineWidth</refname> - <refpurpose>Get the current line width</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>float</type><methodname>HaruPage::getLineWidth</methodname> - <void/> - </methodsynopsis> - <para> - Get the current line width. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the current line width. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::setLineWidth</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/getmiterlimit.xml b/reference/haru/harupage/getmiterlimit.xml deleted file mode 100644 index 9b608adb793c..000000000000 --- a/reference/haru/harupage/getmiterlimit.xml +++ /dev/null @@ -1,67 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.getmiterlimit" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getMiterLimit</refname> - <refpurpose>Get the value of miter limit</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>float</type><methodname>HaruPage::getMiterLimit</methodname> - <void/> - </methodsynopsis> - <para> - Get the value of the miter limit. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the value of the miter limit. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::setMiterLimit</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/getrgbfill.xml b/reference/haru/harupage/getrgbfill.xml deleted file mode 100644 index f0f1355a04f2..000000000000 --- a/reference/haru/harupage/getrgbfill.xml +++ /dev/null @@ -1,67 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.getrgbfill" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getRGBFill</refname> - <refpurpose>Get the current filling color</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>array</type><methodname>HaruPage::getRGBFill</methodname> - <void/> - </methodsynopsis> - <para> - Get the current filling color. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the current filling color as an array with 3 elements: "r", "g" and "b". - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::setRGBFill</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/getrgbstroke.xml b/reference/haru/harupage/getrgbstroke.xml deleted file mode 100644 index e8bb01c05219..000000000000 --- a/reference/haru/harupage/getrgbstroke.xml +++ /dev/null @@ -1,67 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.getrgbstroke" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getRGBStroke</refname> - <refpurpose>Get the current stroking color</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>array</type><methodname>HaruPage::getRGBStroke</methodname> - <void/> - </methodsynopsis> - <para> - Get the current stroking color. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the current stroking color. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::setRGBStroke</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/getstrokingcolorspace.xml b/reference/haru/harupage/getstrokingcolorspace.xml deleted file mode 100644 index b350a8ea8a1f..000000000000 --- a/reference/haru/harupage/getstrokingcolorspace.xml +++ /dev/null @@ -1,68 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.getstrokingcolorspace" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getStrokingColorSpace</refname> - <refpurpose>Get the current stroking color space</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>int</type><methodname>HaruPage::getStrokingColorSpace</methodname> - <void/> - </methodsynopsis> - <para> - Get the current stroking color space. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the current stroking color space. The list of return values is the same as for - <methodname>HaruPage::getFillingColorSpace</methodname> - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::getFillingColorSpace</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/gettextleading.xml b/reference/haru/harupage/gettextleading.xml deleted file mode 100644 index 438b24ba297a..000000000000 --- a/reference/haru/harupage/gettextleading.xml +++ /dev/null @@ -1,67 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.gettextleading" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getTextLeading</refname> - <refpurpose>Get the current value of line spacing</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>float</type><methodname>HaruPage::getTextLeading</methodname> - <void/> - </methodsynopsis> - <para> - Get the current value of line spacing. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the current value of line spacing. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::setTextLeading</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/gettextmatrix.xml b/reference/haru/harupage/gettextmatrix.xml deleted file mode 100644 index 8e1c8637ec2b..000000000000 --- a/reference/haru/harupage/gettextmatrix.xml +++ /dev/null @@ -1,63 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.gettextmatrix" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getTextMatrix</refname> - <refpurpose>Get the current text transformation matrix of the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>array</type><methodname>HaruPage::getTextMatrix</methodname> - <void/> - </methodsynopsis> - <para> - Get the current text transformation matrix of the page. - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the current text transformation matrix of the page as an array of 6 elements: - "a", "b", "c", "d", "x" and "y". - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::setTextMatrix</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/gettextrenderingmode.xml b/reference/haru/harupage/gettextrenderingmode.xml deleted file mode 100644 index 6721b78d9496..000000000000 --- a/reference/haru/harupage/gettextrenderingmode.xml +++ /dev/null @@ -1,93 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.gettextrenderingmode" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getTextRenderingMode</refname> - <refpurpose>Get the current text rendering mode</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>int</type><methodname>HaruPage::getTextRenderingMode</methodname> - <void/> - </methodsynopsis> - <para> - Get the current text rendering mode. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the current text rendering mode. The result value is one of the following: - <simplelist> - <member> - <constant>HaruPage::FILL</constant> - </member> - <member> - <constant>HaruPage::STROKE</constant> - </member> - <member> - <constant>HaruPage::FILL_THEN_STROKE</constant> - </member> - <member> - <constant>HaruPage::INVISIBLE</constant> - </member> - <member> - <constant>HaruPage::FILL_CLIPPING</constant> - </member> - <member> - <constant>HaruPage::STROKE_CLIPPING</constant> - </member> - <member> - <constant>HaruPage::FILL_STROKE_CLIPPING</constant> - </member> - <member> - <constant>HaruPage::CLIPPING</constant> - </member> - </simplelist> - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::setTextRenderingMode</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/gettextrise.xml b/reference/haru/harupage/gettextrise.xml deleted file mode 100644 index 4d09ef16d5b5..000000000000 --- a/reference/haru/harupage/gettextrise.xml +++ /dev/null @@ -1,67 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.gettextrise" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getTextRise</refname> - <refpurpose>Get the current value of text rising</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>float</type><methodname>HaruPage::getTextRise</methodname> - <void/> - </methodsynopsis> - <para> - Get the current value of text rising. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the current value of text rising. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::setTextRise</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/gettextwidth.xml b/reference/haru/harupage/gettextwidth.xml deleted file mode 100644 index d9e10c657fbd..000000000000 --- a/reference/haru/harupage/gettextwidth.xml +++ /dev/null @@ -1,78 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.gettextwidth" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getTextWidth</refname> - <refpurpose>Get the width of the text using current fontsize, character spacing and word spacing</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>float</type><methodname>HaruPage::getTextWidth</methodname> - <methodparam><type>string</type><parameter>text</parameter></methodparam> - </methodsynopsis> - <para> - Get the width of the text using current fontsize, character spacing and word spacing - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>text</parameter></term> - <listitem> - <para> - The text to measure. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the width of the text using current fontsize, character spacing and word spacing. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::measureText</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/gettransmatrix.xml b/reference/haru/harupage/gettransmatrix.xml deleted file mode 100644 index cee37cccdd02..000000000000 --- a/reference/haru/harupage/gettransmatrix.xml +++ /dev/null @@ -1,68 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.gettransmatrix" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getTransMatrix</refname> - <refpurpose>Get the current transformation matrix of the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>array</type><methodname>HaruPage::getTransMatrix</methodname> - <void/> - </methodsynopsis> - <para> - Get the current transformation matrix of the page. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the current transformation matrix of the page as an array of 6 elements: - "a", "b", "c", "d", "x" and "y". - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::concat</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/getwidth.xml b/reference/haru/harupage/getwidth.xml deleted file mode 100644 index 40bea814584f..000000000000 --- a/reference/haru/harupage/getwidth.xml +++ /dev/null @@ -1,67 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.getwidth" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getWidth</refname> - <refpurpose>Get the width of the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>float</type><methodname>HaruPage::getWidth</methodname> - <void/> - </methodsynopsis> - <para> - Get the width of the page. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the width of the page. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::setWidth</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/getwordspace.xml b/reference/haru/harupage/getwordspace.xml deleted file mode 100644 index 4105328c9875..000000000000 --- a/reference/haru/harupage/getwordspace.xml +++ /dev/null @@ -1,67 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.getwordspace" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::getWordSpace</refname> - <refpurpose>Get the current value of word spacing</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>float</type><methodname>HaruPage::getWordSpace</methodname> - <void/> - </methodsynopsis> - <para> - Get the current value of word spacing. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the current value of word spacing. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::setWordSpace</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/lineto.xml b/reference/haru/harupage/lineto.xml deleted file mode 100644 index 0157537ca680..000000000000 --- a/reference/haru/harupage/lineto.xml +++ /dev/null @@ -1,89 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.lineto" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::lineTo</refname> - <refpurpose>Draw a line from the current point to the specified point</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::lineTo</methodname> - <methodparam><type>float</type><parameter>x</parameter></methodparam> - <methodparam><type>float</type><parameter>y</parameter></methodparam> - </methodsynopsis> - <para> - Draws a line from the current point to the specified point. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>x</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>y</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::curveTo</methodname></member> - <member><methodname>HaruPage::curveTo2</methodname></member> - <member><methodname>HaruPage::curveTo3</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/measuretext.xml b/reference/haru/harupage/measuretext.xml deleted file mode 100644 index 464283828b44..000000000000 --- a/reference/haru/harupage/measuretext.xml +++ /dev/null @@ -1,100 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.measuretext" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::measureText</refname> - <refpurpose>Calculate the byte length of characters which can be included on one line of the specified width</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>int</type><methodname>HaruPage::measureText</methodname> - <methodparam><type>string</type><parameter>text</parameter></methodparam> - <methodparam><type>float</type><parameter>width</parameter></methodparam> - <methodparam choice="opt"><type>bool</type><parameter>wordwrap</parameter><initializer>&false;</initializer></methodparam> - </methodsynopsis> - <para> - Get the byte length of characters which can be included on one line of the specified width. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>text</parameter></term> - <listitem> - <para> - The text to measure. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>width</parameter></term> - <listitem> - <para> - The width of the line. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>wordwrap</parameter></term> - <listitem> - <para> - When this parameter is set to &true; the function "emulates" word - wrapping by stopping after the last full word (delimited by whitespace) - that can fit on the line. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns the byte length of characters which can be included within the specified width. - For single-byte encodings, this is equal to the number of characters. For multi-byte encodings, - this is not necessarily the case. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruFont::measureText</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/movetextpos.xml b/reference/haru/harupage/movetextpos.xml deleted file mode 100644 index 06e1495b1cbd..000000000000 --- a/reference/haru/harupage/movetextpos.xml +++ /dev/null @@ -1,98 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.movetextpos" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::moveTextPos</refname> - <refpurpose>Move text position to the specified offset</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::moveTextPos</methodname> - <methodparam><type>float</type><parameter>x</parameter></methodparam> - <methodparam><type>float</type><parameter>y</parameter></methodparam> - <methodparam choice="opt"><type>bool</type><parameter>set_leading</parameter><initializer>&false;</initializer></methodparam> - </methodsynopsis> - <para> - Moves text position to the specified offset. If the start position of the current - line is (x1, y1), the start of the next line is (x1 + <parameter>x</parameter>, - y1 + <parameter>y</parameter>). - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>x</parameter></term> - <listitem> - <para> - The specified text position offset. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>y</parameter></term> - <listitem> - <para> - The specified text position offset. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>set_leading</parameter></term> - <listitem> - <para> - If set to &true;, the function sets the text leading to -<parameter>y</parameter>. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::moveToNextLine</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/moveto.xml b/reference/haru/harupage/moveto.xml deleted file mode 100644 index 8a0e687d71f3..000000000000 --- a/reference/haru/harupage/moveto.xml +++ /dev/null @@ -1,78 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.moveto" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::moveTo</refname> - <refpurpose>Set starting point for new drawing path</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::moveTo</methodname> - <methodparam><type>float</type><parameter>x</parameter></methodparam> - <methodparam><type>float</type><parameter>y</parameter></methodparam> - </methodsynopsis> - <para> - Defines starting point for new drawing path. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>x</parameter></term> - <listitem> - <para> - A new starting point coordinate. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>y</parameter></term> - <listitem> - <para> - A new starting point coordinate. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/movetonextline.xml b/reference/haru/harupage/movetonextline.xml deleted file mode 100644 index ed1ee60f92f2..000000000000 --- a/reference/haru/harupage/movetonextline.xml +++ /dev/null @@ -1,67 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.movetonextline" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::moveToNextLine</refname> - <refpurpose>Move text position to the start of the next line</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::moveToNextLine</methodname> - <void/> - </methodsynopsis> - <para> - Moves text position to the start of the next line. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - &no.function.parameters; - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::moveTextPos</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/rectangle.xml b/reference/haru/harupage/rectangle.xml deleted file mode 100644 index c6a1388dde2b..000000000000 --- a/reference/haru/harupage/rectangle.xml +++ /dev/null @@ -1,96 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.rectangle" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::rectangle</refname> - <refpurpose>Append a rectangle to the current path</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::rectangle</methodname> - <methodparam><type>float</type><parameter>x</parameter></methodparam> - <methodparam><type>float</type><parameter>y</parameter></methodparam> - <methodparam><type>float</type><parameter>width</parameter></methodparam> - <methodparam><type>float</type><parameter>height</parameter></methodparam> - </methodsynopsis> - <para> - Appends a rectangle to the current drawing path. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>x</parameter></term> - <listitem> - <para> - The left border of the rectangle. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>y</parameter></term> - <listitem> - <para> - The lower border of the rectangle. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>width</parameter></term> - <listitem> - <para> - The width of the rectangle. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>height</parameter></term> - <listitem> - <para> - The height of the rectangle. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/setcharspace.xml b/reference/haru/harupage/setcharspace.xml deleted file mode 100644 index 68c6b7fde129..000000000000 --- a/reference/haru/harupage/setcharspace.xml +++ /dev/null @@ -1,78 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.setcharspace" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::setCharSpace</refname> - <refpurpose>Set character spacing for the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::setCharSpace</methodname> - <methodparam><type>float</type><parameter>char_space</parameter></methodparam> - </methodsynopsis> - <para> - Defines character spacing for the page. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>char_space</parameter></term> - <listitem> - <para> - The new character spacing for the page. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::getCharSpace</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/setcmykfill.xml b/reference/haru/harupage/setcmykfill.xml deleted file mode 100644 index e91f590b04d9..000000000000 --- a/reference/haru/harupage/setcmykfill.xml +++ /dev/null @@ -1,105 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.setcmykfill" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::setCMYKFill</refname> - <refpurpose>Set filling color for the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::setCMYKFill</methodname> - <methodparam><type>float</type><parameter>c</parameter></methodparam> - <methodparam><type>float</type><parameter>m</parameter></methodparam> - <methodparam><type>float</type><parameter>y</parameter></methodparam> - <methodparam><type>float</type><parameter>k</parameter></methodparam> - </methodsynopsis> - <para> - Defines filling color for the page. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>c</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>m</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>y</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>k</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::getCMYKFill</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/setcmykstroke.xml b/reference/haru/harupage/setcmykstroke.xml deleted file mode 100644 index 0d0a63f82fe4..000000000000 --- a/reference/haru/harupage/setcmykstroke.xml +++ /dev/null @@ -1,105 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.setcmykstroke" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::setCMYKStroke</refname> - <refpurpose>Set stroking color for the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::setCMYKStroke</methodname> - <methodparam><type>float</type><parameter>c</parameter></methodparam> - <methodparam><type>float</type><parameter>m</parameter></methodparam> - <methodparam><type>float</type><parameter>y</parameter></methodparam> - <methodparam><type>float</type><parameter>k</parameter></methodparam> - </methodsynopsis> - <para> - Defines stroking color for the page. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>c</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>m</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>y</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>k</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::getCMYKStroke</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/setdash.xml b/reference/haru/harupage/setdash.xml deleted file mode 100644 index 381fe63cc18e..000000000000 --- a/reference/haru/harupage/setdash.xml +++ /dev/null @@ -1,88 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.setdash" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::setDash</refname> - <refpurpose>Set the dash pattern for the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::setDash</methodname> - <methodparam><type>array</type><parameter>pattern</parameter></methodparam> - <methodparam><type>int</type><parameter>phase</parameter></methodparam> - </methodsynopsis> - <para> - Defines the dash pattern for the page. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>pattern</parameter></term> - <listitem> - <para> - An array (8 elements max) which contains a pattern of dashes and gaps - used for lines on the page. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>phase</parameter></term> - <listitem> - <para> - The phase on which the pattern begins. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::getDash</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/setflatness.xml b/reference/haru/harupage/setflatness.xml deleted file mode 100644 index dcb726879e3b..000000000000 --- a/reference/haru/harupage/setflatness.xml +++ /dev/null @@ -1,78 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.setflatness" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::setFlatness</refname> - <refpurpose>Set flatness for the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::setFlatness</methodname> - <methodparam><type>float</type><parameter>flatness</parameter></methodparam> - </methodsynopsis> - <para> - Defines flatness for the page. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>flatness</parameter></term> - <listitem> - <para> - The defined flatness for the page. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::getFlatness</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/setfontandsize.xml b/reference/haru/harupage/setfontandsize.xml deleted file mode 100644 index 921a6bf0f050..000000000000 --- a/reference/haru/harupage/setfontandsize.xml +++ /dev/null @@ -1,87 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.setfontandsize" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::setFontAndSize</refname> - <refpurpose>Set font and fontsize for the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::setFontAndSize</methodname> - <methodparam><type>object</type><parameter>font</parameter></methodparam> - <methodparam><type>float</type><parameter>size</parameter></methodparam> - </methodsynopsis> - <para> - Defines current font and its size for the page. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>font</parameter></term> - <listitem> - <para> - A valid <classname>HaruFont</classname> instance. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>size</parameter></term> - <listitem> - <para> - The size of the font. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruDoc::getFont</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/setgrayfill.xml b/reference/haru/harupage/setgrayfill.xml deleted file mode 100644 index b3c10f341a93..000000000000 --- a/reference/haru/harupage/setgrayfill.xml +++ /dev/null @@ -1,78 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.setgrayfill" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::setGrayFill</refname> - <refpurpose>Set filling color for the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::setGrayFill</methodname> - <methodparam><type>float</type><parameter>value</parameter></methodparam> - </methodsynopsis> - <para> - Defines filling color for the page. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>value</parameter></term> - <listitem> - <para> - The value of gray level between 0 and 1. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::getGrayFill</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/setgraystroke.xml b/reference/haru/harupage/setgraystroke.xml deleted file mode 100644 index e99c6e2afac7..000000000000 --- a/reference/haru/harupage/setgraystroke.xml +++ /dev/null @@ -1,79 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.setgraystroke" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::setGrayStroke</refname> - <refpurpose>Sets stroking color for the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::setGrayStroke</methodname> - <methodparam><type>float</type><parameter>value</parameter></methodparam> - </methodsynopsis> - <para> - Defines stroking color for the page. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>value</parameter></term> - <listitem> - <para> - The value of gray level between 0 and 1. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::getGrayStroke</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/setheight.xml b/reference/haru/harupage/setheight.xml deleted file mode 100644 index 8c756e0e255c..000000000000 --- a/reference/haru/harupage/setheight.xml +++ /dev/null @@ -1,78 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.setheight" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::setHeight</refname> - <refpurpose>Set height of the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::setHeight</methodname> - <methodparam><type>float</type><parameter>height</parameter></methodparam> - </methodsynopsis> - <para> - Defines height of the page. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>height</parameter></term> - <listitem> - <para> - The defined height for the page. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::getHeight</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/sethorizontalscaling.xml b/reference/haru/harupage/sethorizontalscaling.xml deleted file mode 100644 index d4223a378597..000000000000 --- a/reference/haru/harupage/sethorizontalscaling.xml +++ /dev/null @@ -1,79 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.sethorizontalscaling" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::setHorizontalScaling</refname> - <refpurpose>Set horizontal scaling for the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::setHorizontalScaling</methodname> - <methodparam><type>float</type><parameter>scaling</parameter></methodparam> - </methodsynopsis> - <para> - Set the horizontal scaling for the page. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>scaling</parameter></term> - <listitem> - <para> - The horizontal scaling for text showing on the page. - The initial value is 100. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::getHorizontalScaling</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/setlinecap.xml b/reference/haru/harupage/setlinecap.xml deleted file mode 100644 index c961ddfbaf30..000000000000 --- a/reference/haru/harupage/setlinecap.xml +++ /dev/null @@ -1,89 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.setlinecap" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::setLineCap</refname> - <refpurpose>Set the shape to be used at the ends of lines</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::setLineCap</methodname> - <methodparam><type>int</type><parameter>cap</parameter></methodparam> - </methodsynopsis> - <para> - Defines the shape to be used at the ends of lines. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>cap</parameter></term> - <listitem> - <para> - Must be one of the following values: - <simplelist> - <member> - <constant>HaruPage::BUTT_END</constant> - the line is squared off at the endpoint of the path. - </member> - <member> - <constant>HaruPage::ROUND_END</constant> - the end of the line becomes a semicircle with center in the end point of the path. - </member> - <member> - <constant>HaruPage::PROJECTING_SCUARE_END</constant> - the line continues to the point that exceeds half of the stroke width the end point. - </member> - </simplelist> - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::getLineCap</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/setlinejoin.xml b/reference/haru/harupage/setlinejoin.xml deleted file mode 100644 index d33d57218818..000000000000 --- a/reference/haru/harupage/setlinejoin.xml +++ /dev/null @@ -1,90 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.setlinejoin" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::setLineJoin</refname> - <refpurpose>Set line join style for the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::setLineJoin</methodname> - <methodparam><type>int</type><parameter>join</parameter></methodparam> - </methodsynopsis> - <para> - Defines line join style for the page. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>join</parameter></term> - <listitem> - <para> - Must be one of the following values: - <simplelist> - <member> - <constant>HaruPage::MITER_JOIN</constant> - </member> - <member> - <constant>HaruPage::ROUND_JOIN</constant> - </member> - <member> - <constant>HaruPage::BEVEL_JOIN</constant> - </member> - </simplelist> - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::getLineJoin</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/setlinewidth.xml b/reference/haru/harupage/setlinewidth.xml deleted file mode 100644 index a34f54c04f31..000000000000 --- a/reference/haru/harupage/setlinewidth.xml +++ /dev/null @@ -1,78 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.setlinewidth" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::setLineWidth</refname> - <refpurpose>Set line width for the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::setLineWidth</methodname> - <methodparam><type>float</type><parameter>width</parameter></methodparam> - </methodsynopsis> - <para> - Defines line width for the page. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>width</parameter></term> - <listitem> - <para> - The defined line width for the page. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::getLineWidth</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/setmiterlimit.xml b/reference/haru/harupage/setmiterlimit.xml deleted file mode 100644 index 7901beda9861..000000000000 --- a/reference/haru/harupage/setmiterlimit.xml +++ /dev/null @@ -1,78 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.setmiterlimit" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::setMiterLimit</refname> - <refpurpose>Set the current value of the miter limit of the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::setMiterLimit</methodname> - <methodparam><type>float</type><parameter>limit</parameter></methodparam> - </methodsynopsis> - <para> - Set the current value of the miter limit of the page. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>limit</parameter></term> - <listitem> - <para> - Defines the current value of the miter limit of the page. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::getMiterLimit</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/setrgbfill.xml b/reference/haru/harupage/setrgbfill.xml deleted file mode 100644 index ad6b664f540c..000000000000 --- a/reference/haru/harupage/setrgbfill.xml +++ /dev/null @@ -1,96 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.setrgbfill" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::setRGBFill</refname> - <refpurpose>Set filling color for the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::setRGBFill</methodname> - <methodparam><type>float</type><parameter>r</parameter></methodparam> - <methodparam><type>float</type><parameter>g</parameter></methodparam> - <methodparam><type>float</type><parameter>b</parameter></methodparam> - </methodsynopsis> - <para> - Defines filling color for the page. All values must be between 0 and 1. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>r</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>g</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>b</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::getRGBFill</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/setrgbstroke.xml b/reference/haru/harupage/setrgbstroke.xml deleted file mode 100644 index 06ea941de647..000000000000 --- a/reference/haru/harupage/setrgbstroke.xml +++ /dev/null @@ -1,96 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.setrgbstroke" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::setRGBStroke</refname> - <refpurpose>Set stroking color for the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::setRGBStroke</methodname> - <methodparam><type>float</type><parameter>r</parameter></methodparam> - <methodparam><type>float</type><parameter>g</parameter></methodparam> - <methodparam><type>float</type><parameter>b</parameter></methodparam> - </methodsynopsis> - <para> - Defines stroking color for the page. All values must be between 0 and 1. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>r</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>g</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>b</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::getRGBStroke</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/setrotate.xml b/reference/haru/harupage/setrotate.xml deleted file mode 100644 index c0fbfc674592..000000000000 --- a/reference/haru/harupage/setrotate.xml +++ /dev/null @@ -1,69 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.setrotate" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::setRotate</refname> - <refpurpose>Set rotation angle of the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::setRotate</methodname> - <methodparam><type>int</type><parameter>angle</parameter></methodparam> - </methodsynopsis> - <para> - Defines rotation angle of the page. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>angle</parameter></term> - <listitem> - <para> - Must be a multiple of 90 degrees. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/setsize.xml b/reference/haru/harupage/setsize.xml deleted file mode 100644 index dd9e9c391841..000000000000 --- a/reference/haru/harupage/setsize.xml +++ /dev/null @@ -1,134 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.setsize" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::setSize</refname> - <refpurpose>Set size and direction of the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::setSize</methodname> - <methodparam><type>int</type><parameter>size</parameter></methodparam> - <methodparam><type>int</type><parameter>direction</parameter></methodparam> - </methodsynopsis> - <para> - Changes size and direction of the page to a predefined format. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>size</parameter></term> - <listitem> - <para> - Must be one of the following values: - <simplelist> - <member> - <constant>HaruPage::SIZE_LETTER</constant> - </member> - <member> - <constant>HaruPage::SIZE_LEGAL</constant> - </member> - <member> - <constant>HaruPage::SIZE_A3</constant> - </member> - <member> - <constant>HaruPage::SIZE_A4</constant> - </member> - <member> - <constant>HaruPage::SIZE_A5</constant> - </member> - <member> - <constant>HaruPage::SIZE_B4</constant> - </member> - <member> - <constant>HaruPage::SIZE_B5</constant> - </member> - <member> - <constant>HaruPage::SIZE_EXECUTIVE</constant> - </member> - <member> - <constant>HaruPage::SIZE_US4x6</constant> - </member> - <member> - <constant>HaruPage::SIZE_US4x8</constant> - </member> - <member> - <constant>HaruPage::SIZE_US5x7</constant> - </member> - <member> - <constant>HaruPage::SIZE_COMM10</constant> - </member> - </simplelist> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>direction</parameter></term> - <listitem> - <para> - Must be one of the following values: - <simplelist> - <member> - <constant>HaruPage::PORTRAIT</constant> - </member> - <member> - <constant>HaruPage::LANDSCAPE</constant> - </member> - </simplelist> - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::setWidth</methodname></member> - <member><methodname>HaruPage::setHeight</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/setslideshow.xml b/reference/haru/harupage/setslideshow.xml deleted file mode 100644 index 0b9b415cc9ff..000000000000 --- a/reference/haru/harupage/setslideshow.xml +++ /dev/null @@ -1,140 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.setslideshow" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::setSlideShow</refname> - <refpurpose>Set transition style for the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::setSlideShow</methodname> - <methodparam><type>int</type><parameter>type</parameter></methodparam> - <methodparam><type>float</type><parameter>disp_time</parameter></methodparam> - <methodparam><type>float</type><parameter>trans_time</parameter></methodparam> - </methodsynopsis> - <para> - Defines transition style for the page. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>type</parameter></term> - <listitem> - <para> - Must be one of the following values: - <simplelist> - <member> - <constant>HaruPage::TS_WIPE_RIGHT</constant> - </member> - <member> - <constant>HaruPage::TS_WIPE_LEFT</constant> - </member> - <member> - <constant>HaruPage::TS_WIPE_UP</constant> - </member> - <member> - <constant>HaruPage::TS_WIPE_DOWN</constant> - </member> - <member> - <constant>HaruPage::TS_BARN_DOORS_HORIZONTAL_OUT</constant> - </member> - <member> - <constant>HaruPage::TS_BARN_DOORS_HORIZONTAL_IN</constant> - </member> - <member> - <constant>HaruPage::TS_BARN_DOORS_VERTICAL_OUT</constant> - </member> - <member> - <constant>HaruPage::TS_BARN_DOORS_VERTICAL_IN</constant> - </member> - <member> - <constant>HaruPage::TS_BOX_OUT</constant> - </member> - <member> - <constant>HaruPage::TS_BOX_IN</constant> - </member> - <member> - <constant>HaruPage::TS_BLINDS_HORIZONTAL</constant> - </member> - <member> - <constant>HaruPage::TS_BLINDS_VERTICAL</constant> - </member> - <member> - <constant>HaruPage::TS_DISSOLVE</constant> - </member> - <member> - <constant>HaruPage::TS_GLITTER_RIGHT</constant> - </member> - <member> - <constant>HaruPage::TS_GLITTER_DOWN</constant> - </member> - <member> - <constant>HaruPage::TS_GLITTER_TOP_LEFT_TO_BOTTOM_RIGHT</constant> - </member> - <member> - <constant>HaruPage::TS_REPLACE</constant> - </member> - </simplelist> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>disp_time</parameter></term> - <listitem> - <para> - The display duration of the page in seconds. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>trans_time</parameter></term> - <listitem> - <para> - The duration of the transition effect in seconds. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/settextleading.xml b/reference/haru/harupage/settextleading.xml deleted file mode 100644 index 8e2516b91b0e..000000000000 --- a/reference/haru/harupage/settextleading.xml +++ /dev/null @@ -1,78 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.settextleading" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::setTextLeading</refname> - <refpurpose>Set text leading (line spacing) for the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::setTextLeading</methodname> - <methodparam><type>float</type><parameter>text_leading</parameter></methodparam> - </methodsynopsis> - <para> - Set the text leading (line spacing) for the page. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>text_leading</parameter></term> - <listitem> - <para> - Defines line spacing for the page. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::getTextLeading</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/settextmatrix.xml b/reference/haru/harupage/settextmatrix.xml deleted file mode 100644 index d9159ff17f29..000000000000 --- a/reference/haru/harupage/settextmatrix.xml +++ /dev/null @@ -1,123 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.settextmatrix" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::setTextMatrix</refname> - <refpurpose>Set the current text transformation matrix of the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::setTextMatrix</methodname> - <methodparam><type>float</type><parameter>a</parameter></methodparam> - <methodparam><type>float</type><parameter>b</parameter></methodparam> - <methodparam><type>float</type><parameter>c</parameter></methodparam> - <methodparam><type>float</type><parameter>d</parameter></methodparam> - <methodparam><type>float</type><parameter>x</parameter></methodparam> - <methodparam><type>float</type><parameter>y</parameter></methodparam> - </methodsynopsis> - <para> - Defines the text transformation matrix of the page. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>a</parameter></term> - <listitem> - <para> - Width multiplier. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>b</parameter></term> - <listitem> - <para> - Vertical skew in radians. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>c</parameter></term> - <listitem> - <para> - Horizontal skew in radians. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>d</parameter></term> - <listitem> - <para> - Height multiplier. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>x</parameter></term> - <listitem> - <para> - Horizontal position for text. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>y</parameter></term> - <listitem> - <para> - Vertical position for text. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::getTextMatrix</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/settextrenderingmode.xml b/reference/haru/harupage/settextrenderingmode.xml deleted file mode 100644 index b59589581bbd..000000000000 --- a/reference/haru/harupage/settextrenderingmode.xml +++ /dev/null @@ -1,104 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.settextrenderingmode" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::setTextRenderingMode</refname> - <refpurpose>Set text rendering mode for the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::setTextRenderingMode</methodname> - <methodparam><type>int</type><parameter>mode</parameter></methodparam> - </methodsynopsis> - <para> - Defines text rendering mode for the page. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>mode</parameter></term> - <listitem> - <para> - Must be one of the following values: - <simplelist> - <member> - <constant>HaruPage::FILL</constant> - </member> - <member> - <constant>HaruPage::STROKE</constant> - </member> - <member> - <constant>HaruPage::FILL_THEN_STROKE</constant> - </member> - <member> - <constant>HaruPage::INVISIBLE</constant> - </member> - <member> - <constant>HaruPage::FILL_CLIPPING</constant> - </member> - <member> - <constant>HaruPage::STROKE_CLIPPING</constant> - </member> - <member> - <constant>HaruPage::FILL_STROKE_CLIPPING</constant> - </member> - <member> - <constant>HaruPage::CLIPPING</constant> - </member> - </simplelist> - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::getTextRenderingMode</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/settextrise.xml b/reference/haru/harupage/settextrise.xml deleted file mode 100644 index 5872a6338fe7..000000000000 --- a/reference/haru/harupage/settextrise.xml +++ /dev/null @@ -1,78 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.settextrise" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::setTextRise</refname> - <refpurpose>Set the current value of text rising</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::setTextRise</methodname> - <methodparam><type>float</type><parameter>rise</parameter></methodparam> - </methodsynopsis> - <para> - Set the current value of text rising. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>rise</parameter></term> - <listitem> - <para> - Defines the current value of text rising. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::getTextRise</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/setwidth.xml b/reference/haru/harupage/setwidth.xml deleted file mode 100644 index d4c61ffb049d..000000000000 --- a/reference/haru/harupage/setwidth.xml +++ /dev/null @@ -1,78 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.setwidth" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::setWidth</refname> - <refpurpose>Set width of the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::setWidth</methodname> - <methodparam><type>float</type><parameter>width</parameter></methodparam> - </methodsynopsis> - <para> - Set the width of the page. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>width</parameter></term> - <listitem> - <para> - Defines width of the page. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::getWidth</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/setwordspace.xml b/reference/haru/harupage/setwordspace.xml deleted file mode 100644 index 8ef218ac676a..000000000000 --- a/reference/haru/harupage/setwordspace.xml +++ /dev/null @@ -1,78 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.setwordspace" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::setWordSpace</refname> - <refpurpose>Set word spacing for the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::setWordSpace</methodname> - <methodparam><type>float</type><parameter>word_space</parameter></methodparam> - </methodsynopsis> - <para> - Set the word spacing for the page. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>word_space</parameter></term> - <listitem> - <para> - Defines word spacing for the page. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::getWordSpace</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/showtext.xml b/reference/haru/harupage/showtext.xml deleted file mode 100644 index 2764971460e2..000000000000 --- a/reference/haru/harupage/showtext.xml +++ /dev/null @@ -1,80 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.showtext" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::showText</refname> - <refpurpose>Print text at the current position of the page</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::showText</methodname> - <methodparam><type>string</type><parameter>text</parameter></methodparam> - </methodsynopsis> - <para> - Prints out the text at the current position of the page. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>text</parameter></term> - <listitem> - <para> - The text to show. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::showTextNextLine</methodname></member> - <member><methodname>HaruPage::textOut</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/showtextnextline.xml b/reference/haru/harupage/showtextnextline.xml deleted file mode 100644 index d69dc2b32b98..000000000000 --- a/reference/haru/harupage/showtextnextline.xml +++ /dev/null @@ -1,97 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.showtextnextline" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::showTextNextLine</refname> - <refpurpose>Move the current position to the start of the next line and print the text</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::showTextNextLine</methodname> - <methodparam><type>string</type><parameter>text</parameter></methodparam> - <methodparam choice="opt"><type>float</type><parameter>word_space</parameter><initializer>0</initializer></methodparam> - <methodparam choice="opt"><type>float</type><parameter>char_space</parameter><initializer>0</initializer></methodparam> - </methodsynopsis> - <para> - Moves the current position to the start of the next line and print out the text. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>text</parameter></term> - <listitem> - <para> - The text to show. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>word_space</parameter></term> - <listitem> - <para> - The word spacing. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>char_space</parameter></term> - <listitem> - <para> - The character spacing. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::showText</methodname></member> - <member><methodname>HaruPage::textOut</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/stroke.xml b/reference/haru/harupage/stroke.xml deleted file mode 100644 index a0c287bab71d..000000000000 --- a/reference/haru/harupage/stroke.xml +++ /dev/null @@ -1,69 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.stroke" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::stroke</refname> - <refpurpose>Paint current path</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::stroke</methodname> - <methodparam choice="opt"><type>bool</type><parameter>close_path</parameter><initializer>&false;</initializer></methodparam> - </methodsynopsis> - <para> - Paints the current path. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>close_path</parameter></term> - <listitem> - <para> - Closes the current path if set to &true;. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/textout.xml b/reference/haru/harupage/textout.xml deleted file mode 100644 index 783fc3098eb2..000000000000 --- a/reference/haru/harupage/textout.xml +++ /dev/null @@ -1,98 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.textout" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::textOut</refname> - <refpurpose>Print the text on the specified position</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::textOut</methodname> - <methodparam><type>float</type><parameter>x</parameter></methodparam> - <methodparam><type>float</type><parameter>y</parameter></methodparam> - <methodparam><type>string</type><parameter>text</parameter></methodparam> - </methodsynopsis> - <para> - Prints the text on the specified position. - </para> - </refsect1> - - <!-- FIXME --> - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>x</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>y</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>text</parameter></term> - <listitem> - <para> - - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::showTextNextLine</methodname></member> - <member><methodname>HaruPage::showText</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/harupage/textrect.xml b/reference/haru/harupage/textrect.xml deleted file mode 100644 index daef467e623e..000000000000 --- a/reference/haru/harupage/textrect.xml +++ /dev/null @@ -1,139 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xml:id="harupage.textrect" xmlns="http://docbook.org/ns/docbook"> - <refnamediv> - <refname>HaruPage::textRect</refname> - <refpurpose>Print the text inside the specified region</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>bool</type><methodname>HaruPage::textRect</methodname> - <methodparam><type>float</type><parameter>left</parameter></methodparam> - <methodparam><type>float</type><parameter>top</parameter></methodparam> - <methodparam><type>float</type><parameter>right</parameter></methodparam> - <methodparam><type>float</type><parameter>bottom</parameter></methodparam> - <methodparam><type>string</type><parameter>text</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>align</parameter><initializer>HaruPage::TALIGN_LEFT</initializer></methodparam> - </methodsynopsis> - <para> - Prints the text inside the specified region. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>left</parameter></term> - <listitem> - <para> - Left border of the text area. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>top</parameter></term> - <listitem> - <para> - Top border of the text area. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>right</parameter></term> - <listitem> - <para> - Right border of the text area. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>bottom</parameter></term> - <listitem> - <para> - Lower border of the text area. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>text</parameter></term> - <listitem> - <para> - The text to print. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>align</parameter></term> - <listitem> - <para> - Text alignment. Must be one of the following values: - <simplelist> - <member> - <constant>HaruPage::TALIGN_LEFT</constant> - </member> - <member> - <constant>HaruPage::TALIGN_RIGHT</constant> - </member> - <member> - <constant>HaruPage::TALIGN_CENTER</constant> - </member> - <member> - <constant>HaruPage::TALIGN_JUSTIFY</constant> - </member> - </simplelist> - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns &true; on success. - </para> - </refsect1> - - <refsect1 role="errors"> - &reftitle.errors; - &haru.error; - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><methodname>HaruPage::showTextNextLine</methodname></member> - <member><methodname>HaruPage::showText</methodname></member> - <member><methodname>HaruPage::textOut</methodname></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/haru/setup.xml b/reference/haru/setup.xml deleted file mode 100644 index ec27bd8c586f..000000000000 --- a/reference/haru/setup.xml +++ /dev/null @@ -1,66 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> - -<chapter xml:id="haru.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> - &reftitle.setup; - - <!-- {{{ Requirements --> - <section xml:id="haru.requirements"> - &reftitle.required; - <para> - You need to install libharu first to be able to use PECL/haru. - PECL/haru is tested with libharu 2.0.8, older versions might or might not - work for you. - PECL/haru also requires PHP 5.1.3 or newer. - </para> - </section> - <!-- }}} --> - - <!-- {{{ Installation --> - <section xml:id="haru.installation"> - &reftitle.install; - <para> - &pecl.info; - <link - xlink:href="&url.pecl.package;haru">&url.pecl.package;haru</link>. - </para> - </section> - <!-- }}} --> - - <!-- {{{ Configuration --> - <section xml:id="haru.configuration"> - &reftitle.runtime; - &no.config; - </section> - <!-- }}} --> - - <!-- {{{ Resources --> - <section xml:id="haru.resources"> - &reftitle.resources; - &no.resource; - </section> - <!-- }}} --> - -</chapter> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> - diff --git a/reference/haru/versions.xml b/reference/haru/versions.xml deleted file mode 100644 index cf89e2842751..000000000000 --- a/reference/haru/versions.xml +++ /dev/null @@ -1,217 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<!-- - Do NOT translate this file ---> -<versions> - - <function name='haruannotation' from='PECL haru >= 0.0.1'/> - <function name='haruannotation::__construct' from='PECL haru >= 0.0.1'/> - <function name='haruannotation::setborderstyle' from='PECL haru >= 0.0.1'/> - <function name='haruannotation::sethighlightmode' from='PECL haru >= 0.0.1'/> - <function name='haruannotation::seticon' from='PECL haru >= 0.0.1'/> - <function name='haruannotation::setopened' from='PECL haru >= 0.0.1'/> - - <function name='harudestination' from='PECL haru >= 0.0.1'/> - <function name='harudestination::__construct' from='PECL haru >= 0.0.1'/> - <function name='harudestination::setfit' from='PECL haru >= 0.0.1'/> - <function name='harudestination::setfitb' from='PECL haru >= 0.0.1'/> - <function name='harudestination::setfitbh' from='PECL haru >= 0.0.1'/> - <function name='harudestination::setfitbv' from='PECL haru >= 0.0.1'/> - <function name='harudestination::setfith' from='PECL haru >= 0.0.1'/> - <function name='harudestination::setfitr' from='PECL haru >= 0.0.1'/> - <function name='harudestination::setfitv' from='PECL haru >= 0.0.1'/> - <function name='harudestination::setxyz' from='PECL haru >= 0.0.1'/> - - <function name='harudoc' from='PECL haru >= 0.0.1'/> - <function name='harudoc::__construct' from='PECL haru >= 0.0.1'/> - <function name='harudoc::addpage' from='PECL haru >= 0.0.1'/> - <function name='harudoc::addpagelabel' from='PECL haru >= 0.0.1'/> - <function name='harudoc::createoutline' from='PECL haru >= 0.0.1'/> - <function name='harudoc::getcurrentencoder' from='PECL haru >= 0.0.1'/> - <function name='harudoc::getcurrentpage' from='PECL haru >= 0.0.1'/> - <function name='harudoc::getencoder' from='PECL haru >= 0.0.1'/> - <function name='harudoc::getfont' from='PECL haru >= 0.0.1'/> - <function name='harudoc::getinfoattr' from='PECL haru >= 0.0.1'/> - <function name='harudoc::getpagelayout' from='PECL haru >= 0.0.1'/> - <function name='harudoc::getpagemode' from='PECL haru >= 0.0.1'/> - <function name='harudoc::getstreamsize' from='PECL haru >= 0.0.1'/> - <function name='harudoc::insertpage' from='PECL haru >= 0.0.1'/> - <function name='harudoc::loadjpeg' from='PECL haru >= 0.0.1'/> - <function name='harudoc::loadpng' from='PECL haru >= 0.0.1'/> - <function name='harudoc::loadraw' from='PECL haru >= 0.0.1'/> - <function name='harudoc::loadttc' from='PECL haru >= 0.0.1'/> - <function name='harudoc::loadttf' from='PECL haru >= 0.0.1'/> - <function name='harudoc::loadtype1' from='PECL haru >= 0.0.1'/> - <function name='harudoc::output' from='PECL haru >= 0.0.1'/> - <function name='harudoc::readfromstream' from='PECL haru >= 0.0.1'/> - <function name='harudoc::reseterror' from='PECL haru >= 0.0.1'/> - <function name='harudoc::resetstream' from='PECL haru >= 0.0.1'/> - <function name='harudoc::save' from='PECL haru >= 0.0.1'/> - <function name='harudoc::savetostream' from='PECL haru >= 0.0.1'/> - <function name='harudoc::setcompressionmode' from='PECL haru >= 0.0.1'/> - <function name='harudoc::setcurrentencoder' from='PECL haru >= 0.0.1'/> - <function name='harudoc::setencryptionmode' from='PECL haru >= 0.0.1'/> - <function name='harudoc::setinfoattr' from='PECL haru >= 0.0.1'/> - <function name='harudoc::setinfodateattr' from='PECL haru >= 0.0.1'/> - <function name='harudoc::setopenaction' from='PECL haru >= 0.0.1'/> - <function name='harudoc::setpagelayout' from='PECL haru >= 0.0.1'/> - <function name='harudoc::setpagemode' from='PECL haru >= 0.0.1'/> - <function name='harudoc::setpagesconfiguration' from='PECL haru >= 0.0.1'/> - <function name='harudoc::setpassword' from='PECL haru >= 0.0.1'/> - <function name='harudoc::setpermission' from='PECL haru >= 0.0.1'/> - <function name='harudoc::usecnsencodings' from='PECL haru >= 0.0.1'/> - <function name='harudoc::usecnsfonts' from='PECL haru >= 0.0.1'/> - <function name='harudoc::usecntencodings' from='PECL haru >= 0.0.1'/> - <function name='harudoc::usecntfonts' from='PECL haru >= 0.0.1'/> - <function name='harudoc::usejpencodings' from='PECL haru >= 0.0.1'/> - <function name='harudoc::usejpfonts' from='PECL haru >= 0.0.1'/> - <function name='harudoc::usekrencodings' from='PECL haru >= 0.0.1'/> - <function name='harudoc::usekrfonts' from='PECL haru >= 0.0.1'/> - - <function name='haruencoder' from='PECL haru >= 0.0.1'/> - <function name='haruencoder::__construct' from='PECL haru >= 0.0.1'/> - <function name='haruencoder::getbytetype' from='PECL haru >= 0.0.1'/> - <function name='haruencoder::gettype' from='PECL haru >= 0.0.1'/> - <function name='haruencoder::getunicode' from='PECL haru >= 0.0.1'/> - <function name='haruencoder::getwritingmode' from='PECL haru >= 0.0.1'/> - - <function name='haruexception' from='PECL haru >= 0.0.1'/> - - <function name='harufont' from='PECL haru >= 0.0.1'/> - <function name='harufont::__construct' from='PECL haru >= 0.0.1'/> - <function name='harufont::getascent' from='PECL haru >= 0.0.1'/> - <function name='harufont::getcapheight' from='PECL haru >= 0.0.1'/> - <function name='harufont::getdescent' from='PECL haru >= 0.0.1'/> - <function name='harufont::getencodingname' from='PECL haru >= 0.0.1'/> - <function name='harufont::getfontname' from='PECL haru >= 0.0.1'/> - <function name='harufont::gettextwidth' from='PECL haru >= 0.0.1'/> - <function name='harufont::getunicodewidth' from='PECL haru >= 0.0.1'/> - <function name='harufont::getxheight' from='PECL haru >= 0.0.1'/> - <function name='harufont::measuretext' from='PECL haru >= 0.0.1'/> - - <function name='haruimage' from='PECL haru >= 0.0.1'/> - <function name='haruimage::__construct' from='PECL haru >= 0.0.1'/> - <function name='haruimage::getbitspercomponent' from='PECL haru >= 0.0.1'/> - <function name='haruimage::getcolorspace' from='PECL haru >= 0.0.1'/> - <function name='haruimage::getheight' from='PECL haru >= 0.0.1'/> - <function name='haruimage::getsize' from='PECL haru >= 0.0.1'/> - <function name='haruimage::getwidth' from='PECL haru >= 0.0.1'/> - <function name='haruimage::setcolormask' from='PECL haru >= 0.0.1'/> - <function name='haruimage::setmaskimage' from='PECL haru >= 0.0.1'/> - - <function name='haruoutline' from='PECL haru >= 0.0.1'/> - <function name='haruoutline::__construct' from='PECL haru >= 0.0.1'/> - <function name='haruoutline::setdestination' from='PECL haru >= 0.0.1'/> - <function name='haruoutline::setopened' from='PECL haru >= 0.0.1'/> - - <function name='harupage' from='PECL haru >= 0.0.1'/> - <function name='harupage::__construct' from='PECL haru >= 0.0.1'/> - <function name='harupage::arc' from='PECL haru >= 0.0.1'/> - <function name='harupage::begintext' from='PECL haru >= 0.0.1'/> - <function name='harupage::circle' from='PECL haru >= 0.0.1'/> - <function name='harupage::closepath' from='PECL haru >= 0.0.1'/> - <function name='harupage::concat' from='PECL haru >= 0.0.1'/> - <function name='harupage::createdestination' from='PECL haru >= 0.0.1'/> - <function name='harupage::createlinkannotation' from='PECL haru >= 0.0.1'/> - <function name='harupage::createtextannotation' from='PECL haru >= 0.0.1'/> - <function name='harupage::createurlannotation' from='PECL haru >= 0.0.1'/> - <function name='harupage::curveto' from='PECL haru >= 0.0.1'/> - <function name='harupage::curveto2' from='PECL haru >= 0.0.1'/> - <function name='harupage::curveto3' from='PECL haru >= 0.0.1'/> - <function name='harupage::drawimage' from='PECL haru >= 0.0.1'/> - <function name='harupage::ellipse' from='PECL haru >= 0.0.1'/> - <function name='harupage::endpath' from='PECL haru >= 0.0.1'/> - <function name='harupage::endtext' from='PECL haru >= 0.0.1'/> - <function name='harupage::eofill' from='PECL haru >= 0.0.1'/> - <function name='harupage::eofillstroke' from='PECL haru >= 0.0.1'/> - <function name='harupage::fill' from='PECL haru >= 0.0.1'/> - <function name='harupage::fillstroke' from='PECL haru >= 0.0.1'/> - <function name='harupage::getcharspace' from='PECL haru >= 0.0.1'/> - <function name='harupage::getcmykfill' from='PECL haru >= 0.0.1'/> - <function name='harupage::getcmykstroke' from='PECL haru >= 0.0.1'/> - <function name='harupage::getcurrentfont' from='PECL haru >= 0.0.1'/> - <function name='harupage::getcurrentfontsize' from='PECL haru >= 0.0.1'/> - <function name='harupage::getcurrentpos' from='PECL haru >= 0.0.1'/> - <function name='harupage::getcurrenttextpos' from='PECL haru >= 0.0.1'/> - <function name='harupage::getdash' from='PECL haru >= 0.0.1'/> - <function name='harupage::getfillingcolorspace' from='PECL haru >= 0.0.1'/> - <function name='harupage::getflatness' from='PECL haru >= 0.0.1'/> - <function name='harupage::getgmode' from='PECL haru >= 0.0.1'/> - <function name='harupage::getgrayfill' from='PECL haru >= 0.0.1'/> - <function name='harupage::getgraystroke' from='PECL haru >= 0.0.1'/> - <function name='harupage::getheight' from='PECL haru >= 0.0.1'/> - <function name='harupage::gethorizontalscaling' from='PECL haru >= 0.0.1'/> - <function name='harupage::getlinecap' from='PECL haru >= 0.0.1'/> - <function name='harupage::getlinejoin' from='PECL haru >= 0.0.1'/> - <function name='harupage::getlinewidth' from='PECL haru >= 0.0.1'/> - <function name='harupage::getmiterlimit' from='PECL haru >= 0.0.1'/> - <function name='harupage::getrgbfill' from='PECL haru >= 0.0.1'/> - <function name='harupage::getrgbstroke' from='PECL haru >= 0.0.1'/> - <function name='harupage::getstrokingcolorspace' from='PECL haru >= 0.0.1'/> - <function name='harupage::gettextleading' from='PECL haru >= 0.0.1'/> - <function name='harupage::gettextmatrix' from='PECL haru >= 0.0.1'/> - <function name='harupage::gettextrenderingmode' from='PECL haru >= 0.0.1'/> - <function name='harupage::gettextrise' from='PECL haru >= 0.0.1'/> - <function name='harupage::gettextwidth' from='PECL haru >= 0.0.1'/> - <function name='harupage::gettransmatrix' from='PECL haru >= 0.0.1'/> - <function name='harupage::getwidth' from='PECL haru >= 0.0.1'/> - <function name='harupage::getwordspace' from='PECL haru >= 0.0.1'/> - <function name='harupage::lineto' from='PECL haru >= 0.0.1'/> - <function name='harupage::measuretext' from='PECL haru >= 0.0.1'/> - <function name='harupage::movetextpos' from='PECL haru >= 0.0.1'/> - <function name='harupage::moveto' from='PECL haru >= 0.0.1'/> - <function name='harupage::movetonextline' from='PECL haru >= 0.0.1'/> - <function name='harupage::rectangle' from='PECL haru >= 0.0.1'/> - <function name='harupage::setcharspace' from='PECL haru >= 0.0.1'/> - <function name='harupage::setcmykfill' from='PECL haru >= 0.0.1'/> - <function name='harupage::setcmykstroke' from='PECL haru >= 0.0.1'/> - <function name='harupage::setdash' from='PECL haru >= 0.0.1'/> - <function name='harupage::setflatness' from='PECL haru >= 0.0.1'/> - <function name='harupage::setfontandsize' from='PECL haru >= 0.0.1'/> - <function name='harupage::setgrayfill' from='PECL haru >= 0.0.1'/> - <function name='harupage::setgraystroke' from='PECL haru >= 0.0.1'/> - <function name='harupage::setheight' from='PECL haru >= 0.0.1'/> - <function name='harupage::sethorizontalscaling' from='PECL haru >= 0.0.1'/> - <function name='harupage::setlinecap' from='PECL haru >= 0.0.1'/> - <function name='harupage::setlinejoin' from='PECL haru >= 0.0.1'/> - <function name='harupage::setlinewidth' from='PECL haru >= 0.0.1'/> - <function name='harupage::setmiterlimit' from='PECL haru >= 0.0.1'/> - <function name='harupage::setrgbfill' from='PECL haru >= 0.0.1'/> - <function name='harupage::setrgbstroke' from='PECL haru >= 0.0.1'/> - <function name='harupage::setrotate' from='PECL haru >= 0.0.1'/> - <function name='harupage::setsize' from='PECL haru >= 0.0.1'/> - <function name='harupage::setslideshow' from='PECL haru >= 0.0.1'/> - <function name='harupage::settextleading' from='PECL haru >= 0.0.1'/> - <function name='harupage::settextmatrix' from='PECL haru >= 0.0.1'/> - <function name='harupage::settextrenderingmode' from='PECL haru >= 0.0.1'/> - <function name='harupage::settextrise' from='PECL haru >= 0.0.1'/> - <function name='harupage::setwidth' from='PECL haru >= 0.0.1'/> - <function name='harupage::setwordspace' from='PECL haru >= 0.0.1'/> - <function name='harupage::showtext' from='PECL haru >= 0.0.1'/> - <function name='harupage::showtextnextline' from='PECL haru >= 0.0.1'/> - <function name='harupage::stroke' from='PECL haru >= 0.0.1'/> - <function name='harupage::textout' from='PECL haru >= 0.0.1'/> - <function name='harupage::textrect' from='PECL haru >= 0.0.1'/> -</versions> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> \ No newline at end of file diff --git a/reference/hash/functions/hash-algos.xml b/reference/hash/functions/hash-algos.xml index 0e481cec7741..8a36714f89cf 100644 --- a/reference/hash/functions/hash-algos.xml +++ b/reference/hash/functions/hash-algos.xml @@ -46,22 +46,6 @@ sha3-512 has been added. </entry> </row> - <row> - <entry>5.6.0</entry> - <entry> - Support for gost-crypto was added. This implements the GOST hash - function using the CryptoPro S-box tables as specified by - <link xlink:href="&url.rfc;4357">RFC 4357, section 11.2</link>. - </entry> - </row> - <row> - <entry>5.4.0</entry> - <entry>Support for joaat, fnv132 and fnv164 was added. Support for Salsa10 and Salsa20 was removed.</entry> - </row> - <row> - <entry>5.3.0</entry> - <entry>Support for md2, ripemd256, ripemd320, salsa10, salsa20, snefru256 and sha224 was added</entry> - </row> </tbody> </tgroup> </informaltable> diff --git a/reference/hash/functions/hash.xml b/reference/hash/functions/hash.xml index 887f3c0fad73..369b1c8e5d72 100644 --- a/reference/hash/functions/hash.xml +++ b/reference/hash/functions/hash.xml @@ -56,28 +56,6 @@ binary representation of the message digest is returned. </para> </refsect1> - - <refsect1 role="changelog"> - &reftitle.changelog; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>&Version;</entry> - <entry>&Description;</entry> - </row> - </thead> - <tbody> - <row> - <entry>5.4.0</entry> - <entry>The tiger algorithm now uses big-endian byte ordering. See also example below.</entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </refsect1> <refsect1 role="examples"> &reftitle.examples; diff --git a/reference/htscanner/book.xml b/reference/htscanner/book.xml deleted file mode 100644 index 43a6fdef43fa..000000000000 --- a/reference/htscanner/book.xml +++ /dev/null @@ -1,41 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> - -<book xml:id="book.htscanner" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> - <title>htaccess-like support for all SAPIs - htscanner - - - &reftitle.intro; - - The htscanner extension gives the possibility to use htaccess-like file to configure PHP - per directory, just like apache's htaccess. It is especially useful with fastcgi - (IIS5/6/7, lighttpd, etc.). - - - - &reference.htscanner.setup; - - - - - diff --git a/reference/htscanner/configure.xml b/reference/htscanner/configure.xml deleted file mode 100644 index 24ebaacbc32c..000000000000 --- a/reference/htscanner/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;htscanner - -
- - - diff --git a/reference/htscanner/ini.xml b/reference/htscanner/ini.xml deleted file mode 100644 index 1e1424061c79..000000000000 --- a/reference/htscanner/ini.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - -
- &reftitle.runtime; - &extension.runtime; - - -
- htscanner &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - Changelog - - - - - htscanner.config_file - ".htscanner" - PHP_INI_SYSTEM - - - - htscanner.default_docroot - "/" - PHP_INI_SYSTEM - - - - htscanner.default_ttl - "300" - PHP_INI_SYSTEM - - - - htscanner.stop_on_error - "Off" - PHP_INI_SYSTEM - - - - - -
- - &ini.php.constants; - - - - &ini.descriptions.title; - - - - - - - htscanner.config_file - string - - - - Filename to use as configuration file. - - - - - - - htscanner.default_docroot - string - - - - Default document root. - - - - - - - htscanner.default_ttl - int - - - - Cache time out for the configuration data, in seconds. - - - - - - - htscanner.stop_on_error - int - - - - Stop on error (parse error, cannot set an ini setting). - - - - - -
- - - diff --git a/reference/htscanner/setup.xml b/reference/htscanner/setup.xml deleted file mode 100644 index 31f2d5fd6ff7..000000000000 --- a/reference/htscanner/setup.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.required; - - PHP version 5.2.0 or greater. - -
- - &reference.htscanner.configure; - &reference.htscanner.ini; - -
- &reftitle.resources; - &no.resource; -
- - - - - diff --git a/reference/hwapi/apache.xml b/reference/hwapi/apache.xml deleted file mode 100644 index 9870b229cdec..000000000000 --- a/reference/hwapi/apache.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - - Integration with Apache - - The Hyperwave extension is best used when PHP is compiled as an - Apache module. In such a case the underlying Hyperwave server can - be hidden from users almost completely if Apache uses its rewriting - engine. The following instructions will explain this. - - - Since PHP with Hyperwave support built into Apache is intended - to replace the native Hyperwave solution based on Wavemaster, we - will assume that the Apache server will only serve as a Hyperwave - web interface for these examples. This is not necessary but it simplifies - the configuration. The concept is quite simple. First of all you - need a PHP script which evaluates the $_ENV['PATH_INFO'] - variable and treats its value as the name of a Hyperwave - object. Let's call this script 'Hyperwave'. The URL - http://your.hostname/Hyperwave/name_of_object - would than return the Hyperwave object with the name - 'name_of_object'. Depending on the type of the object - the script has to react accordingly. If it is a collection, it will probably - return a list of children. If it is a document it will return the - mime type and the content. A slight improvement can be achieved - if the Apache rewriting engine is used. From the users point of - view it would be more straight forward if the URL - http://your.hostname/name_of_object would - return the object. The rewriting rule is quite easy: - - - - - - - - Now every URL relates to an object in the Hyperwave server. This - causes a simple to solve problem. There is no way to execute a - different script, e.g. for searching, than the 'Hyperwave' - script. This can be fixed with another rewriting rule like the - following: - - - - - - - - This will reserve the directory /usr/local/apache/htdocs/hw - for additional scripts and other files. Just make sure this rule is - evaluated before the one above. There is just a little drawback: - all Hyperwave objects whose name starts with 'hw/' - will be shadowed. So, make sure you don't use such names. If you need - more directories, e.g. for images just add more rules or place - them all in one directory. Before you put those instructions, don't - forget to turn on the rewriting engine with - - - - - - - - You will need scripts: - - - - - to return the object itself - - - - - to allow searching - - - - - to identify yourself - - - - - to set your profile - - - - - one for each additional function like to show - the object attributes, to show information about users, - to show the status of the server, etc. - - - - - - As an alternative to the Rewrite Engine, you can also consider using - the Apache ErrorDocument directive, but be aware, - that ErrorDocument redirected pages cannot receive - POST data. - - - - - diff --git a/reference/hwapi/book.xml b/reference/hwapi/book.xml deleted file mode 100644 index ef0b7f7af3f9..000000000000 --- a/reference/hwapi/book.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - Hyperwave API - - - - &reftitle.intro; - - Hyperwave has been developed at - IICM in Graz. It started with - the name Hyper-G and changed to Hyperwave when - it was commercialised (in 1996). - - - Hyperwave is not free software. The current version, 5.5, is - available at &url.hyperwave;. - A time limited version can be ordered for free (30 days). - - - Hyperwave is an information system similar to a database - (HIS, Hyperwave Information Server). Its focus - is the storage and management of documents. A document can be any - possible piece of data that may as well be stored in file. Each - document is accompanied by its object record. The object record - contains meta data for the document. The meta data is a list of - attributes which can be extended by the user. Certain attributes - are always set by the Hyperwave server, other may be modified by - the user. - - - - &pecl.moved-ver;5.2.0. - - - - - - &reference.hwapi.setup; - &reference.hwapi.constants; - &reference.hwapi.apache; - &reference.hwapi.reference; - - - - - diff --git a/reference/hwapi/configure.xml b/reference/hwapi/configure.xml deleted file mode 100644 index 9b98279ef5c5..000000000000 --- a/reference/hwapi/configure.xml +++ /dev/null @@ -1,36 +0,0 @@ - - -
- &reftitle.install; - - &pecl.info; - &url.pecl.package;hwapi. - - - &pecl.moved-ver;5.2.0 - - - &pecl.windows.download; - -
- - diff --git a/reference/hwapi/constants.xml b/reference/hwapi/constants.xml deleted file mode 100644 index 8e751e78d26c..000000000000 --- a/reference/hwapi/constants.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - &reftitle.constants; - &no.constants; - - - - diff --git a/reference/hwapi/functions/hwapi-attribute-new.xml b/reference/hwapi/functions/hwapi-attribute-new.xml deleted file mode 100644 index 126141f58b5f..000000000000 --- a/reference/hwapi/functions/hwapi-attribute-new.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - hwapi_attribute_new - Creates instance of class hw_api_attribute - - - - &reftitle.description; - - HW_API_Attributehwapi_attribute_new - stringname - stringvalue - - - Creates a new instance of hw_api_attribute with the given name and value. - - - - - &reftitle.parameters; - - - - name - - - The attribute name. - - - - - value - - - The attribute value. - - - - - - - - - &reftitle.returnvalues; - - Returns an instance of hw_api_attribute. - - - - - - diff --git a/reference/hwapi/functions/hwapi-content-new.xml b/reference/hwapi/functions/hwapi-content-new.xml deleted file mode 100644 index c9dc255375c2..000000000000 --- a/reference/hwapi/functions/hwapi-content-new.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - hwapi_content_new - Create new instance of class hw_api_content - - - - &reftitle.description; - - HW_API_Contenthwapi_content_new - stringcontent - stringmimetype - - - Creates a new content object from the string - content. - - - - - &reftitle.parameters; - - - - content - - - - - - - mimetype - - - The mimetype for the contents. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/hwapi/functions/hwapi-hgcsp.xml b/reference/hwapi/functions/hwapi-hgcsp.xml deleted file mode 100644 index 6adfb9524508..000000000000 --- a/reference/hwapi/functions/hwapi-hgcsp.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - hwapi_hgcsp - Returns object of class hw_api - - - - &reftitle.description; - - HW_APIhwapi_hgcsp - stringhostname - intport - - - Opens a connection to the Hyperwave server on host - hostname. The protocol used is HGCSP. - - - - - &reftitle.parameters; - - - - hostname - - - The host name. - - - - - port - - - If you do not pass a port number, 418 is used. - - - - - - - - - &reftitle.returnvalues; - - Returns an instance of HW_API. - - - - - - diff --git a/reference/hwapi/functions/hwapi-object-new.xml b/reference/hwapi/functions/hwapi-object-new.xml deleted file mode 100644 index 05544f5bb3d2..000000000000 --- a/reference/hwapi/functions/hwapi-object-new.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - hwapi_object_new - Creates a new instance of class hwapi_object_new - - - - &reftitle.description; - - hw_api_objecthwapi_object_new - arrayparameter - - - Creates a new instance of the class hw_api_object. - - - - - &reftitle.parameters; - - - - parameter - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/hwapi/hw_api/checkin.xml b/reference/hwapi/hw_api/checkin.xml deleted file mode 100644 index 032e8c5e48b1..000000000000 --- a/reference/hwapi/hw_api/checkin.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - hw_api::checkin - Checks in an object - - - - &reftitle.description; - - boolhw_api::checkin - arrayparameter - - - This function checks in an object or a whole hierarchy of objects. - The parameters array contains the required element - 'objectIdentifier' and the optional element 'version', 'comment', 'mode' - and - 'objectQuery'. 'version' sets the version of the object. It consists of - the major and minor version separated by a period. If the version is not - set, the minor version is incremented. 'mode' can be one of the following - values: - - - HW_API_CHECKIN_NORMAL - - - Checks in and commits the object. The object must be a document. - - - - - HW_API_CHECKIN_RECURSIVE - - - If the object to check in is a collection, all children will be - checked in recursively if they are documents. Trying to check in - a collection would result in an error. - - - - - HW_API_CHECKIN_FORCE_VERSION_CONTROL - - - Checks in an object even if it is not under version control. - - - - - HW_API_CHECKIN_REVERT_IF_NOT_CHANGED - - - Check if the new version is different from the last version. Unless - this is the case the object will be checked in. - - - - - HW_API_CHECKIN_KEEP_TIME_MODIFIED - - - Keeps the time modified from the most recent object. - - - - - HW_API_CHECKIN_NO_AUTO_COMMIT - - - The object is not automatically committed on check-in. - - - - - - - - - &reftitle.parameters; - - - - parameter - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/hwapi/hw_api/checkout.xml b/reference/hwapi/hw_api/checkout.xml deleted file mode 100644 index 472b3466b30a..000000000000 --- a/reference/hwapi/hw_api/checkout.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - hw_api::checkout - Checks out an object - - - - &reftitle.description; - - boolhw_api::checkout - arrayparameter - - - This function checks out an object or a whole hierarchy of objects. - - - - - &reftitle.parameters; - - - - parameter - - - The parameters array contains the required element - 'objectIdentifier' and the optional element 'version', 'mode' - and 'objectQuery'. 'mode' can be one of the following values: - - - HW_API_CHECKIN_NORMAL - - - Checks out an object. The object must be a document. - - - - - HW_API_CHECKIN_RECURSIVE - - - If the object to check out is a collection, all children will be - checked out recursively if they are documents. Trying to check out - a collection would result in an error. - - - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/hwapi/hw_api/children.xml b/reference/hwapi/hw_api/children.xml deleted file mode 100644 index 87ddc4247430..000000000000 --- a/reference/hwapi/hw_api/children.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - hw_api::children - Returns children of an object - - - - &reftitle.description; - - arrayhw_api::children - arrayparameter - - - Retrieves the children of a collection or the attributes of a document. - The children can be further filtered by specifying an object query. - - - - - &reftitle.parameters; - - - - parameter - - - The parameter array contains the required elements 'objectIdentifier' - and the optional elements 'attributeSelector' and 'objectQuery'. - - - - - - - - - &reftitle.returnvalues; - - The return value is an array of objects of type - HW_API_Object or - HW_API_Error. - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/hwapi/hw_api/content.xml b/reference/hwapi/hw_api/content.xml deleted file mode 100644 index f7fa499538fc..000000000000 --- a/reference/hwapi/hw_api/content.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - hw_api::content - Returns content of an object - - - - &reftitle.description; - - HW_API_Contenthw_api::content - arrayparameter - - - This function returns the content of a document as an object of type - hw_api_content. - - - - - &reftitle.parameters; - - - - parameter - - - The parameter array contains the required elements 'objectidentifier' - and the optional element 'mode'. The mode can be one of the constants - HW_API_CONTENT_ALLLINKS, - HW_API_CONTENT_REACHABLELINKS or - HW_API_CONTENT_PLAIN. - - - HW_API_CONTENT_ALLLINKS means to insert all - anchors even if the destination is not reachable. - - - HW_API_CONTENT_REACHABLELINKS tells this method - to insert only reachable links and - HW_API_CONTENT_PLAIN will lead to document - without any links. - - - - - - - - - &reftitle.returnvalues; - - Returns an instance of hw_api_content. - - - - - - diff --git a/reference/hwapi/hw_api/copy.xml b/reference/hwapi/hw_api/copy.xml deleted file mode 100644 index c9bc35922efe..000000000000 --- a/reference/hwapi/hw_api/copy.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - hw_api::copy - Copies physically - - - - &reftitle.description; - - hw_api_contenthw_api::copy - arrayparameter - - - This function will make a physical copy including the content if it - exists and returns the new object or an error object. - - - - - &reftitle.parameters; - - - - parameter - - - The parameter array contains the required elements 'objectIdentifier' - and 'destinationParentIdentifier'. The optional parameter is - 'attributeSelector'` - - - - - - - - - &reftitle.returnvalues; - - Returns the copied object. - - - - - &reftitle.seealso; - - - - - - - - - - - diff --git a/reference/hwapi/hw_api/dbstat.xml b/reference/hwapi/hw_api/dbstat.xml deleted file mode 100644 index 259f51e24f2b..000000000000 --- a/reference/hwapi/hw_api/dbstat.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - hw_api::dbstat - Returns statistics about database server - - - - &reftitle.description; - - hw_api_objecthw_api::dbstat - arrayparameter - - - Returns statistics about database server. - - - - - &reftitle.parameters; - - - - parameter - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - - - - - - - - - - - diff --git a/reference/hwapi/hw_api/dcstat.xml b/reference/hwapi/hw_api/dcstat.xml deleted file mode 100644 index 60acb836394e..000000000000 --- a/reference/hwapi/hw_api/dcstat.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - hw_api::dcstat - Returns statistics about document cache server - - - - &reftitle.description; - - hw_api_objecthw_api::dcstat - arrayparameter - - - Returns statistics about document cache server. - - - - - &reftitle.parameters; - - - - parameter - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - - - - - - - - - - - diff --git a/reference/hwapi/hw_api/dstanchors.xml b/reference/hwapi/hw_api/dstanchors.xml deleted file mode 100644 index 46a101415f95..000000000000 --- a/reference/hwapi/hw_api/dstanchors.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - hw_api::dstanchors - Returns a list of all destination anchors - - - - &reftitle.description; - - arrayhw_api::dstanchors - arrayparameter - - - Retrieves all destination anchors of an object. - - - - - &reftitle.parameters; - - - - parameter - - - The parameter array contains the required element 'objectIdentifier' - and the optional elements 'attributeSelector' and 'objectQuery'. - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/hwapi/hw_api/dstofsrcanchor.xml b/reference/hwapi/hw_api/dstofsrcanchor.xml deleted file mode 100644 index 8fdb4583f4b2..000000000000 --- a/reference/hwapi/hw_api/dstofsrcanchor.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - hw_api::dstofsrcanchor - Returns destination of a source anchor - - - - &reftitle.description; - - hw_api_objecthw_api::dstofsrcanchor - arrayparameter - - - Retrieves the destination object pointed by the specified source anchors. - The destination object can either be a destination anchor or a whole - document. - - - - - &reftitle.parameters; - - - - parameter - - - The parameters array contains the required element 'objectIdentifier' - and the optional element 'attributeSelector'. - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - - - - - - - - - - - diff --git a/reference/hwapi/hw_api/find.xml b/reference/hwapi/hw_api/find.xml deleted file mode 100644 index 2eb0e8c71013..000000000000 --- a/reference/hwapi/hw_api/find.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - hw_api::find - Search for objects - - - - &reftitle.description; - - arrayhw_api::find - arrayparameter - - - This functions searches for objects either by executing a key or/and full - text query. The found objects can further be filtered by an optional - object query. They are sorted by their importance. The second search - operation is relatively slow and its result can be limited to a certain - number of hits. This allows to perform an incremental search, each - returning just a subset of all found documents, starting at a given - index. - - - - - &reftitle.parameters; - - - - parameter - - - The parameter array contains the 'keyquery' or/and 'fulltextquery' - depending on who you would like to search. Optional parameters are - 'objectquery', 'scope', 'languages' and 'attributeselector'. In case - of an incremental search the optional parameters 'startIndex', - 'numberOfObjectsToGet' and 'exactMatchUnit' can be passed. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/hwapi/hw_api/ftstat.xml b/reference/hwapi/hw_api/ftstat.xml deleted file mode 100644 index 19859829f274..000000000000 --- a/reference/hwapi/hw_api/ftstat.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - hw_api::ftstat - Returns statistics about fulltext server - - - - &reftitle.description; - - hw_api_objecthw_api::ftstat - arrayparameter - - - Returns statistics about fulltext server. - - - - - &reftitle.parameters; - - - - parameter - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - - - - - - - - - - - diff --git a/reference/hwapi/hw_api/hwstat.xml b/reference/hwapi/hw_api/hwstat.xml deleted file mode 100644 index de005dccc79a..000000000000 --- a/reference/hwapi/hw_api/hwstat.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - hw_api::hwstat - Returns statistics about Hyperwave server - - - - &reftitle.description; - - hw_api_objecthw_api::hwstat - arrayparameter - - - Returns statistics about Hyperwave server. - - - - - &reftitle.parameters; - - - - parameter - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - - - - - - - - - - - diff --git a/reference/hwapi/hw_api/identify.xml b/reference/hwapi/hw_api/identify.xml deleted file mode 100644 index 4be5d542823f..000000000000 --- a/reference/hwapi/hw_api/identify.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - hw_api::identify - Log into Hyperwave Server - - - - &reftitle.description; - - boolhw_api::identify - arrayparameter - - - Logs into the Hyperwave Server. - - - - - &reftitle.parameters; - - - - parameter - - - The parameter array must contain the elements 'username' and - 'password'. - - - - - - - - - &reftitle.returnvalues; - - Returns an object of typeHW_API_Error if - identification failed or &true; if it was successful. - - - - - - diff --git a/reference/hwapi/hw_api/info.xml b/reference/hwapi/hw_api/info.xml deleted file mode 100644 index c92fad9ddc78..000000000000 --- a/reference/hwapi/hw_api/info.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - hw_api::info - Returns information about server configuration - - - - &reftitle.description; - - arrayhw_api::info - arrayparameter - - - Returns information about server configuration. - - - - - &reftitle.parameters; - - - - parameter - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - - - - - - - - - - - - diff --git a/reference/hwapi/hw_api/insert.xml b/reference/hwapi/hw_api/insert.xml deleted file mode 100644 index ca8a4e7a5636..000000000000 --- a/reference/hwapi/hw_api/insert.xml +++ /dev/null @@ -1,125 +0,0 @@ - - - - - hw_api::insert - Inserts a new object - - - - &reftitle.description; - - hw_api_objecthw_api::insert - arrayparameter - - - Insert a new object. The object type can be user, group, document or - anchor. Depending on the type other object attributes has to be set. - - - - - &reftitle.parameters; - - - - parameter - - - The parameter array contains the required elements 'object' and 'content' - (if the object is a document) and the optional parameters 'parameters', - 'mode' and 'attributeSelector'. The 'object' must contain all attributes - of the object. 'parameters' is an object as well holding further - attributes like the destination (attribute key is 'Parent'). 'content' is - the content of the document. 'mode' can be a - combination of the following flags: - - - HW_API_INSERT_NORMAL - - - The object in inserted into the server. - - - - - HW_API_INSERT_FORCE_VERSION_CONTROL - - - - - - - HW_API_INSERT_AUTOMATIC_CHECKOUT - - - - - - - HW_API_INSERT_PLAIN - - - - - - - HW_API_INSERT_KEEP_TIME_MODIFIED - - - - - - - HW_API_INSERT_DELAY_INDEXING - - - - - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/hwapi/hw_api/insertanchor.xml b/reference/hwapi/hw_api/insertanchor.xml deleted file mode 100644 index dc7f261936d5..000000000000 --- a/reference/hwapi/hw_api/insertanchor.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - hw_api::insertanchor - Inserts a new object of type anchor - - - - &reftitle.description; - - hw_api_objecthw_api::insertanchor - arrayparameter - - - This function is a shortcut for hwapi_insert. It - inserts an object of type anchor and sets some of the attributes - required for an anchor. - - - - - &reftitle.parameters; - - - - parameter - - - The parameter array contains the required elements 'object' and - 'documentIdentifier' and the optional elements 'destinationIdentifier', - 'parameter', 'hint' and 'attributeSelector'. The 'documentIdentifier' - specifies the document where the anchor shall be inserted. The target - of the anchor is set in 'destinationIdentifier' if it already exists. - If the target does not exists the element 'hint' has to be set to the - name of object which is supposed to be inserted later. Once it is - inserted the anchor target is resolved automatically. - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - - - - - - - - - - - diff --git a/reference/hwapi/hw_api/insertcollection.xml b/reference/hwapi/hw_api/insertcollection.xml deleted file mode 100644 index 8e844d982567..000000000000 --- a/reference/hwapi/hw_api/insertcollection.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - hw_api::insertcollection - Inserts a new object of type collection - - - - &reftitle.description; - - hw_api_objecthw_api::insertcollection - arrayparameter - - - This function is a shortcut for hwapi_insert. It - inserts an object of type collection and sets some of the attributes - required for a collection. - - - - - &reftitle.parameters; - - - - parameter - - - The parameter array contains the required elements 'object' and - 'parentIdentifier' and the optional elements 'parameter' and - 'attributeSelector'. See hwapi_insert for the - meaning of each element. - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - - - - - - - - - - - diff --git a/reference/hwapi/hw_api/insertdocument.xml b/reference/hwapi/hw_api/insertdocument.xml deleted file mode 100644 index 7a1838ad1e9b..000000000000 --- a/reference/hwapi/hw_api/insertdocument.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - hw_api::insertdocument - Inserts a new object of type document - - - - &reftitle.description; - - hw_api_objecthw_api::insertdocument - arrayparameter - - - This function is a shortcut for hwapi_insert. It - inserts an object with content and sets some of the attributes required - for a document. - - - - - &reftitle.parameters; - - - - parameter - - - The parameter array contains the required elements 'object', - 'parentIdentifier' and 'content' and the optional elements 'mode', - 'parameter' and 'attributeSelector'. - - - See hwapi_insert for the meaning of each element. - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - - - - - - - - - - - diff --git a/reference/hwapi/hw_api/link.xml b/reference/hwapi/hw_api/link.xml deleted file mode 100644 index 8fa1677fcf82..000000000000 --- a/reference/hwapi/hw_api/link.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - hw_api::link - Creates a link to an object - - - - &reftitle.description; - - boolhw_api::link - arrayparameter - - - Creates a link to an object. Accessing this link is like accessing the - object to links points to. - - - - - &reftitle.parameters; - - - - parameter - - - The parameter array contains the required elements 'objectIdentifier' - and 'destinationParentIdentifier'. 'destinationParentIdentifier' is - the target collection. - - - - - - - - - &reftitle.returnvalues; - - The function returns &true; on success or an error object. - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/hwapi/hw_api/lock.xml b/reference/hwapi/hw_api/lock.xml deleted file mode 100644 index 867f9b0386f6..000000000000 --- a/reference/hwapi/hw_api/lock.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - hw_api::lock - Locks an object - - - - &reftitle.description; - - boolhw_api::lock - arrayparameter - - - Locks an object for exclusive editing by the user calling this function. - The object can be only unlocked by this user or the system user. - - - - - &reftitle.parameters; - - - - parameter - - - The parameter array contains the required element 'objectIdentifier' - and the optional parameters 'mode' and 'objectquery'. - - - 'mode' determines how an object is locked. - HW_API_LOCK_NORMAL means, an object is locked - until it is unlocked. HW_API_LOCK_RECURSIVE is - only valid for collection and locks all objects within the collection - and possible subcollections. HW_API_LOCK_SESSION - means, an object is locked only as long as the session is valid. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - - - - - - - - - diff --git a/reference/hwapi/hw_api/move.xml b/reference/hwapi/hw_api/move.xml deleted file mode 100644 index 91d6e0b145ee..000000000000 --- a/reference/hwapi/hw_api/move.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - hw_api::move - Moves object between collections - - - - &reftitle.description; - - boolhw_api::move - arrayparameter - - - Moves object between collections. - - - - - &reftitle.parameters; - - - - parameter - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - hw_objrec2array - - - - - - - diff --git a/reference/hwapi/hw_api/object.xml b/reference/hwapi/hw_api/object.xml deleted file mode 100644 index c0557f1518a6..000000000000 --- a/reference/hwapi/hw_api/object.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - hw_api::object - Retrieve attribute information - - - - &reftitle.description; - - hw_api_objecthw_api::object - arrayparameter - - - This function retrieves the attribute information of an object of any - version. It will not return the document content. - - - - - &reftitle.parameters; - - - - parameter - - - The parameter array contains the required elements 'objectIdentifier' - and the optional elements 'attributeSelector' and 'version'. - - - - - - - - - &reftitle.returnvalues; - - The returned object is an instance of class - HW_API_Object on success or - HW_API_Error if an error occurred. - - - - - &reftitle.examples; - - This simple example retrieves an object and checks for errors. - - Retrieve an object - -reason(0); - echo "Type: "; - switch ($reason->type()) { - case 0: - echo "Error"; - break; - case 1: - echo "Warning"; - break; - case 2: - echo "Message"; - break; - } - echo "
\n"; - echo "Description: " . $reason->description("en") . "
\n"; -} - -function list_attr($obj) -{ - echo "\n"; - $count = $obj->count(); - for ($i=0; $i<$count; $i++) { - $attr = $obj->attribute($i); - printf("\n", - $attr->key(), $attr->value()); - } - echo "
%s%s
\n"; -} - -$hwapi = hwapi_hgcsp($g_config[HOSTNAME]); -$parms = array("objectIdentifier"=>"rootcollection", "attributeSelector"=>array("Title", "Name", "DocumentType")); -$root = $hwapi->object($parms); -if (get_class($root) == "HW_API_Error") { - handle_error($root); - exit; -} -list_attr($root); -?> -]]> - - - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/hwapi/hw_api/objectbyanchor.xml b/reference/hwapi/hw_api/objectbyanchor.xml deleted file mode 100644 index 3730286ad3c2..000000000000 --- a/reference/hwapi/hw_api/objectbyanchor.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - hw_api::objectbyanchor - Returns the object an anchor belongs to - - - - &reftitle.description; - - hw_api_objecthw_api::objectbyanchor - arrayparameter - - - This function retrieves an object the specified anchor belongs to. - - - - - &reftitle.parameters; - - - - parameter - - - The parameter array contains the required element 'objectIdentifier' - and the optional element 'attributeSelector'. - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - - - - - - - - - - - diff --git a/reference/hwapi/hw_api/parents.xml b/reference/hwapi/hw_api/parents.xml deleted file mode 100644 index 8c4fb535cf62..000000000000 --- a/reference/hwapi/hw_api/parents.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - hw_api::parents - Returns parents of an object - - - - &reftitle.description; - - arrayhw_api::parents - arrayparameter - - - Retrieves the parents of an object. The parents can be further filtered by - specifying an object query. - - - - - &reftitle.parameters; - - - - parameter - - - The parameter array contains the required elements 'objectidentifier' - and the optional elements 'attributeselector' and 'objectquery'. - - - - - - - - - &reftitle.returnvalues; - - The return value is an array of objects of type - HW_API_Object or - HW_API_Error. - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/hwapi/hw_api/remove.xml b/reference/hwapi/hw_api/remove.xml deleted file mode 100644 index 857029ff6c26..000000000000 --- a/reference/hwapi/hw_api/remove.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - hw_api::remove - Delete an object - - - - &reftitle.description; - - boolhw_api::remove - arrayparameter - - - Removes an object from the specified parent. Collections - will be removed recursively. - - - - - &reftitle.parameters; - - - - parameter - - - You can pass an optional object query to remove only those objects - which match the query. An object will be deleted physically if it is - the last instance. - - - The parameter array contains the required elements 'objectidentifier' - and 'parentidentifier'. If you want to remove a user or group - 'parentidentifier' can be skipped. - - - The optional parameter 'mode' determines how the deletion is - performed. In normal mode the object will not be removed physically - until all instances are removed. In physical mode all instances of the - object will be deleted immediately. In removelinks mode all references - to and from the objects will be deleted as well. In nonrecursive the - deletion is not performed recursive. Removing a collection which is - not empty will cause an error. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/hwapi/hw_api/replace.xml b/reference/hwapi/hw_api/replace.xml deleted file mode 100644 index 1c06134a6da8..000000000000 --- a/reference/hwapi/hw_api/replace.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - hw_api::replace - Replaces an object - - - - &reftitle.description; - - hw_api_objecthw_api::replace - arrayparameter - - - Replaces the attributes and the content of an object. - - - - - &reftitle.parameters; - - - - parameter - - - The parameter array contains the required elements 'objectIdentifier' - and 'object' and the optional parameters 'content', 'parameters', - 'mode' and 'attributeSelector'. 'objectIdentifier' contains the object - to be replaced. 'object' contains the new object. 'content' contains - the new content. 'parameters' contain extra information for HTML - documents. HTML_Language is the letter abbreviation of the language of - the title. HTML_Base sets the base attribute of the HTML document. - - - 'mode' can be a combination of the following flags: - - - HW_API_REPLACE_NORMAL - - - The object on the server is replace with the object passed. - - - - - HW_API_REPLACE_FORCE_VERSION_CONTROL - - - - - - - HW_API_REPLACE_AUTOMATIC_CHECKOUT - - - - - - - HW_API_REPLACE_AUTOMATIC_CHECKIN - - - - - - - HW_API_REPLACE_PLAIN - - - - - - - HW_API_REPLACE_REVERT_IF_NOT_CHANGED - - - - - - - HW_API_REPLACE_KEEP_TIME_MODIFIED - - - - - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/hwapi/hw_api/setcommittedversion.xml b/reference/hwapi/hw_api/setcommittedversion.xml deleted file mode 100644 index 965ba7f23507..000000000000 --- a/reference/hwapi/hw_api/setcommittedversion.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - hw_api::setcommittedversion - Commits version other than last version - - - - &reftitle.description; - - hw_api_objecthw_api::setcommittedversion - arrayparameter - - - Commits a version of a document. The committed version is the one which is - visible to users with read access. By default the last version is the - committed version. - - - - - &reftitle.parameters; - - - - parameter - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - - - - - - - - - - - diff --git a/reference/hwapi/hw_api/srcanchors.xml b/reference/hwapi/hw_api/srcanchors.xml deleted file mode 100644 index f107c29b9a75..000000000000 --- a/reference/hwapi/hw_api/srcanchors.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - hw_api::srcanchors - Returns a list of all source anchors - - - - &reftitle.description; - - arrayhw_api::srcanchors - arrayparameter - - - Retrieves all source anchors of an object. - - - - - &reftitle.parameters; - - - - parameter - - - The parameter array contains the required element 'objectIdentifier' - and the optional elements 'attributeSelector' and 'objectQuery'. - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/hwapi/hw_api/srcsofdst.xml b/reference/hwapi/hw_api/srcsofdst.xml deleted file mode 100644 index 8490fff3d963..000000000000 --- a/reference/hwapi/hw_api/srcsofdst.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - hw_api::srcsofdst - Returns source of a destination object - - - - &reftitle.description; - - arrayhw_api::srcsofdst - arrayparameter - - - Retrieves all the source anchors pointing to the specified destination. - The destination object can either be a destination anchor or a whole - document. - - - - - &reftitle.parameters; - - - - parameter - - - The parameters array contains the required element 'objectIdentifier' - and the optional element 'attributeSelector' and 'objectQuery'. The - function returns an array of objects or an error. - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/hwapi/hw_api/unlock.xml b/reference/hwapi/hw_api/unlock.xml deleted file mode 100644 index 9715ef853623..000000000000 --- a/reference/hwapi/hw_api/unlock.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - hw_api::unlock - Unlocks a locked object - - - - &reftitle.description; - - boolhw_api::unlock - arrayparameter - - - Unlocks a locked object. Only the user who has locked the object and the - system user may unlock an object. - - - - - &reftitle.parameters; - - - - parameter - - - The parameter array contains the required element 'objectIdentifier' - and the optional parameters 'mode' and 'objectquery'. The meaning of - 'mode' is the same as in function hwapi_lock. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success or an object of class HW_API_Error. - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/hwapi/hw_api/user.xml b/reference/hwapi/hw_api/user.xml deleted file mode 100644 index c6804df64b16..000000000000 --- a/reference/hwapi/hw_api/user.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - hw_api::user - Returns the own user object - - - - &reftitle.description; - - hw_api_objecthw_api::user - arrayparameter - - - Returns the own user object. - - - - - &reftitle.parameters; - - - - parameter - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/hwapi/hw_api/userlist.xml b/reference/hwapi/hw_api/userlist.xml deleted file mode 100644 index fed77839febd..000000000000 --- a/reference/hwapi/hw_api/userlist.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - hw_api::userlist - Returns a list of all logged in users - - - - &reftitle.description; - - arrayhw_api::userlist - arrayparameter - - - Returns a list of all logged in users. - - - - - &reftitle.parameters; - - - - parameter - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/hwapi/hw_api_attribute/key.xml b/reference/hwapi/hw_api_attribute/key.xml deleted file mode 100644 index 5eb281d5786e..000000000000 --- a/reference/hwapi/hw_api_attribute/key.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - hw_api_attribute::key - Returns key of the attribute - - - - &reftitle.description; - - stringhw_api_attribute::key - - - - Returns the name of the attribute. - - - - - &reftitle.returnvalues; - - Returns the name of the attribute as a string. - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/hwapi/hw_api_attribute/langdepvalue.xml b/reference/hwapi/hw_api_attribute/langdepvalue.xml deleted file mode 100644 index 8c8de227b3a1..000000000000 --- a/reference/hwapi/hw_api_attribute/langdepvalue.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - hw_api_attribute::langdepvalue - Returns value for a given language - - - - &reftitle.description; - - stringhw_api_attribute::langdepvalue - stringlanguage - - - Returns the value in the given language of the attribute. - - - - - &reftitle.parameters; - - - - language - - - - - - - - - - - &reftitle.returnvalues; - - Returns the value of the attribute as a string. - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/hwapi/hw_api_attribute/value.xml b/reference/hwapi/hw_api_attribute/value.xml deleted file mode 100644 index e21a4f9c8676..000000000000 --- a/reference/hwapi/hw_api_attribute/value.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - hw_api_attribute::value - Returns value of the attribute - - - - &reftitle.description; - - stringhw_api_attribute::value - - - - Gets the value of the attribute. - - - - - &reftitle.returnvalues; - - Returns the value, as a string. - - - - - &reftitle.seealso; - - - - - - - - - - - diff --git a/reference/hwapi/hw_api_attribute/values.xml b/reference/hwapi/hw_api_attribute/values.xml deleted file mode 100644 index 6ae03b47e076..000000000000 --- a/reference/hwapi/hw_api_attribute/values.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - hw_api_attribute::values - Returns all values of the attribute - - - - &reftitle.description; - - arrayhw_api_attribute::values - - - - Gets all values of the attribute. - - - - - &reftitle.returnvalues; - - Returns an array of attribute values. - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/hwapi/hw_api_content/mimetype.xml b/reference/hwapi/hw_api_content/mimetype.xml deleted file mode 100644 index 3eaf301c4343..000000000000 --- a/reference/hwapi/hw_api_content/mimetype.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - hw_api_content::mimetype - Returns mimetype - - - - &reftitle.description; - - stringhw_api_content::mimetype - - - - Returns the mimetype of the content. - - - - - &reftitle.returnvalues; - - Returns the mimetype as a string. - - - - - - diff --git a/reference/hwapi/hw_api_content/read.xml b/reference/hwapi/hw_api_content/read.xml deleted file mode 100644 index 6153c6792e67..000000000000 --- a/reference/hwapi/hw_api_content/read.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - hw_api_content::read - Read content - - - - &reftitle.description; - - stringhw_api_content::read - stringbuffer - intlen - - - Reads len bytes from the content into the given - buffer. - - - - - &reftitle.parameters; - - - - buffer - - - - - - - len - - - Number of bytes to read. - - - - - - - - - &reftitle.returnvalues; - - - - - - - - diff --git a/reference/hwapi/hw_api_error/count.xml b/reference/hwapi/hw_api_error/count.xml deleted file mode 100644 index 656f6d34e5fa..000000000000 --- a/reference/hwapi/hw_api_error/count.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - hw_api_error::count - Returns number of reasons - - - - &reftitle.description; - - inthw_api_error::count - - - - Returns the number of error reasons. - - - - - &reftitle.returnvalues; - - Returns the number of errors, as an integer. - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/hwapi/hw_api_error/reason.xml b/reference/hwapi/hw_api_error/reason.xml deleted file mode 100644 index f023fab28388..000000000000 --- a/reference/hwapi/hw_api_error/reason.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - hw_api_error::reason - Returns reason of error - - - - &reftitle.description; - - HW_API_Reasonhw_api_error::reason - - - - Returns the first error reason. - - - - - &reftitle.returnvalues; - - - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/hwapi/hw_api_object/assign.xml b/reference/hwapi/hw_api_object/assign.xml deleted file mode 100644 index c8863c85e29b..000000000000 --- a/reference/hwapi/hw_api_object/assign.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - hw_api_object::assign - Clones object - - - - &reftitle.description; - - boolhw_api_object::assign - arrayparameter - - - Clones the attributes of an object. - - - - - &reftitle.parameters; - - - - parameter - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/hwapi/hw_api_object/attreditable.xml b/reference/hwapi/hw_api_object/attreditable.xml deleted file mode 100644 index 6b458eea65f3..000000000000 --- a/reference/hwapi/hw_api_object/attreditable.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - hw_api_object::attreditable - Checks whether an attribute is editable - - - - &reftitle.description; - - boolhw_api_object::attreditable - arrayparameter - - - Checks whether an attribute is editable. - - - - - &reftitle.parameters; - - - - parameter - - - - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the attribute is editable, &false; otherwise. - - - - - - diff --git a/reference/hwapi/hw_api_object/count.xml b/reference/hwapi/hw_api_object/count.xml deleted file mode 100644 index 1addc843c977..000000000000 --- a/reference/hwapi/hw_api_object/count.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - hw_api_object::count - Returns number of attributes - - - - &reftitle.description; - - inthw_api_object::count - arrayparameter - - - Returns the number of attributes. - - - - - &reftitle.parameters; - - - - parameter - - - - - - - - - - - &reftitle.returnvalues; - - Returns the number as an integer. - - - - - - diff --git a/reference/hwapi/hw_api_object/insert.xml b/reference/hwapi/hw_api_object/insert.xml deleted file mode 100644 index e7e2945538f7..000000000000 --- a/reference/hwapi/hw_api_object/insert.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - hw_api_object::insert - Inserts new attribute - - - - &reftitle.description; - - boolhw_api_object::insert - HW_API_Attributeattribute - - - Adds an attribute to the object. - - - - - &reftitle.parameters; - - - - attribute - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/hwapi/hw_api_object/remove.xml b/reference/hwapi/hw_api_object/remove.xml deleted file mode 100644 index 3b0ae69cad9e..000000000000 --- a/reference/hwapi/hw_api_object/remove.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - hw_api_object::remove - Removes attribute - - - - &reftitle.description; - - boolhw_api_object::remove - stringname - - - Removes the attribute with the given name. - - - - - &reftitle.parameters; - - - - name - - - The attribute name. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/hwapi/hw_api_object/title.xml b/reference/hwapi/hw_api_object/title.xml deleted file mode 100644 index 14fe11c401f1..000000000000 --- a/reference/hwapi/hw_api_object/title.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - hw_api_object::title - Returns the title attribute - - - - &reftitle.description; - - stringhw_api_object::title - arrayparameter - - - Returns the title attribute. - - - - - &reftitle.parameters; - - - - parameter - - - - - - - - - - - &reftitle.returnvalues; - - Returns the title as a string. - - - - - - diff --git a/reference/hwapi/hw_api_object/value.xml b/reference/hwapi/hw_api_object/value.xml deleted file mode 100644 index 0ade314f3730..000000000000 --- a/reference/hwapi/hw_api_object/value.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - hw_api_object::value - Returns value of attribute - - - - &reftitle.description; - - stringhw_api_object::value - stringname - - - Returns value of an attribute. - - - - - &reftitle.parameters; - - - - name - - - The attribute name. - - - - - - - - - &reftitle.returnvalues; - - Returns the value of the attribute with the given name or &false; if an - error occurred. - - - - - - diff --git a/reference/hwapi/hw_api_reason/description.xml b/reference/hwapi/hw_api_reason/description.xml deleted file mode 100644 index 7c300985cabf..000000000000 --- a/reference/hwapi/hw_api_reason/description.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - hw_api_reason::description - Returns description of reason - - - - &reftitle.description; - - stringhw_api_reason::description - - - - Returns the description of a reason - - - - - &reftitle.returnvalues; - - Returns the description, as a string. - - - - - - diff --git a/reference/hwapi/hw_api_reason/type.xml b/reference/hwapi/hw_api_reason/type.xml deleted file mode 100644 index e1adea2ae214..000000000000 --- a/reference/hwapi/hw_api_reason/type.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - hw_api_reason::type - Returns type of reason - - - - &reftitle.description; - - HW_API_Reasonhw_api_reason::type - - - - Returns the type of a reason. - - - - - &reftitle.returnvalues; - - Returns an instance of HW_API_Reason. - - - - - - diff --git a/reference/hwapi/ini.xml b/reference/hwapi/ini.xml deleted file mode 100644 index 20b093276c4c..000000000000 --- a/reference/hwapi/ini.xml +++ /dev/null @@ -1,52 +0,0 @@ - - -
- &reftitle.runtime; - &extension.runtime; - - - Hyperwave API configuration options - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - hwapi.allow_persistent - "0" - PHP_INI_SYSTEM - - - - -
- &ini.php.constants; - -
- - - diff --git a/reference/hwapi/reference.xml b/reference/hwapi/reference.xml deleted file mode 100644 index dc6ee7d653e1..000000000000 --- a/reference/hwapi/reference.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - Hyperwave API &Functions; - - -
- Integration with Apache - - The integration with Apache and possible other servers has been - described in the separate chapter. - -
- - -
- Classes - - The API provided by the HW_API extension is fully object oriented. - It is very similar to the C++ interface of the Hyperwave SDK. - It consist of the following classes. - - - - HW_API - - - - - HW_API_Object - - - - - HW_API_Attribute - - - - - HW_API_Error - - - - - HW_API_Content - - - - - HW_API_Reason - - - - Some basic classes like HW_API_String, - HW_API_String_Array, etc., which exist in the - Hyperwave SDK have not been implemented since PHP has powerful - replacements for them. - - - Each class has certain method, whose names are identical to its - counterparts in the Hyperwave SDK. Passing arguments to this function - differs from all the other PHP extensions but is close to the C++ API of - the HW SDK. Instead of passing several parameters they are all put into - an associated array and passed as one parameter. The names of the keys - are identical to those documented in the HW SDK. The common parameters - are listed below. If other parameters are required they will be - documented if needed. - - - - objectIdentifier The name or id of an object, - e.g. "rootcollection", "0x873A8768 0x00000002". - - - - - parentIdentifier The name or id of an object - which is considered to be a parent. - - - - - object An instance of class HW_API_Object. - - - - - parameters An instance of class HW_API_Object. - - - - - version The version of an object. - - - - - mode An integer value determine the way an - operation is executed. - - - - - attributeSelector Any array of strings, each - containing a name of an attribute. This is used if you retrieve the - object record and want to include certain attributes. - - - - - objectQuery A query to select certain object - out of a list of objects. This is used to reduce the number of objects - which was delivered by a function like - hw_api::children or hw_api::find. - - - - - - - Methods returning boolean can return &true;, &false; or - HW_API_Error object. - - -
- - -&reference.hwapi.entities.hw-api; -&reference.hwapi.entities.hw-api-attribute; -&reference.hwapi.entities.hw-api-content; -&reference.hwapi.entities.hw-api-error; -&reference.hwapi.entities.hw-api-object; -&reference.hwapi.entities.hw-api-reason; -&reference.hwapi.entities.functions; - - - diff --git a/reference/hwapi/setup.xml b/reference/hwapi/setup.xml deleted file mode 100644 index 438879790cc4..000000000000 --- a/reference/hwapi/setup.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - &reftitle.setup; - - -
- &reftitle.required; - - Since 2001 there is a Hyperwave SDK available. It supports Java, - JavaScript and C++. This PHP Extension is based on the C++ interface. - In order to activate the hwapi support in PHP you will have to install - the Hyperwave SDK first. - -
- - - - &reference.hwapi.configure; - - - - &reference.hwapi.ini; - - - -
- &reftitle.resources; - &no.resource; -
- - - - - - diff --git a/reference/hwapi/versions.xml b/reference/hwapi/versions.xml deleted file mode 100644 index 70fcdcda7576..000000000000 --- a/reference/hwapi/versions.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/ibase/functions/ibase-query.xml b/reference/ibase/functions/ibase-query.xml index 07a8b6aeaf71..337057304294 100644 --- a/reference/ibase/functions/ibase-query.xml +++ b/reference/ibase/functions/ibase-query.xml @@ -80,32 +80,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.1 - - On success the function now returns &true; if there were no - affected rows, where it previously returned 0 - (a zero followed by an empty space). - - - - - - - - &reftitle.examples; diff --git a/reference/iconv/functions/iconv.xml b/reference/iconv/functions/iconv.xml index de12e5c55044..c9a89b028cb9 100644 --- a/reference/iconv/functions/iconv.xml +++ b/reference/iconv/functions/iconv.xml @@ -79,32 +79,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - Since this version, the function returns &false; on illegal characters, - unless //IGNORE is specified in output charset. - Before, it returned partial output string. - - - - - - - - &reftitle.examples; diff --git a/reference/id3/book.xml b/reference/id3/book.xml deleted file mode 100644 index d7b51cc0fae3..000000000000 --- a/reference/id3/book.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - ID3 Tags - ID3 - - - - &reftitle.intro; - - These functions let you read and manipulate ID3 tags. - ID3 tags are used in MP3 files to store title of the song, as well - as information about the artist, album, genre, year and track - number. - - - Since version 0.2 it is also possible to extract text frames from - ID3 v2.2+ tags. - - - - - &reference.id3.setup; - &reference.id3.constants; - &reference.id3.reference; - - - - - diff --git a/reference/id3/constants.xml b/reference/id3/constants.xml deleted file mode 100644 index b019b4471915..000000000000 --- a/reference/id3/constants.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - Predefined Constants - - Most of the id3 functions either let you specify - or return a tag version. In order to specify the version - please use on of these constants. - - - - - - ID3_V1_0 - (integer) - - - - ID3_V1_0 is used if you are working with - ID3 V1.0 tags. These tags may contain the fields title, artist, - album, genre, year and comment. - - - - - - ID3_V1_1 - (integer) - - - - ID3_V1_1 is used if you are working with - ID3 V1.1 tags. These tags may all information contained in v1.0 - tags plus the track number. - - - - - - ID3_V2_1 - (integer) - - - - ID3_V2_1 is used if you are working with - ID3 V2.1 tags. - - - - - - ID3_V2_2 - (integer) - - - - ID3_V2_2 is used if you are working with - ID3 V2.2 tags. - - - - - - ID3_V2_3 - (integer) - - - - ID3_V2_3 is used if you are working with - ID3 V2.3 tags. - - - - - - ID3_V2_4 - (integer) - - - - ID3_V2_4 is used if you are working with - ID3 V2.4 tags. - - - - - - ID3_BEST - (integer) - - - - ID3_BEST is used if would like to let the id3 functions - determine which tag version should be used. - - - - - - - - diff --git a/reference/id3/functions/id3-get-frame-long-name.xml b/reference/id3/functions/id3-get-frame-long-name.xml deleted file mode 100644 index 4e64ff43ea63..000000000000 --- a/reference/id3/functions/id3-get-frame-long-name.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - id3_get_frame_long_name - Get the long name of an ID3v2 frame - - - &reftitle.description; - - stringid3_get_frame_long_name - stringframeId - - - id3_get_frame_long_name returns the long name for an - ID3v2 frame. - - - - &reftitle.parameters; - - - - frameId - - - An ID3v2 frame - - - - - - - - &reftitle.returnvalues; - - Returns the frame long name or &false; on errors. - - - - &reftitle.examples; - - - <function>id3_get_frame_long_name</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - - id3_get_frame_short_name - - - - - - diff --git a/reference/id3/functions/id3-get-frame-short-name.xml b/reference/id3/functions/id3-get-frame-short-name.xml deleted file mode 100644 index 621b6d458d94..000000000000 --- a/reference/id3/functions/id3-get-frame-short-name.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - id3_get_frame_short_name - Get the short name of an ID3v2 frame - - - &reftitle.description; - - stringid3_get_frame_short_name - stringframeId - - - id3_get_frame_short_name returns the short name for an - ID3v2 frame. - - - - &reftitle.parameters; - - - - frameId - - - An ID3v2 frame - - - - - - - - &reftitle.returnvalues; - - 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. - - - - &reftitle.examples; - - - <function>id3_get_frame_short_name</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - - id3_get_frame_long_name - - - - - - diff --git a/reference/id3/functions/id3-get-genre-id.xml b/reference/id3/functions/id3-get-genre-id.xml deleted file mode 100644 index 645671b589ea..000000000000 --- a/reference/id3/functions/id3-get-genre-id.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - id3_get_genre_id - Get the id for a genre - - - &reftitle.description; - - intid3_get_genre_id - stringgenre - - - id3_get_genre_id returns the id for a genre. - - - - &reftitle.parameters; - - - - genre - - - Genre name as string. - - - - - - - - &reftitle.returnvalues; - - The genre id or &false; on errors. - - - - &reftitle.examples; - - - <function>id3_get_genre_id</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - - id3_get_genre_name - id3_get_genre_list - - - - - - diff --git a/reference/id3/functions/id3-get-genre-list.xml b/reference/id3/functions/id3-get-genre-list.xml deleted file mode 100644 index 98c18d187545..000000000000 --- a/reference/id3/functions/id3-get-genre-list.xml +++ /dev/null @@ -1,234 +0,0 @@ - - - - - id3_get_genre_list - Get all possible genre values - - - &reftitle.description; - - arrayid3_get_genre_list - - - - id3_get_genre_list returns an array containing all - possible genres that may be stored in an ID3 tag. This list has been created - by Eric Kemp and later extended by WinAmp. - - - This function is useful to provide you users a list of genres from which - they may choose one. When updating the ID3 tag you will always have to - specify the genre as an integer ranging from 0 to 147. - - - - &reftitle.returnvalues; - - Returns an array containing all possible genres that may be stored in an - ID3 tag. - - - - &reftitle.examples; - - - <function>id3_get_genre_list</function> example - - -]]> - - &example.outputs; - - Blues - [1] => Classic Rock - [2] => Country - [3] => Dance - [4] => Disco - [5] => Funk - [6] => Grunge - [7] => Hip-Hop - [8] => Jazz - [9] => Metal - [10] => New Age - [11] => Oldies - [12] => Other - [13] => Pop - [14] => R&B - [15] => Rap - [16] => Reggae - [17] => Rock - [18] => Techno - [19] => Industrial - [20] => Alternative - [21] => Ska - [22] => Death Metal - [23] => Pranks - [24] => Soundtrack - [25] => Euro-Techno - [26] => Ambient - [27] => Trip-Hop - [28] => Vocal - [29] => Jazz+Funk - [30] => Fusion - [31] => Trance - [32] => Classical - [33] => Instrumental - [34] => Acid - [35] => House - [36] => Game - [37] => Sound Clip - [38] => Gospel - [39] => Noise - [40] => Alternative Rock - [41] => Bass - [42] => Soul - [43] => Punk - [44] => Space - [45] => Meditative - [46] => Instrumental Pop - [47] => Instrumental Rock - [48] => Ethnic - [49] => Gothic - [50] => Darkwave - [51] => Techno-Industrial - [52] => Electronic - [53] => Pop-Folk - [54] => Eurodance - [55] => Dream - [56] => Southern Rock - [57] => Comedy - [58] => Cult - [59] => Gangsta - [60] => Top 40 - [61] => Christian Rap - [62] => Pop/Funk - [63] => Jungle - [64] => Native US - [65] => Cabaret - [66] => New Wave - [67] => Psychadelic - [68] => Rave - [69] => Showtunes - [70] => Trailer - [71] => Lo-Fi - [72] => Tribal - [73] => Acid Punk - [74] => Acid Jazz - [75] => Polka - [76] => Retro - [77] => Musical - [78] => Rock & Roll - [79] => Hard Rock - [80] => Folk - [81] => Folk-Rock - [82] => National Folk - [83] => Swing - [84] => Fast Fusion - [85] => Bebob - [86] => Latin - [87] => Revival - [88] => Celtic - [89] => Bluegrass - [90] => Avantgarde - [91] => Gothic Rock - [92] => Progressive Rock - [93] => Psychedelic Rock - [94] => Symphonic Rock - [95] => Slow Rock - [96] => Big Band - [97] => Chorus - [98] => Easy Listening - [99] => Acoustic - [100] => Humour - [101] => Speech - [102] => Chanson - [103] => Opera - [104] => Chamber Music - [105] => Sonata - [106] => Symphony - [107] => Booty Bass - [108] => Primus - [109] => Porn Groove - [110] => Satire - [111] => Slow Jam - [112] => Club - [113] => Tango - [114] => Samba - [115] => Folklore - [116] => Ballad - [117] => Power Ballad - [118] => Rhytmic Soul - [119] => Freestyle - [120] => Duet - [121] => Punk Rock - [122] => Drum Solo - [123] => Acapella - [124] => Euro-House - [125] => Dance Hall - [126] => Goa - [127] => Drum & Bass - [128] => Club-House - [129] => Hardcore - [130] => Terror - [131] => Indie - [132] => BritPop - [133] => Negerpunk - [134] => Polsk Punk - [135] => Beat - [136] => Christian Gangsta - [137] => Heavy Metal - [138] => Black Metal - [139] => Crossover - [140] => Contemporary C - [141] => Christian Rock - [142] => Merengue - [143] => Salsa - [144] => Thrash Metal - [145] => Anime - [146] => JPop - [147] => SynthPop -) -]]> - - - - - - &reftitle.seealso; - - - id3_get_genre_name - id3_get_genre_id - - - - - - diff --git a/reference/id3/functions/id3-get-genre-name.xml b/reference/id3/functions/id3-get-genre-name.xml deleted file mode 100644 index 7d1ff42b5a65..000000000000 --- a/reference/id3/functions/id3-get-genre-name.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - id3_get_genre_name - Get the name for a genre id - - - &reftitle.description; - - stringid3_get_genre_name - intgenre_id - - - id3_get_genre_name returns the name for a genre id. - - - - &reftitle.parameters; - - - - genre_id - - - An integer ranging from 0 to 147 - - - - - - - - &reftitle.returnvalues; - - Returns the name as a string. - - - - &reftitle.examples; - - - <function>id3_get_genre_name</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - - id3_get_genre_list - id3_get_genre_id - - - - - - diff --git a/reference/id3/functions/id3-get-tag.xml b/reference/id3/functions/id3-get-tag.xml deleted file mode 100644 index 9257a5e4c9be..000000000000 --- a/reference/id3/functions/id3-get-tag.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - id3_get_tag - Get all information stored in an ID3 tag - - - &reftitle.description; - - arrayid3_get_tag - stringfilename - intversionID3_BEST - - - id3_get_tag is used to get all information stored - in the id3 tag of the specified file. - - - - &reftitle.parameters; - - - - filename - - - The path to the MP3 file - - - Instead of a filename you may also pass a valid stream resource - - - - - version - - - Allows you to specify the version of the tag as MP3 files may contain - both, version 1.x and version 2.x tags - - - Since version 0.2 id3_get_tag also supports ID3 - tags of version 2.2, 2.3 and 2.4. To extract information from these - tags, pass one of the constants ID3_V2_2, ID3_V2_3 or ID3_V2_4 as the - second parameter. - ID3 v2.x tags can contain a lot more information about the MP3 file - than ID3 v1.x tags. - - - - - - - - &reftitle.returnvalues; - - 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. - - - - &reftitle.examples; - - - <function>id3_get_tag</function> example - - -]]> - - &example.outputs.similar; - - DN-38416 - [artist] => Re:\Legion - [album] => Reflections - [year] => 2004 - [genre] => 19 -) -]]> - - - - <function>id3_get_tag</function> example - - -]]> - - &example.outputs.similar; - - Dirty Mac - [originalArtist] => Dirty Mac - [composer] => Marcus Götze - [artist] => Dirty Mac - [title] => Little Big Man - [album] => Demo-Tape - [track] => 5/12 - [genre] => (17)Rock - [year] => 2001 -) -]]> - - - - - - &reftitle.seealso; - - - id3_set_tag - id3_remove_tag - id3_get_version - - - - - - diff --git a/reference/id3/functions/id3-get-version.xml b/reference/id3/functions/id3-get-version.xml deleted file mode 100644 index 33360acf0bb6..000000000000 --- a/reference/id3/functions/id3-get-version.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - id3_get_version - Get version of an ID3 tag - - - &reftitle.description; - - intid3_get_version - stringfilename - - - id3_get_version retrieves the version(s) of the - ID3 tag(s) in the MP3 file. - - - If a file contains an ID3 v1.1 tag, it always contains - a 1.0 tag, as version 1.1 is just an extension of 1.0. - - - - &reftitle.parameters; - - - - filename - - - The path to the MP3 file - - - Instead of a filename you may also pass a valid stream resource - - - - - - - - &reftitle.returnvalues; - - 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. - - - - &reftitle.examples; - - - <function>id3_get_version</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - &reftitle.seealso; - - - id3_set_tag - id3_get_tag - id3_remove_tag - - - - - - diff --git a/reference/id3/functions/id3-remove-tag.xml b/reference/id3/functions/id3-remove-tag.xml deleted file mode 100644 index f104e290f67e..000000000000 --- a/reference/id3/functions/id3-remove-tag.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - id3_remove_tag - Remove an existing ID3 tag - - - &reftitle.description; - - boolid3_remove_tag - stringfilename - intversionID3_V1_0 - - - id3_remove_tag is used to remove the information stored - of an ID3 tag. - - - - &reftitle.parameters; - - - - filename - - - The path to the MP3 file - - - Instead of a filename you may also pass a valid stream resource - - - - - version - - - Allows you to specify the version of the tag as MP3 files may contain - both, version 1.x and version 2.x tags. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - <function>id3_remove_tag</function> example - - -]]> - - - If the file is writable and contained a 1.0 tag, this will output: - - - - - - - - - &reftitle.notes; - - - Currently id3_remove_tag only supports version 1.0 - and 1.1. If you choose to remove a 1.0 tag and the file contains a 1.1 - tag, this tag will be removed, as v1.1 is only an extension of 1.0. - - - - - &reftitle.seealso; - - - id3_set_tag - id3_get_tag - id3_get_version - - - - - - diff --git a/reference/id3/functions/id3-set-tag.xml b/reference/id3/functions/id3-set-tag.xml deleted file mode 100644 index 099606546b2c..000000000000 --- a/reference/id3/functions/id3-set-tag.xml +++ /dev/null @@ -1,187 +0,0 @@ - - - - - id3_set_tag - Update information stored in an ID3 tag - - - &reftitle.description; - - boolid3_set_tag - stringfilename - arraytag - intversionID3_V1_0 - - - id3_set_tag is used to change the information stored - of an ID3 tag. If no tag has been present, it will be added to the file. - - - - &reftitle.parameters; - - - - filename - - - The path to the MP3 file - - - Instead of a filename you may also pass a valid stream resource - - - - - tag - - - An associative array of tag keys and values - - - The following keys may be used in the associative array: - - - - Keys in the associative array - - - - key - possible value - available in version - - - - - title - string with maximum of 30 characters - v1.0, v1.1 - - - artist - string with maximum of 30 characters - v1.0, v1.1 - - - album - string with maximum of 30 characters - v1.0, v1.1 - - - year - 4 digits - v1.0, v1.1 - - - genre - integer value between 0 and 147 - v1.0, v1.1 - - - comment - string with maximum of 30 characters (28 in v1.1) - v1.0, v1.1 - - - track - integer between 0 and 255 - v1.1 - - - -
- - - - - version - - - Allows you to specify the version of the tag as MP3 files may contain - both, version 1.x and version 2.x tags - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - <function>id3_set_tag</function> example - - "Re:Start", - "artist" => "Re:\Legion", - "comment" => "A nice track" - ); -$result = id3_set_tag( "path/to/example.mp3", $data, ID3_V1_0 ); -if ($result === true) { - echo "Tag successfully updated\n"; -} -?> -]]> - - - If the file is writable, this will output: - - - - - - - - - &reftitle.notes; - - - Currently id3_set_tag only supports version 1.0 - and 1.1. - - - - - &reftitle.seealso; - - - id3_remove_tag - id3_get_tag - id3_get_version - - - - - - diff --git a/reference/id3/reference.xml b/reference/id3/reference.xml deleted file mode 100644 index 8e0166a1d9aa..000000000000 --- a/reference/id3/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - ID3 &Functions; - - &reference.id3.entities.functions; - - - - - diff --git a/reference/id3/setup.xml b/reference/id3/setup.xml deleted file mode 100644 index 7cc746af904b..000000000000 --- a/reference/id3/setup.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - &reftitle.setup; - - -
- &reftitle.required; - &no.requirement; -
- - - -
- &reftitle.install; - - &pecl.info; - &url.pecl.package;id3. - - - &pecl.windows.download; - -
- - - -
- &reftitle.runtime; - &no.config; -
- - - -
- &reftitle.resources; - &no.resource; -
- - - - - - diff --git a/reference/id3/versions.xml b/reference/id3/versions.xml deleted file mode 100644 index 4169d77d80e5..000000000000 --- a/reference/id3/versions.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/image/functions/gd-info.xml b/reference/image/functions/gd-info.xml index 0dbe5837aa08..4665789fb2d4 100644 --- a/reference/image/functions/gd-info.xml +++ b/reference/image/functions/gd-info.xml @@ -104,36 +104,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.6.12 - - WebP Support added. - - - - 5.3.0 - - JPG Support attribute renamed to JPEG Support. - - - - - - - - &reftitle.examples; diff --git a/reference/image/functions/getimagesize.xml b/reference/image/functions/getimagesize.xml index c583c0c9cd74..f708e16e40e6 100644 --- a/reference/image/functions/getimagesize.xml +++ b/reference/image/functions/getimagesize.xml @@ -197,19 +197,6 @@ if ($size && $fp) { Added WebP support. - - 5.3.0 - - Added icon support. - - - - 5.2.3 - - Read errors generated by this function downgraded to - E_NOTICE from E_WARNING. - - diff --git a/reference/image/functions/imagecolorallocate.xml b/reference/image/functions/imagecolorallocate.xml index 345681c0fd49..9b3c5f7b0f2f 100644 --- a/reference/image/functions/imagecolorallocate.xml +++ b/reference/image/functions/imagecolorallocate.xml @@ -66,30 +66,6 @@ &return.falseproblem; - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.3 - - Returns &false; if the allocation failed. Previously - -1 was returned. - - - - - - - &reftitle.examples; diff --git a/reference/image/functions/imagecolorallocatealpha.xml b/reference/image/functions/imagecolorallocatealpha.xml index 555cb72d280b..210c1c8e3c57 100644 --- a/reference/image/functions/imagecolorallocatealpha.xml +++ b/reference/image/functions/imagecolorallocatealpha.xml @@ -67,30 +67,6 @@ &return.falseproblem; - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.3 - - Returns &false; if the allocation failed. Previously - -1 was returned. - - - - - - - &reftitle.examples; diff --git a/reference/image/functions/imagecolorclosesthwb.xml b/reference/image/functions/imagecolorclosesthwb.xml index 2a50236e24fe..3c5b08802d34 100644 --- a/reference/image/functions/imagecolorclosesthwb.xml +++ b/reference/image/functions/imagecolorclosesthwb.xml @@ -53,30 +53,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function is now available on Windows - - - - - - - - &reftitle.examples; diff --git a/reference/image/functions/imagecolorset.xml b/reference/image/functions/imagecolorset.xml index 32e40973427e..8165b3d159b3 100644 --- a/reference/image/functions/imagecolorset.xml +++ b/reference/image/functions/imagecolorset.xml @@ -72,28 +72,6 @@ - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 5.4.0 - - The alpha parameter was added. - - - - - - - &reftitle.examples; diff --git a/reference/image/functions/imagecreatefromxpm.xml b/reference/image/functions/imagecreatefromxpm.xml index 82f56aa127cc..f07edc8d20ba 100644 --- a/reference/image/functions/imagecreatefromxpm.xml +++ b/reference/image/functions/imagecreatefromxpm.xml @@ -37,28 +37,6 @@ &gd.return.identifier; - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 5.3.19 - - imagecreatefromxpm is available on Windows. - - - - - - - &reftitle.examples; diff --git a/reference/image/functions/imagefilter.xml b/reference/image/functions/imagefilter.xml index 8b2e408a3695..29155a177cf8 100644 --- a/reference/image/functions/imagefilter.xml +++ b/reference/image/functions/imagefilter.xml @@ -255,18 +255,6 @@ Scatter support (IMG_FILTER_SCATTER) was added. - - 5.3.0 - - Pixelation support (IMG_FILTER_PIXELATE) was added. - - - - 5.2.5 - - Alpha support for IMG_FILTER_COLORIZE was added. - - diff --git a/reference/image/functions/imagegd.xml b/reference/image/functions/imagegd.xml index b68c0f59a3a6..fb6217ee0b9b 100644 --- a/reference/image/functions/imagegd.xml +++ b/reference/image/functions/imagegd.xml @@ -57,13 +57,6 @@ Formerly, these have been implicitly converted to palette. - - 5.4.0 - - Added support for passing a stream resource to - to. - - diff --git a/reference/image/functions/imagegd2.xml b/reference/image/functions/imagegd2.xml index 25ae7f68fcf2..23898f2960fe 100644 --- a/reference/image/functions/imagegd2.xml +++ b/reference/image/functions/imagegd2.xml @@ -58,31 +58,6 @@ &gd.return.trueonerror; - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - Added support for passing a stream resource to - to. - - - - - - - - &reftitle.examples; diff --git a/reference/image/functions/imagegif.xml b/reference/image/functions/imagegif.xml index 1e5aeb4dd9c5..92d591135a4c 100644 --- a/reference/image/functions/imagegif.xml +++ b/reference/image/functions/imagegif.xml @@ -48,31 +48,6 @@ &gd.return.trueonerror; - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - Added support for passing a stream resource to - to. - - - - - - - - &reftitle.examples; diff --git a/reference/image/functions/imagejpeg.xml b/reference/image/functions/imagejpeg.xml index 6c50087ac0fd..e40e33bbdd04 100644 --- a/reference/image/functions/imagejpeg.xml +++ b/reference/image/functions/imagejpeg.xml @@ -50,38 +50,6 @@ &gd.return.trueonerror; - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - Added support for passing a stream resource to - to. - - - - 5.4.0 - - Disallowed passing an empty string to to to - skip this argument. - - - - - - - - &reftitle.examples; diff --git a/reference/image/functions/imagepng.xml b/reference/image/functions/imagepng.xml index 648a51573f62..f949f55b484b 100644 --- a/reference/image/functions/imagepng.xml +++ b/reference/image/functions/imagepng.xml @@ -75,43 +75,6 @@ &gd.return.trueonerror; - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - Added support for passing a stream resource to - to. - - - - 5.1.3 - - Added the filters parameter. - - - - 5.1.2 - - Added the quality parameter. - - - - - - - - &reftitle.examples; diff --git a/reference/image/functions/imagepsbbox.xml b/reference/image/functions/imagepsbbox.xml deleted file mode 100644 index 79ee602a5dd2..000000000000 --- a/reference/image/functions/imagepsbbox.xml +++ /dev/null @@ -1,212 +0,0 @@ - - - - - imagepsbbox - Give the bounding box of a text rectangle using PostScript Type1 fonts - - - &warn.removed.function-7-0-0; - - - &reftitle.description; - - arrayimagepsbbox - stringtext - resourcefont - intsize - - - arrayimagepsbbox - stringtext - resourcefont - intsize - intspace - inttightness - floatangle - - - Gives the bounding box of a text rectangle using PostScript Type1 fonts. - - - The bounding box is calculated using information available from character - metrics, and unfortunately tends to differ slightly from the results - achieved by actually rasterizing the text. If the angle is 0 degrees, you - can expect the text to need 1 pixel more to every direction. - - - - &reftitle.parameters; - - - - text - - - The text to be written. - - - - &gd.psfont.description; - - size - - - size is expressed in pixels. - - - - - space - - - Allows you to change the default value of a space in a font. This - amount is added to the normal value and can also be negative. - Expressed in character space units, where 1 unit is 1/1000th of an - em-square. - - - - - tightness - - - tightness allows you to control the amount - of white space between characters. This amount is added to the - normal character width and can also be negative. - Expressed in character space units, where 1 unit is 1/1000th of an - em-square. - - - - - angle - - - angle is in degrees. - - - - - - - - &reftitle.returnvalues; - - Returns an array containing the following elements: - - - - - 0 - left x-coordinate - - - 1 - upper y-coordinate - - - 2 - right x-coordinate - - - 3 - lower y-coordinate - - - - - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - &gd.changlog.t1lib; - - - - - - - - &reftitle.examples; - - <function>imagepsbbox</function> usage - - -]]> - - - - - - &reftitle.notes; - ¬e.config.t1lib; - - - &reftitle.seealso; - - - imagepstext - - - - - - diff --git a/reference/image/functions/imagepsencodefont.xml b/reference/image/functions/imagepsencodefont.xml deleted file mode 100644 index a1228bb6a55a..000000000000 --- a/reference/image/functions/imagepsencodefont.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - imagepsencodefont - Change the character encoding vector of a font - - - &warn.removed.function-7-0-0; - - - &reftitle.description; - - boolimagepsencodefont - resourcefont_index - stringencodingfile - - - Loads a character encoding vector from a file and changes the fonts - encoding vector to it. As a PostScript fonts default vector lacks most of - the character positions above 127, you'll definitely want to change this - if you use a language other than English. - - - If you find yourself using this function all the time, a much - better way to define the encoding is to set ps.default_encoding in - the configuration file - to point to the right encoding file and all fonts you load will - automatically have the right encoding. - - - - &reftitle.parameters; - - - &gd.psfont.description; - - encodingfile - - - The exact format of this file is described in T1libs documentation. - T1lib comes with two ready-to-use files, - IsoLatin1.enc and - IsoLatin2.enc. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - &gd.changlog.t1lib; - - - - - - - - &reftitle.examples; - - - <function>imagepsencodefont</function> example - - -]]> - - - - - - - &reftitle.notes; - ¬e.config.t1lib; - - - - diff --git a/reference/image/functions/imagepsextendfont.xml b/reference/image/functions/imagepsextendfont.xml deleted file mode 100644 index 8c809b3a3f3b..000000000000 --- a/reference/image/functions/imagepsextendfont.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - imagepsextendfont - Extend or condense a font - - - &warn.removed.function-7-0-0; - - - &reftitle.description; - - boolimagepsextendfont - resourcefont_index - floatextend - - - Extend or condense a font (font_index), if - the value of the extend parameter is less - than one you will be condensing the font. - - - - &reftitle.parameters; - - - &gd.psfont.description; - - extend - - - Extension value, must be greater than 0. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - &gd.changlog.t1lib; - - - - - - - - &reftitle.examples; - - - <function>imagepsextendfont</function> example - - -]]> - - - - - - - &reftitle.notes; - ¬e.config.t1lib; - - - - diff --git a/reference/image/functions/imagepsfreefont.xml b/reference/image/functions/imagepsfreefont.xml deleted file mode 100644 index 7d5ac2b7d600..000000000000 --- a/reference/image/functions/imagepsfreefont.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - imagepsfreefont - Free memory used by a PostScript Type 1 font - - - &warn.removed.function-7-0-0; - - - &reftitle.description; - - boolimagepsfreefont - resourcefont_index - - - imagepsfreefont frees memory used by a PostScript - Type 1 font. - - - - &reftitle.parameters; - - - &gd.psfont.description; - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - &gd.changlog.t1lib; - - - - - - - - &reftitle.examples; - - - <function>imagepsfreefont</function> example - - -]]> - - - - - - - &reftitle.notes; - ¬e.config.t1lib; - - - &reftitle.seealso; - - - imagepsloadfont - - - - - - diff --git a/reference/image/functions/imagepsloadfont.xml b/reference/image/functions/imagepsloadfont.xml deleted file mode 100644 index 89cdc8bdb60c..000000000000 --- a/reference/image/functions/imagepsloadfont.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - imagepsloadfont - Load a PostScript Type 1 font from file - - - &warn.removed.function-7-0-0; - - - &reftitle.description; - - resourceimagepsloadfont - stringfilename - - - Load a PostScript Type 1 font from the given - filename. - - - - &reftitle.parameters; - - - - filename - - - Path to the Postscript font file. - - - - - - - - &reftitle.returnvalues; - - 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;. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - &gd.changlog.t1lib; - - - - - - - - &reftitle.examples; - - - <function>imagepsloadfont</function> example - - -]]> - - - - - - - &reftitle.notes; - ¬e.config.t1lib; - - - &reftitle.seealso; - - - imagepsfreefont - - - - - - diff --git a/reference/image/functions/imagepsslantfont.xml b/reference/image/functions/imagepsslantfont.xml deleted file mode 100644 index fb1ecc6c93d4..000000000000 --- a/reference/image/functions/imagepsslantfont.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - imagepsslantfont - Slant a font - - - &warn.removed.function-7-0-0; - - - &reftitle.description; - - boolimagepsslantfont - resourcefont_index - floatslant - - - Slant a given font. - - - - &reftitle.parameters; - - - &gd.psfont.description; - - slant - - - Slant level. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - &gd.changlog.t1lib; - - - - - - - - &reftitle.examples; - - - <function>imagepsslantfont</function> example - - -]]> - - - - - - - &reftitle.notes; - ¬e.config.t1lib; - - - - diff --git a/reference/image/functions/imagepstext.xml b/reference/image/functions/imagepstext.xml deleted file mode 100644 index 59ae1b93b0cf..000000000000 --- a/reference/image/functions/imagepstext.xml +++ /dev/null @@ -1,251 +0,0 @@ - - - - - imagepstext - Draws a text over an image using PostScript Type1 fonts - - - &warn.removed.function-7-0-0; - - - &reftitle.description; - - arrayimagepstext - resourceimage - stringtext - resourcefont_index - intsize - intforeground - intbackground - intx - inty - intspace0 - inttightness0 - floatangle0.0 - intantialias_steps4 - - - Draws a text on an image using PostScript Type1 fonts. - - - Refer to PostScript documentation about fonts and their measuring system - if you have trouble understanding how this works. - - - - &reftitle.parameters; - - - &gd.image.description; - - text - - - The text to be written. - - - - &gd.psfont.description; - - size - - - size is expressed in pixels. - - - - - foreground - - - The color in which the text will be painted. - - - - - background - - - The color to which the text will try to fade in with antialiasing. - No pixels with the color background are - actually painted, so the background image does not need to be of solid - color. - - - - - x - - - x-coordinate for the lower-left corner of the first character. - - - - - y - - - y-coordinate for the lower-left corner of the first character. - - - - - space - - - Allows you to change the default value of a space in a font. This - amount is added to the normal value and can also be negative. - Expressed in character space units, where 1 unit is 1/1000th of an - em-square. - - - - - tightness - - - tightness allows you to control the amount - of white space between characters. This amount is added to the - normal character width and can also be negative. - Expressed in character space units, where 1 unit is 1/1000th of an - em-square. - - - - - angle - - - angle is in degrees. - - - - - antialias_steps - - - Allows you to control the number of colours used for antialiasing - text. Allowed values are 4 and 16. The higher value is recommended - for text sizes lower than 20, where the effect in text quality is - quite visible. With bigger sizes, use 4. It's less computationally - intensive. - - - - - - - - &reftitle.returnvalues; - - 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 - - - - - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - &gd.changlog.t1lib; - - - - - - - - &reftitle.examples; - - <function>imagepstext</function> usage - - -]]> - - - - - - &reftitle.notes; - ¬e.config.t1lib; - - - &reftitle.seealso; - - - imagepsbbox - - - - - - diff --git a/reference/image/functions/imagerotate.xml b/reference/image/functions/imagerotate.xml index a2b6909c2ced..1b1204b30885 100644 --- a/reference/image/functions/imagerotate.xml +++ b/reference/image/functions/imagerotate.xml @@ -80,19 +80,6 @@ The ignore_transparent is now silently ignored. - - 5.5.0 - - This function is now affected by the interpolation method set by the - imagesetinterpolation function. - - - - 5.1.0 - - ignore_transparent was added. - - diff --git a/reference/image/functions/imagettftext.xml b/reference/image/functions/imagettftext.xml index ab27268ac122..448b9898fad4 100644 --- a/reference/image/functions/imagettftext.xml +++ b/reference/image/functions/imagettftext.xml @@ -121,30 +121,6 @@ Returns &false; on error. - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.0 - - It is now possible to specify an hexadecimal entity in - text. - - - - - - - &reftitle.examples; diff --git a/reference/image/functions/imagewbmp.xml b/reference/image/functions/imagewbmp.xml index 50ce34198aa3..235337e29654 100644 --- a/reference/image/functions/imagewbmp.xml +++ b/reference/image/functions/imagewbmp.xml @@ -50,31 +50,6 @@ &gd.return.trueonerror; - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - Added support for passing a stream resource to - to. - - - - - - - - &reftitle.examples; diff --git a/reference/image/versions.xml b/reference/image/versions.xml index 223d277bc9f8..39e268ba8470 100644 --- a/reference/image/versions.xml +++ b/reference/image/versions.xml @@ -90,14 +90,6 @@ - - - - - - - - diff --git a/reference/imap/functions/imap-append.xml b/reference/imap/functions/imap-append.xml index f18efb8bfa68..c55d07375350 100644 --- a/reference/imap/functions/imap-append.xml +++ b/reference/imap/functions/imap-append.xml @@ -73,31 +73,7 @@ &return.success; - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.2 - - Added INTERNALDATE support to imap_append. - - - - - - - - + &reftitle.examples; diff --git a/reference/imap/functions/imap-fetch-overview.xml b/reference/imap/functions/imap-fetch-overview.xml index e1ff11b9f5e9..2bd553c6a371 100644 --- a/reference/imap/functions/imap-fetch-overview.xml +++ b/reference/imap/functions/imap-fetch-overview.xml @@ -143,28 +143,6 @@ - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 5.3.3 - - Add the udate property. - - - - - - - &reftitle.examples; diff --git a/reference/imap/functions/imap-open.xml b/reference/imap/functions/imap-open.xml index e66ea184034f..53ba2a4b38d8 100644 --- a/reference/imap/functions/imap-open.xml +++ b/reference/imap/functions/imap-open.xml @@ -279,32 +279,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.2 - params added - - - 5.2.0 - n_retries added - - - - - - - &reftitle.examples; diff --git a/reference/imap/functions/imap-reopen.xml b/reference/imap/functions/imap-reopen.xml index 803f44463849..efa9d1e5b4a3 100644 --- a/reference/imap/functions/imap-reopen.xml +++ b/reference/imap/functions/imap-reopen.xml @@ -93,28 +93,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.0 - n_retries added - - - - - - - &reftitle.examples; diff --git a/reference/inclued/book.xml b/reference/inclued/book.xml deleted file mode 100644 index c03afa4df19b..000000000000 --- a/reference/inclued/book.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - Inclusion hierarchy viewer - inclued - - - &reftitle.intro; - - Traces through and dumps the hierarchy of file inclusions and class inheritance at runtime. - - - The files may have been included using - include, include_once, - require, or require_once. - - - Class inheritance dependencies are also reported. - - - - &reference.inclued.setup; - &reference.inclued.constants; - &reference.inclued.examples; - &reference.inclued.reference; - - - - - diff --git a/reference/inclued/configure.xml b/reference/inclued/configure.xml deleted file mode 100644 index 858ec144c056..000000000000 --- a/reference/inclued/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;inclued - -
- - - diff --git a/reference/inclued/constants.xml b/reference/inclued/constants.xml deleted file mode 100644 index 0a9e0505f38e..000000000000 --- a/reference/inclued/constants.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - &no.constants; - - - - - diff --git a/reference/inclued/examples.xml b/reference/inclued/examples.xml deleted file mode 100644 index 1c65e305c6d6..000000000000 --- a/reference/inclued/examples.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - &reftitle.examples; - -
- Example that implements inclued into an application - - This example demonstrates the process of implementing inclued into - an existing application, and viewing the results. - - - - Getting the data within the PHP application itself (function) - - -]]> - - - - - Now that some data exists, it's time to make sense of it in the form of - a graph. The inclued extension includes a PHP file named - gengraph.php that creates a dot file that - requires the graphviz library. - However, this form is not required. - - - - Example use of gengraph.php - - This example creates an image named inclued.png that - shows the inclued data. - - - - - - - - - Listing data via inclued dumps (configuration) - - When using the inclued.dumpdir - directive, files (include clues) are dumped with every request. Here's one - way to list those files, and unserialize them. - - -count() === 0) { - echo 'No clues today', PHP_EOL; - exit; - } - - foreach ($inclues as $inclue) { - - echo 'Inclued file: ', $inclue->getFilename(), PHP_EOL; - - $data = file_get_contents($inclue->getPathname()); - if ($data) { - $inc = unserialize($data); - echo ' -- filename: ', $inc['request']['SCRIPT_FILENAME'], PHP_EOL; - echo ' -- number of includes: ', count($inc['includes']), PHP_EOL; - } - echo PHP_EOL; - } -} else { - echo 'I am totally clueless today.', PHP_EOL; -} -?> -]]> - - &example.outputs.similar; - - - - - -
- - - - diff --git a/reference/inclued/functions/inclued-get-data.xml b/reference/inclued/functions/inclued-get-data.xml deleted file mode 100644 index dd7914c31714..000000000000 --- a/reference/inclued/functions/inclued-get-data.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - inclued_get_data - Get the inclued data - - - - &reftitle.description; - - arrayinclued_get_data - - - - Get the inclued data. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - The inclued data. - - - - - &reftitle.examples; - - - <function>inclued_get_data</function> example - - See the inclued examples - section for ways to create graphs with this data. - - - -]]> - - &example.outputs.similar; - - Array - ( - [0] => Array - ( - [operation] => include - [op_type] => 2 - [filename] => x.php - [opened_path] => /tmp/x.php - [fromfile] => /tmp/z.php - [fromline] => 2 - ) - ) -) -]]> - - - - - - - &reftitle.seealso; - - - inclued examples - debug_backtrace - include - - - - - - - diff --git a/reference/inclued/ini.xml b/reference/inclued/ini.xml deleted file mode 100644 index 3db54b193b16..000000000000 --- a/reference/inclued/ini.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - -
- &reftitle.runtime; - &extension.runtime; - - - - inclued &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - inclued.enabled - Off - PHP_INI_SYSTEM - - - - inclued.dumpdir - &null; - PHP_INI_SYSTEM - - - - -
- - &ini.php.constants; - - - - &ini.descriptions.title; - - - - - - - inclued.enabled - bool - - - - Whether or not to enable inclued. - - - - - - - inclued.dumpdir - string - - - - Location (path) to the directory that stores inclued files. If set, each - PHP request will create a file. These files are serialized versions of - what inclued_get_data would produce, so may be - unserialized with unserialize. - - - - Because every request creates a file, this directory may fill up fast! - - - - - - - -
- - - diff --git a/reference/inclued/reference.xml b/reference/inclued/reference.xml deleted file mode 100644 index 668b372b1f2a..000000000000 --- a/reference/inclued/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - inclued &Functions; - - &reference.inclued.entities.functions; - - - - diff --git a/reference/inclued/setup.xml b/reference/inclued/setup.xml deleted file mode 100644 index 08cae24adf7c..000000000000 --- a/reference/inclued/setup.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.required; - - PHP version 5.1.0 or greater. - - - The included gengraph.php file utilizes - the graphviz library, - however, this is not required. - -
- - &reference.inclued.configure; - &reference.inclued.ini; - -
- &reftitle.resources; - &no.resource; -
- - - - - diff --git a/reference/inclued/versions.xml b/reference/inclued/versions.xml deleted file mode 100644 index ab4b08e4e74a..000000000000 --- a/reference/inclued/versions.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - - \ No newline at end of file diff --git a/reference/info/functions/assert.xml b/reference/info/functions/assert.xml index 4491527b6a2f..800b7c7f067f 100644 --- a/reference/info/functions/assert.xml +++ b/reference/info/functions/assert.xml @@ -245,15 +245,6 @@ description supported from PHP 5.4.8 onwards. - - 5.4.8 - - The description parameter was added. The - description is also now provided to a callback - function in ASSERT_CALLBACK mode as the fourth - argument. - - diff --git a/reference/info/functions/dl.xml b/reference/info/functions/dl.xml index 534490da51c0..d48ce936742e 100644 --- a/reference/info/functions/dl.xml +++ b/reference/info/functions/dl.xml @@ -132,46 +132,6 @@ if (!extension_loaded('sqlite')) { - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 7.0.0 - - dl is disabled in PHP-FPM. - - - - 5.3.9 - - dl is enabled in PHP-FPM, albeit discouraged. - - - - 5.3.0 - - dl is now disabled in some SAPIs due to - stability issues. The only SAPIs that - allow dl are CLI and Embed. Use - the Extension Loading - Directives instead. - - - - - - - - &reftitle.notes; diff --git a/reference/info/functions/get-cfg-var.xml b/reference/info/functions/get-cfg-var.xml index 747e9ccdded9..e2b153beee5c 100644 --- a/reference/info/functions/get-cfg-var.xml +++ b/reference/info/functions/get-cfg-var.xml @@ -51,31 +51,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - get_cfg_var was fixed to be able - to return "array" ini options. - - - - - - - - &reftitle.seealso; diff --git a/reference/info/functions/get-defined-constants.xml b/reference/info/functions/get-defined-constants.xml index 646f2833907f..fded4de6d170 100644 --- a/reference/info/functions/get-defined-constants.xml +++ b/reference/info/functions/get-defined-constants.xml @@ -96,48 +96,6 @@ Array - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.1 - - Windows only: Core constants are categorized under Core, - previously mhash. - - - - 5.3.0 - - Core constants are categorized under Core, - previously internal. On Windows, the Core Constants - are categorized under mhash. - - - - 5.2.11 - - The categorize parameter now operates appropriately. - Previously, the categorize parameter was interpreted - as !is_null($categorize), making any value other than &null; - force the constants to be categorized. - - - - - - - - &reftitle.examples; diff --git a/reference/info/functions/get-loaded-extensions.xml b/reference/info/functions/get-loaded-extensions.xml index 50440b50e4ef..0e4e793c98be 100644 --- a/reference/info/functions/get-loaded-extensions.xml +++ b/reference/info/functions/get-loaded-extensions.xml @@ -42,31 +42,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.4 - - The optional zend_extensions parameter was added - - - - - - - - - &reftitle.examples; diff --git a/reference/info/functions/get-magic-quotes-gpc.xml b/reference/info/functions/get-magic-quotes-gpc.xml index 98b738bd3d47..d5ed0a209380 100644 --- a/reference/info/functions/get-magic-quotes-gpc.xml +++ b/reference/info/functions/get-magic-quotes-gpc.xml @@ -56,12 +56,6 @@ This function has been deprecated. - - 5.4.0 - - Always returns &false; because the magic quotes feature was removed from PHP. - - @@ -100,21 +94,6 @@ $sql = "INSERT INTO lastnames (lastname) VALUES ('$lastname')"; - - &reftitle.notes; - - - If the directive - magic_quotes_sybase is ON it will completely override - magic_quotes_gpc. So even - when get_magic_quotes_gpc returns - &true; neither double quotes, backslashes or NUL's will - be escaped. Only single quotes will be escaped. In this - case they'll look like: '' - - - - &reftitle.seealso; diff --git a/reference/info/functions/get-magic-quotes-runtime.xml b/reference/info/functions/get-magic-quotes-runtime.xml index aaeac05a87d0..3b610ab5523c 100644 --- a/reference/info/functions/get-magic-quotes-runtime.xml +++ b/reference/info/functions/get-magic-quotes-runtime.xml @@ -48,12 +48,6 @@ This function has been deprecated. - - 5.4.0 - - Always returns &false; because the magic quotes feature was removed from PHP. - - diff --git a/reference/info/functions/getopt.xml b/reference/info/functions/getopt.xml index eadbccff5e3f..a1019f3ffe0b 100644 --- a/reference/info/functions/getopt.xml +++ b/reference/info/functions/getopt.xml @@ -123,30 +123,6 @@ Added the optind parameter. - - 5.3.0 - - Added support for "=" as argument/value separator. - - - - 5.3.0 - - Added support for optional values (specified with "::"). - - - - 5.3.0 - - Parameter longopts is available on all systems. - - - - 5.3.0 - - This function is no longer system dependent, and now works on Windows, too. - - diff --git a/reference/info/functions/ini-get-all.xml b/reference/info/functions/ini-get-all.xml index d63d5ac40f85..dd124e2e9cb3 100644 --- a/reference/info/functions/ini-get-all.xml +++ b/reference/info/functions/ini-get-all.xml @@ -84,30 +84,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - Added details. - - - - - - - - &reftitle.examples; diff --git a/reference/info/functions/ini-get.xml b/reference/info/functions/ini-get.xml index 4559a771f3fc..226011dd23f8 100644 --- a/reference/info/functions/ini-get.xml +++ b/reference/info/functions/ini-get.xml @@ -132,30 +132,6 @@ post_max_size in bytes = 8388608 - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - Previously, the empty string was returned if the configuration - option didn't exist. now, &false; is returned instead. - - - - - - - - &reftitle.seealso; diff --git a/reference/info/functions/magic-quotes-runtime.xml b/reference/info/functions/magic-quotes-runtime.xml deleted file mode 100644 index b3a40fa11161..000000000000 --- a/reference/info/functions/magic-quotes-runtime.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - magic_quotes_runtime - &Alias; set_magic_quotes_runtime - - - - &warn.deprecated.alias-5-3-0.removed-7-0-0; - - - - &reftitle.description; - - &info.function.alias; - set_magic_quotes_runtime - - - - - diff --git a/reference/info/functions/memory-get-peak-usage.xml b/reference/info/functions/memory-get-peak-usage.xml index db0a5d6a4833..6fccb0a258d4 100644 --- a/reference/info/functions/memory-get-peak-usage.xml +++ b/reference/info/functions/memory-get-peak-usage.xml @@ -43,37 +43,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.1 - - Compiling with --enable-memory-limit - is no longer required for this function to exist. - - - - 5.2.0 - - real_usage was added. - - - - - - - - &reftitle.seealso; diff --git a/reference/info/functions/memory-get-usage.xml b/reference/info/functions/memory-get-usage.xml index a886ecb40789..1d2e401efaf6 100644 --- a/reference/info/functions/memory-get-usage.xml +++ b/reference/info/functions/memory-get-usage.xml @@ -46,37 +46,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.1 - - Compiling with --enable-memory-limit - is no longer required for this function to exist. - - - - 5.2.0 - - real_usage was added. - - - - - - - - &reftitle.examples; diff --git a/reference/info/functions/php-logo-guid.xml b/reference/info/functions/php-logo-guid.xml deleted file mode 100644 index ed647ae7c0fe..000000000000 --- a/reference/info/functions/php-logo-guid.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - php_logo_guid - Gets the logo guid - - - - &reftitle.description; - - stringphp_logo_guid - - - - This function returns the ID which can be used to display the PHP logo - using the built-in image. - Logo is displayed only if expose_php - is On. - - &warn.deprecated.function.removed-5-5-0; - - - - &reftitle.returnvalues; - - Returns PHPE9568F34-D428-11d2-A769-00AA001ACF42. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.5.0 - - php_logo_guid has been removed from PHP. - - - - - - - - - - &reftitle.examples; - - - <function>php_logo_guid</function> example - -'; - -?> -]]> - - - - - - - &reftitle.seealso; - - - phpinfo - phpversion - phpcredits - zend_logo_guid - - - - - - - diff --git a/reference/info/functions/phpinfo.xml b/reference/info/functions/phpinfo.xml index fa0340c54699..fb2ab37558f2 100644 --- a/reference/info/functions/phpinfo.xml +++ b/reference/info/functions/phpinfo.xml @@ -139,39 +139,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.5.0 - - Logo GUIDs were replaced with data URIs, and so turning off expose_php - now has no effect on the result of phpinfo(). Credits are also now - embedded within the output itself instead of linked. - - - - 5.2.2 - - The "Loaded Configuration File" information was added, when before - only "Configuration File (php.ini) Path" existed. - - - - - - - - &reftitle.examples; diff --git a/reference/info/functions/set-magic-quotes-runtime.xml b/reference/info/functions/set-magic-quotes-runtime.xml deleted file mode 100644 index d953da0b757d..000000000000 --- a/reference/info/functions/set-magic-quotes-runtime.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - set_magic_quotes_runtime - Sets the current active configuration setting of magic_quotes_runtime - - - - &warn.deprecated.function-5-3-0.removed-7-0-0; - - - - &reftitle.description; - - boolset_magic_quotes_runtime - boolnew_setting - - - Set the current active configuration setting of magic_quotes_runtime. - - - - - &reftitle.errors; - - Since PHP 5.3 this function has been deprecated and will raise an E_DEPRECATED warning upon execution. - Since PHP 5.4 this function will also raise an E_CORE_ERROR on trying to enable magic quotes. - - - - - &reftitle.parameters; - - - - new_setting - - - &false; for off, &true; for on. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>set_magic_quotes_runtime</function> example - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - get_magic_quotes_gpc - get_magic_quotes_runtime - - - - - - - diff --git a/reference/info/functions/zend-logo-guid.xml b/reference/info/functions/zend-logo-guid.xml deleted file mode 100644 index d9b80fbb434a..000000000000 --- a/reference/info/functions/zend-logo-guid.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - zend_logo_guid - Gets the Zend guid - - - - &reftitle.description; - - stringzend_logo_guid - - - - This function returns the ID which can be used to display the Zend logo - using the built-in image. - - &warn.deprecated.function.removed-5-5-0; - - - - &reftitle.returnvalues; - - Returns PHPE9568F35-D428-11d2-A769-00AA001ACF42. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.5.0 - - zend_logo_guid has been removed from PHP. - - - - - - - - - - &reftitle.examples; - - - <function>zend_logo_guid</function> example - -'; - -?> -]]> - - - - - - - &reftitle.seealso; - - - php_logo_guid - - - - - - - diff --git a/reference/info/ini.xml b/reference/info/ini.xml index 164fa5c91b17..880eab48ed16 100644 --- a/reference/info/ini.xml +++ b/reference/info/ini.xml @@ -306,16 +306,6 @@ " (double quote), \ (backslash) and NUL's are escaped with a backslash automatically. - - - If the - magic_quotes_sybase directive is also ON it will - completely override magic_quotes_gpc. Having both directives - enabled means only single quotes are escaped as - ''. Double quotes, backslashes and - NUL's will remain untouched and unescaped. - - See also get_magic_quotes_gpc @@ -333,10 +323,7 @@ If magic_quotes_runtime is enabled, most functions that return data from any sort of external source including databases and text files will have quotes - escaped with a backslash. If - magic_quotes_sybase - is also on, a single-quote is escaped with a single-quote instead - of a backslash. + escaped with a backslash. Functions affected by magic_quotes_runtime diff --git a/reference/info/versions.xml b/reference/info/versions.xml index 7658bafc22ec..a2dba8a424fb 100644 --- a/reference/info/versions.xml +++ b/reference/info/versions.xml @@ -48,8 +48,6 @@ - - @@ -62,7 +60,6 @@ - diff --git a/reference/intl/dateformatter/format.xml b/reference/intl/dateformatter/format.xml index a6831467c50e..0d54cc5dc6c0 100644 --- a/reference/intl/dateformatter/format.xml +++ b/reference/intl/dateformatter/format.xml @@ -94,19 +94,12 @@ - 5.5.0/PECL 3.0.0 + PECL 3.0.0 Support for providing IntlCalendar objects to the value parameter was added. - - 5.3.4 - - Support for providing DateTime objects to the - value parameter was added. - - diff --git a/reference/intl/grapheme/grapheme-substr.xml b/reference/intl/grapheme/grapheme-substr.xml index 317ee9997677..98bac762db82 100644 --- a/reference/intl/grapheme/grapheme-substr.xml +++ b/reference/intl/grapheme/grapheme-substr.xml @@ -68,34 +68,6 @@ Returns the extracted part of $string. - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4 - - If length is given and positive and the - argument string is shorter than the specified length, all the rest of - the string according to start parameter is - returned. Previously, &false; was returned. - - - - - - - - &reftitle.examples; diff --git a/reference/intl/idn/idn-to-ascii.xml b/reference/intl/idn/idn-to-ascii.xml index 9a8c2a48e6b1..503f717f775e 100644 --- a/reference/intl/idn/idn-to-ascii.xml +++ b/reference/intl/idn/idn-to-ascii.xml @@ -105,13 +105,6 @@ INTL_IDNA_VARIANT_UTS46 instead. - - 5.4.0/PECL 2.0.0b1 - - Added the parameters variant and - idna_info; UTS #46 support (requires ICU ≥ 4.6). - - diff --git a/reference/intl/idn/idn-to-utf8.xml b/reference/intl/idn/idn-to-utf8.xml index 64789d5b0882..20b26fb7968b 100644 --- a/reference/intl/idn/idn-to-utf8.xml +++ b/reference/intl/idn/idn-to-utf8.xml @@ -105,13 +105,6 @@ INTL_IDNA_VARIANT_UTS46 instead. - - 5.4.0/PECL 2.0.0b1 - - Added the parameters variant and - idna_info; UTS #46 support (requires ICU ≥ 4.6). - - diff --git a/reference/json/functions/json-decode.xml b/reference/json/functions/json-decode.xml index aca893946f31..4c702121cd15 100644 --- a/reference/json/functions/json-decode.xml +++ b/reference/json/functions/json-decode.xml @@ -117,62 +117,6 @@ instead of using a key with value _empty_. - - 7.0.0 - - Rejected RFC 7159 incompatible number formats - top level - (07, 0xff, .1, -.1) and all levels ([1.], [1.e1]) - - - - 7.0.0 - - An empty PHP string or value that after casting to string is an empty - string (NULL, FALSE) results - in JSON syntax error. - - - - 5.6.0 - - Invalid non-lowercased variants of the true, - false and null literals are no - longer accepted as valid input, and will generate warnings. - - - - 5.4.0 - - JSON_BIGINT_AS_STRING, and - JSON_OBJECT_AS_ARRAY - options were added. - - - - 5.4.0 - - The options parameter was added. - - - - 5.3.0 - - Added the optional depth. The default - recursion depth was increased from 128 to 512 - - - - 5.2.3 - - The nesting limit was increased from 20 to 128 - - - - 5.2.1 - - Added support for JSON decoding of basic types. - - diff --git a/reference/json/functions/json-encode.xml b/reference/json/functions/json-encode.xml index 6965d7163ebf..70374cb37a27 100644 --- a/reference/json/functions/json-encode.xml +++ b/reference/json/functions/json-encode.xml @@ -128,81 +128,6 @@ encoding double values. - - 5.6.6 - - JSON_PRESERVE_ZERO_FRACTION - options was added. - - - - 5.5.0 - - depth parameter was added. - - - - 5.5.0 - - JSON_PARTIAL_OUTPUT_ON_ERROR - options was added. - - - - 5.5.0 - - When value triggers a JSON encoding error, - &false; is returned instead of partial output, - unless options contains JSON_PARTIAL_OUTPUT_ON_ERROR. - See json_last_error for the full list of reasons that can cause JSON encoding to fail. - One of the potential failure reasons is that value contains strings containing invalid UTF-8. - - - - 5.5.0 - - E_WARNING is no longer emitted for an invalid value. - - - - 5.5.0 - - The return value on failure was changed from null - string to &false;. - - - - 5.4.0 - - JSON_PRETTY_PRINT, - JSON_UNESCAPED_SLASHES, and - JSON_UNESCAPED_UNICODE - options were added. - - - - 5.3.3 - - JSON_NUMERIC_CHECK options was added. - - - - 5.3.0 - - JSON_FORCE_OBJECT, - JSON_HEX_AMP, - JSON_HEX_APOS, - JSON_HEX_QUOT, and - JSON_HEX_TAG, - options were added. - - - - 5.3.0 - - The options parameter was added. - - diff --git a/reference/kadm5/book.xml b/reference/kadm5/book.xml deleted file mode 100644 index 49972ad7f066..000000000000 --- a/reference/kadm5/book.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - Kerberos V - KADM5 - - - - &reftitle.intro; - - These package allows you to access Kerberos V administration servers. - You can create, modify, and delete Kerberos V principals and policies. - - - More information about Kerberos can be found at &url.kerberos.info;. - - - Documentation for Kerberos and KADM5 can be found at &url.kerberos.docs;. - - - - - &reference.kadm5.setup; - &reference.kadm5.constants; - &reference.kadm5.examples; - &reference.kadm5.reference; - - - - - diff --git a/reference/kadm5/constants.xml b/reference/kadm5/constants.xml deleted file mode 100644 index fb8abba3fe97..000000000000 --- a/reference/kadm5/constants.xml +++ /dev/null @@ -1,214 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; -
- Constants for Attribute Flags - - The functions kadm5_create_principal, - kadm5_modify_principal, and - kadm5_modify_principal allow to specify - special attributes using a bitfield. The symbols are defined below: - - Attributes for use by the KDC - - - - constant - - - - - KRB5_KDB_DISALLOW_POSTDATED - - - KRB5_KDB_DISALLOW_FORWARDABLE - - - KRB5_KDB_DISALLOW_TGT_BASED - - - KRB5_KDB_DISALLOW_RENEWABLE - - - KRB5_KDB_DISALLOW_PROXIABLE - - - KRB5_KDB_DISALLOW_DUP_SKEY - - - KRB5_KDB_DISALLOW_ALL_TIX - - - KRB5_KDB_REQUIRES_PRE_AUTH - - - KRB5_KDB_REQUIRES_HW_AUTH - - - KRB5_KDB_REQUIRES_PWCHANGE - - - KRB5_KDB_DISALLOW_SVR - - - KRB5_KDB_PWCHANGE_SERVER - - - KRB5_KDB_SUPPORT_DESMD5 - - - KRB5_KDB_NEW_PRINC - - - -
- -
- -
- Constants for Options - - The functions kadm5_create_principal, - kadm5_modify_principal, and - kadm5_get_principal allow to specify or return - principal's options as an associative array. The keys for the associative - array are defined as string constants below: - - Options for creating/modifying/retrieving principals - - - - constant - funcdef - description - - - - - KADM5_PRINCIPAL - long - The expire time of the princial as a Kerberos timestamp. - - - KADM5_PRINC_EXPIRE_TIME - long - The expire time of the princial as a Kerberos timestamp. - - - KADM5_LAST_PW_CHANGE - long - The time this principal's password was last changed. - - - KADM5_PW_EXPIRATION - long - - The expire time of the principal's current password, as a Kerberos - timestamp. - - - - KADM5_MAX_LIFE - long - - The maximum lifetime of any Kerberos ticket issued to this principal. - - - - KADM5_MAX_RLIFE - long - - The maximum renewable lifetime of any Kerberos ticket issued to or - for this principal. - - - - KADM5_MOD_NAME - string - - The name of the Kerberos principal that most recently modified this - principal. - - - - KADM5_MOD_TIME - long - - The time this principal was last modified, as a Kerberos timestamp. - - - - KADM5_KVNO - long - The version of the principal's current key. - - - KADM5_POLICY - string - The name of the policy controlling this principal. - - - KADM5_CLEARPOLICY - long - - Standard procedure is to assign the 'default' policy to new - principals. KADM5_CLEARPOLICY suppresses this behaviour. - - - - KADM5_LAST_SUCCESS - long - The KDC time of the last successfull AS_REQ. - - - KADM5_LAST_FAILED - long - The KDC time of the last failed AS_REQ. - - - KADM5_FAIL_AUTH_COUNT - long - The number of consecutive failed AS_REQs. - - - KADM5_RANDKEY - long - - Generates a random password for the principal. The parameter - password will be ignored. - - - - KADM5_ATTRIBUTES - long - A bitfield of attributes for use by the KDC. - - - -
- -
- - - diff --git a/reference/kadm5/examples.xml b/reference/kadm5/examples.xml deleted file mode 100644 index 66b3d811c213..000000000000 --- a/reference/kadm5/examples.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - &reftitle.examples; -
- Basic usage - - This simple example shows how to connect, query, print - resulting principals and disconnect from a KADM5 database. - - KADM5 extension overview example - -get_principals\n"; - $principals = kadm5_get_principals($handle); - for( $i=0; $i\n"; - - print "

get_policies

\n"; - $policies = kadm5_get_policies($handle); - for( $i=0; $i\n"; - - print "

get_principal burbach@GONICUS.LOCAL

\n"; - - $options = kadm5_get_principal($handle, "burbach@GONICUS.LOCAL" ); - $keys = array_keys($options); - for( $i=0; $i\n"; - } - - $options = array(KADM5_PRINC_EXPIRE_TIME => 0); - kadm5_modify_principal($handle, "burbach@GONICUS.LOCAL", $options); - - kadm5_destroy($handle); -?> -]]> - - - -
- - - - diff --git a/reference/kadm5/functions/kadm5-chpass-principal.xml b/reference/kadm5/functions/kadm5-chpass-principal.xml deleted file mode 100644 index c55dfa63a83c..000000000000 --- a/reference/kadm5/functions/kadm5-chpass-principal.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - kadm5_chpass_principal - Changes the principal's password - - - - &reftitle.description; - - boolkadm5_chpass_principal - resourcehandle - stringprincipal - stringpassword - - - kadm5_chpass_principal sets the new password - password for the principal. - - - - - &reftitle.parameters; - - - - handle - - - A KADM5 handle. - - - - - principal - - - The principal. - - - - - password - - - The new password. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Example of changing principal's password - - -]]> - - - - - - - diff --git a/reference/kadm5/functions/kadm5-create-principal.xml b/reference/kadm5/functions/kadm5-create-principal.xml deleted file mode 100644 index 073af90b42e3..000000000000 --- a/reference/kadm5/functions/kadm5-create-principal.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - kadm5_create_principal - Creates a kerberos principal with the given parameters - - - - &reftitle.description; - - boolkadm5_create_principal - resourcehandle - stringprincipal - stringpassword - arrayoptions - - - Creates a principal with the given - password. - - - - - &reftitle.parameters; - - - - handle - - - A KADM5 handle. - - - - - principal - - - The principal. - - - - - password - - - If password is omitted or is &null;, a random - key will be generated. - - - - - options - - - It is possible to specify several optional parameters within the - array options. Allowed are the following options: - KADM5_PRINC_EXPIRE_TIME, - KADM5_PW_EXPIRATION, - KADM5_ATTRIBUTES, - KADM5_MAX_LIFE, - KADM5_KVNO, - KADM5_POLICY, - KADM5_CLEARPOLICY, - KADM5_MAX_RLIFE. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Example of principal's creation - - 0, - KADM5_POLICY => "default", - KADM5_ATTRIBUTES => $attributes); - -kadm5_create_principal($handle, "burbach@GONICUS.LOCAL", "password", $options); - -kadm5_destroy($handle); -?> -]]> - - - - - - - &reftitle.seealso; - - - kadm5_modify_principal - kadm5_delete_principal - - - - - - - diff --git a/reference/kadm5/functions/kadm5-delete-principal.xml b/reference/kadm5/functions/kadm5-delete-principal.xml deleted file mode 100644 index 34209defa6cd..000000000000 --- a/reference/kadm5/functions/kadm5-delete-principal.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - kadm5_delete_principal - Deletes a kerberos principal - - - - &reftitle.description; - - boolkadm5_delete_principal - resourcehandle - stringprincipal - - - Removes the principal from the Kerberos database. - - - - - &reftitle.parameters; - - - - handle - - - A KADM5 handle. - - - - - principal - - - The removed principal. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>kadm5_delete_principal</function> example - - -]]> - - - - - - - &reftitle.seealso; - - - kadm5_modify_principal - kadm5_create_principal - - - - - - - diff --git a/reference/kadm5/functions/kadm5-destroy.xml b/reference/kadm5/functions/kadm5-destroy.xml deleted file mode 100644 index be02bf9720f3..000000000000 --- a/reference/kadm5/functions/kadm5-destroy.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - kadm5_destroy - Closes the connection to the admin server and releases all related resources - - - - &reftitle.description; - - boolkadm5_destroy - resourcehandle - - - Closes the connection to the admin server and releases all related - resources. - - - - - &reftitle.parameters; - - - - handle - - - A KADM5 handle. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - kadm5_init_with_password - - - - - - - diff --git a/reference/kadm5/functions/kadm5-flush.xml b/reference/kadm5/functions/kadm5-flush.xml deleted file mode 100644 index 20afee9ee678..000000000000 --- a/reference/kadm5/functions/kadm5-flush.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - kadm5_flush - Flush all changes to the Kerberos database - - - - &reftitle.description; - - boolkadm5_flush - resourcehandle - - - Flush all changes to the Kerberos database, leaving the connection to the - Kerberos admin server open. - - - - - &reftitle.parameters; - - - - handle - - - A KADM5 handle. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - diff --git a/reference/kadm5/functions/kadm5-get-policies.xml b/reference/kadm5/functions/kadm5-get-policies.xml deleted file mode 100644 index 0db0b925bc92..000000000000 --- a/reference/kadm5/functions/kadm5-get-policies.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - kadm5_get_policies - Gets all policies from the Kerberos database - - - - &reftitle.description; - - arraykadm5_get_policies - resourcehandle - - - Gets an array containing the policies's names. - - - - - &reftitle.parameters; - - - - handle - - - A KADM5 handle. - - - - - - - - - &reftitle.returnvalues; - - Returns array of policies on success&return.falseforfailure;. - - - - - &reftitle.examples; - - - <function>kadm5_get_policies</function> example - -get_policies\n"; -foreach (kadm5_get_policies($handle) as $policy) { - echo "$policy
\n"; -} - -kadm5_destroy($handle); -?> -]]> - - - - - - - diff --git a/reference/kadm5/functions/kadm5-get-principal.xml b/reference/kadm5/functions/kadm5-get-principal.xml deleted file mode 100644 index e4f367d1e3f0..000000000000 --- a/reference/kadm5/functions/kadm5-get-principal.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - kadm5_get_principal - Gets the principal's entries from the Kerberos database - - - - &reftitle.description; - - arraykadm5_get_principal - resourcehandle - stringprincipal - - - Gets the principal's entries from the Kerberos database. - - - - - &reftitle.parameters; - - - - handle - - - A KADM5 handle. - - - - - principal - - - The principal. - - - - - - - - - &reftitle.returnvalues; - - 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&return.falseforfailure;. - - - - - &reftitle.examples; - - - <function>kadm5_get_principal</function> example - -get_principal burbach@GONICUS.LOCAL\n"; - -$options = kadm5_get_principal($handle, "burbach@GONICUS.LOCAL" ); - -foreach ($options as $key => $value) { - echo "$key: $value
\n"; -} - -kadm5_destroy($handle); -?> -]]> - - - - - - - &reftitle.seealso; - - - kadm5_get_principals - - - - - - - diff --git a/reference/kadm5/functions/kadm5-get-principals.xml b/reference/kadm5/functions/kadm5-get-principals.xml deleted file mode 100644 index 0e51d7bc5304..000000000000 --- a/reference/kadm5/functions/kadm5-get-principals.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - kadm5_get_principals - Gets all principals from the Kerberos database - - - - &reftitle.description; - - arraykadm5_get_principals - resourcehandle - - - kadm5_get_principals returns an array containing the - principals's names. - - - - - &reftitle.parameters; - - - - handle - - - A KADM5 handle. - - - - - - - - - &reftitle.returnvalues; - - Returns array of principals on success&return.falseforfailure;. - - - - - &reftitle.examples; - - - <function>kadm5_get_principals</function> example - -get_principals\n"; -foreach (kadm5_get_principals($handle) as $principal) { - echo "$principal
\n"; -} - -kadm5_destroy($handle); -?> -]]> - - - - - - - &reftitle.seealso; - - - kadm5_get_principal - - - - - - - diff --git a/reference/kadm5/functions/kadm5-init-with-password.xml b/reference/kadm5/functions/kadm5-init-with-password.xml deleted file mode 100644 index 1dfabedaa5df..000000000000 --- a/reference/kadm5/functions/kadm5-init-with-password.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - kadm5_init_with_password - Opens a connection to the KADM5 library - - - - &reftitle.description; - - resourcekadm5_init_with_password - stringadmin_server - stringrealm - stringprincipal - stringpassword - - - Opens a connection with the KADM5 library using the - principal and the given - password to obtain initial credentials from the - admin_server. - - - - - &reftitle.parameters; - - - - admin_server - - - The server. - - - - - realm - - - Defines the authentication domain for the connection. - - - - - principal - - - The principal. - - - - - password - - - If password is omitted or is &null;, a random - key will be generated. - - - - - - - - - &reftitle.returnvalues; - - Returns a KADM5 handle on success&return.falseforfailure;. - - - - - &reftitle.examples; - - - KADM5 initialization example - - 0, - KADM5_POLICY => "default", - KADM5_ATTRIBUTES => $attributes); - -kadm5_create_principal($handle, "burbach@GONICUS.LOCAL", "password", $options); - -kadm5_destroy($handle); -?> -]]> - - - - - - - &reftitle.notes; - - - Connection should be closed after use with - kadm5_destroy. - - - - - - &reftitle.seealso; - - - kadm5_destroy - - - - - - - diff --git a/reference/kadm5/functions/kadm5-modify-principal.xml b/reference/kadm5/functions/kadm5-modify-principal.xml deleted file mode 100644 index 9b67d547ae17..000000000000 --- a/reference/kadm5/functions/kadm5-modify-principal.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - kadm5_modify_principal - Modifies a kerberos principal with the given parameters - - - - &reftitle.description; - - boolkadm5_modify_principal - resourcehandle - stringprincipal - arrayoptions - - - Modifies a principal according to the given - options. - - - - - &reftitle.parameters; - - - - handle - - - A KADM5 handle. - - - - - principal - - - The principal. - - - - - options - - - It is possible to specify several optional parameters within the - array options. Allowed are the following options: - KADM5_PRINC_EXPIRE_TIME, - KADM5_PW_EXPIRATION, - KADM5_ATTRIBUTES, - KADM5_MAX_LIFE, - KADM5_KVNO, - KADM5_POLICY, - KADM5_CLEARPOLICY, - KADM5_MAX_RLIFE. - KADM5_FAIL_AUTH_COUNT. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Example of modifying principal - - 3451234, - KADM5_POLICY => "gonicus", - KADM5_ATTRIBUTES => $attributes); - -kadm5_modify_principal($handle, "burbach@GONICUS.LOCAL", $options); - -kadm5_destroy($handle); -?> -]]> - - - - - - - &reftitle.seealso; - - - kadm5_create_principal - kadm5_delete_principal - - - - - - - diff --git a/reference/kadm5/reference.xml b/reference/kadm5/reference.xml deleted file mode 100644 index a286ddeb2966..000000000000 --- a/reference/kadm5/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - KADM5 &Functions; - - &reference.kadm5.entities.functions; - - - - diff --git a/reference/kadm5/setup.xml b/reference/kadm5/setup.xml deleted file mode 100644 index 28f38a5a4155..000000000000 --- a/reference/kadm5/setup.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - &reftitle.setup; - - -
- &reftitle.required; - &no.requirement; -
- - - -
- &reftitle.install; - - &pecl.info; - &url.pecl.package;kadm5. - - - - If this option is used without specifying the path to KADM5, PHP will - use the built-in KADM5 client libraries. Users who run other applications - that use KADM5 (for example, running PHP 4 and PHP 5 as concurrent apache - modules, or auth-kadm5) should always specify the path to KADM5: - --with-kadm5=/path/to/kadm5. This will force PHP to use - the client libraries installed by KADM5, avoiding any conflicts. - - - - &pecl.windows.download; - -
- - - -
- &reftitle.runtime; - &no.config; -
- - - -
- &reftitle.resources; - - This extension defines a KADM5 handle returned by - kadm5_init_with_password. - -
- - - - - - diff --git a/reference/kadm5/versions.xml b/reference/kadm5/versions.xml deleted file mode 100644 index d503b9c93962..000000000000 --- a/reference/kadm5/versions.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/ktaglib/audioproperties.xml b/reference/ktaglib/audioproperties.xml deleted file mode 100644 index 0fd3bb2e5b06..000000000000 --- a/reference/ktaglib/audioproperties.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - The KTaglib_MPEG_AudioProperties class - KTaglib_MPEG_AudioProperties - - - - -
- &reftitle.intro; - -Represents the audio properties of a MPEG file, like length, bitrate or samplerate. - -
- - -
- Class synopsis - - - - KTaglib_MPEG_Audioproperties - - - - - KTaglib_MPEG_AudioProperties - - - - &Methods; - - - -
- - - -&reference.ktaglib.entities.audioproperties; - - - - diff --git a/reference/ktaglib/audioproperties/getBitrate.xml b/reference/ktaglib/audioproperties/getBitrate.xml deleted file mode 100644 index 6a46afa41c4e..000000000000 --- a/reference/ktaglib/audioproperties/getBitrate.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - KTaglib_MPEG_AudioProperties::getBitrate - Returns the bitrate of the MPEG file - - - &reftitle.description; - - public - int - KTaglib_MPEG_AudioProperties::getBitrate - - - - Returns the bitrate of the MPEG file - - - - &reftitle.returnvalues; - - Returns the bitrate as an integer - - - - - - diff --git a/reference/ktaglib/audioproperties/getChannels.xml b/reference/ktaglib/audioproperties/getChannels.xml deleted file mode 100644 index 264eea59d730..000000000000 --- a/reference/ktaglib/audioproperties/getChannels.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - KTaglib_MPEG_AudioProperties::getChannels - Returns the amount of channels of a MPEG file - - - &reftitle.description; - - public - int - KTaglib_MPEG_AudioProperties::getChannels - - - - Returns the amount of channels of the MPEG file - - - - &reftitle.returnvalues; - - Returns the channel count as an integer - - - - - - diff --git a/reference/ktaglib/audioproperties/getLayer.xml b/reference/ktaglib/audioproperties/getLayer.xml deleted file mode 100644 index 7fdcb0df13ba..000000000000 --- a/reference/ktaglib/audioproperties/getLayer.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - KTaglib_MPEG_AudioProperties::getLayer - Returns the layer of a MPEG file - - - &reftitle.description; - - public - int - KTaglib_MPEG_AudioProperties::getLayer - - - - Returns the layer of the MPEG file (usually 3 for MP3). - - - - &reftitle.returnvalues; - - Returns the layer as an integer - - - - - - diff --git a/reference/ktaglib/audioproperties/getLength.xml b/reference/ktaglib/audioproperties/getLength.xml deleted file mode 100644 index 3962d9567469..000000000000 --- a/reference/ktaglib/audioproperties/getLength.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - KTaglib_MPEG_AudioProperties::getLength - Returns the length of a MPEG file - - - &reftitle.description; - - public - int - KTaglib_MPEG_AudioProperties::getLength - - - - Returns the length of the MPEG file - - - - &reftitle.returnvalues; - - Returns the length as an integer - - - - - - diff --git a/reference/ktaglib/audioproperties/getSampleBitrate.xml b/reference/ktaglib/audioproperties/getSampleBitrate.xml deleted file mode 100644 index 5ec4ce33c27e..000000000000 --- a/reference/ktaglib/audioproperties/getSampleBitrate.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - KTaglib_MPEG_AudioProperties::getSampleBitrate - Returns the sample bitrate of a MPEG file - - - &reftitle.description; - - public - int - KTaglib_MPEG_AudioProperties::getSampleBitrate - - - - Returns the sample bitrate of the MPEG file - - - - &reftitle.returnvalues; - - Returns the sample bitrate as an integer - - - - - - diff --git a/reference/ktaglib/audioproperties/getVersion.xml b/reference/ktaglib/audioproperties/getVersion.xml deleted file mode 100644 index 90e20ae8760f..000000000000 --- a/reference/ktaglib/audioproperties/getVersion.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - KTaglib_MPEG_AudioProperties::getVersion - Returns the version of a MPEG file - - - &reftitle.description; - - public - int - KTaglib_MPEG_AudioProperties::getVersion - - - - Returns the version of the MPEG file header. The possible versions are - defined in Tag_MPEG_Header (Version1, Version2, Version2.5). - - - - &reftitle.returnvalues; - - Returns the version - - - - - - diff --git a/reference/ktaglib/audioproperties/isCopyrighted.xml b/reference/ktaglib/audioproperties/isCopyrighted.xml deleted file mode 100644 index 50797df88eb9..000000000000 --- a/reference/ktaglib/audioproperties/isCopyrighted.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - KTaglib_MPEG_AudioProperties::isCopyrighted - Returns the copyright status of an MPEG file - - - &reftitle.description; - - public - bool - KTaglib_MPEG_AudioProperties::isCopyrighted - - - - Returns true if the MPEG file is copyrighted - - - - &reftitle.returnvalues; - - Returns true if the MPEG file is copyrighted - - - - - - diff --git a/reference/ktaglib/audioproperties/isOriginal.xml b/reference/ktaglib/audioproperties/isOriginal.xml deleted file mode 100644 index a979b9206151..000000000000 --- a/reference/ktaglib/audioproperties/isOriginal.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - KTaglib_MPEG_AudioProperties::isOriginal - Returns if the file is marked as the original file - - - &reftitle.description; - - public - bool - KTaglib_MPEG_AudioProperties::isOriginal - - - - Returns true if the file is marked as the original file - - - - &reftitle.returnvalues; - - Returns true if the file is marked as the original file - - - - - - diff --git a/reference/ktaglib/audioproperties/isProtectionEnabled.xml b/reference/ktaglib/audioproperties/isProtectionEnabled.xml deleted file mode 100644 index 43a141f3d94f..000000000000 --- a/reference/ktaglib/audioproperties/isProtectionEnabled.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - KTaglib_MPEG_AudioProperties::isProtectionEnabled - Returns if protection mechanisms of an MPEG file are enabled - - - &reftitle.description; - - public - bool - KTaglib_MPEG_AudioProperties::isProtectionEnabled - - - - Returns true if protection mechanisms (like DRM) are enabled for this file - - - - &reftitle.returnvalues; - - Returns true if protection mechanisms (like DRM) are enabled for this file - - - - - - diff --git a/reference/ktaglib/book.xml b/reference/ktaglib/book.xml deleted file mode 100644 index 413f6ebc1c68..000000000000 --- a/reference/ktaglib/book.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - KTaglib - - &reftitle.intro; - - KTaglib is an object oriented binding to the taglib library from the KDE project used in projects like Amarok to read and write ID3 and Ogg tags. - The library also provides access to audio information. The bindings are designed usually follow the underlying C++ API, but were changed whenever - there is a more PHP-like way. - - - - At the moment ktaglib is able to read and write ID3v1 and ID3v2 tags. - - - - &reference.ktaglib.setup; - &reference.ktaglib.constants; - &reference.ktaglib.mpegfile; - &reference.ktaglib.audioproperties; - &reference.ktaglib.tag; - &reference.ktaglib.id3v2tag; - &reference.ktaglib.id3v2frame; - &reference.ktaglib.id3v2attachedpictureframe; - - - diff --git a/reference/ktaglib/configure.xml b/reference/ktaglib/configure.xml deleted file mode 100644 index a7c8b700cdc1..000000000000 --- a/reference/ktaglib/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - -
- &reftitle.install; - - &pecl.info; - &url.pecl.package;ktaglib. - - - &pecl.windows.download; - -
- - diff --git a/reference/ktaglib/constants.xml b/reference/ktaglib/constants.xml deleted file mode 100644 index 889310e3fa08..000000000000 --- a/reference/ktaglib/constants.xml +++ /dev/null @@ -1,265 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - KTaglib uses class constants. Most of the constants are mappings to the according - Taglib enums and constants. - - - - - KTaglib_MPEG_Header::Version1 - (integer) - - - - ID3 version is 1.0 - - - - - KTaglib_MPEG_Header::Version2 - (integer) - - - - ID3 version is 2.0 - - - - - KTaglib_MPEG_Header::Version2_5 - (integer) - - - - ID3 version is 2.5 - - - - - KTaglib_ID3v2_AttachedPictureFrame::Other - (integer) - - - - Picture type Other - - - - - KTaglib_ID3v2_AttachedPictureFrame::FileIcon - (integer) - - - - Picture type FileIcon - - - - - KTaglib_ID3v2_AttachedPictureFrame::OtherFileIcon - (integer) - - - - Picture type OtherFileIcon - - - - - KTaglib_ID3v2_AttachedPictureFrame::FrontCover - (integer) - - - - Picture type FrontCover - - - - - KTaglib_ID3v2_AttachedPictureFrame::BackCover - (integer) - - - - Picture type BackCover - - - - - KTaglib_ID3v2_AttachedPictureFrame::LeafletPage - (integer) - - - - Picture type LeafletPage - - - - - KTaglib_ID3v2_AttachedPictureFrame::Media - (integer) - - - - Picture type Media - - - - - KTaglib_ID3v2_AttachedPictureFrame::LeadArtist - (integer) - - - - Picture type LeadArtist - - - - - KTaglib_ID3v2_AttachedPictureFrame::Artist - (integer) - - - - Picture type Artist - - - - - KTaglib_ID3v2_AttachedPictureFrame::Conductor - (integer) - - - - Picture type Conductor - - - - - KTaglib_ID3v2_AttachedPictureFrame::Band - (integer) - - - - Picture type Band - - - - - KTaglib_ID3v2_AttachedPictureFrame::Composer - (integer) - - - - Picture type Composer - - - - - KTaglib_ID3v2_AttachedPictureFrame::Lyricist - (integer) - - - - Picture type Lyricist - - - - - KTaglib_ID3v2_AttachedPictureFrame::RecordingLocation - (integer) - - - - Picture type RecordingLocation - - - - - KTaglib_ID3v2_AttachedPictureFrame::DuringRecording - (integer) - - - - Picture type DuringRecording - - - - - KTaglib_ID3v2_AttachedPictureFrame::DuringPerformance - (integer) - - - - Picture type DuringPerformance - - - - - KTaglib_ID3v2_AttachedPictureFrame::MovieScreenCapture - (integer) - - - - Picture type MovieScreenCapture - - - - - KTaglib_ID3v2_AttachedPictureFrame::ColouredFish - (integer) - - - - Picture type ColouredFish - - - - - KTaglib_ID3v2_AttachedPictureFrame::Illustration - (integer) - - - - Picture type Illustration - - - - - KTaglib_ID3v2_AttachedPictureFrame::BandLogo - (integer) - - - - Picture type BandLogo - - - - - - - diff --git a/reference/ktaglib/examples.xml b/reference/ktaglib/examples.xml deleted file mode 100644 index 3ccfbc2740f9..000000000000 --- a/reference/ktaglib/examples.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - &reftitle.examples; - - The example read an ID3v2 tag from an MP3 and saves it's attached - cover. - - - Small Taglib Example - -getID3v2Tag()->getFrameList(); -if (isset($frames['APIC'])) { - $frames['APIC']->savePicture('example.png'); -} else { - die("No picture frame"); -} -?> -]]> - - - - - diff --git a/reference/ktaglib/id3v2attachedpictureframe.xml b/reference/ktaglib/id3v2attachedpictureframe.xml deleted file mode 100644 index 41cadc94312e..000000000000 --- a/reference/ktaglib/id3v2attachedpictureframe.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - The KTaglib_ID3v2_AttachedPictureFrame class - KTaglib_ID3v2_AttachedPictureFrame - - - - -
- &reftitle.intro; - - Represents an ID3v2 frame that can hold a picture. - -
- - -
- Class synopsis - - - - KTaglib_ID3v2_AttachedPictureFrame - - - - - extends - KTaglib_ID3v2_Frame - - - - &Methods; - - - &InheritedMethods; - - - - -
- - - -&reference.ktaglib.entities.id3v2attachedpictureframe; - - - - diff --git a/reference/ktaglib/id3v2attachedpictureframe/getDescription.xml b/reference/ktaglib/id3v2attachedpictureframe/getDescription.xml deleted file mode 100644 index b563f2b05a99..000000000000 --- a/reference/ktaglib/id3v2attachedpictureframe/getDescription.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - KTaglib_ID3v2_AttachedPictureFrame::getDescription - Returns a description for the picture in a picture frame - - - &reftitle.description; - - public - string - KTaglib_ID3v2_AttachedPictureFrame::getDescription - - - - Returns the attached description for a picture frame in an ID3v2.x frame. - - - - &reftitle.returnvalues; - - Returns a description for the picture in a picture frame - - - - - - diff --git a/reference/ktaglib/id3v2attachedpictureframe/getMimeType.xml b/reference/ktaglib/id3v2attachedpictureframe/getMimeType.xml deleted file mode 100644 index 3b006c696b52..000000000000 --- a/reference/ktaglib/id3v2attachedpictureframe/getMimeType.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - KTaglib_ID3v2_AttachedPictureFrame::getMimeType - Returns the mime type of the picture - - - &reftitle.description; - - public - string - KTaglib_ID3v2_AttachedPictureFrame::getMimeType - - - - Returns the mime type of the image represented by the attached picture frame. - - - Please notice that this method might return different types. While ID3v2.2 - have a mime type that doesn't start with "image/", ID3v2.3 and v2.4 usually - start with "image/". Therefore the method might return "image/png" for IDv2.3 frames - and just "PNG" for ID3v2.2 frames. - - - Notice that even the frame is an attached picture, the mime type might not be set - and therefore an empty string might be returned. - - - - &reftitle.returnvalues; - - Returns the mime type of the image represented by the attached picture frame. - - - - - - diff --git a/reference/ktaglib/id3v2attachedpictureframe/getType.xml b/reference/ktaglib/id3v2attachedpictureframe/getType.xml deleted file mode 100644 index 3a5a1f53a844..000000000000 --- a/reference/ktaglib/id3v2attachedpictureframe/getType.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - KTaglib_ID3v2_AttachedPictureFrame::getType - Returns the type of the image - - - &reftitle.description; - - public - int - KTaglib_ID3v2_AttachedPictureFrame::getType - - - - Returns the type of the image. - - - The ID3v2 specification allows an AttachedPictureFrame to set the type of an image. This can be e.g. FrontCover or FileIcon. Please refer to the KTaglib_ID3v2_AttachedPictureFrame class description for a list of available types. - - - - &reftitle.returnvalues; - - Returns the integer representation of the type. - - - - - - diff --git a/reference/ktaglib/id3v2attachedpictureframe/savePicture.xml b/reference/ktaglib/id3v2attachedpictureframe/savePicture.xml deleted file mode 100644 index 6762c2ad38a1..000000000000 --- a/reference/ktaglib/id3v2attachedpictureframe/savePicture.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - KTaglib_ID3v2_AttachedPictureFrame::savePicture - Saves the picture to a file - - - &reftitle.description; - - public - bool - KTaglib_ID3v2_AttachedPictureFrame::savePicture - stringfilename - - - Saves the attached picture to the given filename. - - - - &reftitle.returnvalues; - - Returns true on success, otherwise false - - - - - - diff --git a/reference/ktaglib/id3v2attachedpictureframe/setMimeType.xml b/reference/ktaglib/id3v2attachedpictureframe/setMimeType.xml deleted file mode 100644 index 0fc141127958..000000000000 --- a/reference/ktaglib/id3v2attachedpictureframe/setMimeType.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - KTaglib_ID3v2_AttachedPictureFrame::setMimeType - Set's the mime type of the picture - - - &reftitle.description; - - public - string - KTaglib_ID3v2_AttachedPictureFrame::getMimeType - stringtype - - - Sets the mime type of the image. This should in most cases be "image/png" or "image/jpeg". - - - - - diff --git a/reference/ktaglib/id3v2attachedpictureframe/setPicture.xml b/reference/ktaglib/id3v2attachedpictureframe/setPicture.xml deleted file mode 100644 index b2fbfb329ec8..000000000000 --- a/reference/ktaglib/id3v2attachedpictureframe/setPicture.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - KTaglib_ID3v2_AttachedPictureFrame::setPicture - Sets the frame picture to the given image - - - &reftitle.description; - - public - void - KTaglib_ID3v2_AttachedPictureFrame::setPicture - stringfilename - - - Sets the picture to the give image. The image is loaded from the given filename. - Please note that the picture is not saved unless you call the save method of the - corresponding file object. - - - - &reftitle.returnvalues; - - Returns true on success, otherwise false - - - - - - diff --git a/reference/ktaglib/id3v2attachedpictureframe/setType.xml b/reference/ktaglib/id3v2attachedpictureframe/setType.xml deleted file mode 100644 index 7e61d88ab0f2..000000000000 --- a/reference/ktaglib/id3v2attachedpictureframe/setType.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - KTaglib_ID3v2_AttachedPictureFrame::setType - Set the type of the image - - - &reftitle.description; - - public - void - KTaglib_ID3v2_AttachedPictureFrame::setType - inttype - - - Sets the type of the image. This can be e.g. FrontCover or FileIcon. - Please refer to the KTaglib_ID3v2_AttachedPictureFrame class description for - a list of available types and their constant mappings. - - - - - - diff --git a/reference/ktaglib/id3v2frame.xml b/reference/ktaglib/id3v2frame.xml deleted file mode 100644 index 7f93ec7747f1..000000000000 --- a/reference/ktaglib/id3v2frame.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - The KTaglib_ID3v2_Frame class - KTaglib_ID3v2_Frame - - - - -
- &reftitle.intro; - -The base class for ID3v2 frames. ID3v2 tags are separated in various -specialized frames. Some frames can exists multiple times. - -
- - -
- Class synopsis - - - - KTaglib_ID3v2_Frame - - - - - extends - KTaglib_Tag - - - - &Methods; - - - &InheritedMethods; - - - -
- - - -&reference.ktaglib.entities.id3v2frame; - - - - diff --git a/reference/ktaglib/id3v2frame/getSize.xml b/reference/ktaglib/id3v2frame/getSize.xml deleted file mode 100644 index 9e1289ef9421..000000000000 --- a/reference/ktaglib/id3v2frame/getSize.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - KTaglib_ID3v2_Frame::getSize - Returns the size of the frame in bytes - - - &reftitle.description; - - public - int - KTaglib_ID3v2_Frame::getSize - - - - Returns the size of the frame in bytes. Please refer to id3.org to see what - ID3v2 frames are and how they are defined. - - - - &reftitle.returnvalues; - - Returns the size of the frame in bytes - - - - - diff --git a/reference/ktaglib/id3v2frame/toString.xml b/reference/ktaglib/id3v2frame/toString.xml deleted file mode 100644 index cd15ec733ae9..000000000000 --- a/reference/ktaglib/id3v2frame/toString.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - KTaglib_ID3v2_Frame::__toString - Returns a string representation of the frame - - - &reftitle.description; - - public - string - KTaglib_ID3v2_Frame::__toString - - - - Returns a string representation of the frame. This might be just the - frame id, but might contain more information. Please see the ktaglib - documentation for more information - - - - &reftitle.returnvalues; - - Returns a string representation of the frame. - - - - - diff --git a/reference/ktaglib/id3v2tag.xml b/reference/ktaglib/id3v2tag.xml deleted file mode 100644 index 7ac8a73764b4..000000000000 --- a/reference/ktaglib/id3v2tag.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - The KTaglib_ID3v2_Tag class - KTaglib_ID3v2_Tag - - - - -
- &reftitle.intro; - - Represents and ID3v2 tag. It provides a list of ID3v2 frames and can be used - to add and remove additional frames. - -
- - -
- Class synopsis - - - - KTaglib_ID3v2_Tag - - - - - extends - KTaglib_Tag - - - - &Methods; - - - &InheritedMethods; - - - -
- - - -&reference.ktaglib.entities.id3v2tag; - - - - diff --git a/reference/ktaglib/id3v2tag/addFrame.xml b/reference/ktaglib/id3v2tag/addFrame.xml deleted file mode 100644 index 3ff7da617502..000000000000 --- a/reference/ktaglib/id3v2tag/addFrame.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - KTaglib_ID3v2_Tag::addFrame - Add a frame to the ID3v2 tag - - - &reftitle.description; - - public - bool - KTaglib_ID3v2_Tag::addFrame - KTaglib_ID3v2_Frameframe - - - Adds a frame to the ID3v2 tag. The frame must be a valid KTaglib_ID3v2_Frame object. - To save the tag, the save function needs to be invoked. - - - - &reftitle.returnvalues; - - Returns true on success, otherwise false. - - - - - diff --git a/reference/ktaglib/id3v2tag/getFrameList.xml b/reference/ktaglib/id3v2tag/getFrameList.xml deleted file mode 100644 index 5c0b3de45ab1..000000000000 --- a/reference/ktaglib/id3v2tag/getFrameList.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - KTaglib_ID3v2_Tag::getFrameList - Returns an array of ID3v2 frames, associated with the ID3v2 tag - - - &reftitle.description; - - public - array - KTaglib_ID3v2_Tag::getFrameList - - - - Returns an array of ID3v2 frames, associated with the ID3v2 tag. - - - - &reftitle.returnvalues; - - Return an array of KTaglib_ID3v2_Frame objects - - - - - diff --git a/reference/ktaglib/mpegfile.xml b/reference/ktaglib/mpegfile.xml deleted file mode 100644 index 2af060dcc616..000000000000 --- a/reference/ktaglib/mpegfile.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - The KTaglib_MPEG_File class - KTaglib_MPEG_File - - - - -
- &reftitle.intro; - -Represents an MPEG file. MPEG files can have ID3v1, ID3v2 tags and audio properties. - -
- - -
- Class synopsis - - - - KTaglib_MPEG_File - - - - - KTaglib_MPEG_File - - - - &Methods; - - - -
- - - -&reference.ktaglib.entities.mpegfile; - - - - diff --git a/reference/ktaglib/mpegfile/construct.xml b/reference/ktaglib/mpegfile/construct.xml deleted file mode 100644 index 901d53ab965b..000000000000 --- a/reference/ktaglib/mpegfile/construct.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - KTaglib_MPEG_File::__construct - Opens a new file - - - &reftitle.description; - - public KTaglib_MPEG_File::__construct - stringfilename - - - Opens a new MPEG file. - - - - - &reftitle.parameters; - - - - filename - - - The file to read - - - - - - - - &reftitle.examples; - - - Opens a new MP3 file and read the title - -getID3v1Tag()->getTitle(); -?> -]]> - - - - - - - - diff --git a/reference/ktaglib/mpegfile/getAudioProperties.xml b/reference/ktaglib/mpegfile/getAudioProperties.xml deleted file mode 100644 index b96d85ce469a..000000000000 --- a/reference/ktaglib/mpegfile/getAudioProperties.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - KTaglib_MPEG_File::getAudioProperties - Returns an object that provides access to the audio properties - - - &reftitle.description; - - public - KTaglib_MPEG_File - KTaglib_MPEG_File::getAudioProperties - - - - Returns an object that provides access to the audio properties of - the mpeg file. - - - - - &reftitle.returnvalues; - - Returns an KTaglib_MPEG_AudioProperties object or false. - - - - - diff --git a/reference/ktaglib/mpegfile/getID3v1Tag.xml b/reference/ktaglib/mpegfile/getID3v1Tag.xml deleted file mode 100644 index 2b26b9d734f8..000000000000 --- a/reference/ktaglib/mpegfile/getID3v1Tag.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - KTaglib_MPEG_File::getID3v1Tag - Returns an object representing an ID3v1 tag - - - &reftitle.description; - - public - KTaglib_ID3v1_Tag - KTaglib_MPEG_File::getID3v1Tag - boolcreate&false; - - - Returns an object that represents an ID3v1 tag, which can be used - to get information about the ID3v1 tag. - - - - - &reftitle.returnvalues; - - Returns an KTaglib_MPEG_ID3v1Tag object or false if there is no ID3v1 tag. - - - - - diff --git a/reference/ktaglib/mpegfile/getID3v2Tag.xml b/reference/ktaglib/mpegfile/getID3v2Tag.xml deleted file mode 100644 index 7e83723978b1..000000000000 --- a/reference/ktaglib/mpegfile/getID3v2Tag.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - KTaglib_MPEG_File::getID3v2Tag - Returns a ID3v2 object - - - &reftitle.description; - - public - KTaglib_ID3v2_Tag - KTaglib_MPEG_File::getID3v2Tag - boolcreate&false; - - - Returns a ID3v2 object for the mpeg file. If no ID3v2 Tag is present, an - KTaglib_TagNotFoundException is thrown. - - - - &reftitle.returnvalues; - - Returns the KTaglib_ID3v2_Tag object of the MPEG file or false if there is -no ID3v2 tag - - - - - diff --git a/reference/ktaglib/setup.xml b/reference/ktaglib/setup.xml deleted file mode 100644 index b5e5a1280e83..000000000000 --- a/reference/ktaglib/setup.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - &reftitle.setup; - - -
- &reftitle.required; - -If you want to build ktaglib you need at least taglib 1.5 installed. To obtain the taglib see the taglib project page. -Windows DLL's are build static against taglib, therefore there is no need to have taglib installed. - -
- - - - &reference.ktaglib.configure; - - - - - diff --git a/reference/ktaglib/tag.xml b/reference/ktaglib/tag.xml deleted file mode 100644 index e6839bc72c45..000000000000 --- a/reference/ktaglib/tag.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - The KTaglib_Tag class - KTaglib_Tag - - - - -
- &reftitle.intro; - - Base class for ID3v1 or ID3v2 tags - -
- - -
- Class synopsis - - - - KTaglib_Tag - - - - - KTaglib_Tag - - - - &Methods; - - - -
- - - -&reference.ktaglib.entities.tag; - - - - diff --git a/reference/ktaglib/tag/getAlbum.xml b/reference/ktaglib/tag/getAlbum.xml deleted file mode 100644 index bce54cc52f08..000000000000 --- a/reference/ktaglib/tag/getAlbum.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - KTaglib_Tag::getAlbum - Returns the album string from a ID3 tag - - - &reftitle.description; - - public - string - KTaglib_Tag::getAlbum - - - - Returns the album string of an ID3 tag. This method is implemented - in ID3v1 and ID3v2 tags. - - - - &reftitle.returnvalues; - - Returns the album string - - - - - - diff --git a/reference/ktaglib/tag/getArtist.xml b/reference/ktaglib/tag/getArtist.xml deleted file mode 100644 index fe6f1feae9c4..000000000000 --- a/reference/ktaglib/tag/getArtist.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - KTaglib_Tag::getArtist - Returns the artist string from a ID3 tag - - - &reftitle.description; - - public - string - KTaglib_Tag::getArtist - - - - Returns the artist string of an ID3 tag. This method is implemented - in ID3v1 and ID3v2 tags. - - - - &reftitle.returnvalues; - - Returns the artist string - - - - - - diff --git a/reference/ktaglib/tag/getComment.xml b/reference/ktaglib/tag/getComment.xml deleted file mode 100644 index 729a8b9dccce..000000000000 --- a/reference/ktaglib/tag/getComment.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - KTaglib_Tag::getComment - Returns the comment from a ID3 tag - - - &reftitle.description; - - public - string - KTaglib_Tag::getComment - - - - Returns the comment of an ID3 tag. This method is implemented - in ID3v1 and ID3v2 tags. - - - - &reftitle.returnvalues; - - Returns the comment string - - - - - - diff --git a/reference/ktaglib/tag/getGenre.xml b/reference/ktaglib/tag/getGenre.xml deleted file mode 100644 index bf74ea73c91b..000000000000 --- a/reference/ktaglib/tag/getGenre.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - KTaglib_Tag::getGenre - Returns the genre from a ID3 tag - - - &reftitle.description; - - public - string - KTaglib_Tag::getGenre - - - - Returns the genre of an ID3 tag. This method is implemented - in ID3v1 and ID3v2 tags. - - - - &reftitle.returnvalues; - - Returns the genre string - - - - - - diff --git a/reference/ktaglib/tag/getTitle.xml b/reference/ktaglib/tag/getTitle.xml deleted file mode 100644 index a77265b54c60..000000000000 --- a/reference/ktaglib/tag/getTitle.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - KTaglib_Tag::getTitle - Returns the title string from a ID3 tag - - - &reftitle.description; - - public - string - KTaglib_Tag::getTitle - - - - Returns the title string of an ID3 tag. This method is implemented - in ID3v1 and ID3v2 tags. - - - - &reftitle.returnvalues; - - Returns the title string - - - - - - diff --git a/reference/ktaglib/tag/getTrack.xml b/reference/ktaglib/tag/getTrack.xml deleted file mode 100644 index b1560939e707..000000000000 --- a/reference/ktaglib/tag/getTrack.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - KTaglib_Tag::getTrack - Returns the track number from a ID3 tag - - - &reftitle.description; - - public - int - KTaglib_Tag::getTrack - - - - Returns the track number of an ID3 tag. This method is implemented - in ID3v1 and ID3v2 tags. - - - - &reftitle.returnvalues; - - Returns the track number as an integer - - - - - - diff --git a/reference/ktaglib/tag/getYear.xml b/reference/ktaglib/tag/getYear.xml deleted file mode 100644 index 784acc11e624..000000000000 --- a/reference/ktaglib/tag/getYear.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - KTaglib_Tag::getYear - Returns the year from a ID3 tag - - - &reftitle.description; - - public - int - KTaglib_Tag::getYear - - - - Returns the year of an ID3 tag. This method is implemented - in ID3v1 and ID3v2 tags. - - - - &reftitle.returnvalues; - - Returns the year as an integer - - - - - - diff --git a/reference/ktaglib/tag/isEmpty.xml b/reference/ktaglib/tag/isEmpty.xml deleted file mode 100644 index 7187c196ab7b..000000000000 --- a/reference/ktaglib/tag/isEmpty.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - KTaglib_Tag::isEmpty - Returns true if the tag is empty - - - &reftitle.description; - - public - bool - KTaglib_Tag::isEmpty - - - - Returns true if the tag exists, but is empty. This method is implemented - in ID3v1 and ID3v2 tags. - - - - &reftitle.returnvalues; - - Returns true if the tag is empty, otherwise false. - - - - - - diff --git a/reference/ktaglib/versions.xml b/reference/ktaglib/versions.xml deleted file mode 100644 index 544e0b6c5898..000000000000 --- a/reference/ktaglib/versions.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/lapack/book.xml b/reference/lapack/book.xml deleted file mode 100644 index 1b92950bec8f..000000000000 --- a/reference/lapack/book.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - Lapack - Lapack - - - &reftitle.intro; - - LAPACK is written in Fortran 90 and provides routines for solving systems of simultaneous linear equations, least-squares solutions of linear systems of equations, eigenvalue problems, and singular value problems. This extension wraps the LAPACKE C bindings to allow access to several processes exposed by the library. Most functions work with arrays of arrays, representing rectangular matrices in row major order - so a two by two matrix [1 2; 3 4] would be array(array(1, 2), array(3, 4)) - - - - &reference.lapack.setup; - &reference.lapack.constants; - - &reference.lapack.lapack; - &reference.lapack.lapackexception; - - - - diff --git a/reference/lapack/configure.xml b/reference/lapack/configure.xml deleted file mode 100644 index 5515f22ba256..000000000000 --- a/reference/lapack/configure.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - -
- &reftitle.install; - - - &pecl.info; - &url.pecl.package;lapack - - - -
- - - diff --git a/reference/lapack/constants.xml b/reference/lapack/constants.xml deleted file mode 100644 index f390419ffbc7..000000000000 --- a/reference/lapack/constants.xml +++ /dev/null @@ -1,28 +0,0 @@ - - - - - &reftitle.constants; - &no.constants; - - - diff --git a/reference/lapack/lapack.xml b/reference/lapack/lapack.xml deleted file mode 100644 index 3e0d3baea8b5..000000000000 --- a/reference/lapack/lapack.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - - The Lapack class - Lapack - - - - -
- &reftitle.intro; - - LAPACK is written in Fortran 90 and provides routines for solving systems of simultaneous linear equations, least-squares solutions of linear systems of equations, eigenvalue problems, and singular value problems. This extension wraps the LAPACKE C bindings to allow access to several processes exposed by the library. Most functions work with arrays of arrays, representing rectangular matrices in row major order - so a two by two matrix [1 2; 3 4] would be array(array(1, 2), array(3, 4)). - - All of the functions are called statically, for example $eig = Lapack::eigenvalues($a); -
- - -
- &reftitle.classsynopsis; - - - - Lapack - - - - - Lapack - - - - - &Methods; - - - - -
- - - - &reference.lapack.entities.lapack; - - - - diff --git a/reference/lapack/lapack/eigenvalues.xml b/reference/lapack/lapack/eigenvalues.xml deleted file mode 100644 index 173f231ddc61..000000000000 --- a/reference/lapack/lapack/eigenvalues.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - Lapack::eigenValues - This function returns the eigenvalues for a given square matrix - - - - &reftitle.description; - - public static arrayLapack::eigenValues - arraya - arrayleft - arrayright - - - Calculate the eigenvalues for a square matrix, and optionally calculate the left and right eigenvectors. - - - - - - &reftitle.parameters; - - - a - - - The matrix to calculate the eigenvalues for. - - - - - left - - - Optional parameter - if an array is passed here, it will be filled with the left eigenvectors - - - - - right - - - Optional parameter - if an array is passed here, it will be filled with the right eigenvectors - - - - - - - - &reftitle.returnvalues; - - Returns an array of arrays representing the eigenvalues for the array. - - - - - &reftitle.examples; - - - Using <function>Lapack::eigenValues</function>: - - - ]]> - - - - - - - - - diff --git a/reference/lapack/lapack/identity.xml b/reference/lapack/lapack/identity.xml deleted file mode 100644 index 347d029520e6..000000000000 --- a/reference/lapack/lapack/identity.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - - Lapack::identity - Return an identity matrix - - - - &reftitle.description; - - public static arrayLapack::identity - intn - - - Return a size n identity matrix - - - - - - &reftitle.parameters; - - - n - - - The height and width of the identity matrix. - - - - - - - - &reftitle.returnvalues; - - Will return a an array of n arrays, each containing n entries. The diagonals of the matrix will be 1s, the other positions 0. - - - - - - - diff --git a/reference/lapack/lapack/leastsquaresbyfactorisation.xml b/reference/lapack/lapack/leastsquaresbyfactorisation.xml deleted file mode 100644 index e17e47d2061c..000000000000 --- a/reference/lapack/lapack/leastsquaresbyfactorisation.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - Lapack::leastSquaresByFactorisation - Calculate the linear least squares solution of a matrix using QR factorisation - - - - &reftitle.description; - - public static arrayLapack::leastSquaresByFactorisation - arraya - arrayb - - - Solve the linear least squares problem, find min x in || B - Ax || - Returns an array representing x. Expects arrays of arrays, and will - return an array of arrays in the dimension B num cols x A num cols. - Uses QR or LQ factorisation on matrix A. - - - - - - &reftitle.parameters; - - - a - - - Matrix A - - - - - b - - - Matrix B - - - - - - - - &reftitle.returnvalues; - - Array of the solution matrix - - - - - &reftitle.examples; - - - Using <function>Lapack::leastSquaresByFactorisation</function>: - - - ]]> - - - - - - - - - diff --git a/reference/lapack/lapack/leastsquaresbysvd.xml b/reference/lapack/lapack/leastsquaresbysvd.xml deleted file mode 100644 index e316736a700b..000000000000 --- a/reference/lapack/lapack/leastsquaresbysvd.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - Lapack::leastSquaresBySVD - Solve the linear least squares problem, using SVD - - - - &reftitle.description; - - public static arrayLapack::leastSquaresBySVD - arraya - arrayb - - - Solve the linear least squares problem, find min x in || B - Ax || - Returns an array representing x. Expects arrays of arrays, and will - return an array of arrays in the dimension B num cols x A num cols. - Uses SVD with a divide and conquer algorithm. - - - - - - &reftitle.parameters; - - - a - - - Matrix A - - - - - b - - - Matrix B - - - - - - - - &reftitle.returnvalues; - - Returns the solution as an array of arrays. - - - - - &reftitle.examples; - - - Using <function>Lapack::leastSquaresBySVD</function>: - - - ]]> - - - - - - - - diff --git a/reference/lapack/lapack/pseudoinverse.xml b/reference/lapack/lapack/pseudoinverse.xml deleted file mode 100644 index 4c572109a2cd..000000000000 --- a/reference/lapack/lapack/pseudoinverse.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - - Lapack::pseudoInverse - Calculate the inverse of a matrix - - - - &reftitle.description; - - public static arrayLapack::pseudoInverse - arraya - - - Find the pseudoinverse of a matrix A. - - - - - - &reftitle.parameters; - - - a - - - Matrix to invert - - - - - - - - &reftitle.returnvalues; - - Inverted matrix (array of arrays). - - - - - &reftitle.examples; - - - Using <function>Lapack::pseudoInverse</function>: - - - ]]> - - - - - - - - diff --git a/reference/lapack/lapack/singularvalues.xml b/reference/lapack/lapack/singularvalues.xml deleted file mode 100644 index 6e961415b5a0..000000000000 --- a/reference/lapack/lapack/singularvalues.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Lapack::singularValues - Calculated the singular values of a matrix - - - - &reftitle.description; - - public static arrayLapack::singularValues - arraya - - - Calculate the singular values of the matrix A. - - - - - - &reftitle.parameters; - - - a - - - The matrix to calculate the singular values for - - - - - - - - &reftitle.returnvalues; - - The singular values - - - - - &reftitle.examples; - - - Using <function>Lapack::singularValues</function>: - - - ]]> - - - - - - - - - diff --git a/reference/lapack/lapack/solvelinearequation.xml b/reference/lapack/lapack/solvelinearequation.xml deleted file mode 100644 index cfd900cc96fd..000000000000 --- a/reference/lapack/lapack/solvelinearequation.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - - Lapack::solveLinearEquation - Solve a system of linear equations - - - - &reftitle.description; - - public static arrayLapack::solveLinearEquation - arraya - arrayb - - - This function computes the solution to the system of linear - equations with a square matrix A and multiple - right-hand sides B. Solves A * X = B for multiple B. - - - - - - &reftitle.parameters; - - - a - - - Square matrix of linear equations - - - - - b - - - Right hand side to be solved for - - - - - - - - &reftitle.returnvalues; - - Matrix X - - - - - &reftitle.examples; - - - Using <function>Lapack::singularValues</function>: - - - ]]> - - - - - - - - - diff --git a/reference/lapack/lapackexception.xml b/reference/lapack/lapackexception.xml deleted file mode 100644 index 8c8cfc32ebf4..000000000000 --- a/reference/lapack/lapackexception.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - The LapackException class - LapackException - - - - -
- &reftitle.intro; - - Exception thrown when an error is caught in the LAPACK functions - -
- - -
- &reftitle.classsynopsis; - - - - lapackexception - - - - - lapackexception - - - - extends - Exception - - - - - &InheritedProperties; - - - &InheritedMethods; - - - - - -
- - - - - - - diff --git a/reference/lapack/setup.xml b/reference/lapack/setup.xml deleted file mode 100644 index bd9953a1f02f..000000000000 --- a/reference/lapack/setup.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.required; - - Lapack requires the LAPACK and LAPACKE libraries. - -
- -
- &reftitle.install; - - Most distribution LAPACK packages do not include lapacke, so the easiest method is to build from source: - - - - - -
- -
- &reftitle.runtime; - &no.config; -
- -
- &reftitle.resources; - &no.resource; -
- - - - diff --git a/reference/lapack/versions.xml b/reference/lapack/versions.xml deleted file mode 100644 index 1d2e6fd3964c..000000000000 --- a/reference/lapack/versions.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/ldap/functions/ldap-first-attribute.xml b/reference/ldap/functions/ldap-first-attribute.xml index 6b88ba9e60b5..f5162b07be76 100644 --- a/reference/ldap/functions/ldap-first-attribute.xml +++ b/reference/ldap/functions/ldap-first-attribute.xml @@ -73,31 +73,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.4 - - The ber_identifier was removed. This - is now handled automatically by PHP. - - - - - - - - &reftitle.seealso; diff --git a/reference/ldap/functions/ldap-next-attribute.xml b/reference/ldap/functions/ldap-next-attribute.xml index e650d1eceee0..ae2a23449b6d 100644 --- a/reference/ldap/functions/ldap-next-attribute.xml +++ b/reference/ldap/functions/ldap-next-attribute.xml @@ -67,31 +67,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.4 - - The ber_identifier was removed. This - is now handled automatically by PHP. - - - - - - - - &reftitle.seealso; diff --git a/reference/ldap/functions/ldap-sasl-bind.xml b/reference/ldap/functions/ldap-sasl-bind.xml index 12bdde599e13..47e6aa6ff233 100644 --- a/reference/ldap/functions/ldap-sasl-bind.xml +++ b/reference/ldap/functions/ldap-sasl-bind.xml @@ -41,29 +41,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.3 - - Support on Windows was added. - - - - - - - - - - Libevent - Libevent - - - - &reftitle.intro; - - Libevent is a library that provides a mechanism to execute a callback - function when a specific event occurs on a file descriptor or after a - timeout has been reached. - - - More information about Libevent can be found at &url.libevent;. - - - - The libevent extension is unmaintained; consider to use the - event extension instead. - - - - - - &reference.libevent.setup; - &reference.libevent.constants; - &reference.libevent.examples; - &reference.libevent.reference; - - - - - diff --git a/reference/libevent/constants.xml b/reference/libevent/constants.xml deleted file mode 100644 index d694b46897ad..000000000000 --- a/reference/libevent/constants.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - EV_TIMEOUT - (integer) - - - - - - - - - - EV_READ - (integer) - - - - - - - - - - EV_WRITE - (integer) - - - - - - - - - - EV_SIGNAL - (integer) - - - - - - - - - - EV_PERSIST - (integer) - - - - - - - - - - EVLOOP_NONBLOCK - (integer) - - - - - - - - - - EVLOOP_ONCE - (integer) - - - - - - - - - - - - diff --git a/reference/libevent/examples.xml b/reference/libevent/examples.xml deleted file mode 100644 index 319117617570..000000000000 --- a/reference/libevent/examples.xml +++ /dev/null @@ -1,110 +0,0 @@ - - - - - &reftitle.examples; - - - polling <constant>STDIN</constant> using basic API - - -]]> - - - - - - polling <constant>STDIN</constant> using buffered event API - - -]]> - - - - - - - diff --git a/reference/libevent/functions/event-add.xml b/reference/libevent/functions/event-add.xml deleted file mode 100644 index ed6d5e09a330..000000000000 --- a/reference/libevent/functions/event-add.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - event_add - Add an event to the set of monitored events - - - - &reftitle.description; - - boolevent_add - resourceevent - inttimeout-1 - - - event_add schedules the execution of the event - when the event specified in event_set occurs or in at least the time - specified by the timeout argument. If - timeout was not specified, not timeout is set. The - event must be already initalized by event_set - and event_base_set functions. If the - event already has a timeout set, it is replaced by - the new one. - - - - - &reftitle.parameters; - - - - event - - - Valid event resource. - - - - - timeout - - - Optional timeout (in microseconds). - - - - - - - - - &reftitle.returnvalues; - - event_add returns &true; on success or &false; on error. - - - - - - diff --git a/reference/libevent/functions/event-base-free.xml b/reference/libevent/functions/event-base-free.xml deleted file mode 100644 index d8e613db232e..000000000000 --- a/reference/libevent/functions/event-base-free.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - event_base_free - Destroy event base - - - - &reftitle.description; - - voidevent_base_free - resourceevent_base - - - Destroys the specified event_base and frees all the - resources associated. Note that it's not possible to destroy an event base - with events attached to it. - - - - - &reftitle.parameters; - - - - event_base - - - Valid event base resource. - - - - - - - - - - diff --git a/reference/libevent/functions/event-base-loop.xml b/reference/libevent/functions/event-base-loop.xml deleted file mode 100644 index 665e95191906..000000000000 --- a/reference/libevent/functions/event-base-loop.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - event_base_loop - Handle events - - - - &reftitle.description; - - intevent_base_loop - resourceevent_base - intflags0 - - - Starts event loop for the specified event base. - - - - - &reftitle.parameters; - - - - event_base - - - Valid event base resource. - - - - - flags - - - Optional parameter, which can take any combination of - EVLOOP_ONCE and EVLOOP_NONBLOCK. - - - - - - - - - &reftitle.returnvalues; - - event_base_loop returns 0 on success, -1 on error and - 1 if no events were registered. - - - - - - diff --git a/reference/libevent/functions/event-base-loopbreak.xml b/reference/libevent/functions/event-base-loopbreak.xml deleted file mode 100644 index 3274d6528539..000000000000 --- a/reference/libevent/functions/event-base-loopbreak.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - event_base_loopbreak - Abort event loop - - - - &reftitle.description; - - boolevent_base_loopbreak - resourceevent_base - - - Abort the active event loop immediately. The behaviour is similar to - break statement. - - - - - &reftitle.parameters; - - - - event_base - - - Valid event base resource. - - - - - - - - - &reftitle.returnvalues; - - event_base_loopbreak returns &true; on success or &false; on error. - - - - - - diff --git a/reference/libevent/functions/event-base-loopexit.xml b/reference/libevent/functions/event-base-loopexit.xml deleted file mode 100644 index 08bf2a76bdc9..000000000000 --- a/reference/libevent/functions/event-base-loopexit.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - event_base_loopexit - Exit loop after a time - - - - &reftitle.description; - - boolevent_base_loopexit - resourceevent_base - inttimeout-1 - - - The next event loop iteration after the given timer expires will complete - normally, then exit without blocking for events again. - - - - - &reftitle.parameters; - - - - event_base - - - Valid event base resource. - - - - - timeout - - - Optional timeout parameter (in microseconds). - - - - - - - - - &reftitle.returnvalues; - - event_base_loopexit returns &true; on success or &false; on error. - - - - - - diff --git a/reference/libevent/functions/event-base-new.xml b/reference/libevent/functions/event-base-new.xml deleted file mode 100644 index 3606f1f6a0c9..000000000000 --- a/reference/libevent/functions/event-base-new.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - event_base_new - Create and initialize new event base - - - - &reftitle.description; - - resourceevent_base_new - - - - Returns new event base, which can be used later in event_base_set, - event_base_loop and other functions. - - - - - &reftitle.parameters; - &no.function.parameters; - - - - - - &reftitle.returnvalues; - - event_base_new returns valid event base resource on - success or &false; on error. - - - - - - diff --git a/reference/libevent/functions/event-base-priority-init.xml b/reference/libevent/functions/event-base-priority-init.xml deleted file mode 100644 index 77cfbf027d96..000000000000 --- a/reference/libevent/functions/event-base-priority-init.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - event_base_priority_init - Set the number of event priority levels - - - - &reftitle.description; - - boolevent_base_priority_init - resourceevent_base - intnpriorities - - - Sets the number of different event priority levels. - - - By default all events are scheduled with the same priority - (npriorities/2). - Using event_base_priority_init you can change the number - of event priority levels and then set a desired priority for each event. - - - - - &reftitle.parameters; - - - - event_base - - - Valid event base resource. - - - - - npriorities - - - The number of event priority levels. - - - - - - - - - &reftitle.returnvalues; - - event_base_priority_init returns &true; on success or &false; on error. - - - - - - diff --git a/reference/libevent/functions/event-base-reinit.xml b/reference/libevent/functions/event-base-reinit.xml deleted file mode 100644 index 332e547cfc90..000000000000 --- a/reference/libevent/functions/event-base-reinit.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - event_base_reinit - Reinitialize the event base after a fork - - - - &reftitle.description; - - boolevent_base_reinit - resourceevent_base - - - Some event mechanisms do not survive across fork. The - event_base needs to be reinitialized with this - function. - - - - - &reftitle.parameters; - - - - event_base - - - Valid event base resource that needs to be re-initialized. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/libevent/functions/event-base-set.xml b/reference/libevent/functions/event-base-set.xml deleted file mode 100644 index b89d922e7e5b..000000000000 --- a/reference/libevent/functions/event-base-set.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - event_base_set - Associate event base with an event - - - - &reftitle.description; - - boolevent_base_set - resourceevent - resourceevent_base - - - Associates the event_base with the - event. - - - - - &reftitle.parameters; - - - - event - - - Valid event resource. - - - - - event_base - - - Valid event base resource. - - - - - - - - - &reftitle.returnvalues; - - event_base_set returns &true; on success or &false; on error. - - - - - - diff --git a/reference/libevent/functions/event-buffer-base-set.xml b/reference/libevent/functions/event-buffer-base-set.xml deleted file mode 100644 index f00f0b0c5b84..000000000000 --- a/reference/libevent/functions/event-buffer-base-set.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - event_buffer_base_set - Associate buffered event with an event base - - - - &reftitle.description; - - boolevent_buffer_base_set - resourcebevent - resourceevent_base - - - Assign the specified bevent to the - event_base. - - - - - &reftitle.parameters; - - - - bevent - - - Valid buffered event resource. - - - - - event_base - - - Valid event base resource. - - - - - - - - - &reftitle.returnvalues; - - event_buffer_base_set returns &true; on success or &false; on error. - - - - - - diff --git a/reference/libevent/functions/event-buffer-disable.xml b/reference/libevent/functions/event-buffer-disable.xml deleted file mode 100644 index 6351d6c41896..000000000000 --- a/reference/libevent/functions/event-buffer-disable.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - event_buffer_disable - Disable a buffered event - - - - &reftitle.description; - - boolevent_buffer_disable - resourcebevent - intevents - - - Disables the specified buffered event. - - - - - &reftitle.parameters; - - - - bevent - - - Valid buffered event resource. - - - - - events - - - Any combination of EV_READ and - EV_WRITE. - - - - - - - - - &reftitle.returnvalues; - - event_buffer_disable returns &true; on success or &false; on error. - - - - - - diff --git a/reference/libevent/functions/event-buffer-enable.xml b/reference/libevent/functions/event-buffer-enable.xml deleted file mode 100644 index b29620dbd394..000000000000 --- a/reference/libevent/functions/event-buffer-enable.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - event_buffer_enable - Enable a buffered event - - - - &reftitle.description; - - boolevent_buffer_enable - resourcebevent - intevents - - - Enables the specified buffered event. - - - - - &reftitle.parameters; - - - - bevent - - - Valid buffered event resource. - - - - - events - - - Any combination of EV_READ and - EV_WRITE. - - - - - - - - - &reftitle.returnvalues; - - event_buffer_enable returns &true; on success or &false; on error. - - - - - - diff --git a/reference/libevent/functions/event-buffer-fd-set.xml b/reference/libevent/functions/event-buffer-fd-set.xml deleted file mode 100644 index 6b0a85e869c1..000000000000 --- a/reference/libevent/functions/event-buffer-fd-set.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - event_buffer_fd_set - Change a buffered event file descriptor - - - - &reftitle.description; - - voidevent_buffer_fd_set - resourcebevent - resourcefd - - - Changes the file descriptor on which the buffered event operates. - - - - - &reftitle.parameters; - - - - bevent - - - Valid buffered event resource. - - - - - fd - - - Valid PHP stream, must be castable to file descriptor. - - - - - - - - - - diff --git a/reference/libevent/functions/event-buffer-free.xml b/reference/libevent/functions/event-buffer-free.xml deleted file mode 100644 index ebb4c806e20e..000000000000 --- a/reference/libevent/functions/event-buffer-free.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - event_buffer_free - Destroy buffered event - - - - &reftitle.description; - - voidevent_buffer_free - resourcebevent - - - Destroys the specified buffered event and frees all the resources - associated. - - - - - &reftitle.parameters; - - - - bevent - - - Valid buffered event resource. - - - - - - - - - - diff --git a/reference/libevent/functions/event-buffer-new.xml b/reference/libevent/functions/event-buffer-new.xml deleted file mode 100644 index 47075faee63a..000000000000 --- a/reference/libevent/functions/event-buffer-new.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - event_buffer_new - Create new buffered event - - - - &reftitle.description; - - resourceevent_buffer_new - resourcestream - mixedreadcb - mixedwritecb - mixederrorcb - mixedarg - - - Libevent provides an abstraction layer on top of the regular event API. - Using buffered event you don't need to deal with the I/O manually, instead - it provides input and output buffers that get filled and drained - automatically. - - - - - &reftitle.parameters; - - - - stream - - - Valid PHP stream resource. Must be castable to file descriptor. - - - - - readcb - - - Callback to invoke where there is data to read, or NULL if - no callback is desired. - - - - - writecb - - - Callback to invoke where the descriptor is ready for writing, - or NULL if no callback is desired. - - - - - errorcb - - - Callback to invoke where there is an error on the descriptor, cannot be - NULL. - - - - - arg - - - An argument that will be passed to each of the callbacks (optional). - - - - - - - - - &reftitle.returnvalues; - - event_buffer_new returns new buffered event resource - on success or &false; on error. - - - - - - diff --git a/reference/libevent/functions/event-buffer-priority-set.xml b/reference/libevent/functions/event-buffer-priority-set.xml deleted file mode 100644 index b24d8230a7f9..000000000000 --- a/reference/libevent/functions/event-buffer-priority-set.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - event_buffer_priority_set - Assign a priority to a buffered event - - - - &reftitle.description; - - boolevent_buffer_priority_set - resourcebevent - intpriority - - - Assign a priority to the bevent. - - - - - &reftitle.parameters; - - - - bevent - - - Valid buffered event resource. - - - - - priority - - - Priority level. Cannot be less than zero and cannot exceed maximum - priority level of the event base (see event_base_priority_init). - - - - - - - - - &reftitle.returnvalues; - - event_buffer_priority_set returns &true; on success or &false; on error. - - - - - - diff --git a/reference/libevent/functions/event-buffer-read.xml b/reference/libevent/functions/event-buffer-read.xml deleted file mode 100644 index 594c6a2d2e41..000000000000 --- a/reference/libevent/functions/event-buffer-read.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - event_buffer_read - Read data from a buffered event - - - - &reftitle.description; - - stringevent_buffer_read - resourcebevent - intdata_size - - - Reads data from the input buffer of the buffered event. - - - - - &reftitle.parameters; - - - - bevent - - - Valid buffered event resource. - - - - - data_size - - - Data size in bytes. - - - - - - - - - - diff --git a/reference/libevent/functions/event-buffer-set-callback.xml b/reference/libevent/functions/event-buffer-set-callback.xml deleted file mode 100644 index ed179d5063fc..000000000000 --- a/reference/libevent/functions/event-buffer-set-callback.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - event_buffer_set_callback - Set or reset callbacks for a buffered event - - - - &reftitle.description; - - boolevent_buffer_set_callback - resourceevent - mixedreadcb - mixedwritecb - mixederrorcb - mixedarg - - - Sets or changes existing callbacks for the buffered event. - - - - - &reftitle.parameters; - - - - event - - - Valid buffered event resource. - - - - - readcb - - - Callback to invoke where there is data to read, or NULL if - no callback is desired. - - - - - writecb - - - Callback to invoke where the descriptor is ready for writing, - or NULL if no callback is desired. - - - - - errorcb - - - Callback to invoke where there is an error on the descriptor, cannot be - NULL. - - - - - arg - - - An argument that will be passed to each of the callbacks (optional). - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/libevent/functions/event-buffer-timeout-set.xml b/reference/libevent/functions/event-buffer-timeout-set.xml deleted file mode 100644 index e4c6226f9274..000000000000 --- a/reference/libevent/functions/event-buffer-timeout-set.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - event_buffer_timeout_set - Set read and write timeouts for a buffered event - - - - &reftitle.description; - - voidevent_buffer_timeout_set - resourcebevent - intread_timeout - intwrite_timeout - - - Sets the read and write timeouts for the specified buffered event. - - - - - &reftitle.parameters; - - - - bevent - - - Valid buffered event resource. - - - - - read_timeout - - - Read timeout (in seconds). - - - - - write_timeout - - - Write timeout (in seconds). - - - - - - - - - - diff --git a/reference/libevent/functions/event-buffer-watermark-set.xml b/reference/libevent/functions/event-buffer-watermark-set.xml deleted file mode 100644 index d2115775fd05..000000000000 --- a/reference/libevent/functions/event-buffer-watermark-set.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - event_buffer_watermark_set - Set the watermarks for read and write events - - - - &reftitle.description; - - voidevent_buffer_watermark_set - resourcebevent - intevents - intlowmark - inthighmark - - - Sets the watermarks for read and write events. Libevent does not invoke - read callback unless there is at least lowmark bytes - in the input buffer; if the read buffer is beyond the highmark, - reading is stopped. On output, the write callback is invoked whenever the - buffered data falls below the lowmark. - - - - - &reftitle.parameters; - - - - bevent - - - Valid buffered event resource. - - - - - events - - - Any combination of EV_READ and - EV_WRITE. - - - - - lowmark - - - Low watermark. - - - - - highmark - - - High watermark. - - - - - - - - - - diff --git a/reference/libevent/functions/event-buffer-write.xml b/reference/libevent/functions/event-buffer-write.xml deleted file mode 100644 index 9929cedf3b63..000000000000 --- a/reference/libevent/functions/event-buffer-write.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - event_buffer_write - Write data to a buffered event - - - - &reftitle.description; - - boolevent_buffer_write - resourcebevent - stringdata - intdata_size-1 - - - Writes data to the specified buffered event. The data is appended to the - output buffer and written to the descriptor when it becomes available for - writing. - - - - - &reftitle.parameters; - - - - bevent - - - Valid buffered event resource. - - - - - data - - - The data to be written. - - - - - data_size - - - Optional size parameter. event_buffer_write writes - all the data by default. - - - - - - - - - &reftitle.returnvalues; - - event_buffer_write returns &true; on success or &false; on error. - - - - - - diff --git a/reference/libevent/functions/event-del.xml b/reference/libevent/functions/event-del.xml deleted file mode 100644 index 6ec1ab95c588..000000000000 --- a/reference/libevent/functions/event-del.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - event_del - Remove an event from the set of monitored events - - - - &reftitle.description; - - boolevent_del - resourceevent - - - Cancels the event. - - - - - &reftitle.parameters; - - - - event - - - Valid event resource. - - - - - - - - - &reftitle.returnvalues; - - event_del returns &true; on success or &false; on error. - - - - - - diff --git a/reference/libevent/functions/event-free.xml b/reference/libevent/functions/event-free.xml deleted file mode 100644 index 2ce6054a02e9..000000000000 --- a/reference/libevent/functions/event-free.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - event_free - Free event resource - - - - &reftitle.description; - - voidevent_free - resourceevent - - - Frees previously created event resource. - - - - - &reftitle.parameters; - - - - event - - - Valid event resource. - - - - - - - - - - diff --git a/reference/libevent/functions/event-new.xml b/reference/libevent/functions/event-new.xml deleted file mode 100644 index f4a84cde4141..000000000000 --- a/reference/libevent/functions/event-new.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - event_new - Create new event - - - - &reftitle.description; - - resourceevent_new - - - - Creates and returns a new event resource. - - - - - &reftitle.returnvalues; - - event_new returns a new event resource on success or &false; on error. - - - - - diff --git a/reference/libevent/functions/event-priority-set.xml b/reference/libevent/functions/event-priority-set.xml deleted file mode 100644 index 5d08f793eec3..000000000000 --- a/reference/libevent/functions/event-priority-set.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - event_priority_set - Assign a priority to an event - - - - &reftitle.description; - - boolevent_priority_set - resourceevent - intpriority - - - Assign a priority to the event. - - - - - &reftitle.parameters; - - - - event - - - Valid event resource. - - - - - priority - - - Priority level. Cannot be less than zero and cannot exceed maximum - priority level of the event base (see - event_base_priority_init). - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/libevent/functions/event-set.xml b/reference/libevent/functions/event-set.xml deleted file mode 100644 index af263d3744a4..000000000000 --- a/reference/libevent/functions/event-set.xml +++ /dev/null @@ -1,175 +0,0 @@ - - - - - event_set - Prepare an event - - - - &reftitle.description; - - boolevent_set - resourceevent - mixedfd - intevents - mixedcallback - mixedarg - - - Prepares the event to be used in event_add. The event - is prepared to call the function specified by the callback - on the events specified in parameter events, which - is a set of the following flags: EV_TIMEOUT, - EV_SIGNAL, EV_READ, - EV_WRITE and EV_PERSIST. - - - If EV_SIGNAL bit is set in parameter events, - the fd is interpreted as signal number. - - - After initializing the event, use event_base_set to - associate the event with its event base. - - - In case of matching event, these three arguments are passed to the - callback function: - - - fd - - - Signal number or resource indicating the stream. - - - - - events - - - A flag indicating the event. Consists of the following flags: - EV_TIMEOUT, EV_SIGNAL, - EV_READ, EV_WRITE - and EV_PERSIST. - - - - - arg - - - Optional parameter, previously passed to event_set - as arg. - - - - - - - - - &reftitle.parameters; - - - - event - - - Valid event resource. - - - - - fd - - - Valid PHP stream resource. The stream must be castable to file - descriptor, so you most likely won't be able to use any of filtered - streams. - - - - - events - - - A set of flags indicating the desired event, can be - EV_READ and/or EV_WRITE. - The additional flag EV_PERSIST makes the event - to persist until event_del is called, otherwise - the callback is invoked only once. - - - - - callback - - - Callback function to be called when the matching event occurs. - - - - - arg - - - Optional callback parameter. - - - - - - - - - &reftitle.returnvalues; - - event_set returns &true; on success or &false; on error. - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 0.0.4 - - EV_SIGNAL support was added. - - - - - - - - - - diff --git a/reference/libevent/functions/event-timer-add.xml b/reference/libevent/functions/event-timer-add.xml deleted file mode 100644 index 15c89243ca95..000000000000 --- a/reference/libevent/functions/event-timer-add.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - event_timer_add - &Alias; event_add - - - - &reftitle.description; - - &info.function.alias; - event_add. - - - - - - diff --git a/reference/libevent/functions/event-timer-del.xml b/reference/libevent/functions/event-timer-del.xml deleted file mode 100644 index 0e6d595967f6..000000000000 --- a/reference/libevent/functions/event-timer-del.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - event_timer_del - &Alias; event_del - - - - &reftitle.description; - - &info.function.alias; - event_del. - - - - - - diff --git a/reference/libevent/functions/event-timer-new.xml b/reference/libevent/functions/event-timer-new.xml deleted file mode 100644 index a995d39cb85f..000000000000 --- a/reference/libevent/functions/event-timer-new.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - event_timer_new - &Alias; event_new - - - - &reftitle.description; - - &info.function.alias; - event_new. - - - - - - diff --git a/reference/libevent/functions/event-timer-set.xml b/reference/libevent/functions/event-timer-set.xml deleted file mode 100644 index f30b24cf96c6..000000000000 --- a/reference/libevent/functions/event-timer-set.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - event_timer_set - Prepare a timer event - - - - &reftitle.description; - - boolevent_timer_set - resourceevent - callablecallback - mixedarg - - - Prepares the timer event to be used in event_add. The - event is prepared to call the function specified by the - callback when the event timeout elapses. - - - After initializing the event, use event_base_set to - associate the event with its event base. - - - In case of matching event, these three arguments are passed to the - callback function: - - - fd - - - Signal number or resource indicating the stream. - - - - - events - - - A flag indicating the event. This will always be - EV_TIMEOUT for timer events. - - - - - arg - - - Optional parameter, previously passed to - event_timer_set as arg. - - - - - - - - - &reftitle.parameters; - - - - event - - - Valid event resource. - - - - - callback - - - Callback function to be called when the matching event occurs. - - - - - arg - - - Optional callback parameter. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/libevent/ini.xml b/reference/libevent/ini.xml deleted file mode 100644 index 4a1b2efbbd14..000000000000 --- a/reference/libevent/ini.xml +++ /dev/null @@ -1,27 +0,0 @@ - - -
- &reftitle.runtime; - &no.config; -
- - diff --git a/reference/libevent/reference.xml b/reference/libevent/reference.xml deleted file mode 100644 index 14dd0cfbbe69..000000000000 --- a/reference/libevent/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - Libevent &Functions; - - &reference.libevent.entities.functions; - - - - diff --git a/reference/libevent/setup.xml b/reference/libevent/setup.xml deleted file mode 100644 index 5458f0da5b82..000000000000 --- a/reference/libevent/setup.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - &reftitle.setup; - - -
- &reftitle.required; - - This extension requires libevent - library. Minimal required version is 1.4.0. - -
- - - -
- &reftitle.install; - - &pecl.info; - &url.pecl.package;libevent. - -
- - - - &reference.libevent.ini; - - - -
- &reftitle.resources; - - There are several resource types used in the extension. These resources - are event, event base and buffered event. - -
- - - - - - diff --git a/reference/libevent/versions.xml b/reference/libevent/versions.xml deleted file mode 100644 index e7dd3a72daf8..000000000000 --- a/reference/libevent/versions.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/mail/functions/mail.xml b/reference/mail/functions/mail.xml index 9329362a8282..b4292437e8de 100644 --- a/reference/mail/functions/mail.xml +++ b/reference/mail/functions/mail.xml @@ -200,14 +200,6 @@ $text = str_replace("\n.", "\n..", $text); an array. - - 5.4.42, 5.5.27 - - Header injection protection has been added for the - additional_headers parameter. This means that - multiple consecutive newlines are no longer allowed. - - diff --git a/reference/math/functions/acosh.xml b/reference/math/functions/acosh.xml index 888bcd18bb92..bc48cbd6697a 100644 --- a/reference/math/functions/acosh.xml +++ b/reference/math/functions/acosh.xml @@ -38,29 +38,6 @@ The inverse hyperbolic cosine of arg - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function is now available on all platforms - - - - - - - &reftitle.seealso; diff --git a/reference/math/functions/asinh.xml b/reference/math/functions/asinh.xml index 1332b3f5add0..54ac38a432c9 100644 --- a/reference/math/functions/asinh.xml +++ b/reference/math/functions/asinh.xml @@ -38,29 +38,6 @@ The inverse hyperbolic sine of arg - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function is now available on all platforms - - - - - - - &reftitle.seealso; diff --git a/reference/math/functions/atanh.xml b/reference/math/functions/atanh.xml index e5ae2bd87530..cb42ba149fa9 100644 --- a/reference/math/functions/atanh.xml +++ b/reference/math/functions/atanh.xml @@ -38,29 +38,6 @@ Inverse hyperbolic tangent of arg - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function is now available on all platforms - - - - - - - &reftitle.seealso; diff --git a/reference/math/functions/expm1.xml b/reference/math/functions/expm1.xml index af6c9bb873ea..84269c6d5124 100644 --- a/reference/math/functions/expm1.xml +++ b/reference/math/functions/expm1.xml @@ -43,29 +43,6 @@ 'e' to the power of arg minus one - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function is now available on all platforms - - - - - - - &reftitle.seealso; diff --git a/reference/math/functions/log1p.xml b/reference/math/functions/log1p.xml index 7c04c57a2a61..44436723c400 100644 --- a/reference/math/functions/log1p.xml +++ b/reference/math/functions/log1p.xml @@ -43,29 +43,6 @@ log(1 + number) - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function is now available on all platforms - - - - - - - &reftitle.seealso; diff --git a/reference/math/functions/mt-rand.xml b/reference/math/functions/mt-rand.xml index 7b1084af757b..91d90aa4cbcf 100644 --- a/reference/math/functions/mt-rand.xml +++ b/reference/math/functions/mt-rand.xml @@ -98,13 +98,6 @@ the Mersenne Twister algorithm. To fall back to the old behaviour, use mt_srand with MT_RAND_PHP as the second parameter. - - 5.3.4 - - Issues an E_WARNING and returns &false; if - max < min. - - diff --git a/reference/math/functions/mt-srand.xml b/reference/math/functions/mt-srand.xml index b3894aec3f73..040b9e1724f5 100644 --- a/reference/math/functions/mt-srand.xml +++ b/reference/math/functions/mt-srand.xml @@ -102,16 +102,6 @@ the Mersenne Twister algorithm. To fall back to the old behaviour, use mt_srand with MT_RAND_PHP as the second parameter. - - 5.2.1 - - The Mersenne Twister implementation in PHP now uses a new seeding - algorithm by Richard Wagner. Identical seeds no longer produce the same - sequence of values they did in previous versions. This behavior is not - expected to change again, but it is considered unsafe to rely upon it - nonetheless. - - diff --git a/reference/math/functions/round.xml b/reference/math/functions/round.xml index f7b857748fb0..9ebc230a54b1 100644 --- a/reference/math/functions/round.xml +++ b/reference/math/functions/round.xml @@ -302,36 +302,6 @@ float(-1.5) - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - The mode parameter was introduced. - - - - 5.2.7 - - The inner workings of round was changed - to conform to the C99 standard. - - - - - - - &reftitle.seealso; diff --git a/reference/mbstring/functions/mb-decode-numericentity.xml b/reference/mbstring/functions/mb-decode-numericentity.xml index 74310cbececa..8df08a1685b2 100644 --- a/reference/mbstring/functions/mb-decode-numericentity.xml +++ b/reference/mbstring/functions/mb-decode-numericentity.xml @@ -67,30 +67,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - Added is_hex parameter. - - - - - - - - &reftitle.examples; diff --git a/reference/mbstring/functions/mb-encode-numericentity.xml b/reference/mbstring/functions/mb-encode-numericentity.xml index 1b176e34ff16..08fed47e3042 100644 --- a/reference/mbstring/functions/mb-encode-numericentity.xml +++ b/reference/mbstring/functions/mb-encode-numericentity.xml @@ -69,30 +69,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - Added is_hex parameter. - - - - - - - - &reftitle.examples; diff --git a/reference/mbstring/functions/mb-get-info.xml b/reference/mbstring/functions/mb-get-info.xml index ccb3f6cd3b4c..5fba7cb10f83 100644 --- a/reference/mbstring/functions/mb-get-info.xml +++ b/reference/mbstring/functions/mb-get-info.xml @@ -49,37 +49,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - The entry "http_output_conv_mimetypes" was made available. - - - - 5.1.3 - - The entries "mail_charset", "mail_header_encoding", and - "mail_body_encoding" were made available. - - - - - - - - &reftitle.seealso; diff --git a/reference/mbstring/functions/mb-strcut.xml b/reference/mbstring/functions/mb-strcut.xml index e258aa8d3892..e027fdc2d64a 100644 --- a/reference/mbstring/functions/mb-strcut.xml +++ b/reference/mbstring/functions/mb-strcut.xml @@ -96,32 +96,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.8 - - Passing NULL as length - extracts all bytes to the end of the string. Prior to this version - NULL was treated the same as 0. - - - - - - - - &reftitle.seealso; diff --git a/reference/mbstring/functions/mb-strrpos.xml b/reference/mbstring/functions/mb-strrpos.xml index 6e74e59d2369..d2ba3f839aaa 100644 --- a/reference/mbstring/functions/mb-strrpos.xml +++ b/reference/mbstring/functions/mb-strrpos.xml @@ -76,28 +76,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.0 - Added the optional parameter offset. - - - - - - - &reftitle.notes; diff --git a/reference/mbstring/functions/mb-substr.xml b/reference/mbstring/functions/mb-substr.xml index 6edae2b4242a..1d0b72d345a9 100644 --- a/reference/mbstring/functions/mb-substr.xml +++ b/reference/mbstring/functions/mb-substr.xml @@ -86,32 +86,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.8 - - Passing NULL as length - extracts all characters to the end of the string. Prior to this version - NULL was treated the same as 0. - - - - - - - - &reftitle.seealso; diff --git a/reference/mcrypt/functions/mcrypt-create-iv.xml b/reference/mcrypt/functions/mcrypt-create-iv.xml index 8d064b320f62..55647a03483e 100644 --- a/reference/mcrypt/functions/mcrypt-create-iv.xml +++ b/reference/mcrypt/functions/mcrypt-create-iv.xml @@ -79,46 +79,6 @@ Returns the initialization vector, or &false; on error. - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.6.0 - - MCRYPT_DEV_URANDOM is now the default value of - source. - - - - 5.3.0 - - MCRYPT_DEV_RANDOM and - MCRYPT_DEV_URANDOM became available on Windows - platforms. - - - - 5.3.0 - - It is no longer required to call srand first. This - is now done automatically. - - - - - - - &reftitle.examples; diff --git a/reference/mcve/book.xml b/reference/mcve/book.xml deleted file mode 100644 index 75333471938e..000000000000 --- a/reference/mcve/book.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - MCVE (Monetra) Payment - MCVE - - - - &reftitle.intro; - - These functions interface the MCVE (Monetra) API (libmonetra, - formerly known as libmcve), allowing you - to work directly with MCVE/Monetra from your PHP scripts. - MCVE/Monetra is Main Street Softworks' solution to direct - credit/debit/gift card processing for Linux/Unix/MacOSX/Windows - ( &url.mcve.home; ). - It lets you directly address the credit card clearing houses via - your *nix box, modem and/or internet connection (bypassing the - need for an additional service such as Authorize.Net or Pay - Flow Pro). Using the MCVE/Monetra module for PHP, you can process - credit cards directly through MCVE/Monetra via your PHP scripts. - The following references will outline the process. - - - - MCVE/Monetra is the replacement for RedHat's CCVS. They contracted with - RedHat in late 2001 to migrate all existing clientele to the - MCVE platform. - - - - - &pecl.moved-ver;5.1.0. - - - ¬e.no-windows.extension; - - - - &reference.mcve.setup; - &reference.mcve.constants; - &reference.mcve.reference; - - - - - diff --git a/reference/mcve/configure.xml b/reference/mcve/configure.xml deleted file mode 100644 index 403704c84138..000000000000 --- a/reference/mcve/configure.xml +++ /dev/null @@ -1,61 +0,0 @@ - - -
- &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;mcve. - - - &pecl.windows.download; - - - If installing without specifying the libmonetra path, - PHP will attempt to look in the default LibMonetra Install location - (/usr/local). If Monetra (MCVE) is in a non-standard - location, run configure with: , where $mcve_path - is the path to your MCVE/Monetra installation. Please note that - MCVE/Monetra support requires that $mcve_path/lib and $mcve_path/include - exist, and include mcve.h or - monetra.h under the include directory and - libmcve.so and/or libmcve.a - and/or libmonetra.so and/or - libmonetra.a under the lib directory. - - - Since MCVE/Monetra has true server/client separation, there are no - additional requirements for running PHP with MCVE support. To test - your MCVE/Monetra extension in PHP, you may connect to - testbox.monetra.com on port 8333 for IP, or port 8444 for SSL using - the MCVE/Monetra PHP API. - Use 'vitale' for your username, and 'test' for your password. - Additional information about test facilities are available at - &url.mcve.home;. - -
- - - diff --git a/reference/mcve/constants.xml b/reference/mcve/constants.xml deleted file mode 100644 index c17b31063f4a..000000000000 --- a/reference/mcve/constants.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - M_PENDING - (integer) - - - - - - - - - - M_DONE - (integer) - - - - - - - - - - M_ERROR - (integer) - - - - - - - - - - M_FAIL - (integer) - - - - - - - - - - M_SUCCESS - (integer) - - - - - - - - - - - diff --git a/reference/mcve/functions/m-checkstatus.xml b/reference/mcve/functions/m-checkstatus.xml deleted file mode 100644 index d033a0a5e0c7..000000000000 --- a/reference/mcve/functions/m-checkstatus.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - m_checkstatus - Check to see if a transaction has completed - - - &reftitle.description; - - intm_checkstatus - resourceconn - intidentifier - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - identifier - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-completeauthorizations.xml b/reference/mcve/functions/m-completeauthorizations.xml deleted file mode 100644 index c79b9b41e2ef..000000000000 --- a/reference/mcve/functions/m-completeauthorizations.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - m_completeauthorizations - Number of complete authorizations in queue, returning an array of their identifiers - - - &reftitle.description; - - intm_completeauthorizations - resourceconn - intarray - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - array - - - Its description - - - - - - - - &reftitle.returnvalues; - - What the function returns, first on success, then on failure. See - also the &return.success; entity - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-connect.xml b/reference/mcve/functions/m-connect.xml deleted file mode 100644 index 040a45e4536a..000000000000 --- a/reference/mcve/functions/m-connect.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - m_connect - Establish the connection to MCVE - - - &reftitle.description; - - intm_connect - resourceconn - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-connectionerror.xml b/reference/mcve/functions/m-connectionerror.xml deleted file mode 100644 index 59325ee2a8e3..000000000000 --- a/reference/mcve/functions/m-connectionerror.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - m_connectionerror - Get a textual representation of why a connection failed - - - &reftitle.description; - - stringm_connectionerror - resourceconn - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-deletetrans.xml b/reference/mcve/functions/m-deletetrans.xml deleted file mode 100644 index cc63835346b4..000000000000 --- a/reference/mcve/functions/m-deletetrans.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - m_deletetrans - Delete specified transaction from MCVE_CONN structure - - - &reftitle.description; - - boolm_deletetrans - resourceconn - intidentifier - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - identifier - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-destroyconn.xml b/reference/mcve/functions/m-destroyconn.xml deleted file mode 100644 index 52be00b49c29..000000000000 --- a/reference/mcve/functions/m-destroyconn.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - m_destroyconn - Destroy the connection and MCVE_CONN structure - - - &reftitle.description; - - boolm_destroyconn - resourceconn - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - - - - &reftitle.returnvalues; - - Returns &true;. - - - - &reftitle.seealso; - - - m_initconn - - - - - - diff --git a/reference/mcve/functions/m-destroyengine.xml b/reference/mcve/functions/m-destroyengine.xml deleted file mode 100644 index 06fc43603d75..000000000000 --- a/reference/mcve/functions/m-destroyengine.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - m_destroyengine - Free memory associated with IP/SSL connectivity - - - &reftitle.description; - - voidm_destroyengine - - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-getcell.xml b/reference/mcve/functions/m-getcell.xml deleted file mode 100644 index e76f551a16c9..000000000000 --- a/reference/mcve/functions/m-getcell.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - m_getcell - Get a specific cell from a comma delimited response by column name - - - &reftitle.description; - - stringm_getcell - resourceconn - intidentifier - stringcolumn - introw - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - identifier - - - - - - - column - - - - - - - row - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-getcellbynum.xml b/reference/mcve/functions/m-getcellbynum.xml deleted file mode 100644 index 21d4e0bfccfa..000000000000 --- a/reference/mcve/functions/m-getcellbynum.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - m_getcellbynum - Get a specific cell from a comma delimited response by column number - - - &reftitle.description; - - stringm_getcellbynum - resourceconn - intidentifier - intcolumn - introw - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - identifier - - - - - - - column - - - - - - - row - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-getcommadelimited.xml b/reference/mcve/functions/m-getcommadelimited.xml deleted file mode 100644 index d42916bcf892..000000000000 --- a/reference/mcve/functions/m-getcommadelimited.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - m_getcommadelimited - Get the RAW comma delimited data returned from MCVE - - - &reftitle.description; - - stringm_getcommadelimited - resourceconn - intidentifier - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - identifier - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-getheader.xml b/reference/mcve/functions/m-getheader.xml deleted file mode 100644 index 3114b1520d26..000000000000 --- a/reference/mcve/functions/m-getheader.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - m_getheader - Get the name of the column in a comma-delimited response - - - &reftitle.description; - - stringm_getheader - resourceconn - intidentifier - intcolumn_num - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - identifier - - - - - - - column_num - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-initconn.xml b/reference/mcve/functions/m-initconn.xml deleted file mode 100644 index b8a1e70c103b..000000000000 --- a/reference/mcve/functions/m-initconn.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - m_initconn - Create and initialize an MCVE_CONN structure - - - &reftitle.description; - - resourcem_initconn - - - - &warn.undocumented.func; - - - - &reftitle.returnvalues; - - Returns an MCVE_CONN resource. - - - - &reftitle.seealso; - - - m_destroyconn - - - - - - diff --git a/reference/mcve/functions/m-initengine.xml b/reference/mcve/functions/m-initengine.xml deleted file mode 100644 index 879d2361abd4..000000000000 --- a/reference/mcve/functions/m-initengine.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - m_initengine - Ready the client for IP/SSL Communication - - - &reftitle.description; - - intm_initengine - stringlocation - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - location - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-iscommadelimited.xml b/reference/mcve/functions/m-iscommadelimited.xml deleted file mode 100644 index 7b026631bfcc..000000000000 --- a/reference/mcve/functions/m-iscommadelimited.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - m_iscommadelimited - Checks to see if response is comma delimited - - - &reftitle.description; - - intm_iscommadelimited - resourceconn - intidentifier - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - identifier - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-maxconntimeout.xml b/reference/mcve/functions/m-maxconntimeout.xml deleted file mode 100644 index 1cf07084e6a9..000000000000 --- a/reference/mcve/functions/m-maxconntimeout.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - m_maxconntimeout - The maximum amount of time the API will attempt a connection to MCVE - - - &reftitle.description; - - boolm_maxconntimeout - resourceconn - intsecs - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - secs - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-monitor.xml b/reference/mcve/functions/m-monitor.xml deleted file mode 100644 index 046800435b10..000000000000 --- a/reference/mcve/functions/m-monitor.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - m_monitor - Perform communication with MCVE (send/receive data) Non-blocking - - - &reftitle.description; - - intm_monitor - resourceconn - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-numcolumns.xml b/reference/mcve/functions/m-numcolumns.xml deleted file mode 100644 index d82c7a821e95..000000000000 --- a/reference/mcve/functions/m-numcolumns.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - m_numcolumns - Number of columns returned in a comma delimited response - - - &reftitle.description; - - intm_numcolumns - resourceconn - intidentifier - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - identifier - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-numrows.xml b/reference/mcve/functions/m-numrows.xml deleted file mode 100644 index 2213349d692b..000000000000 --- a/reference/mcve/functions/m-numrows.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - m_numrows - Number of rows returned in a comma delimited response - - - &reftitle.description; - - intm_numrows - resourceconn - intidentifier - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - identifier - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-parsecommadelimited.xml b/reference/mcve/functions/m-parsecommadelimited.xml deleted file mode 100644 index ae0b38798ade..000000000000 --- a/reference/mcve/functions/m-parsecommadelimited.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - m_parsecommadelimited - Parse the comma delimited response so m_getcell, etc will work - - - &reftitle.description; - - intm_parsecommadelimited - resourceconn - intidentifier - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - identifier - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-responsekeys.xml b/reference/mcve/functions/m-responsekeys.xml deleted file mode 100644 index 3ba5d8aa1450..000000000000 --- a/reference/mcve/functions/m-responsekeys.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - m_responsekeys - Returns array of strings which represents the keys that can be used - for response parameters on this transaction - - - &reftitle.description; - - arraym_responsekeys - resourceconn - intidentifier - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - identifier - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-responseparam.xml b/reference/mcve/functions/m-responseparam.xml deleted file mode 100644 index fbf40ceac983..000000000000 --- a/reference/mcve/functions/m-responseparam.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - m_responseparam - Get a custom response parameter - - - &reftitle.description; - - stringm_responseparam - resourceconn - intidentifier - stringkey - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - identifier - - - - - - - key - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-returnstatus.xml b/reference/mcve/functions/m-returnstatus.xml deleted file mode 100644 index 2bc19b93d72e..000000000000 --- a/reference/mcve/functions/m-returnstatus.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - m_returnstatus - Check to see if the transaction was successful - - - &reftitle.description; - - intm_returnstatus - resourceconn - intidentifier - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - identifier - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-setblocking.xml b/reference/mcve/functions/m-setblocking.xml deleted file mode 100644 index 5c88a6e4eab9..000000000000 --- a/reference/mcve/functions/m-setblocking.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - m_setblocking - Set blocking/non-blocking mode for connection - - - &reftitle.description; - - intm_setblocking - resourceconn - inttf - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - tf - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-setdropfile.xml b/reference/mcve/functions/m-setdropfile.xml deleted file mode 100644 index 18ff19cfd93f..000000000000 --- a/reference/mcve/functions/m-setdropfile.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - m_setdropfile - Set the connection method to Drop-File - - - &reftitle.description; - - intm_setdropfile - resourceconn - stringdirectory - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - directory - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-setip.xml b/reference/mcve/functions/m-setip.xml deleted file mode 100644 index 9849ef82d27b..000000000000 --- a/reference/mcve/functions/m-setip.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - m_setip - Set the connection method to IP - - - &reftitle.description; - - intm_setip - resourceconn - stringhost - intport - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - host - - - - - - - port - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-setssl-cafile.xml b/reference/mcve/functions/m-setssl-cafile.xml deleted file mode 100644 index 6bcae4a7fb98..000000000000 --- a/reference/mcve/functions/m-setssl-cafile.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - m_setssl_cafile - Set SSL CA (Certificate Authority) file for verification of server - certificate - - - &reftitle.description; - - intm_setssl_cafile - resourceconn - stringcafile - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - cafile - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-setssl-files.xml b/reference/mcve/functions/m-setssl-files.xml deleted file mode 100644 index 9df126f515a4..000000000000 --- a/reference/mcve/functions/m-setssl-files.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - m_setssl_files - Set certificate key files and certificates if server requires client certificate - verification - - - &reftitle.description; - - intm_setssl_files - resourceconn - stringsslkeyfile - stringsslcertfile - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - sslkeyfile - - - - - - - sslcertfile - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-setssl.xml b/reference/mcve/functions/m-setssl.xml deleted file mode 100644 index 50e4c708a92e..000000000000 --- a/reference/mcve/functions/m-setssl.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - m_setssl - Set the connection method to SSL - - - &reftitle.description; - - intm_setssl - resourceconn - stringhost - intport - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - host - - - - - - - port - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-settimeout.xml b/reference/mcve/functions/m-settimeout.xml deleted file mode 100644 index ff6c18710a84..000000000000 --- a/reference/mcve/functions/m-settimeout.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - m_settimeout - Set maximum transaction time (per trans) - - - &reftitle.description; - - intm_settimeout - resourceconn - intseconds - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - seconds - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-sslcert-gen-hash.xml b/reference/mcve/functions/m-sslcert-gen-hash.xml deleted file mode 100644 index ac08526f32fd..000000000000 --- a/reference/mcve/functions/m-sslcert-gen-hash.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - m_sslcert_gen_hash - Generate hash for SSL client certificate verification - - - &reftitle.description; - - stringm_sslcert_gen_hash - stringfilename - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - filename - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-transactionssent.xml b/reference/mcve/functions/m-transactionssent.xml deleted file mode 100644 index ffb2dfeeb15b..000000000000 --- a/reference/mcve/functions/m-transactionssent.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - m_transactionssent - Check to see if outgoing buffer is clear - - - &reftitle.description; - - intm_transactionssent - resourceconn - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-transinqueue.xml b/reference/mcve/functions/m-transinqueue.xml deleted file mode 100644 index 6f7fa6e1373c..000000000000 --- a/reference/mcve/functions/m-transinqueue.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - m_transinqueue - Number of transactions in client-queue - - - &reftitle.description; - - intm_transinqueue - resourceconn - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-transkeyval.xml b/reference/mcve/functions/m-transkeyval.xml deleted file mode 100644 index d6c49a71b197..000000000000 --- a/reference/mcve/functions/m-transkeyval.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - m_transkeyval - Add key/value pair to a transaction. Replaces deprecated transparam() - - - &reftitle.description; - - intm_transkeyval - resourceconn - intidentifier - stringkey - stringvalue - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - identifier - - - - - - - key - - - - - - - value - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-transnew.xml b/reference/mcve/functions/m-transnew.xml deleted file mode 100644 index e34f877fba0a..000000000000 --- a/reference/mcve/functions/m-transnew.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - m_transnew - Start a new transaction - - - &reftitle.description; - - intm_transnew - resourceconn - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-transsend.xml b/reference/mcve/functions/m-transsend.xml deleted file mode 100644 index 2c1144061e57..000000000000 --- a/reference/mcve/functions/m-transsend.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - m_transsend - Finalize and send the transaction - - - &reftitle.description; - - intm_transsend - resourceconn - intidentifier - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - identifier - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-uwait.xml b/reference/mcve/functions/m-uwait.xml deleted file mode 100644 index 4904938a8527..000000000000 --- a/reference/mcve/functions/m-uwait.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - m_uwait - Wait x microsecs - - - &reftitle.description; - - intm_uwait - intmicrosecs - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - microsecs - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-validateidentifier.xml b/reference/mcve/functions/m-validateidentifier.xml deleted file mode 100644 index f0d1ba2b57e4..000000000000 --- a/reference/mcve/functions/m-validateidentifier.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - m_validateidentifier - Whether or not to validate the passed identifier on any transaction it is passed to - - - &reftitle.description; - - intm_validateidentifier - resourceconn - inttf - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - tf - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-verifyconnection.xml b/reference/mcve/functions/m-verifyconnection.xml deleted file mode 100644 index 846256b71928..000000000000 --- a/reference/mcve/functions/m-verifyconnection.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - m_verifyconnection - Set whether or not to PING upon connect to verify connection - - - &reftitle.description; - - boolm_verifyconnection - resourceconn - inttf - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - tf - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/functions/m-verifysslcert.xml b/reference/mcve/functions/m-verifysslcert.xml deleted file mode 100644 index c9125a5605e2..000000000000 --- a/reference/mcve/functions/m-verifysslcert.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - m_verifysslcert - Set whether or not to verify the server ssl certificate - - - &reftitle.description; - - boolm_verifysslcert - resourceconn - inttf - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - &mcve.conn.description; - - tf - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/mcve/reference.xml b/reference/mcve/reference.xml deleted file mode 100644 index 923a0b264cbf..000000000000 --- a/reference/mcve/reference.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - MCVE &Functions; - - - &reftitle.seealso; - - Additional documentation about MCVE/Monetra's PHP API can be found - at &url.mcve.docs;. - Main Street's documentation is complete and should be the - primary reference for functions. - - - - &reference.mcve.entities.functions; - - - - - diff --git a/reference/mcve/setup.xml b/reference/mcve/setup.xml deleted file mode 100644 index 8803ee48a31e..000000000000 --- a/reference/mcve/setup.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - &reftitle.setup; - - -
- &reftitle.required; - - The LibMonetra (formerly libmcve) library. - -
- - - - &reference.mcve.configure; - - - -
- &reftitle.runtime; - &no.config; -
- - - -
- &reftitle.resources; - - This extension defines a MCVE_CONN resource returned by - m_initconn. - -
- - - - - - diff --git a/reference/mcve/versions.xml b/reference/mcve/versions.xml deleted file mode 100644 index 6ecb600d8c5a..000000000000 --- a/reference/mcve/versions.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/ming/book.xml b/reference/ming/book.xml deleted file mode 100644 index fee36b3e7b4f..000000000000 --- a/reference/ming/book.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - Ming (flash) - Ming - - - - &reftitle.intro; - - First of all: Ming is not an acronym. Ming is an open-source (LGPL) - library which allows you to create SWF ("Flash") format movies. Ming - supports almost all of Flash 4's features, including: shapes, gradients, - bitmaps (pngs and jpegs), morphs ("shape tweens"), text, buttons, - actions, sprites ("movie clips"), streaming mp3, and color transforms - --the only thing that's missing is sound events. - - - Note that all values specifying length, distance, size, etc. are in "twips", - twenty units per pixel. That's pretty much arbitrary, though, since the player - scales the movie to whatever pixel size is specified in the embed/object tag, - or the entire frame if not embedded. - - - Ming offers a number of advantages over the existing - PHP/libswf module. - You can use Ming anywhere you can compile the code, whereas libswf is - closed-source and only available for a few platforms, Windows not one of - them. Ming provides some insulation from the mundane details of the SWF - file format, wrapping the movie elements in PHP objects. Also, Ming is - still being maintained; if there's a feature that you want to see, just - let us know at &url.ming;. - - &warn.experimental; - - - - &pecl.moved-ver;5.3.0. - - - - - - - &reference.ming.setup; - &reference.ming.constants; - &reference.ming.examples; - &reference.ming.reference; - - &reference.ming.swfaction; - &reference.ming.swfbitmap; - &reference.ming.swfbutton; - &reference.ming.swfdisplayitem; - &reference.ming.swffill; - &reference.ming.swffont; - &reference.ming.swffontchar; - &reference.ming.swfgradient; - &reference.ming.swfmorph; - &reference.ming.swfmovie; - &reference.ming.swfprebuiltclip; - &reference.ming.swfshape; - &reference.ming.swfsound; - &reference.ming.swfsoundinstance; - &reference.ming.swfsprite; - &reference.ming.swftext; - &reference.ming.swftextfield; - &reference.ming.swfvideostream; - - - - - diff --git a/reference/ming/configure.xml b/reference/ming/configure.xml deleted file mode 100644 index 76776b3492df..000000000000 --- a/reference/ming/configure.xml +++ /dev/null @@ -1,37 +0,0 @@ - - -
- &reftitle.install; - - &pecl.info; - &url.pecl.package;ming. - - - &pecl.moved-ver;5.3.0 - - - &pecl.windows.download; - -
- - - diff --git a/reference/ming/constants.xml b/reference/ming/constants.xml deleted file mode 100644 index 9feb848b291d..000000000000 --- a/reference/ming/constants.xml +++ /dev/null @@ -1,447 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - MING_NEW - (integer) - - - - - - - - - - MING_ZLIB - (integer) - - - - - - - - - - SWFBUTTON_HIT - (integer) - - - - - - - - - - SWFBUTTON_DOWN - (integer) - - - - - - - - - - SWFBUTTON_OVER - (integer) - - - - - - - - - - SWFBUTTON_UP - (integer) - - - - - - - - - - SWFBUTTON_MOUSEUPOUTSIDE - (integer) - - - - - - - - - - SWFBUTTON_DRAGOVER - (integer) - - - - - - - - - - SWFBUTTON_DRAGOUT - (integer) - - - - - - - - - - SWFBUTTON_MOUSEUP - (integer) - - - - - - - - - - SWFBUTTON_MOUSEDOWN - (integer) - - - - - - - - - - SWFBUTTON_MOUSEOUT - (integer) - - - - - - - - - - SWFBUTTON_MOUSEOVER - (integer) - - - - - - - - - - SWFFILL_RADIAL_GRADIENT - (integer) - - - - - - - - - - SWFFILL_LINEAR_GRADIENT - (integer) - - - - - - - - - - SWFFILL_TILED_BITMAP - (integer) - - - - - - - - - - SWFFILL_CLIPPED_BITMAP - (integer) - - - - - - - - - - SWFTEXTFIELD_HASLENGTH - (integer) - - - - - - - - - - SWFTEXTFIELD_NOEDIT - (integer) - - - - - - - - - - SWFTEXTFIELD_PASSWORD - (integer) - - - - - - - - - - SWFTEXTFIELD_MULTILINE - (integer) - - - - - - - - - - SWFTEXTFIELD_WORDWRAP - (integer) - - - - - - - - - - SWFTEXTFIELD_DRAWBOX - (integer) - - - - - - - - - - SWFTEXTFIELD_NOSELECT - (integer) - - - - - - - - - - SWFTEXTFIELD_HTML - (integer) - - - - - - - - - - SWFTEXTFIELD_ALIGN_LEFT - (integer) - - - - - - - - - - SWFTEXTFIELD_ALIGN_RIGHT - (integer) - - - - - - - - - - SWFTEXTFIELD_ALIGN_CENTER - (integer) - - - - - - - - - - SWFTEXTFIELD_ALIGN_JUSTIFY - (integer) - - - - - - - - - - SWFACTION_ONLOAD - (integer) - - - - - - - - - - SWFACTION_ENTERFRAME - (integer) - - - - - - - - - - SWFACTION_UNLOAD - (integer) - - - - - - - - - - SWFACTION_MOUSEMOVE - (integer) - - - - - - - - - - SWFACTION_MOUSEDOWN - (integer) - - - - - - - - - - SWFACTION_MOUSEUP - (integer) - - - - - - - - - - SWFACTION_KEYDOWN - (integer) - - - - - - - - - - SWFACTION_KEYUP - (integer) - - - - - - - - - - SWFACTION_DATA - (integer) - - - - - - - - - - - diff --git a/reference/ming/examples.xml b/reference/ming/examples.xml deleted file mode 100644 index b438e8a5f8eb..000000000000 --- a/reference/ming/examples.xml +++ /dev/null @@ -1,446 +0,0 @@ - - - - - &reftitle.examples; -
- SWFAction Examples - - This simple example will move the red square across the window. - - <function>swfaction</function> example - -addFill(0xff, 0, 0); - $s->setRightFill($f); - - $s->movePenTo(-500, -500); - $s->drawLineTo(500, -500); - $s->drawLineTo(500, 500); - $s->drawLineTo(-500, 500); - $s->drawLineTo(-500, -500); - - $p = new SWFSprite(); - $i = $p->add($s); - $i->setDepth(1); - $p->nextFrame(); - - for ($n=0; $n<5; ++$n) { - $i->rotate(-15); - $p->nextFrame(); - } - - $m = new SWFMovie(); - $m->setBackground(0xff, 0xff, 0xff); - $m->setDimension(6000, 4000); - - $i = $m->add($p); - $i->setDepth(1); - $i->moveTo(-500,2000); - $i->setName("box"); - - $m->add(new SWFAction("/box.x += 3;")); - $m->nextFrame(); - $m->add(new SWFAction("gotoFrame(0); play();")); - $m->nextFrame(); - - header('Content-type: application/x-shockwave-flash'); - $m->output(); -?> -]]> - - - - - This simple example tracks down your mouse on the screen. - - <function>swfaction</function> example - -setRate(36.0); - $m->setDimension(1200, 800); - $m->setBackground(0, 0, 0); - - /* mouse tracking sprite - empty, but follows mouse so we can - get its x and y coordinates */ - - $i = $m->add(new SWFSprite()); - $i->setName('mouse'); - - $m->add(new SWFAction(" - startDrag('/mouse', 1); /* '1' means lock sprite to the mouse */ - ")); - - /* might as well turn off antialiasing, since these are just squares. */ - - $m->add(new SWFAction(" - this.quality = 0; - ")); - - /* morphing box */ - $r = new SWFMorph(); - $s = $r->getShape1(); - - /* Note this is backwards from normal shapes. No idea why. */ - $s->setLeftFill($s->addFill(0xff, 0xff, 0xff)); - $s->movePenTo(-40, -40); - $s->drawLine(80, 0); - $s->drawLine(0, 80); - $s->drawLine(-80, 0); - $s->drawLine(0, -80); - - $s = $r->getShape2(); - - $s->setLeftFill($s->addFill(0x00, 0x00, 0x00)); - $s->movePenTo(-1, -1); - $s->drawLine(2, 0); - $s->drawLine(0, 2); - $s->drawLine(-2, 0); - $s->drawLine(0, -2); - - /* sprite container for morphing box - - this is just a timeline w/ the box morphing */ - - $box = new SWFSprite(); - $box->add(new SWFAction(" - stop(); - ")); - $i = $box->add($r); - - for ($n=0; $n<=20; ++$n) { - $i->setRatio($n/20); - $box->nextFrame(); - } - - /* this container sprite allows us to use the same action code many times */ - - $cell = new SWFSprite(); - $i = $cell->add($box); - $i->setName('box'); - - $cell->add(new SWFAction(" - - setTarget('box'); - - /* ...x means the x coordinate of the parent, i.e. (..).x */ - dx = (/mouse.x + random(6)-3 - ...x)/5; - dy = (/mouse.y + random(6)-3 - ...y)/5; - gotoFrame(int(dx*dx + dy*dy)); - - ")); - - $cell->nextFrame(); - $cell->add(new SWFAction(" - - gotoFrame(0); - play(); - - ")); - - $cell->nextFrame(); - - /* finally, add a bunch of the cells to the movie */ - - for ($x=0; $x<12; ++$x) { - for ($y=0; $y<8; ++$y) { - $i = $m->add($cell); - $i->moveTo(100*$x+50, 100*$y+50); - } - } - - $m->nextFrame(); - - $m->add(new SWFAction(" - - gotoFrame(1); - play(); - - ")); - - header('Content-type: application/x-shockwave-flash'); - $m->output(); -?> -]]> - - - - - Same as above, but with nice colored balls... - - <function>swfaction</function> example - -setDimension(11000, 8000); - $m->setBackground(0x00, 0x00, 0x00); - - $m->add(new SWFAction(" - -this.quality = 0; -/frames.visible = 0; -startDrag('/mouse', 1); - - ")); - - // mouse tracking sprite - $t = new SWFSprite(); - $i = $m->add($t); - $i->setName('mouse'); - - $g = new SWFGradient(); - $g->addEntry(0, 0xff, 0xff, 0xff, 0xff); - $g->addEntry(0.1, 0xff, 0xff, 0xff, 0xff); - $g->addEntry(0.5, 0xff, 0xff, 0xff, 0x5f); - $g->addEntry(1.0, 0xff, 0xff, 0xff, 0); - - // gradient shape thing - $s = new SWFShape(); - $f = $s->addFill($g, SWFFILL_RADIAL_GRADIENT); - $f->scaleTo(0.03); - $s->setRightFill($f); - $s->movePenTo(-600, -600); - $s->drawLine(1200, 0); - $s->drawLine(0, 1200); - $s->drawLine(-1200, 0); - $s->drawLine(0, -1200); - - // need to make this a sprite so we can multColor it - $p = new SWFSprite(); - $p->add($s); - $p->nextFrame(); - - // put the shape in here, each frame a different color - $q = new SWFSprite(); - $q->add(new SWFAction("gotoFrame(random(7)+1); stop();")); - $i = $q->add($p); - - $i->multColor(1.0, 1.0, 1.0); - $q->nextFrame(); - $i->multColor(1.0, 0.5, 0.5); - $q->nextFrame(); - $i->multColor(1.0, 0.75, 0.5); - $q->nextFrame(); - $i->multColor(1.0, 1.0, 0.5); - $q->nextFrame(); - $i->multColor(0.5, 1.0, 0.5); - $q->nextFrame(); - $i->multColor(0.5, 0.5, 1.0); - $q->nextFrame(); - $i->multColor(1.0, 0.5, 1.0); - $q->nextFrame(); - - // finally, this one contains the action code - $p = new SWFSprite(); - $i = $p->add($q); - $i->setName('frames'); - $p->add(new SWFAction(" - -dx = (/:mousex-/:lastx)/3 + random(10)-5; -dy = (/:mousey-/:lasty)/3; -x = /:mousex; -y = /:mousey; -alpha = 100; - - ")); - $p->nextFrame(); - - $p->add(new SWFAction(" - -this.x = x; -this.y = y; -this.alpha = alpha; -x += dx; -y += dy; -dy += 3; -alpha -= 8; - - ")); - $p->nextFrame(); - - $p->add(new SWFAction("prevFrame(); play();")); - $p->nextFrame(); - - $i = $m->add($p); - $i->setName('frames'); - $m->nextFrame(); - - $m->add(new SWFAction(" - -lastx = mousex; -lasty = mousey; -mousex = /mouse.x; -mousey = /mouse.y; - -++num; - -if (num == 11) - num = 1; - -removeClip('char' & num); -duplicateClip(/frames, 'char' & num, num); - - ")); - - $m->nextFrame(); - $m->add(new SWFAction("prevFrame(); play();")); - - header('Content-type: application/x-shockwave-flash'); - $m->output(); -?> -]]> - - - - -
-
- SWFSPrite basic examples - - This simple example will spin gracefully a big red square. - - <function>swfsprite</function> example - -setRightFill($s->addFill(0xff, 0, 0)); -$s->movePenTo(-500, -500); -$s->drawLineTo(500, -500); -$s->drawLineTo(500, 500); -$s->drawLineTo(-500, 500); -$s->drawLineTo(-500, -500); - -$p = new SWFSprite(); -$i = $p->add($s); -$p->nextFrame(); -$i->rotate(15); -$p->nextFrame(); -$i->rotate(15); -$p->nextFrame(); -$i->rotate(15); -$p->nextFrame(); -$i->rotate(15); -$p->nextFrame(); -$i->rotate(15); -$p->nextFrame(); - -$m = new SWFMovie(); -$i = $m->add($p); -$i->moveTo(1500, 1000); -$i->setName("blah"); - -$m->setBackground(0xff, 0xff, 0xff); -$m->setDimension(3000, 2000); - -header('Content-type: application/x-shockwave-flash'); -$m->output(); -?> -]]> - - - -
- - - - diff --git a/reference/ming/functions/ming-keypress.xml b/reference/ming/functions/ming-keypress.xml deleted file mode 100644 index 4e75402bf7fa..000000000000 --- a/reference/ming/functions/ming-keypress.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - ming_keypress - Returns the action flag for keyPress(char) - - - &reftitle.description; - - intming_keypress - stringchar - - - &warn.undocumented.func; - - - - - - - diff --git a/reference/ming/functions/ming-setcubicthreshold.xml b/reference/ming/functions/ming-setcubicthreshold.xml deleted file mode 100644 index 4d33d14233ab..000000000000 --- a/reference/ming/functions/ming-setcubicthreshold.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - ming_setcubicthreshold - - Set cubic threshold - - - - &reftitle.description; - - voidming_setcubicthreshold - intthreshold - - - Sets the threshold error for drawing cubic beziers. - - - - - &reftitle.parameters; - - - - threshold - - - The Threshold. Lower is more accurate, hence larger file size. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/functions/ming-setscale.xml b/reference/ming/functions/ming-setscale.xml deleted file mode 100644 index 2eacbc6c1f0d..000000000000 --- a/reference/ming/functions/ming-setscale.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - ming_setscale - - Set the global scaling factor - - - - &reftitle.description; - - voidming_setscale - floatscale - - - Sets the scale of the output SWF. Inside the SWF file, coordinates are - measured in TWIPS, rather than PIXELS. There are 20 TWIPS in 1 pixel. - - - - - &reftitle.parameters; - - - - scale - - - The scale to be set. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/functions/ming-setswfcompression.xml b/reference/ming/functions/ming-setswfcompression.xml deleted file mode 100644 index 38fe4276002f..000000000000 --- a/reference/ming/functions/ming-setswfcompression.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - ming_setswfcompression - Sets the SWF output compression - - - &reftitle.description; - - voidming_setswfcompression - intlevel - - - Sets the SWF output compression level. - - - - - &reftitle.parameters; - - - - level - - - The new compression level. Should be a value between 1 and 9 - inclusive. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/functions/ming-useconstants.xml b/reference/ming/functions/ming-useconstants.xml deleted file mode 100644 index 00a4cd23550f..000000000000 --- a/reference/ming/functions/ming-useconstants.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - ming_useconstants - Use constant pool - - - &reftitle.description; - - voidming_useconstants - intuse - - - &warn.undocumented.func; - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/functions/ming-useswfversion.xml b/reference/ming/functions/ming-useswfversion.xml deleted file mode 100644 index e3b1f054b4c2..000000000000 --- a/reference/ming/functions/ming-useswfversion.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - - ming_useswfversion - Sets the SWF version - - - &reftitle.description; - - voidming_useswfversion - intversion - - - Sets the SWF version to be used in the movie. This affect the bahaviour - of Action Script. - - - - - &reftitle.parameters; - - - - version - - - SWF version to use. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>ming_useswfversion</function> example - - -]]> - - - - - - - - diff --git a/reference/ming/reference.xml b/reference/ming/reference.xml deleted file mode 100644 index 189a759b7a11..000000000000 --- a/reference/ming/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - Ming &Functions; - - &reference.ming.entities.functions; - - - - diff --git a/reference/ming/setup.xml b/reference/ming/setup.xml deleted file mode 100644 index 45107810a330..000000000000 --- a/reference/ming/setup.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - &reftitle.setup; - - -
- &reftitle.required; - - To use Ming with PHP, you first need to build and install the Ming - library. Source code and installation instructions are available at the - Ming home page: &url.ming; - along with examples, a small tutorial, and the latest news. - - - Download the ming archive. Unpack the archive. Go in the - Ming directory. make. make install. - - - This will build libming.so and install it - into /usr/lib/, and copy - ming.h into /usr/include/. - Edit the PREFIX= line in the - Makefile to change the installation directory. - -
- - - - &reference.ming.configure; - - - -
- &reftitle.runtime; - &no.config; -
- - - -
- &reftitle.resources; - &no.resource; -
- - - - - - diff --git a/reference/ming/swfaction.xml b/reference/ming/swfaction.xml deleted file mode 100644 index dfec18050181..000000000000 --- a/reference/ming/swfaction.xml +++ /dev/null @@ -1,454 +0,0 @@ - - - - The SWFAction class - SWFAction - - - - -
- &reftitle.intro; - - SWFAction. - -
- - -
- &reftitle.classsynopsis; - - - - SWFAction - - - - - SWFAction - - - - - &Methods; - - - - - -
- -
- &reftitle.description; - - The script syntax is based on the C language, but with a lot taken out- the SWF - bytecode machine is just too simpleminded to do a lot of things we might like. - For instance, we can't implement function calls without a tremendous - amount of hackery because the jump bytecode has a hardcoded offset - value. No pushing your calling address to the stack and returning- - every function would have to know exactly where to return to. - - - So what's left? The compiler recognises the following tokens: - - - - break - - - - - for - - - - - continue - - - - - if - - - - - else - - - - - do - - - - - while - - - - - - There is no typed data; all values in the SWF action machine are stored as strings. - The following functions can be used in expressions: - - - time() - - - Returns the number of milliseconds (?) elapsed since the movie started. - - - - - random(seed) - - - Returns a pseudo-random number in the range 0-seed. - - - - - length(expr) - - - Returns the length of the given expression. - - - - - int(number) - - - Returns the given number rounded down to the nearest integer. - - - - - concat(expr, expr) - - - Returns the concatenation of the given expressions. - - - - - ord(expr) - - - Returns the ASCII code for the given character - - - - - chr(num) - - - Returns the character for the given ASCII code - - - - - substr(string, location, length) - - - Returns the substring of length length at location location of - the given string string. - - - - - - - Additionally, the following commands may be used: - - - duplicateClip(clip, name, depth) - - - Duplicate the named movie clip (aka sprite). The new movie clip has name name - and is at depth depth. - - - - - removeClip(expr) - - - Removes the named movie clip. - - - - - trace(expr) - - - Write the given expression to the trace log. Doubtful that the browser - plugin does anything with this. - - - - - startDrag(target, lock, [left, top, right, bottom]) - - - Start dragging the movie clip target. The lock argument indicates whether - to lock the mouse (?)- use 0 (&false;) or 1 (&true;). Optional parameters - define a bounding area for the dragging. - - - - - stopDrag() - - - Stop dragging my heart around. And this movie clip, too. - - - - - callFrame(expr) - - - Call the named frame as a function. - - - - - getURL(url, target, [method]) - - - Load the given URL into the named target. The target argument - corresponds to HTML document targets (such as "_top" or "_blank"). - The optional method argument can be POST or GET if you want to submit - variables back to the server. - - - - - loadMovie(url, target) - - - Load the given URL into the named target. The target argument can be a - frame name (I think), or one of the magical values "_level0" (replaces - current movie) or "_level1" (loads new movie on top of current movie). - - - - - nextFrame() - - - Go to the next frame. - - - - - prevFrame() - - - Go to the last (or, rather, previous) frame. - - - - - play() - - - Start playing the movie. - - - - - stop() - - - Stop playing the movie. - - - - - toggleQuality() - - - Toggle between high and low quality. - - - - - stopSounds() - - - Stop playing all sounds. - - - - - gotoFrame(num) - - - Go to frame number num. Frame numbers start at 0. - - - - - gotoFrame(name) - - - Go to the frame named name. Which does a lot of good, since I - haven't added frame labels yet. - - - - - setTarget(expr) - - - Sets the context for action. Or so they say- I really have no - idea what this does. - - - - - And there's one weird extra thing. The expression frameLoaded(num) can be used - in if statements and while loops to check if the given frame number has been - loaded yet. Well, it's supposed to, anyway, but I've never tested it and I - seriously doubt it actually works. You can just use /:framesLoaded instead. - - - Movie clips (all together now- aka sprites) have properties. You can - read all of them (or can you?), you can set some of them, and here - they are: - - - - x - - - - - y - - - - - xScale - - - - - yScale - - - - - currentFrame - (read-only) - - - - - totalFrames - (read-only) - - - - - alpha - transparency level - - - - - visible - 1=on, 0=off (?) - - - - - width - (read-only) - - - - - height - (read-only) - - - - - rotation - - - - - target - (read-only) (???) - - - - - framesLoaded - (read-only) - - - - - name - - - - - dropTarget - (read-only) (???) - - - - - url - (read-only) (???) - - - - - highQuality - 1=high, 0=low (?) - - - - - focusRect - (???) - - - - - soundBufTime - (???) - - - - So, setting a sprite's x position is as simple as /box.x = 100;. - Why the slash in front of the box, though? That's how flash keeps - track of the sprites in the movie, just like a Unix filesystem- - here it shows that box is at the top level. If the sprite named - box had another sprite named biff inside of it, you'd set its x - position with /box/biff.x = 100;. At least, I think so; correct - me if I'm wrong here. - -
- - - - &reference.ming.entities.swfaction; - - - - diff --git a/reference/ming/swfaction/construct.xml b/reference/ming/swfaction/construct.xml deleted file mode 100644 index 85495f745e53..000000000000 --- a/reference/ming/swfaction/construct.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - SWFAction::__construct - Creates a new SWFAction - - - &reftitle.description; - - SWFAction::__construct - stringscript - - &warn.experimental.func; - - Creates a new SWFAction and compiles the given script - in it. - - - - - &reftitle.parameters; - - - - script - - - An ActionScript snippet to associate with the SWFAction. - See for more details. - - - - - - - - - - diff --git a/reference/ming/swfbitmap.xml b/reference/ming/swfbitmap.xml deleted file mode 100644 index 045b3a2c4ca6..000000000000 --- a/reference/ming/swfbitmap.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - The SWFBitmap class - SWFBitmap - - - - -
- &reftitle.intro; - - SWFBitmap. - -
- - -
- &reftitle.classsynopsis; - - - - SWFBitmap - - - - - SWFBitmap - - - - - &Methods; - - - - - -
- - &reference.ming.entities.swfbitmap; - - - - diff --git a/reference/ming/swfbitmap/construct.xml b/reference/ming/swfbitmap/construct.xml deleted file mode 100644 index d6742f01e781..000000000000 --- a/reference/ming/swfbitmap/construct.xml +++ /dev/null @@ -1,163 +0,0 @@ - - - - - SWFBitmap::__construct - Loads Bitmap object - - - &reftitle.description; - - SWFBitmap::__construct - mixedfile - mixedalphafile - - &warn.experimental.func; - - Creates the new SWFBitmap object from the given - file. - - - - - &reftitle.parameters; - - For both parameters you can provide a file pointer returned by - fopen or the image data, as a binary string. - - - file - - - - - - We can only deal with baseline (frame 0) jpegs, no baseline optimized or - progressive scan jpegs! - - - - You can't import png images directly, though- have to use the png2dbl - utility to make a dbl ("define bits lossless") file from the png. - The reason for this is that I don't want a dependency on the png library - in ming- autoconf should solve this, but that's not set up yet. - - - - - alphafile - - - An MSK file to be used as an alpha mask for a JPEG image. - - - - - - - - - &reftitle.examples; - - - Importing a DBL file - -addFill(new SWFBitmap(file_get_contents("image.dbl"))); -$s->setRightFill($f); - -$s->drawLine(32, 0); -$s->drawLine(0, 32); -$s->drawLine(-32, 0); -$s->drawLine(0, -32); - -$m = new SWFMovie(); -$m->setDimension(32, 32); -$m->add($s); - -header('Content-type: application/x-shockwave-flash'); -$m->output(); -?> -]]> - - - - - - Using an alpha mask - -addFill(new SWFBitmap(file_get_contents("alphafill.jpg"), file_get_contents("alphafill.msk"))); -$s->setRightFill($f); - -$s->drawLine(640, 0); -$s->drawLine(0, 480); -$s->drawLine(-640, 0); -$s->drawLine(0, -480); - -$c = new SWFShape(); -$c->setRightFill($c->addFill(0x99, 0x99, 0x99)); -$c->drawLine(40, 0); -$c->drawLine(0, 40); -$c->drawLine(-40, 0); -$c->drawLine(0, -40); - -$m = new SWFMovie(); -$m->setDimension(640, 480); -$m->setBackground(0xcc, 0xcc, 0xcc); - -// draw checkerboard background -for ($y=0; $y<480; $y+=40) { - for ($x=0; $x<640; $x+=80) { - $i = $m->add($c); - $i->moveTo($x, $y); - } - - $y+=40; - - for ($x=40; $x<640; $x+=80) { - $i = $m->add($c); - $i->moveTo($x, $y); - } -} - -$m->add($s); - -header('Content-type: application/x-shockwave-flash'); -$m->output(); -?> -]]> - - - - - - - - diff --git a/reference/ming/swfbitmap/getheight.xml b/reference/ming/swfbitmap/getheight.xml deleted file mode 100644 index e59c00c6436b..000000000000 --- a/reference/ming/swfbitmap/getheight.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - SWFBitmap::getHeight - Returns the bitmap's height - - - &reftitle.description; - - floatSWFBitmap::getHeight - - - &warn.experimental.func; - - Returns the bitmap's height. - - - - - &reftitle.returnvalues; - - Returns the bitmap height in pixels. - - - - - &reftitle.seealso; - - - SWFBitmap::getWidth - - - - - - - diff --git a/reference/ming/swfbitmap/getwidth.xml b/reference/ming/swfbitmap/getwidth.xml deleted file mode 100644 index b009a4cb7b0e..000000000000 --- a/reference/ming/swfbitmap/getwidth.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - SWFBitmap::getWidth - Returns the bitmap's width - - - &reftitle.description; - - floatSWFBitmap::getWidth - - - &warn.experimental.func; - - Returns the bitmap's width. - - - - - &reftitle.returnvalues; - - Returns the bitmap width in pixels. - - - - - &reftitle.seealso; - - - SWFBitmap::getHeight - - - - - - - diff --git a/reference/ming/swfbutton.xml b/reference/ming/swfbutton.xml deleted file mode 100644 index dd2f7a09e58a..000000000000 --- a/reference/ming/swfbutton.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - The SWFButton class - SWFButton - - - - -
- &reftitle.intro; - - SWFButton. - -
- - -
- &reftitle.classsynopsis; - - - - SWFButton - - - - - SWFButton - - - - - &Methods; - - - - - -
- - &reference.ming.entities.swfbutton; - - - - diff --git a/reference/ming/swfbutton/addaction.xml b/reference/ming/swfbutton/addaction.xml deleted file mode 100644 index ba3dc3f0370e..000000000000 --- a/reference/ming/swfbutton/addaction.xml +++ /dev/null @@ -1,92 +0,0 @@ - - - - - SWFButton::addAction - Adds an action - - - &reftitle.description; - - voidSWFButton::addAction - SWFActionaction - intflags - - &warn.experimental.func; - - Adds the given action to the button for the given - conditions. - - - - - &reftitle.parameters; - - - - action - - - An SWFAction, returned by - SWFAction::__construct. - - - - - flags - - - The following flags are valid: - SWFBUTTON_MOUSEOVER, - SWFBUTTON_MOUSEOUT, - SWFBUTTON_MOUSEUP, - SWFBUTTON_MOUSEUPOUTSIDE, - SWFBUTTON_MOUSEDOWN, - SWFBUTTON_DRAGOUT and - SWFBUTTON_DRAGOVER. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFButton::addShape - - - - - - - - diff --git a/reference/ming/swfbutton/addasound.xml b/reference/ming/swfbutton/addasound.xml deleted file mode 100644 index 0c0ce787aeea..000000000000 --- a/reference/ming/swfbutton/addasound.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - SWFButton::addASound - Associates a sound with a button transition - - - &reftitle.description; - - SWFSoundInstanceSWFButton::addASound - SWFSoundsound - intflags - - - &warn.undocumented.func; - - - - - - - diff --git a/reference/ming/swfbutton/addshape.xml b/reference/ming/swfbutton/addshape.xml deleted file mode 100644 index e379af615149..000000000000 --- a/reference/ming/swfbutton/addshape.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - SWFButton::addShape - Adds a shape to a button - - - &reftitle.description; - - voidSWFButton::addShape - SWFShapeshape - intflags - - &warn.experimental.func; - - Adds the given shape to the button. - - - - - &reftitle.parameters; - - - - shape - - - An SWFShape instance - - - - - flags - - - The following flags are valid: - SWFBUTTON_UP, - SWFBUTTON_OVER, - SWFBUTTON_DOWN and - SWFBUTTON_HIT. - - - SWFBUTTON_HIT isn't ever displayed, it defines - the hit region for the button. That is, everywhere the hit shape would - be drawn is considered a "touchable" part of the button. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfbutton/construct.xml b/reference/ming/swfbutton/construct.xml deleted file mode 100644 index a961aea441e4..000000000000 --- a/reference/ming/swfbutton/construct.xml +++ /dev/null @@ -1,184 +0,0 @@ - - - - - SWFButton::__construct - Creates a new Button - - - &reftitle.description; - - SWFButton::__construct - - - &warn.experimental.func; - - Creates a new Button. - - - - - &reftitle.examples; - - This simple example will show your usual interactions with buttons : - rollover, rollon, mouseup, mousedown, noaction. - - Usual interactions with buttons - -setFont($f); - $t->addString($string); - $t->setHeight(200); - $t->setBounds(3200, 200); - return $t; -} - -function addLabel($string) -{ - global $p; - - $i = $p->add(label($string)); - $p->nextFrame(); - $p->remove($i); -} - -$p->add(new SWFAction("stop();")); -addLabel("NO ACTION"); -addLabel("SWFBUTTON_MOUSEUP"); -addLabel("SWFBUTTON_MOUSEDOWN"); -addLabel("SWFBUTTON_MOUSEOVER"); -addLabel("SWFBUTTON_MOUSEOUT"); -addLabel("SWFBUTTON_MOUSEUPOUTSIDE"); -addLabel("SWFBUTTON_DRAGOVER"); -addLabel("SWFBUTTON_DRAGOUT"); - -function rect($r, $g, $b) -{ - $s = new SWFShape(); - $s->setRightFill($s->addFill($r, $g, $b)); - $s->drawLine(600, 0); - $s->drawLine(0, 600); - $s->drawLine(-600, 0); - $s->drawLine(0, -600); - - return $s; -} - -$b = new SWFButton(); -$b->addShape(rect(0xff, 0, 0), SWFBUTTON_UP | SWFBUTTON_HIT); -$b->addShape(rect(0, 0xff, 0), SWFBUTTON_OVER); -$b->addShape(rect(0, 0, 0xff), SWFBUTTON_DOWN); - -$b->addAction(new SWFAction("setTarget('/label'); gotoFrame(1);"), - SWFBUTTON_MOUSEUP); - -$b->addAction(new SWFAction("setTarget('/label'); gotoFrame(2);"), - SWFBUTTON_MOUSEDOWN); - -$b->addAction(new SWFAction("setTarget('/label'); gotoFrame(3);"), - SWFBUTTON_MOUSEOVER); - -$b->addAction(new SWFAction("setTarget('/label'); gotoFrame(4);"), - SWFBUTTON_MOUSEOUT); - -$b->addAction(new SWFAction("setTarget('/label'); gotoFrame(5);"), - SWFBUTTON_MOUSEUPOUTSIDE); - -$b->addAction(new SWFAction("setTarget('/label'); gotoFrame(6);"), - SWFBUTTON_DRAGOVER); - -$b->addAction(new SWFAction("setTarget('/label'); gotoFrame(7);"), - SWFBUTTON_DRAGOUT); - -$m = new SWFMovie(); -$m->setDimension(4000, 3000); - -$i = $m->add($p); -$i->setName("label"); -$i->moveTo(400, 1900); - -$i = $m->add($b); -$i->moveTo(400, 900); - -header('Content-type: application/x-shockwave-flash'); -$m->output(); -?> -]]> - - - - - This simple example will enables you to drag draw a big red button - on the windows. No drag-and-drop, just moving around. - - Drag example - -setRightFill($s->addFill(0xff, 0, 0)); -$s->drawLine(1000,0); -$s->drawLine(0,1000); -$s->drawLine(-1000,0); -$s->drawLine(0,-1000); - -$b = new SWFButton(); -$b->addShape($s, SWFBUTTON_HIT | SWFBUTTON_UP | SWFBUTTON_DOWN | SWFBUTTON_OVER); - -$b->addAction(new SWFAction("startDrag('/test', 0);"), // '0' means don't lock to mouse - SWFBUTTON_MOUSEDOWN); - -$b->addAction(new SWFAction("stopDrag();"), - SWFBUTTON_MOUSEUP | SWFBUTTON_MOUSEUPOUTSIDE); - -$p = new SWFSprite(); -$p->add($b); -$p->nextFrame(); - -$m = new SWFMovie(); -$i = $m->add($p); -$i->setName('test'); -$i->moveTo(1000,1000); - -header('Content-type: application/x-shockwave-flash'); -$m->output(); -?> -]]> - - - - - - - diff --git a/reference/ming/swfbutton/setaction.xml b/reference/ming/swfbutton/setaction.xml deleted file mode 100644 index efde1071cc35..000000000000 --- a/reference/ming/swfbutton/setaction.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - SWFButton::setAction - Sets the action - - - &reftitle.description; - - voidSWFButton::setAction - SWFActionaction - - &warn.experimental.func; - - Sets the action to be performed when the button is clicked. - - - This is a shortcut for SWFButton::addAction - called with the SWFBUTTON_MOUSEUP flag. - - - - - &reftitle.parameters; - - - - action - - - An SWFAction, returned by - SWFAction::__construct. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFButton::addAction - - - - - - - - diff --git a/reference/ming/swfbutton/setdown.xml b/reference/ming/swfbutton/setdown.xml deleted file mode 100644 index 494b6539ed78..000000000000 --- a/reference/ming/swfbutton/setdown.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - SWFButton::setDown - Alias for addShape(shape, SWFBUTTON_DOWN) - - - &reftitle.description; - - voidSWFButton::setDown - SWFShapeshape - - &warn.experimental.func; - - swfbutton::setdown alias for addShape(shape, SWFBUTTON_DOWN). - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFButton::addShape - - - - - - - - diff --git a/reference/ming/swfbutton/sethit.xml b/reference/ming/swfbutton/sethit.xml deleted file mode 100644 index 62485e57027c..000000000000 --- a/reference/ming/swfbutton/sethit.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - SWFButton::setHit - Alias for addShape(shape, SWFBUTTON_HIT) - - - &reftitle.description; - - voidSWFButton::setHit - SWFShapeshape - - &warn.experimental.func; - - swfbutton::sethit alias for addShape(shape, SWFBUTTON_HIT). - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFButton::addShape - - - - - - - - diff --git a/reference/ming/swfbutton/setmenu.xml b/reference/ming/swfbutton/setmenu.xml deleted file mode 100644 index 4ca1d0256d2c..000000000000 --- a/reference/ming/swfbutton/setmenu.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - SWFButton::setMenu - Enable track as menu button behaviour - - - &reftitle.description; - - voidSWFButton::setMenu - intflag - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - flag - - - This parameter can be used for a slight different behavior of buttons. - You can set it to 0 (off) or 1 (on). - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfbutton/setover.xml b/reference/ming/swfbutton/setover.xml deleted file mode 100644 index 8fcf0c4a9093..000000000000 --- a/reference/ming/swfbutton/setover.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - SWFButton::setOver - Alias for addShape(shape, SWFBUTTON_OVER) - - - &reftitle.description; - - voidSWFButton::setOver - SWFShapeshape - - &warn.experimental.func; - - swfbutton::setover alias for addShape(shape, SWFBUTTON_OVER). - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFButton::addShape - - - - - - - - diff --git a/reference/ming/swfbutton/setup.xml b/reference/ming/swfbutton/setup.xml deleted file mode 100644 index f6856bdf7cf1..000000000000 --- a/reference/ming/swfbutton/setup.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - SWFButton::setUp - Alias for addShape(shape, SWFBUTTON_UP) - - - &reftitle.description; - - voidSWFButton::setUp - SWFShapeshape - - &warn.experimental.func; - - swfbutton::setup alias for addShape(shape, SWFBUTTON_UP). - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFButton::addShape - - - - - - - - diff --git a/reference/ming/swfdisplayitem.xml b/reference/ming/swfdisplayitem.xml deleted file mode 100644 index 09cc08366c75..000000000000 --- a/reference/ming/swfdisplayitem.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - The SWFDisplayItem class - SWFDisplayItem - - - - -
- &reftitle.intro; - - SWFDisplayItem. - -
- - -
- &reftitle.classsynopsis; - - - - SWFDisplayItem - - - - - SWFDisplayItem - - - - - &Methods; - - - - - -
- - &reference.ming.entities.swfdisplayitem; - - - - diff --git a/reference/ming/swfdisplayitem/addaction.xml b/reference/ming/swfdisplayitem/addaction.xml deleted file mode 100644 index 01fb57ec67ce..000000000000 --- a/reference/ming/swfdisplayitem/addaction.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - SWFDisplayItem::addAction - Adds this SWFAction to the given SWFSprite instance - - - &reftitle.description; - - voidSWFDisplayItem::addAction - SWFActionaction - intflags - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - action - - - An SWFAction, returned by - SWFAction::__construct. - - - - - flags - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/ming/swfdisplayitem/addcolor.xml b/reference/ming/swfdisplayitem/addcolor.xml deleted file mode 100644 index a93514df8768..000000000000 --- a/reference/ming/swfdisplayitem/addcolor.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - SWFDisplayItem::addColor - Adds the given color to this item's color transform - - - &reftitle.description; - - voidSWFDisplayItem::addColor - intred - intgreen - intblue - inta - - &warn.experimental.func; - - swfdisplayitem::addcolor adds the color to - this item's color transform. The color is given in its RGB form. - - - The object may be a swfshape, a - swfbutton, a swftext or a - swfsprite object. It must have been added using - the swfmovie::add. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfdisplayitem/endmask.xml b/reference/ming/swfdisplayitem/endmask.xml deleted file mode 100644 index e1e27e5103b1..000000000000 --- a/reference/ming/swfdisplayitem/endmask.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - SWFDisplayItem::endMask - Another way of defining a MASK layer - - - &reftitle.description; - - voidSWFDisplayItem::endMask - - - - &warn.undocumented.func; - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfdisplayitem/getrot.xml b/reference/ming/swfdisplayitem/getrot.xml deleted file mode 100644 index f6b86ccf4722..000000000000 --- a/reference/ming/swfdisplayitem/getrot.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - SWFDisplayItem::getRot - - - - &reftitle.description; - - floatSWFDisplayItem::getRot - - - - &warn.undocumented.func; - - - - - - - diff --git a/reference/ming/swfdisplayitem/getx.xml b/reference/ming/swfdisplayitem/getx.xml deleted file mode 100644 index cc255be18c1a..000000000000 --- a/reference/ming/swfdisplayitem/getx.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - SWFDisplayItem::getX - - - - &reftitle.description; - - floatSWFDisplayItem::getX - - - - &warn.undocumented.func; - - - - - - &reftitle.seealso; - - - SWFDisplayItem::getY - - - - - - - diff --git a/reference/ming/swfdisplayitem/getxscale.xml b/reference/ming/swfdisplayitem/getxscale.xml deleted file mode 100644 index 77e63282ea6e..000000000000 --- a/reference/ming/swfdisplayitem/getxscale.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - SWFDisplayItem::getXScale - - - - &reftitle.description; - - floatSWFDisplayItem::getXScale - - - - &warn.undocumented.func; - - - - - - &reftitle.seealso; - - - SWFDisplayItem::getYScale - - - - - - - diff --git a/reference/ming/swfdisplayitem/getxskew.xml b/reference/ming/swfdisplayitem/getxskew.xml deleted file mode 100644 index 1537a226d353..000000000000 --- a/reference/ming/swfdisplayitem/getxskew.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - SWFDisplayItem::getXSkew - - - - &reftitle.description; - - floatSWFDisplayItem::getXSkew - - - - &warn.undocumented.func; - - - - - &reftitle.seealso; - - - SWFDisplayItem::getYSkew - - - - - - - diff --git a/reference/ming/swfdisplayitem/gety.xml b/reference/ming/swfdisplayitem/gety.xml deleted file mode 100644 index bee2802fc3d0..000000000000 --- a/reference/ming/swfdisplayitem/gety.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - SWFDisplayItem::getY - - - - &reftitle.description; - - floatSWFDisplayItem::getY - - - - &warn.undocumented.func; - - - - - - &reftitle.seealso; - - - SWFDisplayItem::getX - - - - - - - diff --git a/reference/ming/swfdisplayitem/getyscale.xml b/reference/ming/swfdisplayitem/getyscale.xml deleted file mode 100644 index 840415f16abf..000000000000 --- a/reference/ming/swfdisplayitem/getyscale.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - SWFDisplayItem::getYScale - - - - &reftitle.description; - - floatSWFDisplayItem::getYScale - - - - &warn.undocumented.func; - - - - - - &reftitle.seealso; - - - SWFDisplayItem::getXScale - - - - - - - diff --git a/reference/ming/swfdisplayitem/getyskew.xml b/reference/ming/swfdisplayitem/getyskew.xml deleted file mode 100644 index 9dd6690854ef..000000000000 --- a/reference/ming/swfdisplayitem/getyskew.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - SWFDisplayItem::getYSkew - - - - &reftitle.description; - - floatSWFDisplayItem::getYSkew - - - - &warn.undocumented.func; - - - - - - &reftitle.seealso; - - - SWFDisplayItem::getXSkew - - - - - - - diff --git a/reference/ming/swfdisplayitem/move.xml b/reference/ming/swfdisplayitem/move.xml deleted file mode 100644 index f79548642d43..000000000000 --- a/reference/ming/swfdisplayitem/move.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - SWFDisplayItem::move - Moves object in relative coordinates - - - &reftitle.description; - - voidSWFDisplayItem::move - floatdx - floatdy - - &warn.experimental.func; - - swfdisplayitem::move moves the current object by - (dx,dy) from its - current position. - - - The object may be a swfshape, a - swfbutton, a swftext or a - swfsprite object. It must have been added using - the swfmovie::add. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFDisplayItem::moveTo - - - - - - - diff --git a/reference/ming/swfdisplayitem/moveto.xml b/reference/ming/swfdisplayitem/moveto.xml deleted file mode 100644 index 93213fb51941..000000000000 --- a/reference/ming/swfdisplayitem/moveto.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - SWFDisplayItem::moveTo - Moves object in global coordinates - - - &reftitle.description; - - voidSWFDisplayItem::moveTo - floatx - floaty - - &warn.experimental.func; - - swfdisplayitem::moveto moves the current object to - (x,y) in global coordinates. - - - The object may be a swfshape, a - swfbutton, a swftext or a - swfsprite object. It must have been added using - the swfmovie::add. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFDisplayItem::move - - - - - - - diff --git a/reference/ming/swfdisplayitem/multcolor.xml b/reference/ming/swfdisplayitem/multcolor.xml deleted file mode 100644 index 126c5e408860..000000000000 --- a/reference/ming/swfdisplayitem/multcolor.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - SWFDisplayItem::multColor - Multiplies the item's color transform - - - &reftitle.description; - - voidSWFDisplayItem::multColor - floatred - floatgreen - floatblue - floata - - &warn.experimental.func; - - swfdisplayitem::multcolor multiplies the item's - color transform by the given values. - - - The object may be a swfshape, a - swfbutton, a swftext or a - swfsprite object. It must have been added using - the swfmovie::add. - - - - - &reftitle.parameters; - - These parameters are floats between 0.0 and 1.0: - - - red - - - Value of red component - - - - - green - - - Value of green component - - - - - blue - - - Value of blue component - - - - - a - - - Value of alpha component - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - This simple example will modify your picture's atmosphere - to Halloween (use a landscape or bright picture). - - <function>swfdisplayitem::multcolor</function> example - -setRightFill($s->addFill($b)); -$s->drawLine($b->getWidth(), 0); -$s->drawLine(0, $b->getHeight()); -$s->drawLine(-$b->getWidth(), 0); -$s->drawLine(0, -$b->getHeight()); - -$m = new SWFMovie(); -$m->setDimension($b->getWidth(), $b->getHeight()); - -$i = $m->add($s); - -for ($n=0; $n<=20; ++$n) { - $i->multColor(1.0-$n/10, 1.0, 1.0); - $i->addColor(0xff*$n/20, 0, 0); - $m->nextFrame(); -} - -header('Content-type: application/x-shockwave-flash'); -$m->output(); -?> -]]> - - - - - - - diff --git a/reference/ming/swfdisplayitem/remove.xml b/reference/ming/swfdisplayitem/remove.xml deleted file mode 100644 index 04a5b6455605..000000000000 --- a/reference/ming/swfdisplayitem/remove.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - SWFDisplayItem::remove - Removes the object from the movie - - - &reftitle.description; - - voidSWFDisplayItem::remove - - - &warn.experimental.func; - - swfdisplayitem::remove removes this object from - the movie's display list. - - - The object may be a swfshape, a - swfbutton, a swftext or a - swfsprite object. It must have been added using - the swfmovie::add. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFMovie::add - - - - - - - diff --git a/reference/ming/swfdisplayitem/rotate.xml b/reference/ming/swfdisplayitem/rotate.xml deleted file mode 100644 index 7a247c30209f..000000000000 --- a/reference/ming/swfdisplayitem/rotate.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - SWFDisplayItem::rotate - Rotates in relative coordinates - - - &reftitle.description; - - voidSWFDisplayItem::rotate - floatangle - - &warn.experimental.func; - - swfdisplayitem::rotate rotates the current object - by angle degrees from its current rotation. - - - The object may be a swfshape, a - swfbutton, a swftext or a - swfsprite object. It must have been added using - the swfmovie::add. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFDisplayItem::rotateTo - - - - - - - diff --git a/reference/ming/swfdisplayitem/rotateto.xml b/reference/ming/swfdisplayitem/rotateto.xml deleted file mode 100644 index 77d8b6f4f610..000000000000 --- a/reference/ming/swfdisplayitem/rotateto.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - SWFDisplayItem::rotateTo - Rotates the object in global coordinates - - - &reftitle.description; - - voidSWFDisplayItem::rotateTo - floatangle - - &warn.experimental.func; - - swfdisplayitem::rotateto set the current object - rotation to angle degrees in global coordinates. - - - The object may be a swfshape, a - swfbutton, a swftext or a - swfsprite object. It must have been added using - the swfmovie::add. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - This example bring three rotating string from the background to the - foreground. Pretty nice. - - <function>swfdisplayitem::rotateto</function> example - -setRate(24.0); -$m->setDimension(2400, 1600); -$m->setBackground(0xff, 0xff, 0xff); - -// functions with huge numbers of arbitrary -// arguments are always a good idea! Really! - -function text($r, $g, $b, $a, $rot, $x, $y, $scale, $string) -{ - global $f, $m; - - $t = new SWFText(); - $t->setFont($f); - $t->setColor($r, $g, $b, $a); - $t->setHeight(960); - $t->moveTo(-($f->getWidth($string))/2, $f->getAscent()/2); - $t->addString($string); - - // we can add properties just like a normal PHP var, - // as long as the names aren't already used. - // e.g., we can't set $i->scale, because that's a function - - $i = $m->add($t); - $i->x = $x; - $i->y = $y; - $i->rot = $rot; - $i->s = $scale; - $i->rotateTo($rot); - $i->scale($scale, $scale); - - // but the changes are local to the function, so we have to - // return the changed object. kinda weird.. - - return $i; -} - -function step($i) -{ - $oldrot = $i->rot; - $i->rot = 19*$i->rot/20; - $i->x = (19*$i->x + 1200)/20; - $i->y = (19*$i->y + 800)/20; - $i->s = (19*$i->s + 1.0)/20; - - $i->rotateTo($i->rot); - $i->scaleTo($i->s, $i->s); - $i->moveTo($i->x, $i->y); - - return $i; -} - -// see? it sure paid off in legibility: - -$i1 = text(0xff, 0x33, 0x33, 0xff, 900, 1200, 800, 0.03, $thetext); -$i2 = text(0x00, 0x33, 0xff, 0x7f, -560, 1200, 800, 0.04, $thetext); -$i3 = text(0xff, 0xff, 0xff, 0x9f, 180, 1200, 800, 0.001, $thetext); - -for ($i=1; $i<=100; ++$i) { - $i1 = step($i1); - $i2 = step($i2); - $i3 = step($i3); - - $m->nextFrame(); -} - -header('Content-type: application/x-shockwave-flash'); -$m->output(); -?> -]]> - - - - - - - &reftitle.seealso; - - - SWFDisplayItem::rotate - - - - - - - diff --git a/reference/ming/swfdisplayitem/scale.xml b/reference/ming/swfdisplayitem/scale.xml deleted file mode 100644 index 8c7160717722..000000000000 --- a/reference/ming/swfdisplayitem/scale.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - SWFDisplayItem::scale - Scales the object in relative coordinates - - - &reftitle.description; - - voidSWFDisplayItem::scale - floatdx - floatdy - - &warn.experimental.func; - - swfdisplayitem::scale scales the current object by - (dx,dy) from its - current size. - - - The object may be a swfshape, a - swfbutton, a swftext or a - swfsprite object. It must have been added using - the swfmovie::add. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFDisplayItem::scaleTo - - - - - - - diff --git a/reference/ming/swfdisplayitem/scaleto.xml b/reference/ming/swfdisplayitem/scaleto.xml deleted file mode 100644 index 51f805307a29..000000000000 --- a/reference/ming/swfdisplayitem/scaleto.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - SWFDisplayItem::scaleTo - Scales the object in global coordinates - - - &reftitle.description; - - voidSWFDisplayItem::scaleTo - floatx - floaty - - &warn.experimental.func; - - swfdisplayitem::scaleto scales the current object to - (x,y) in global coordinates. - - - The object may be a swfshape, a - swfbutton, a swftext or a - swfsprite object. It must have been added using - the swfmovie::add. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFDisplayItem::scale - - - - - - - diff --git a/reference/ming/swfdisplayitem/setdepth.xml b/reference/ming/swfdisplayitem/setdepth.xml deleted file mode 100644 index 188e0ed5a7dc..000000000000 --- a/reference/ming/swfdisplayitem/setdepth.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - SWFDisplayItem::setDepth - Sets z-order - - - &reftitle.description; - - voidSWFDisplayItem::setDepth - intdepth - - &warn.experimental.func; - - swfdisplayitem::setdepth sets the object's - z-order to depth. Depth defaults to the - order in which instances are created (by adding a shape/text to - a movie)- newer ones are on top of older ones. If two objects are - given the same depth, only the later-defined one can be moved. - - - The object may be a swfshape, a - swfbutton, a swftext or a - swfsprite object. It must have been added using - the swfmovie::add. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfdisplayitem/setmasklevel.xml b/reference/ming/swfdisplayitem/setmasklevel.xml deleted file mode 100644 index 2bc42f0dbb76..000000000000 --- a/reference/ming/swfdisplayitem/setmasklevel.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - SWFDisplayItem::setMaskLevel - Defines a MASK layer at level - - - &reftitle.description; - - voidSWFDisplayItem::setMaskLevel - intlevel - - - &warn.undocumented.func; - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfdisplayitem/setmatrix.xml b/reference/ming/swfdisplayitem/setmatrix.xml deleted file mode 100644 index 4217e1023a17..000000000000 --- a/reference/ming/swfdisplayitem/setmatrix.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - SWFDisplayItem::setMatrix - Sets the item's transform matrix - - - &reftitle.description; - - voidSWFDisplayItem::setMatrix - floata - floatb - floatc - floatd - floatx - floaty - - - &warn.undocumented.func; - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfdisplayitem/setname.xml b/reference/ming/swfdisplayitem/setname.xml deleted file mode 100644 index 835d8a9b87ea..000000000000 --- a/reference/ming/swfdisplayitem/setname.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - SWFDisplayItem::setName - Sets the object's name - - - &reftitle.description; - - voidSWFDisplayItem::setName - stringname - - &warn.experimental.func; - - swfdisplayitem::setname sets the object's name to - name, for targetting with action script. - Only useful on sprites. - - - The object may be a swfshape, a - swfbutton, a swftext or a - swfsprite object. It must have been added using - the swfmovie::add. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfdisplayitem/setratio.xml b/reference/ming/swfdisplayitem/setratio.xml deleted file mode 100644 index c0697694d9d0..000000000000 --- a/reference/ming/swfdisplayitem/setratio.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - SWFDisplayItem::setRatio - Sets the object's ratio - - - &reftitle.description; - - voidSWFDisplayItem::setRatio - floatratio - - &warn.experimental.func; - - swfdisplayitem::setratio sets the object's ratio - to ratio. Obviously only useful for morphs. - - - The object may be a swfshape, a - swfbutton, a swftext or a - swfsprite object. It must have been added using - the swfmovie::add. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - This simple example will morph nicely three concentric circles. - - <function>swfdisplayitem::setname</function> example - -addEntry(0.0, 0, 0, 0); -$g->addEntry(0.16, 0xff, 0xff, 0xff); -$g->addEntry(0.32, 0, 0, 0); -$g->addEntry(0.48, 0xff, 0xff, 0xff); -$g->addEntry(0.64, 0, 0, 0); -$g->addEntry(0.80, 0xff, 0xff, 0xff); -$g->addEntry(1.00, 0, 0, 0); - -$s = $p->getShape1(); -$f = $s->addFill($g, SWFFILL_RADIAL_GRADIENT); -$f->scaleTo(0.05); -$s->setLeftFill($f); -$s->movePenTo(-160, -120); -$s->drawLine(320, 0); -$s->drawLine(0, 240); -$s->drawLine(-320, 0); -$s->drawLine(0, -240); - -$g = new SWFGradient(); -$g->addEntry(0.0, 0, 0, 0); -$g->addEntry(0.16, 0xff, 0, 0); -$g->addEntry(0.32, 0, 0, 0); -$g->addEntry(0.48, 0, 0xff, 0); -$g->addEntry(0.64, 0, 0, 0); -$g->addEntry(0.80, 0, 0, 0xff); -$g->addEntry(1.00, 0, 0, 0); - -$s = $p->getShape2(); -$f = $s->addFill($g, SWFFILL_RADIAL_GRADIENT); -$f->scaleTo(0.05); -$f->skewXTo(1.0); -$s->setLeftFill($f); -$s->movePenTo(-160, -120); -$s->drawLine(320, 0); -$s->drawLine(0, 240); -$s->drawLine(-320, 0); -$s->drawLine(0, -240); - -$m = new SWFMovie(); -$m->setDimension(320, 240); -$i = $m->add($p); -$i->moveTo(160, 120); - -for ($n=0; $n<=1.001; $n+=0.01) { - $i->setRatio($n); - $m->nextFrame(); -} - -header('Content-type: application/x-shockwave-flash'); -$m->output(); -?> -]]> - - - - - - - diff --git a/reference/ming/swfdisplayitem/skewx.xml b/reference/ming/swfdisplayitem/skewx.xml deleted file mode 100644 index 098e0384258a..000000000000 --- a/reference/ming/swfdisplayitem/skewx.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - SWFDisplayItem::skewX - Sets the X-skew - - - &reftitle.description; - - voidSWFDisplayItem::skewX - floatddegrees - - &warn.experimental.func; - - swfdisplayitem::skewx adds ddegrees - to current x-skew. - - - The object may be a swfshape, a - swfbutton, a swftext or a - swfsprite object. It must have been added using - the swfmovie::add. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFDisplayItem::skewXTo - SWFDisplayItem::skewY - SWFDisplayItem::skewYTo - - - - - - - diff --git a/reference/ming/swfdisplayitem/skewxto.xml b/reference/ming/swfdisplayitem/skewxto.xml deleted file mode 100644 index 199b67d50d02..000000000000 --- a/reference/ming/swfdisplayitem/skewxto.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - SWFDisplayItem::skewXTo - Sets the X-skew - - - &reftitle.description; - - voidSWFDisplayItem::skewXTo - floatdegrees - - &warn.experimental.func; - - swfdisplayitem::skewxto sets the - x-skew to degrees. For degrees - is 1.0, it means a 45-degree forward slant. More is more forward, - less is more backward. - - - The object may be a swfshape, a - swfbutton, a swftext or a - swfsprite object. It must have been added using - the swfmovie::add. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFDisplayItem::skewX - SWFDisplayItem::skewY - SWFDisplayItem::skewYTo - - - - - - - diff --git a/reference/ming/swfdisplayitem/skewy.xml b/reference/ming/swfdisplayitem/skewy.xml deleted file mode 100644 index 9beaa6c48721..000000000000 --- a/reference/ming/swfdisplayitem/skewy.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - SWFDisplayItem::skewY - Sets the Y-skew - - - &reftitle.description; - - voidSWFDisplayItem::skewY - floatddegrees - - &warn.experimental.func; - - swfdisplayitem::skewy adds ddegrees - to current y-skew. - - - The object may be a swfshape, a - swfbutton, a swftext or a - swfsprite object. It must have been added using - the swfmovie::add. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFDisplayItem::skewYTo - SWFDisplayItem::skewX - SWFDisplayItem::skewXTo - - - - - - - diff --git a/reference/ming/swfdisplayitem/skewyto.xml b/reference/ming/swfdisplayitem/skewyto.xml deleted file mode 100644 index d6ffcb5581c0..000000000000 --- a/reference/ming/swfdisplayitem/skewyto.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - SWFDisplayItem::skewYTo - Sets the Y-skew - - - &reftitle.description; - - voidSWFDisplayItem::skewYTo - floatdegrees - - &warn.experimental.func; - - swfdisplayitem::skewyto sets the - y-skew to degrees. For degrees - is 1.0, it means a 45-degree forward slant. More is more upward, - less is more downward. - - - The object may be a swfshape, a - swfbutton, a swftext or a - swfsprite object. It must have been added using - the swfmovie::add. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFDisplayItem::skewY - SWFDisplayItem::skewX - SWFDisplayItem::skewXTo - - - - - - - diff --git a/reference/ming/swffill.xml b/reference/ming/swffill.xml deleted file mode 100644 index 457568074fae..000000000000 --- a/reference/ming/swffill.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - The SWFFill class - SWFFill - - - - -
- &reftitle.intro; - - The SWFFill object allows you to transform - (scale, skew, rotate) bitmap and gradient fills. - - - swffill objects are created by the - SWFShape::addFill method. - -
- - -
- &reftitle.classsynopsis; - - - - SWFFill - - - - - SWFFill - - - - - &Methods; - - - - - -
- - &reference.ming.entities.swffill; - - - - diff --git a/reference/ming/swffill/moveto.xml b/reference/ming/swffill/moveto.xml deleted file mode 100644 index f48e85cafde8..000000000000 --- a/reference/ming/swffill/moveto.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - SWFFill::moveTo - Moves fill origin - - - &reftitle.description; - - voidSWFFill::moveTo - floatx - floaty - - &warn.experimental.func; - - Moves the fill origin to the given global coordinates. - - - - - &reftitle.parameters; - - - - x - - - X-coordinate - - - - - y - - - Y-coordinate - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swffill/rotateto.xml b/reference/ming/swffill/rotateto.xml deleted file mode 100644 index 45fe5f05502e..000000000000 --- a/reference/ming/swffill/rotateto.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - SWFFill::rotateTo - Sets fill's rotation - - - &reftitle.description; - - voidSWFFill::rotateTo - floatangle - - &warn.experimental.func; - - Sets the fill rotation to the given angle. - - - - - &reftitle.parameters; - - - - angle - - - The rotation angle, in degrees. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swffill/scaleto.xml b/reference/ming/swffill/scaleto.xml deleted file mode 100644 index d595653a0759..000000000000 --- a/reference/ming/swffill/scaleto.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - SWFFill::scaleTo - Sets fill's scale - - - &reftitle.description; - - voidSWFFill::scaleTo - floatx - floaty - - &warn.experimental.func; - - Sets the fill scale to the given coordinates. - - - - - &reftitle.parameters; - - - - x - - - X-coordinate - - - - - y - - - Y-coordinate - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swffill/skewxto.xml b/reference/ming/swffill/skewxto.xml deleted file mode 100644 index 8c832f49a39e..000000000000 --- a/reference/ming/swffill/skewxto.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - SWFFill::skewXTo - Sets fill x-skew - - - &reftitle.description; - - voidSWFFill::skewXTo - floatx - - &warn.experimental.func; - - Sets the fill x-skew to x. - - - - - &reftitle.parameters; - - - - x - - - When x is 1.0, it is a 45-degree forward slant. - More is more forward, less is more backward. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFFill::skewYTo - - - - - - - diff --git a/reference/ming/swffill/skewyto.xml b/reference/ming/swffill/skewyto.xml deleted file mode 100644 index 1c173c4d107d..000000000000 --- a/reference/ming/swffill/skewyto.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - SWFFill::skewYTo - Sets fill y-skew - - - &reftitle.description; - - voidSWFFill::skewYTo - floaty - - &warn.experimental.func; - - Sets the fill y-skew to y. - - - - &reftitle.parameters; - - - - y - - - When y is 1.0, it is a 45-degree upward slant. - More is more upward, less is more downward. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFFill::skewXTo - - - - - - - diff --git a/reference/ming/swffont.xml b/reference/ming/swffont.xml deleted file mode 100644 index 34e549886ea0..000000000000 --- a/reference/ming/swffont.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - The SWFFont class - SWFFont - - - - -
- &reftitle.intro; - - The SWFFont object represent a reference to the - font definition, for us with SWFText::setFont - and SWFTextField::setFont. - -
- - -
- &reftitle.classsynopsis; - - - - SWFFont - - - - - SWFFont - - - - - &Methods; - - - - - -
- - &reference.ming.entities.swffont; - - - - diff --git a/reference/ming/swffont/construct.xml b/reference/ming/swffont/construct.xml deleted file mode 100644 index 7ea199dc6a03..000000000000 --- a/reference/ming/swffont/construct.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - SWFFont::__construct - Loads a font definition - - - &reftitle.description; - - SWFFont::__construct - stringfilename - - &warn.experimental.func; - - If filename is the name of an FDB file - (i.e., it ends in ".fdb"), load the font definition found in said - file. Otherwise, create a browser-defined font reference. - - - FDB ("font definition block") is a very simple wrapper for the SWF DefineFont2 - block which contains a full description of a font. One may create FDB files from - SWT Generator template files with the included makefdb utility- look in the - util directory off the main ming distribution directory. - - - Browser-defined fonts don't contain any information about the font other - than its name. It is assumed that the font definition will be provided by - the movie player. The fonts _serif, _sans, and _typewriter should always - be available. For example: - - -]]> - - will give you the standard sans-serif font, probably the same as what you'd get - with <font name="sans-serif"> in HTML. - - - - - - - - diff --git a/reference/ming/swffont/getascent.xml b/reference/ming/swffont/getascent.xml deleted file mode 100644 index a0f4801e204b..000000000000 --- a/reference/ming/swffont/getascent.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - SWFFont::getAscent - Returns the ascent of the font, or 0 if not available - - - &reftitle.description; - - floatSWFFont::getAscent - - - - &warn.undocumented.func; - - - - - - &reftitle.seealso; - - - SWFFont::getDescent - - - - - - - diff --git a/reference/ming/swffont/getdescent.xml b/reference/ming/swffont/getdescent.xml deleted file mode 100644 index 8f84fb74822b..000000000000 --- a/reference/ming/swffont/getdescent.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - SWFFont::getDescent - Returns the descent of the font, or 0 if not available - - - &reftitle.description; - - floatSWFFont::getDescent - - - - &warn.undocumented.func; - - - - - - &reftitle.seealso; - - - SWFFont::getAscent - - - - - - - diff --git a/reference/ming/swffont/getleading.xml b/reference/ming/swffont/getleading.xml deleted file mode 100644 index 03ba5c0533cc..000000000000 --- a/reference/ming/swffont/getleading.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - SWFFont::getLeading - Returns the leading of the font, or 0 if not available - - - &reftitle.description; - - floatSWFFont::getLeading - - - - &warn.undocumented.func; - - - - - - - diff --git a/reference/ming/swffont/getshape.xml b/reference/ming/swffont/getshape.xml deleted file mode 100644 index ed8871fc606e..000000000000 --- a/reference/ming/swffont/getshape.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - SWFFont::getShape - Returns the glyph shape of a char as a text string - - - &reftitle.description; - - stringSWFFont::getShape - intcode - - - &warn.undocumented.func; - - - - - - - diff --git a/reference/ming/swffont/getutf8width.xml b/reference/ming/swffont/getutf8width.xml deleted file mode 100644 index e24f16585a7f..000000000000 --- a/reference/ming/swffont/getutf8width.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - SWFFont::getUTF8Width - Calculates the width of the given string in this font at full height - - - &reftitle.description; - - floatSWFFont::getUTF8Width - stringstring - - - &warn.undocumented.func; - - - - - - &reftitle.seealso; - - - SWFFont::getWidth - - - - - - - diff --git a/reference/ming/swffont/getwidth.xml b/reference/ming/swffont/getwidth.xml deleted file mode 100644 index 96fad82ccfdb..000000000000 --- a/reference/ming/swffont/getwidth.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - SWFFont::getWidth - Returns the string's width - - - &reftitle.description; - - floatSWFFont::getWidth - stringstring - - &warn.experimental.func; - - swffont::getwidth returns the string - string's width, using font's default scaling. - You'll probably want to use the swftext version of this method which - uses the text object's scale. - - - - - &reftitle.seealso; - - - SWFFont::getUTF8Width - - - - - - - diff --git a/reference/ming/swffontchar.xml b/reference/ming/swffontchar.xml deleted file mode 100644 index 061d97b3e61d..000000000000 --- a/reference/ming/swffontchar.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - The SWFFontChar class - SWFFontChar - - - - -
- &reftitle.intro; - - SWFFontChar. - -
- - -
- &reftitle.classsynopsis; - - - - SWFFontChar - - - - - SWFFontChar - - - - - &Methods; - - - - - -
- - &reference.ming.entities.swffontchar; - - - - diff --git a/reference/ming/swffontchar/addchars.xml b/reference/ming/swffontchar/addchars.xml deleted file mode 100644 index ad82a0ef76ab..000000000000 --- a/reference/ming/swffontchar/addchars.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - SWFFontChar::addChars - Adds characters to a font for exporting font - - - &reftitle.description; - - voidSWFFontChar::addChars - stringchar - - - &warn.undocumented.func; - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFFontChar::addUTF8Chars - - - - - - - diff --git a/reference/ming/swffontchar/addutf8chars.xml b/reference/ming/swffontchar/addutf8chars.xml deleted file mode 100644 index 42e0f6298f1d..000000000000 --- a/reference/ming/swffontchar/addutf8chars.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - SWFFontChar::addUTF8Chars - Adds characters to a font for exporting font - - - &reftitle.description; - - voidSWFFontChar::addUTF8Chars - stringchar - - - &warn.undocumented.func; - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFFontChar::addChars - - - - - - - diff --git a/reference/ming/swfgradient.xml b/reference/ming/swfgradient.xml deleted file mode 100644 index 420bece6799a..000000000000 --- a/reference/ming/swfgradient.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - The SWFGradient class - SWFGradient - - - - -
- &reftitle.intro; - - SWFGradient. - -
- - -
- &reftitle.classsynopsis; - - - - SWFGradient - - - - - SWFGradient - - - - - &Methods; - - - - - -
- - &reference.ming.entities.swfgradient; - - - - diff --git a/reference/ming/swfgradient/addentry.xml b/reference/ming/swfgradient/addentry.xml deleted file mode 100644 index a21f1a2fde61..000000000000 --- a/reference/ming/swfgradient/addentry.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - SWFGradient::addEntry - Adds an entry to the gradient list - - - &reftitle.description; - - voidSWFGradient::addEntry - floatratio - intred - intgreen - intblue - intalpha255 - - &warn.experimental.func; - - swfgradient::addentry adds an entry to the gradient list. - ratio is a number between 0 and 1 indicating where in - the gradient this color appears. Thou shalt add entries in order of increasing ratio. - - - red, green, blue - is a color (RGB mode). - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfgradient/construct.xml b/reference/ming/swfgradient/construct.xml deleted file mode 100644 index ba2cd21bf633..000000000000 --- a/reference/ming/swfgradient/construct.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - SWFGradient::__construct - Creates a gradient object - - - &reftitle.description; - - SWFGradient::__construct - - - &warn.experimental.func; - - swfgradient creates a new SWFGradient object. - - - After you've added the entries to your gradient, you can use the gradient - in a shape fill with the swfshape::addfill method. - - - SWFGradient has the following methods : swfgradient::addentry. - - - This simple example will draw a big black-to-white gradient as background, - and a reddish disc in its center. - - <function>swfgradient</function> example - -setDimension(320, 240); - - $s = new SWFShape(); - - // first gradient- black to white - $g = new SWFGradient(); - $g->addEntry(0.0, 0, 0, 0); - $g->addEntry(1.0, 0xff, 0xff, 0xff); - - $f = $s->addFill($g, SWFFILL_LINEAR_GRADIENT); - $f->scaleTo(0.01); - $f->moveTo(160, 120); - $s->setRightFill($f); - $s->drawLine(320, 0); - $s->drawLine(0, 240); - $s->drawLine(-320, 0); - $s->drawLine(0, -240); - - $m->add($s); - - $s = new SWFShape(); - - // second gradient- radial gradient from red to transparent - $g = new SWFGradient(); - $g->addEntry(0.0, 0xff, 0, 0, 0xff); - $g->addEntry(1.0, 0xff, 0, 0, 0); - - $f = $s->addFill($g, SWFFILL_RADIAL_GRADIENT); - $f->scaleTo(0.005); - $f->moveTo(160, 120); - $s->setRightFill($f); - $s->drawLine(320, 0); - $s->drawLine(0, 240); - $s->drawLine(-320, 0); - $s->drawLine(0, -240); - - $m->add($s); - - header('Content-type: application/x-shockwave-flash'); - $m->output(); -?> -]]> - - - - - - - diff --git a/reference/ming/swfmorph.xml b/reference/ming/swfmorph.xml deleted file mode 100644 index 7bc228094a0e..000000000000 --- a/reference/ming/swfmorph.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - -The SWFMorph class -SWFMorph - - - - -
- &reftitle.intro; - - The methods here are sort of weird. It would make more sense to just - have newSWFMorph(shape1, shape2);, but as things are now, shape2 needs - to know that it's the second part of a morph. (This, because it starts - writing its output as soon as it gets drawing commands- if it kept its - own description of its shapes and wrote on completion this and some - other things would be much easier.) - -
- - -
- &reftitle.classsynopsis; - - - - SWFMorph - - - - - SWFMorph - - - - - &Methods; - - - - - -
- -&reference.ming.entities.swfmorph; - - - - diff --git a/reference/ming/swfmorph/construct.xml b/reference/ming/swfmorph/construct.xml deleted file mode 100644 index 6f81919af276..000000000000 --- a/reference/ming/swfmorph/construct.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - SWFMorph::__construct - Creates a new SWFMorph object - - - &reftitle.description; - - SWFMorph::__construct - - - &warn.experimental.func; - - Creates a new SWFMorph object. - - - Also called a "shape tween". This thing lets you make those tacky - twisting things that make your computer choke. Oh, joy! - - - - &reftitle.examples; - - This simple example will morph a big red square into a smaller - blue black-bordered square. - - <function>swfmorph</function> example - -getShape1(); - $s->setLine(0, 0, 0, 0); - - /* Note that this is backwards from normal shapes (left instead of right). - I have no idea why, but this seems to work.. */ - - $s->setLeftFill($s->addFill(0xff, 0, 0)); - $s->movePenTo(-1000,-1000); - $s->drawLine(2000,0); - $s->drawLine(0,2000); - $s->drawLine(-2000,0); - $s->drawLine(0,-2000); - - $s = $p->getShape2(); - $s->setLine(60,0,0,0); - $s->setLeftFill($s->addFill(0, 0, 0xff)); - $s->movePenTo(0,-1000); - $s->drawLine(1000,1000); - $s->drawLine(-1000,1000); - $s->drawLine(-1000,-1000); - $s->drawLine(1000,-1000); - - $m = new SWFMovie(); - $m->setDimension(3000,2000); - $m->setBackground(0xff, 0xff, 0xff); - - $i = $m->add($p); - $i->moveTo(1500,1000); - - for ($r=0.0; $r<=1.0; $r+=0.1) { - $i->setRatio($r); - $m->nextFrame(); - } - - header('Content-type: application/x-shockwave-flash'); - $m->output(); -?> -]]> - - - - - - - diff --git a/reference/ming/swfmorph/getshape1.xml b/reference/ming/swfmorph/getshape1.xml deleted file mode 100644 index 4378b26efac5..000000000000 --- a/reference/ming/swfmorph/getshape1.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - SWFMorph::getShape1 - Gets a handle to the starting shape - - - &reftitle.description; - - SWFShapeSWFMorph::getShape1 - - - &warn.experimental.func; - - Gets the morph's starting shape. - - - - - &reftitle.returnvalues; - - Returns a object. - - - - - &reftitle.seealso; - - - SWFMorph::getShape2 - - - - - - - diff --git a/reference/ming/swfmorph/getshape2.xml b/reference/ming/swfmorph/getshape2.xml deleted file mode 100644 index 5d460770b11c..000000000000 --- a/reference/ming/swfmorph/getshape2.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - SWFMorph::getShape2 - Gets a handle to the ending shape - - - &reftitle.description; - - SWFShapeSWFMorph::getShape2 - - - &warn.experimental.func; - - Gets the morph's ending shape. - - - - - &reftitle.returnvalues; - - Returns a object. - - - - - &reftitle.seealso; - - - SWFMorph::getShape1 - - - - - - - diff --git a/reference/ming/swfmovie.xml b/reference/ming/swfmovie.xml deleted file mode 100644 index c927a9953c0b..000000000000 --- a/reference/ming/swfmovie.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - The SWFMovie class - SWFMovie - - - - -
- &reftitle.intro; - - SWFMovie is a movie object representing an SWF - movie. - -
- - -
- &reftitle.classsynopsis; - - - - SWFMovie - - - - - SWFMovie - - - - - &Methods; - - - - - -
- - &reference.ming.entities.swfmovie; - - - diff --git a/reference/ming/swfmovie/add.xml b/reference/ming/swfmovie/add.xml deleted file mode 100644 index d070e2fe95d8..000000000000 --- a/reference/ming/swfmovie/add.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - SWFMovie::add - Adds any type of data to a movie - - - &reftitle.description; - - mixedSWFMovie::add - objectinstance - - &warn.experimental.func; - - Adds an SWF object instance to the current movie. - - - - - &reftitle.parameters; - - - - instance - - - Any type of object instance, like , - , . - - - - - - - - - &reftitle.returnvalues; - - For displayable types (shape, text, button, sprite), this returns an - , a handle to the object in a display - list. Thus, you can add the same shape to a movie multiple - times and get separate handles back for each separate instance. - - - - - &reftitle.seealso; - - - SWFMovie::remove - - - - - - - diff --git a/reference/ming/swfmovie/addexport.xml b/reference/ming/swfmovie/addexport.xml deleted file mode 100644 index e9a2a2970251..000000000000 --- a/reference/ming/swfmovie/addexport.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - SWFMovie::addExport - - - - &reftitle.description; - - voidSWFMovie::addExport - SWFCharacterchar - stringname - - - &warn.undocumented.func; - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfmovie/addfont.xml b/reference/ming/swfmovie/addfont.xml deleted file mode 100644 index 814862dfbe9a..000000000000 --- a/reference/ming/swfmovie/addfont.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - SWFMovie::addFont - - - - &reftitle.description; - - mixedSWFMovie::addFont - SWFFontfont - - - &warn.undocumented.func; - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfmovie/construct.xml b/reference/ming/swfmovie/construct.xml deleted file mode 100644 index 83ecaae0268e..000000000000 --- a/reference/ming/swfmovie/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - SWFMovie::__construct - Creates a new movie object, representing an SWF version 4 movie - - - &reftitle.description; - - SWFMovie::__construct - intversion - - &warn.experimental.func; - - Creates a new movie object, representing an SWF movie. - - - - - &reftitle.parameters; - - - - version - - - The desired SWF version. Default is 4. - - - - - - - - - - diff --git a/reference/ming/swfmovie/importchar.xml b/reference/ming/swfmovie/importchar.xml deleted file mode 100644 index 3e38676c1136..000000000000 --- a/reference/ming/swfmovie/importchar.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - SWFMovie::importChar - - - - &reftitle.description; - - SWFSpriteSWFMovie::importChar - stringlibswf - stringname - - - &warn.undocumented.func; - - - - - - &reftitle.seealso; - - - SWFMovie::importFont - - - - - - - diff --git a/reference/ming/swfmovie/importfont.xml b/reference/ming/swfmovie/importfont.xml deleted file mode 100644 index 6f2d0522dbc4..000000000000 --- a/reference/ming/swfmovie/importfont.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - SWFMovie::importFont - - - - &reftitle.description; - - SWFFontCharSWFMovie::importFont - stringlibswf - stringname - - - &warn.undocumented.func; - - - - - - &reftitle.seealso; - - - SWFMovie::importChar - - - - - - - diff --git a/reference/ming/swfmovie/labelframe.xml b/reference/ming/swfmovie/labelframe.xml deleted file mode 100644 index b3cd92634969..000000000000 --- a/reference/ming/swfmovie/labelframe.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - SWFMovie::labelFrame - Labels a frame - - - &reftitle.description; - - voidSWFMovie::labelFrame - stringlabel - - - &warn.undocumented.func; - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfmovie/nextframe.xml b/reference/ming/swfmovie/nextframe.xml deleted file mode 100644 index 572ba8fe881d..000000000000 --- a/reference/ming/swfmovie/nextframe.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - SWFMovie::nextFrame - Moves to the next frame of the animation - - - &reftitle.description; - - voidSWFMovie::nextFrame - - - &warn.experimental.func; - - Moves to the next frame of the animation. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfmovie/output.xml b/reference/ming/swfmovie/output.xml deleted file mode 100644 index ea5bfa435a90..000000000000 --- a/reference/ming/swfmovie/output.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - SWFMovie::output - Dumps your lovingly prepared movie out - - - &reftitle.description; - - intSWFMovie::output - intcompression - - &warn.experimental.func; - - Dumps the SWFMovie. - - - Don't forget to send the Content-Type HTTP header file - before using this function, in order to display the movie in a browser. - - - - - &reftitle.parameters; - - - - compression - - - The compression level can be a value between 0 and 9, defining the SWF - compression similar to gzip compression. - - - This parameter is only available as of Flash MX (6). - - - - - - - - - &reftitle.returnvalues; - - Return the number of bytes written or &false; on error. - - - - - &reftitle.examples; - - - Displaying your $movie in a browser - -output(); -?> -]]> - - - - - - - &reftitle.seealso; - - - SWFMovie::save - SWFMovie::saveToFile - - - - - - - diff --git a/reference/ming/swfmovie/remove.xml b/reference/ming/swfmovie/remove.xml deleted file mode 100644 index 0db3ca2b89fe..000000000000 --- a/reference/ming/swfmovie/remove.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - SWFMovie::remove - Removes the object instance from the display list - - - &reftitle.description; - - voidSWFMovie::remove - objectinstance - - &warn.experimental.func; - - Removes the given object instance from the display - list. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFMovie::add - - - - - - - diff --git a/reference/ming/swfmovie/save.xml b/reference/ming/swfmovie/save.xml deleted file mode 100644 index 23f2dc0ee669..000000000000 --- a/reference/ming/swfmovie/save.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - SWFMovie::save - Saves the SWF movie in a file - - - &reftitle.description; - - intSWFMovie::save - stringfilename - intcompression-1 - - &warn.experimental.func; - - Saves the SWF movie to the specified filename. - - - - - &reftitle.parameters; - - - - filename - - - The path to the saved SWF document. - - - - - compression - - - The compression level can be a value between 0 and 9, defining the SWF - compression similar to gzip compression. - - - This parameter is only available as of Flash MX (6). - - - - - - - - - &reftitle.returnvalues; - - Return the number of bytes written or &false; on error. - - - - - &reftitle.seealso; - - - SWFMovie::output - SWFMovie::saveToFile - - - - - - diff --git a/reference/ming/swfmovie/savetofile.xml b/reference/ming/swfmovie/savetofile.xml deleted file mode 100644 index fd180ddf4475..000000000000 --- a/reference/ming/swfmovie/savetofile.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - SWFMovie::saveToFile - - - - &reftitle.description; - - intSWFMovie::saveToFile - resourcex - intcompression-1 - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - X - - - - - - - compression - - - The compression level can be a value between 0 and 9, defining the SWF - compression similar to gzip compression. - - - This parameter is only available as of Flash MX (6). - - - - - - - - - &reftitle.returnvalues; - - Return the number of bytes written or &false; on error. - - - - - &reftitle.seealso; - - - SWFMovie::output - SWFMovie::save - - - - - - - diff --git a/reference/ming/swfmovie/setbackground.xml b/reference/ming/swfmovie/setbackground.xml deleted file mode 100644 index 7c2ae979dc38..000000000000 --- a/reference/ming/swfmovie/setbackground.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - SWFMovie::setbackground - Sets the background color - - - &reftitle.description; - - voidSWFMovie::setbackground - intred - intgreen - intblue - - &warn.experimental.func; - - Sets the background color. - - - Why is there no rgba version? Think about it, you might want to let the - HTML background show through. There's a way to do that, but it only works - on IE4. Search the &url.macromedia; - site for details. - - - - - &reftitle.parameters; - - These parameters are integers between 0 and 255 or hexadecimals between - 0x00 and 0xFF: - - - red - - - Value of red component - - - - - green - - - Value of green component - - - - - blue - - - Value of blue component - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfmovie/setdimension.xml b/reference/ming/swfmovie/setdimension.xml deleted file mode 100644 index 128c12325b9a..000000000000 --- a/reference/ming/swfmovie/setdimension.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - SWFMovie::setDimension - Sets the movie's width and height - - - &reftitle.description; - - voidSWFMovie::setDimension - floatwidth - floatheight - - &warn.experimental.func; - - Sets the movie's dimension to the specified width - and height. - - - - - &reftitle.parameters; - - - - width - - - The movie width. - - - - - height - - - The movie height. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfmovie/setframes.xml b/reference/ming/swfmovie/setframes.xml deleted file mode 100644 index af10aae6bac2..000000000000 --- a/reference/ming/swfmovie/setframes.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - SWFMovie::setFrames - Sets the total number of frames in the animation - - - &reftitle.description; - - voidSWFMovie::setFrames - intnumber - - &warn.experimental.func; - - Sets the total number of frames in the animation to the given - number. - - - - - &reftitle.parameters; - - - - number - - - The number of frames. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfmovie/setrate.xml b/reference/ming/swfmovie/setrate.xml deleted file mode 100644 index 099884f978f9..000000000000 --- a/reference/ming/swfmovie/setrate.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - SWFMovie::setRate - Sets the animation's frame rate - - - &reftitle.description; - - voidSWFMovie::setRate - floatrate - - &warn.experimental.func; - - Sets the frame rate to the specified rate. - - - Animation will slow down if the player can't render frames fast enough- - unless there's a streaming sound, in which case display frames are - sacrificed to keep sound from skipping. - - - - - &reftitle.parameters; - - - - rate - - - The frame rate, in frame per seconds. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfmovie/startsound.xml b/reference/ming/swfmovie/startsound.xml deleted file mode 100644 index e93172352971..000000000000 --- a/reference/ming/swfmovie/startsound.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - SWFMovie::startSound - - - - &reftitle.description; - - SWFSoundInstanceSWFMovie::startSound - SWFSoundsound - - - &warn.undocumented.func; - - - - - - &reftitle.seealso; - - - SWFMovie::stopSound - - - - - - - diff --git a/reference/ming/swfmovie/stopsound.xml b/reference/ming/swfmovie/stopsound.xml deleted file mode 100644 index 6934f6850e51..000000000000 --- a/reference/ming/swfmovie/stopsound.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - SWFMovie::stopSound - - - - &reftitle.description; - - voidSWFMovie::stopSound - SWFSoundsound - - - &warn.undocumented.func; - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFMovie::startSound - - - - - - - diff --git a/reference/ming/swfmovie/streammp3.xml b/reference/ming/swfmovie/streammp3.xml deleted file mode 100644 index e97608b341c3..000000000000 --- a/reference/ming/swfmovie/streammp3.xml +++ /dev/null @@ -1,130 +0,0 @@ - - - - - SWFMovie::streamMP3 - Streams a MP3 file - - - &reftitle.description; - - intSWFMovie::streamMP3 - mixedmp3file - floatskip0 - - &warn.experimental.func; - - Streams the given MP3 file mp3file. - - - This method is not very robust in dealing with oddities (can skip over an - initial ID3 tag, but that's about it). - - - Note that the movie isn't smart enough to put enough frames in to contain - the entire mp3 stream- you'll have to add (length of song * frames per second) - frames to get the entire stream in. - - - - - &reftitle.parameters; - - - - mp3file - - - Can be a file pointer returned by fopen or the - MP3 data, as a binary string. - - - - - skip - - - Number of seconds to skip. - - - - - - - - - &reftitle.returnvalues; - - Return number of frames. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.0 - skip added - - - - - - - - - &reftitle.examples; - - - Streaming example - -setRate(12.0); -$m->streamMp3(file_get_contents("distortobass.mp3")); -// use your own MP3 - -// The file is 11.85 seconds at 12.0 fps = 142 frames -$m->setFrames(142); - -header('Content-type: application/x-shockwave-flash'); -$m->output(); -?> -]]> - - - - - - - - diff --git a/reference/ming/swfmovie/writeexports.xml b/reference/ming/swfmovie/writeexports.xml deleted file mode 100644 index 30a01a7068b6..000000000000 --- a/reference/ming/swfmovie/writeexports.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - SWFMovie::writeExports - - - - &reftitle.description; - - voidSWFMovie::writeExports - - - - &warn.undocumented.func; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfprebuiltclip.xml b/reference/ming/swfprebuiltclip.xml deleted file mode 100644 index 82739f87ec16..000000000000 --- a/reference/ming/swfprebuiltclip.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - The SWFPrebuiltClip class - SWFPrebuiltClip - - - - -
- &reftitle.intro; - - SWFPrebuiltClip. - -
- - -
- &reftitle.classsynopsis; - - - - SWFPrebuiltClip - - - - - SWFPrebuiltClip - - - - - &Methods; - - - - - -
- - &reference.ming.entities.swfprebuiltclip; - - - diff --git a/reference/ming/swfprebuiltclip/construct.xml b/reference/ming/swfprebuiltclip/construct.xml deleted file mode 100644 index cd26346ffa0b..000000000000 --- a/reference/ming/swfprebuiltclip/construct.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - SWFPrebuiltClip::__construct - Returns a SWFPrebuiltClip object - - - &reftitle.description; - - SWFPrebuiltClip::__construct - mixedfile - - - &warn.undocumented.func; - - - - - - - diff --git a/reference/ming/swfshape.xml b/reference/ming/swfshape.xml deleted file mode 100644 index 360326af0b16..000000000000 --- a/reference/ming/swfshape.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - The SWFShape class - SWFShape - - - - -
- &reftitle.intro; - - SWFShape. - -
- - -
- &reftitle.classsynopsis; - - - - SWFShape - - - - - SWFShape - - - - - &Methods; - - - - - -
- - &reference.ming.entities.swfshape; - - - - diff --git a/reference/ming/swfshape/addfill.xml b/reference/ming/swfshape/addfill.xml deleted file mode 100644 index d2d1b7d0f923..000000000000 --- a/reference/ming/swfshape/addfill.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - SWFShape::addFill - Adds a solid fill to the shape - - - &reftitle.description; - - SWFFillSWFShape::addFill - intred - intgreen - intblue - intalpha255 - - - SWFFilladdFill - SWFBitmapbitmap - intflags - - - SWFFilladdFill - SWFGradientgradient - intflags - - &warn.experimental.func; - - SWFShape::addFill adds a solid fill to the shape's list - of fill styles. SWFShape::addFill accepts three different - types of arguments. - - - red, green, blue - is a color (RGB mode). - - - The bitmap argument is an SWFBitmap object. - The flags argument can be one - of the following values: SWFFILL_CLIPPED_BITMAP, SWFFILL_TILED_BITMAP, - SWFFILL_LINEAR_GRADIENT or SWFFILL_RADIAL_GRADIENT. Default is - SWFFILL_TILED_BITMAP for SWFBitmap and SWFFILL_LINEAR_GRADIENT for - SWFGradient. - - - The gradient argument is an SWFGradient - object. The flags argument can be one of the following values : - SWFFILL_RADIAL_GRADIENT or SWFFILL_LINEAR_GRADIENT. Default is - SWFFILL_LINEAR_GRADIENT. I'm sure about this one. Really. - - - SWFShape::addFill returns an SWFFill - object for use with the SWFShape::setLeftFill - and SWFShape::setRightFill functions - described below. - - - - - &reftitle.examples; - - This simple example will draw a frame on a bitmap. Ah, here's another buglet in - the flash player- it doesn't seem to care about the second shape's bitmap's - transformation in a morph. According to spec, the bitmap should stretch - along with the shape in this example.. - - <function>SWFShape::addFill</function> example - -getWidth(); -$height = $b->getHeight(); - -$s = $p->getShape1(); -$f = $s->addFill($b, SWFFILL_TILED_BITMAP); -$f->moveTo(-$width/2, -$height/4); -$f->scaleTo(1.0, 0.5); -$s->setLeftFill($f); -$s->movePenTo(-$width/2, -$height/4); -$s->drawLine($width, 0); -$s->drawLine(0, $height/2); -$s->drawLine(-$width, 0); -$s->drawLine(0, -$height/2); - -$s = $p->getShape2(); -$f = $s->addFill($b, SWFFILL_TILED_BITMAP); - -// these two have no effect! -$f->moveTo(-$width/4, -$height/2); -$f->scaleTo(0.5, 1.0); - -$s->setLeftFill($f); -$s->movePenTo(-$width/4, -$height/2); -$s->drawLine($width/2, 0); -$s->drawLine(0, $height); -$s->drawLine(-$width/2, 0); -$s->drawLine(0, -$height); - -$m = new SWFMovie(); -$m->setDimension($width, $height); -$i = $m->add($p); -$i->moveTo($width/2, $height/2); - -for ($n=0; $n<1.001; $n+=0.03) { - $i->setRatio($n); - $m->nextFrame(); -} - -header('Content-type: application/x-shockwave-flash'); -$m->output(); -?> -]]> - - - - - - - &reftitle.seealso; - - - SWFShape::setLeftFill - SWFShape::setRightFill - - - - - - - diff --git a/reference/ming/swfshape/construct.xml b/reference/ming/swfshape/construct.xml deleted file mode 100644 index 45b9e07883a4..000000000000 --- a/reference/ming/swfshape/construct.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - SWFShape::__construct - Creates a new shape object - - - &reftitle.description; - - SWFShape::__construct - - - &warn.experimental.func; - - Created a new SWFShape object. - - - - - &reftitle.examples; - - This simple example will draw a big red elliptic quadrant. - - <function>swfshape</function> example - -setLine(40, 0x7f, 0, 0); -$s->setRightFill($s->addFill(0xff, 0, 0)); -$s->movePenTo(200, 200); -$s->drawLineTo(6200, 200); -$s->drawLineTo(6200, 4600); -$s->drawCurveTo(200, 4600, 200, 200); - -$m = new SWFMovie(); -$m->setDimension(6400, 4800); -$m->setRate(12.0); -$m->add($s); -$m->nextFrame(); - -header('Content-type: application/x-shockwave-flash'); -$m->output(); -?> -]]> - - - - - - - diff --git a/reference/ming/swfshape/drawarc.xml b/reference/ming/swfshape/drawarc.xml deleted file mode 100644 index 39f7e4fd6a7b..000000000000 --- a/reference/ming/swfshape/drawarc.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - SWFShape::drawArc - Draws an arc of radius r centered at the current location, from angle startAngle to angle endAngle measured clockwise from 12 o'clock - - - &reftitle.description; - - voidSWFShape::drawArc - floatr - floatstartAngle - floatendAngle - - - &warn.undocumented.func; - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFShape::drawCircle - - - - - - - diff --git a/reference/ming/swfshape/drawcircle.xml b/reference/ming/swfshape/drawcircle.xml deleted file mode 100644 index 882d3be14e61..000000000000 --- a/reference/ming/swfshape/drawcircle.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - SWFShape::drawCircle - Draws a circle of radius r centered at the current location, in a counter-clockwise fashion - - - &reftitle.description; - - voidSWFShape::drawCircle - floatr - - - &warn.undocumented.func; - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfshape/drawcubic.xml b/reference/ming/swfshape/drawcubic.xml deleted file mode 100644 index 6df623bf3317..000000000000 --- a/reference/ming/swfshape/drawcubic.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - SWFShape::drawCubic - Draws a cubic bezier curve using the current position and the three given points as control points - - - &reftitle.description; - - intSWFShape::drawCubic - floatbx - floatby - floatcx - floatcy - floatdx - floatdy - - - &warn.undocumented.func; - - - - - - &reftitle.seealso; - - - SWFShape::drawCubicTo - - - - - - - diff --git a/reference/ming/swfshape/drawcubicto.xml b/reference/ming/swfshape/drawcubicto.xml deleted file mode 100644 index 9d918d161bdb..000000000000 --- a/reference/ming/swfshape/drawcubicto.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - SWFShape::drawCubicTo - Draws a cubic bezier curve using the current position and the three given points as control points - - - &reftitle.description; - - intSWFShape::drawCubicTo - floatbx - floatby - floatcx - floatcy - floatdx - floatdy - - - &warn.undocumented.func; - - - - - - &reftitle.seealso; - - - SWFShape::drawCubic - - - - - - - diff --git a/reference/ming/swfshape/drawcurve.xml b/reference/ming/swfshape/drawcurve.xml deleted file mode 100644 index d6f749add527..000000000000 --- a/reference/ming/swfshape/drawcurve.xml +++ /dev/null @@ -1,69 +0,0 @@ - - - - - SWFShape::drawCurve - Draws a curve (relative) - - - &reftitle.description; - - intSWFShape::drawCurve - floatcontroldx - floatcontroldy - floatanchordx - floatanchordy - floattargetdx - floattargetdy - - &warn.experimental.func; - - swfshape::drawcurve draws a quadratic curve - (using the current line style,set by swfshape::setline) - from the current pen position to the relative position - (anchorx,anchory) - using relative control point - (controlx,controly). - That is, head towards the control point, then smoothly turn to the - anchor point. - - - With 6 parameters, it draws a cubic bezier to point - (x+targetdx, x+targetdy) - with control points (x+controldx, - y+controldy) and - (x+anchordx, y+anchordy). - - - - - &reftitle.seealso; - - - SWFShape::drawCurve - - - - - - - diff --git a/reference/ming/swfshape/drawcurveto.xml b/reference/ming/swfshape/drawcurveto.xml deleted file mode 100644 index d0c3d30b1cc7..000000000000 --- a/reference/ming/swfshape/drawcurveto.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - SWFShape::drawCurveTo - Draws a curve - - - &reftitle.description; - - intSWFShape::drawCurveTo - floatcontrolx - floatcontroly - floatanchorx - floatanchory - floattargetx - floattargety - - &warn.experimental.func; - - swfshape::drawcurveto draws a quadratic curve - (using the current line style, set by swfshape::setline) - from the current pen position to - (anchorx,anchory) - using (controlx,controly) - as a control point. That is, head towards the control point, - then smoothly turn to the anchor point. - - - With 6 parameters, it draws a cubic bezier to point - (targetx, targety) - with control points (controlx, - controly) and - (anchorx, anchory). - - - - - &reftitle.seealso; - - - SWFShape::drawCurveTo - - - - - - - diff --git a/reference/ming/swfshape/drawglyph.xml b/reference/ming/swfshape/drawglyph.xml deleted file mode 100644 index 04c98818a6bc..000000000000 --- a/reference/ming/swfshape/drawglyph.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - SWFShape::drawGlyph - Draws the first character in the given string into the shape using the glyph definition from the given font - - - &reftitle.description; - - voidSWFShape::drawGlyph - SWFFontfont - stringcharacter - intsize - - - &warn.undocumented.func; - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfshape/drawline.xml b/reference/ming/swfshape/drawline.xml deleted file mode 100644 index bf9bb5e20e73..000000000000 --- a/reference/ming/swfshape/drawline.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - SWFShape::drawLine - Draws a line (relative) - - - &reftitle.description; - - voidSWFShape::drawLine - floatdx - floatdy - - &warn.experimental.func; - - swfshape::drawline draws a line (using the current line style - set by swfshape::setline) from the current pen position to - displacement (dx,dy). - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFShape::drawLineTo - - - - - - - diff --git a/reference/ming/swfshape/drawlineto.xml b/reference/ming/swfshape/drawlineto.xml deleted file mode 100644 index 05c0e2f959c7..000000000000 --- a/reference/ming/swfshape/drawlineto.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - SWFShape::drawLineTo - Draws a line - - - &reftitle.description; - - voidSWFShape::drawLineTo - floatx - floaty - - &warn.experimental.func; - - swfshape::setrightfill draws a line (using the - current line style, set by swfshape::setline) from the current - pen position to point (x,y) - in the shape's coordinate space. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFShape::drawLine - - - - - - - diff --git a/reference/ming/swfshape/movepen.xml b/reference/ming/swfshape/movepen.xml deleted file mode 100644 index e1516dd9845f..000000000000 --- a/reference/ming/swfshape/movepen.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - SWFShape::movePen - Moves the shape's pen (relative) - - - &reftitle.description; - - voidSWFShape::movePen - floatdx - floatdy - - &warn.experimental.func; - - swfshape::setrightfill move the shape's pen from - coordinates (current x,current y) to (current x + dx, - current y + dy) in the shape's coordinate space. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFShape::movePenTo - - - - - - - diff --git a/reference/ming/swfshape/movepento.xml b/reference/ming/swfshape/movepento.xml deleted file mode 100644 index 33537677da82..000000000000 --- a/reference/ming/swfshape/movepento.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - SWFShape::movePenTo - Moves the shape's pen - - - &reftitle.description; - - voidSWFShape::movePenTo - floatx - floaty - - &warn.experimental.func; - - swfshape::setrightfill move the shape's pen to - (x,y) in the shape's - coordinate space. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFShape::movePen - - - - - - - diff --git a/reference/ming/swfshape/setleftfill.xml b/reference/ming/swfshape/setleftfill.xml deleted file mode 100644 index 6436e179af88..000000000000 --- a/reference/ming/swfshape/setleftfill.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - SWFShape::setLeftFill - Sets left rasterizing color - - - &reftitle.description; - - voidSWFShape::setLeftFill - SWFGradientfill - - - voidsetLeftFill - intred - intgreen - intblue - inta - - &warn.experimental.func; - - What this nonsense is about is, every edge segment borders at most two fills. - When rasterizing the object, it's pretty handy to know what those fills are - ahead of time, so the swf format requires these to be specified. - - - swfshape::setleftfill sets the fill on the left side of - the edge- that is, on the interior if you're defining the outline of the shape in a counter-clockwise - fashion. The fill object is an SWFFill object returned from one of the addFill - functions above. - - - This seems to be reversed when you're defining a shape in a morph, though. - If your browser crashes, just try setting the fill on the other side. - - - Shortcut for $swfshape->setleftfill($s->addfill($r, $g, $b [, $a]));. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFShape::setRightFill - - - - - - - diff --git a/reference/ming/swfshape/setline.xml b/reference/ming/swfshape/setline.xml deleted file mode 100644 index 08e865679f2a..000000000000 --- a/reference/ming/swfshape/setline.xml +++ /dev/null @@ -1,136 +0,0 @@ - - - - - SWFShape::setLine - Sets the shape's line style - - - &reftitle.description; - - voidSWFShape::setLine - SWFShapeshape - - - voidsetLine - intwidth - intred - intgreen - intblue - inta - - &warn.experimental.func; - - swfshape::setline sets the shape's line style. - width is the line's width. If width - is 0, the line's style is removed (then, all other arguments are ignored). - If width > 0, then line's color is set to - red, green, blue. - Last parameter a is optional. - - - You must declare all line styles before you use them (see example). - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - This simple example will draw a big "!#%*@", in funny colors and - gracious style. - - <function>swfshape::setline</function> example - -addFill(0xff, 0, 0); -$f2 = $s->addFill(0xff, 0x7f, 0); -$f3 = $s->addFill(0xff, 0xff, 0); -$f4 = $s->addFill(0, 0xff, 0); -$f5 = $s->addFill(0, 0, 0xff); - -// bug: have to declare all line styles before you use them -$s->setLine(40, 0x7f, 0, 0); -$s->setLine(40, 0x7f, 0x3f, 0); -$s->setLine(40, 0x7f, 0x7f, 0); -$s->setLine(40, 0, 0x7f, 0); -$s->setLine(40, 0, 0, 0x7f); - -$f = new SWFFont('Techno.fdb'); - -$s->setRightFill($f1); -$s->setLine(40, 0x7f, 0, 0); -$s->drawGlyph($f, '!'); -$s->movePen($f->getWidth('!'), 0); - -$s->setRightFill($f2); -$s->setLine(40, 0x7f, 0x3f, 0); -$s->drawGlyph($f, '#'); -$s->movePen($f->getWidth('#'), 0); - -$s->setRightFill($f3); -$s->setLine(40, 0x7f, 0x7f, 0); -$s->drawGlyph($f, '%'); -$s->movePen($f->getWidth('%'), 0); - -$s->setRightFill($f4); -$s->setLine(40, 0, 0x7f, 0); -$s->drawGlyph($f, '*'); -$s->movePen($f->getWidth('*'), 0); - -$s->setRightFill($f5); -$s->setLine(40, 0, 0, 0x7f); -$s->drawGlyph($f, '@'); - -$m = new SWFMovie(); -$m->setDimension(3000,2000); -$m->setRate(12.0); -$i = $m->add($s); -$i->moveTo(1500-$f->getWidth("!#%*@")/2, 1000+$f->getAscent()/2); - -header('Content-type: application/x-shockwave-flash'); -$m->output(); -?> -]]> - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfshape/setrightfill.xml b/reference/ming/swfshape/setrightfill.xml deleted file mode 100644 index ea2f8ed36bb5..000000000000 --- a/reference/ming/swfshape/setrightfill.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - SWFShape::setRightFill - Sets right rasterizing color - - - &reftitle.description; - - voidSWFShape::setRightFill - SWFGradientfill - - - voidsetRightFill - intred - intgreen - intblue - inta - - &warn.experimental.func; - - Shortcut for $swfshape->setrightfill($s->addfill($r, $g, $b [, $a]));. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFShape::setLeftFill - - - - - - - diff --git a/reference/ming/swfsound.xml b/reference/ming/swfsound.xml deleted file mode 100644 index d88a4a9a4680..000000000000 --- a/reference/ming/swfsound.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - The SWFSound class - SWFSound - - - - -
- &reftitle.intro; - - SWFSound. - -
- - -
- &reftitle.classsynopsis; - - - - SWFSound - - - - - SWFSound - - - - - &Methods; - - - - - -
- - - &reference.ming.entities.swfsound; - - - - diff --git a/reference/ming/swfsound/construct.xml b/reference/ming/swfsound/construct.xml deleted file mode 100644 index 5ee1f70e2bcf..000000000000 --- a/reference/ming/swfsound/construct.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - SWFSound::__construct - Returns a new SWFSound object from given file - - - &reftitle.description; - - SWFSound::__construct - stringfilename - intflags0 - - - &warn.undocumented.func; - - - - - - - diff --git a/reference/ming/swfsoundinstance.xml b/reference/ming/swfsoundinstance.xml deleted file mode 100644 index 4562feff4253..000000000000 --- a/reference/ming/swfsoundinstance.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - The SWFSoundInstance class - SWFSoundInstance - - - - -
- &reftitle.intro; - - SWFSoundInstance objects are returned by the - SWFSprite::startSound and - SWFMovie::startSound methods. - -
- - -
- &reftitle.classsynopsis; - - - - SWFSoundInstance - - - - - SWFSoundInstance - - - - - &Methods; - - - - - -
- - - &reference.ming.entities.swfsoundinstance; - - - - diff --git a/reference/ming/swfsoundinstance/loopcount.xml b/reference/ming/swfsoundinstance/loopcount.xml deleted file mode 100644 index e710edea0a63..000000000000 --- a/reference/ming/swfsoundinstance/loopcount.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - SWFSoundInstance::loopCount - - - - &reftitle.description; - - voidSWFSoundInstance::loopCount - intpoint - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - point - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFSoundInstance::loopOutPoint - - - - - - - diff --git a/reference/ming/swfsoundinstance/loopinpoint.xml b/reference/ming/swfsoundinstance/loopinpoint.xml deleted file mode 100644 index fcf7e2819c96..000000000000 --- a/reference/ming/swfsoundinstance/loopinpoint.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - SWFSoundInstance::loopInPoint - - - - &reftitle.description; - - voidSWFSoundInstance::loopInPoint - intpoint - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - point - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFSoundInstance::loopOutPoint - - - - - - - diff --git a/reference/ming/swfsoundinstance/loopoutpoint.xml b/reference/ming/swfsoundinstance/loopoutpoint.xml deleted file mode 100644 index 883e6a68e0ca..000000000000 --- a/reference/ming/swfsoundinstance/loopoutpoint.xml +++ /dev/null @@ -1,71 +0,0 @@ - - - - - SWFSoundInstance::loopOutPoint - - - - &reftitle.description; - - voidSWFSoundInstance::loopOutPoint - intpoint - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - point - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFSoundInstance::loopInPoint - - - - - - - diff --git a/reference/ming/swfsoundinstance/nomultiple.xml b/reference/ming/swfsoundinstance/nomultiple.xml deleted file mode 100644 index 8e85dd011aa8..000000000000 --- a/reference/ming/swfsoundinstance/nomultiple.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - SWFSoundInstance::noMultiple - - - - &reftitle.description; - - voidSWFSoundInstance::noMultiple - - - - &warn.undocumented.func; - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfsprite.xml b/reference/ming/swfsprite.xml deleted file mode 100644 index 5a4eecacd22d..000000000000 --- a/reference/ming/swfsprite.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - The SWFSprite class - SWFSprite - - - - -
- &reftitle.intro; - - An SWFSprite is also known as a "movie clip", this - allows one to create objects which are animated in their own timelines. - Hence, the sprite has most of the same methods as the movie. - -
- - -
- &reftitle.classsynopsis; - - - - SWFSprite - - - - - SWFSprite - - - - - &Methods; - - - - - -
- - - &reference.ming.entities.swfsprite; - - - - diff --git a/reference/ming/swfsprite/add.xml b/reference/ming/swfsprite/add.xml deleted file mode 100644 index 4351eadfb9d4..000000000000 --- a/reference/ming/swfsprite/add.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - SWFSprite::add - Adds an object to a sprite - - - &reftitle.description; - - voidSWFSprite::add - objectobject - - &warn.experimental.func; - - swfsprite::add adds a swfshape, a - swfbutton, a swftext, - a swfaction or a swfsprite object. - - - For displayable types (swfshape, - swfbutton, swftext, - swfaction or swfsprite), - this returns a handle to the object in a display list. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfsprite/construct.xml b/reference/ming/swfsprite/construct.xml deleted file mode 100644 index 376cc082eb45..000000000000 --- a/reference/ming/swfsprite/construct.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - SWFSprite::__construct - Creates a movie clip (a sprite) - - - &reftitle.description; - - SWFSprite::__construct - - - &warn.experimental.func; - - Creates a new SWFSprite object. - - - - - diff --git a/reference/ming/swfsprite/labelframe.xml b/reference/ming/swfsprite/labelframe.xml deleted file mode 100644 index b71fb17b3286..000000000000 --- a/reference/ming/swfsprite/labelframe.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - SWFSprite::labelFrame - Labels frame - - - &reftitle.description; - - voidSWFSprite::labelFrame - stringlabel - - - &warn.undocumented.func; - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfsprite/nextframe.xml b/reference/ming/swfsprite/nextframe.xml deleted file mode 100644 index 9f89fc0d7813..000000000000 --- a/reference/ming/swfsprite/nextframe.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - SWFSprite::nextFrame - Moves to the next frame of the animation - - - &reftitle.description; - - voidSWFSprite::nextFrame - - - &warn.experimental.func; - - swfsprite::setframes moves to the next frame of - the animation. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfsprite/remove.xml b/reference/ming/swfsprite/remove.xml deleted file mode 100644 index eecdea1464dd..000000000000 --- a/reference/ming/swfsprite/remove.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - SWFSprite::remove - Removes an object to a sprite - - - &reftitle.description; - - voidSWFSprite::remove - objectobject - - &warn.experimental.func; - - swfsprite::remove remove a swfshape, a - swfbutton, a swftext, - a swfaction or a swfsprite object - from the sprite. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfsprite/setframes.xml b/reference/ming/swfsprite/setframes.xml deleted file mode 100644 index c24a3c099590..000000000000 --- a/reference/ming/swfsprite/setframes.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - SWFSprite::setFrames - Sets the total number of frames in the animation - - - &reftitle.description; - - voidSWFSprite::setFrames - intnumber - - &warn.experimental.func; - - swfsprite::setframes sets the total number of frames - in the animation to numberofframes. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfsprite/startsound.xml b/reference/ming/swfsprite/startsound.xml deleted file mode 100644 index 734a3966d6ab..000000000000 --- a/reference/ming/swfsprite/startsound.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - SWFSprite::startSound - - - - &reftitle.description; - - SWFSoundInstanceSWFSprite::startSound - SWFSoundsount - - - &warn.undocumented.func; - - - - - - &reftitle.seealso; - - - SWFSprite::stopSound - - - - - - - diff --git a/reference/ming/swfsprite/stopsound.xml b/reference/ming/swfsprite/stopsound.xml deleted file mode 100644 index 120901b4db0b..000000000000 --- a/reference/ming/swfsprite/stopsound.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - SWFSprite::stopSound - - - - &reftitle.description; - - voidSWFSprite::stopSound - SWFSoundsount - - - &warn.undocumented.func; - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFSprite::startSound - - - - - - - diff --git a/reference/ming/swftext.xml b/reference/ming/swftext.xml deleted file mode 100644 index 693ffe4959f7..000000000000 --- a/reference/ming/swftext.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - The SWFText class - SWFText - - - - -
- &reftitle.intro; - - SWFText. - -
- - -
- &reftitle.classsynopsis; - - - - SWFText - - - - - SWFText - - - - - &Methods; - - - - - -
- - - &reference.ming.entities.swftext; - - - - diff --git a/reference/ming/swftext/addstring.xml b/reference/ming/swftext/addstring.xml deleted file mode 100644 index a7e27932529a..000000000000 --- a/reference/ming/swftext/addstring.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - SWFText::addString - Draws a string - - - &reftitle.description; - - voidSWFText::addString - stringstring - - &warn.experimental.func; - - swftext::addstring draws the string string - at the current pen (cursor) location. Pen is at the baseline of the text; - i.e., ascending text is in the -y direction. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFText::addUTF8String - - - - - - - diff --git a/reference/ming/swftext/addutf8string.xml b/reference/ming/swftext/addutf8string.xml deleted file mode 100644 index c63d3f7cb0a0..000000000000 --- a/reference/ming/swftext/addutf8string.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - SWFText::addUTF8String - Writes the given text into this SWFText object at the current pen position, - using the current font, height, spacing, and color - - - &reftitle.description; - - voidSWFText::addUTF8String - stringtext - - - &warn.undocumented.func; - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFText::addString - - - - - - - diff --git a/reference/ming/swftext/construct.xml b/reference/ming/swftext/construct.xml deleted file mode 100644 index 5b5c5353539f..000000000000 --- a/reference/ming/swftext/construct.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - SWFText::__construct - Creates a new SWFText object - - - &reftitle.description; - - SWFText::__construct - - - &warn.experimental.func; - - Creates a new SWFText object, fresh for - manipulating. - - - - - &reftitle.examples; - - This simple example will draw a big yellow "PHP generates Flash with Ming" - text, on white background. - - <function>swftext</function> example - -setFont($f); -$t->moveTo(200, 2400); -$t->setColor(0xff, 0xff, 0); -$t->setHeight(1200); -$t->addString("PHP generates Flash with Ming!!"); - -$m = new SWFMovie(); -$m->setDimension(5400, 3600); - -$m->add($t); - -header('Content-type: application/x-shockwave-flash'); -$m->output(); -?> -]]> - - - - - - - diff --git a/reference/ming/swftext/getascent.xml b/reference/ming/swftext/getascent.xml deleted file mode 100644 index 4f99f97c69a9..000000000000 --- a/reference/ming/swftext/getascent.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - SWFText::getAscent - Returns the ascent of the current font at its current size, or 0 if not available - - - &reftitle.description; - - floatSWFText::getAscent - - - - &warn.undocumented.func; - - - - - - &reftitle.seealso; - - - SWFText::getDescent - - - - - - - diff --git a/reference/ming/swftext/getdescent.xml b/reference/ming/swftext/getdescent.xml deleted file mode 100644 index 421be9ebe4cf..000000000000 --- a/reference/ming/swftext/getdescent.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - SWFText::getDescent - Returns the descent of the current font at its current size, or 0 if not available - - - &reftitle.description; - - floatSWFText::getDescent - - - - &warn.undocumented.func; - - - - - - &reftitle.seealso; - - - SWFText::getAscent - - - - - - - diff --git a/reference/ming/swftext/getleading.xml b/reference/ming/swftext/getleading.xml deleted file mode 100644 index 8db7564bee65..000000000000 --- a/reference/ming/swftext/getleading.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - SWFText::getLeading - Returns the leading of the current font at its current size, or 0 if not available - - - &reftitle.description; - - floatSWFText::getLeading - - - - &warn.undocumented.func; - - - - - - - diff --git a/reference/ming/swftext/getutf8width.xml b/reference/ming/swftext/getutf8width.xml deleted file mode 100644 index fbbda98a411a..000000000000 --- a/reference/ming/swftext/getutf8width.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - SWFText::getUTF8Width - Calculates the width of the given string in this text objects current font and size - - - &reftitle.description; - - floatSWFText::getUTF8Width - stringstring - - - &warn.undocumented.func; - - - - - - &reftitle.seealso; - - - SWFText::getWidth - - - - - - - diff --git a/reference/ming/swftext/getwidth.xml b/reference/ming/swftext/getwidth.xml deleted file mode 100644 index e61ec73e4e05..000000000000 --- a/reference/ming/swftext/getwidth.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - SWFText::getWidth - Computes string's width - - - &reftitle.description; - - floatSWFText::getWidth - stringstring - - &warn.experimental.func; - - Returns the rendered width of the string at the - text object's current font, scale, and spacing settings. - - - - - &reftitle.seealso; - - - SWFText::getUTF8Width - - - - - - - diff --git a/reference/ming/swftext/moveto.xml b/reference/ming/swftext/moveto.xml deleted file mode 100644 index 92807eb19a55..000000000000 --- a/reference/ming/swftext/moveto.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - SWFText::moveTo - Moves the pen - - - &reftitle.description; - - voidSWFText::moveTo - floatx - floaty - - &warn.experimental.func; - - swftext::moveto moves the pen (or cursor, if - that makes more sense) to (x,y) - in text object's coordinate space. If either is zero, though, value - in that dimension stays the same. Annoying, should be fixed. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swftext/setcolor.xml b/reference/ming/swftext/setcolor.xml deleted file mode 100644 index a625a53e382d..000000000000 --- a/reference/ming/swftext/setcolor.xml +++ /dev/null @@ -1,93 +0,0 @@ - - - - - SWFText::setColor - Sets the current text color - - - &reftitle.description; - - voidSWFText::setColor - intred - intgreen - intblue - inta255 - - &warn.experimental.func; - - Changes the current text color. - - - - - &reftitle.parameters; - - These parameters are integers between 0 and 255 or hexadecimals between - 0x00 and 0xFF: - - - red - - - Value of red component - - - - - green - - - Value of green component - - - - - blue - - - Value of blue component - - - - - a - - - Value of alpha component - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swftext/setfont.xml b/reference/ming/swftext/setfont.xml deleted file mode 100644 index 1ca77b685b6b..000000000000 --- a/reference/ming/swftext/setfont.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - SWFText::setFont - Sets the current font - - - &reftitle.description; - - voidSWFText::setFont - SWFFontfont - - &warn.experimental.func; - - swftext::setfont sets the current font to - font. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swftext/setheight.xml b/reference/ming/swftext/setheight.xml deleted file mode 100644 index 900f35b12e44..000000000000 --- a/reference/ming/swftext/setheight.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - SWFText::setHeight - Sets the current font height - - - &reftitle.description; - - voidSWFText::setHeight - floatheight - - &warn.experimental.func; - - swftext::setheight sets the current font height to - height. Default is 240. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swftext/setspacing.xml b/reference/ming/swftext/setspacing.xml deleted file mode 100644 index 7be8a7fda1ae..000000000000 --- a/reference/ming/swftext/setspacing.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - SWFText::setSpacing - Sets the current font spacing - - - &reftitle.description; - - voidSWFText::setSpacing - floatspacing - - &warn.experimental.func; - - swftext::setspacing sets the current font spacing to - spacing. Default is 1.0. - 0 is all of the letters written at the same point. This doesn't really work - that well because it inflates the advance across the letter, doesn't add - the same amount of spacing between the letters. I should try and explain - that better, prolly. Or just fix the damn thing to do constant spacing. - This was really just a way to figure out how letter advances work, - anyway.. So nyah. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swftextfield.xml b/reference/ming/swftextfield.xml deleted file mode 100644 index 7bd2b4149ab3..000000000000 --- a/reference/ming/swftextfield.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - The SWFTextField class - SWFTextField - - - - -
- &reftitle.intro; - - SWFTextField. - -
- - -
- &reftitle.classsynopsis; - - - - SWFTextField - - - - - SWFTextField - - - - - &Methods; - - - - - -
- - - &reference.ming.entities.swftextfield; - - - diff --git a/reference/ming/swftextfield/addchars.xml b/reference/ming/swftextfield/addchars.xml deleted file mode 100644 index 18a1a727749e..000000000000 --- a/reference/ming/swftextfield/addchars.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - SWFTextField::addChars - Adds characters to a font that will be available within a textfield - - - &reftitle.description; - - voidSWFTextField::addChars - stringchars - - - &warn.undocumented.func; - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - SWFTextField::addString - - - - - - - diff --git a/reference/ming/swftextfield/addstring.xml b/reference/ming/swftextfield/addstring.xml deleted file mode 100644 index 0d1e4786a622..000000000000 --- a/reference/ming/swftextfield/addstring.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - SWFTextField::addString - Concatenates the given string to the text field - - - &reftitle.description; - - voidSWFTextField::addString - stringstring - - &warn.experimental.func; - - swftextfield::setname concatenates the string - string to the text field. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swftextfield/align.xml b/reference/ming/swftextfield/align.xml deleted file mode 100644 index 314a3fe6e940..000000000000 --- a/reference/ming/swftextfield/align.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - SWFTextField::align - Sets the text field alignment - - - &reftitle.description; - - voidSWFTextField::align - intalignement - - &warn.experimental.func; - - swftextfield::align sets the text field alignment - to alignement. Valid values for - alignement are : SWFTEXTFIELD_ALIGN_LEFT, - SWFTEXTFIELD_ALIGN_RIGHT, SWFTEXTFIELD_ALIGN_CENTER and - SWFTEXTFIELD_ALIGN_JUSTIFY. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swftextfield/construct.xml b/reference/ming/swftextfield/construct.xml deleted file mode 100644 index ced41c6e326b..000000000000 --- a/reference/ming/swftextfield/construct.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - SWFTextField::__construct - Creates a text field object - - - &reftitle.description; - - SWFTextField::__construct - intflags - - &warn.experimental.func; - - swftextfield creates a new text field object. - Text Fields are less flexible than swftext objects- - they can't be rotated, scaled non-proportionally, or skewed, but they can - be used as form entries, and they can use browser-defined fonts. - - - The optional flags change the text field's behavior. It has the following - possibles values : - - - - SWFTEXTFIELD_DRAWBOX draws the outline of the textfield - - - - - SWFTEXTFIELD_HASLENGTH - - - - - SWFTEXTFIELD_HTML allows text markup using HTML-tags - - - - - SWFTEXTFIELD_MULTILINE allows multiple lines - - - - - SWFTEXTFIELD_NOEDIT indicates that the field shouldn't be user-editable - - - - - SWFTEXTFIELD_NOSELECT makes the field non-selectable - - - - - SWFTEXTFIELD_PASSWORD obscures the data entry - - - - - SWFTEXTFIELD_WORDWRAP allows text to wrap - - - - Flags are combined with the bitwise - OR operation. For example, - - -]]> - - creates a totally useless non-editable password field. - - - SWFTextField has the following methods : swftextfield::setfont, - swftextfield::setbounds, swftextfield::align, - swftextfield::setheight, swftextfield::setleftmargin, - swftextfield::setrightmargin, swftextfield::setmargins, - swftextfield::setindentation, swftextfield::setlinespacing, - swftextfield::setcolor, swftextfield::setname and - swftextfield::addstring. - - - - - diff --git a/reference/ming/swftextfield/setbounds.xml b/reference/ming/swftextfield/setbounds.xml deleted file mode 100644 index 49f7cd7dba4b..000000000000 --- a/reference/ming/swftextfield/setbounds.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - SWFTextField::setBounds - Sets the text field width and height - - - &reftitle.description; - - voidSWFTextField::setBounds - floatwidth - floatheight - - &warn.experimental.func; - - swftextfield::setbounds sets the text field width - to width and height to height. - If you don't set the bounds yourself, Ming makes a poor guess at what - the bounds are. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swftextfield/setcolor.xml b/reference/ming/swftextfield/setcolor.xml deleted file mode 100644 index 1c1cdfe0b305..000000000000 --- a/reference/ming/swftextfield/setcolor.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - SWFTextField::setColor - Sets the color of the text field - - - &reftitle.description; - - voidSWFTextField::setColor - intred - intgreen - intblue - inta255 - - &warn.experimental.func; - - swftextfield::setcolor sets the color of the text field. - Default is fully opaque black. Color is represented using RGB system. - - - - - &reftitle.parameters; - - These parameters are integers between 0 and 255 or hexadecimals between - 0x00 and 0xFF: - - - red - - - Value of red component - - - - - green - - - Value of green component - - - - - blue - - - Value of blue component - - - - - a - - - Value of alpha component - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swftextfield/setfont.xml b/reference/ming/swftextfield/setfont.xml deleted file mode 100644 index 7cf1ca958e71..000000000000 --- a/reference/ming/swftextfield/setfont.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - SWFTextField::setFont - Sets the text field font - - - &reftitle.description; - - voidSWFTextField::setFont - SWFFontfont - - &warn.experimental.func; - - swftextfield::setfont sets the text field font to - the [browser-defined?] font font. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swftextfield/setheight.xml b/reference/ming/swftextfield/setheight.xml deleted file mode 100644 index ca9f3bf7f98c..000000000000 --- a/reference/ming/swftextfield/setheight.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - SWFTextField::setHeight - Sets the font height of this text field font - - - &reftitle.description; - - voidSWFTextField::setHeight - floatheight - - &warn.experimental.func; - - swftextfield::setheight sets the font height of this text field - font to the given height height. Default is 240. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swftextfield/setindentation.xml b/reference/ming/swftextfield/setindentation.xml deleted file mode 100644 index 58c337366dda..000000000000 --- a/reference/ming/swftextfield/setindentation.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - SWFTextField::setIndentation - Sets the indentation of the first line - - - &reftitle.description; - - voidSWFTextField::setIndentation - floatwidth - - &warn.experimental.func; - - swftextfield::setindentation sets the indentation of - the first line in the text field, to width. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swftextfield/setleftmargin.xml b/reference/ming/swftextfield/setleftmargin.xml deleted file mode 100644 index dda5612260a9..000000000000 --- a/reference/ming/swftextfield/setleftmargin.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - SWFTextField::setLeftMargin - Sets the left margin width of the text field - - - &reftitle.description; - - voidSWFTextField::setLeftMargin - floatwidth - - &warn.experimental.func; - - swftextfield::setleftmargin sets the left margin width - of the text field to width. Default is 0. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swftextfield/setlinespacing.xml b/reference/ming/swftextfield/setlinespacing.xml deleted file mode 100644 index bb113225316a..000000000000 --- a/reference/ming/swftextfield/setlinespacing.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - SWFTextField::setLineSpacing - Sets the line spacing of the text field - - - &reftitle.description; - - voidSWFTextField::setLineSpacing - floatheight - - &warn.experimental.func; - - swftextfield::setlinespacing sets the line spacing - of the text field to the height of height. Default is 40. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swftextfield/setmargins.xml b/reference/ming/swftextfield/setmargins.xml deleted file mode 100644 index 75fcc0e470a7..000000000000 --- a/reference/ming/swftextfield/setmargins.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - SWFTextField::setMargins - Sets the margins width of the text field - - - &reftitle.description; - - voidSWFTextField::setMargins - floatleft - floatright - - &warn.experimental.func; - - swftextfield::setmargins set both margins at once, - for the man on the go. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swftextfield/setname.xml b/reference/ming/swftextfield/setname.xml deleted file mode 100644 index 54592fe31956..000000000000 --- a/reference/ming/swftextfield/setname.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - SWFTextField::setName - Sets the variable name - - - &reftitle.description; - - voidSWFTextField::setName - stringname - - &warn.experimental.func; - - swftextfield::setname sets the variable name of this - text field to name, for form posting and action - scripting purposes. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swftextfield/setpadding.xml b/reference/ming/swftextfield/setpadding.xml deleted file mode 100644 index e6fc7e7db6c2..000000000000 --- a/reference/ming/swftextfield/setpadding.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - SWFTextField::setPadding - Sets the padding of this textfield - - - &reftitle.description; - - voidSWFTextField::setPadding - floatpadding - - - &warn.undocumented.func; - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swftextfield/setrightmargin.xml b/reference/ming/swftextfield/setrightmargin.xml deleted file mode 100644 index 489a32fde0ad..000000000000 --- a/reference/ming/swftextfield/setrightmargin.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - SWFTextField::setRightMargin - Sets the right margin width of the text field - - - &reftitle.description; - - voidSWFTextField::setRightMargin - floatwidth - - &warn.experimental.func; - - swftextfield::setrightmargin sets the right margin width - of the text field to width. Default is 0. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/swfvideostream.xml b/reference/ming/swfvideostream.xml deleted file mode 100644 index 9ac1a424c878..000000000000 --- a/reference/ming/swfvideostream.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - The SWFVideoStream class - SWFVideoStream - - - - -
- &reftitle.intro; - - SWFVideoStream. - -
- - -
- &reftitle.classsynopsis; - - - - SWFVideoStream - - - - - SWFVideoStream - - - - - &Methods; - - - - - -
- - - &reference.ming.entities.swfvideostream; - - - - diff --git a/reference/ming/swfvideostream/construct.xml b/reference/ming/swfvideostream/construct.xml deleted file mode 100644 index 454b6beae0f2..000000000000 --- a/reference/ming/swfvideostream/construct.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - SWFVideoStream::__construct - Returns a SWFVideoStream object - - - &reftitle.description; - - SWFVideoStream::__construct - stringfile - - - &warn.undocumented.func; - - - - - - - diff --git a/reference/ming/swfvideostream/getnumframes.xml b/reference/ming/swfvideostream/getnumframes.xml deleted file mode 100644 index 25ab1083248a..000000000000 --- a/reference/ming/swfvideostream/getnumframes.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - SWFVideoStream::getNumFrames - Returns the number of frames in the video - - - &reftitle.description; - - intSWFVideoStream::getNumFrames - - - - This function returns the number of video-frames of a SWFVideoStream. - - - - - &reftitle.returnvalues; - - Returns the number of frames, as an integer - - - - - - diff --git a/reference/ming/swfvideostream/setdimension.xml b/reference/ming/swfvideostream/setdimension.xml deleted file mode 100644 index 59052442e9eb..000000000000 --- a/reference/ming/swfvideostream/setdimension.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - SWFVideoStream::setDimension - Sets video dimension - - - &reftitle.description; - - voidSWFVideoStream::setDimension - intx - inty - - - Sets the width and height for streamed videos. - - - - - &reftitle.parameters; - - - - x - - - Width in pixels. - - - - - y - - - Height in pixels. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/ming/versions.xml b/reference/ming/versions.xml deleted file mode 100644 index 5f27649e785d..000000000000 --- a/reference/ming/versions.xml +++ /dev/null @@ -1,219 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/misc/functions/php-check-syntax.xml b/reference/misc/functions/php-check-syntax.xml deleted file mode 100644 index 5b2f0a166ddb..000000000000 --- a/reference/misc/functions/php-check-syntax.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - - php_check_syntax - - Check the PHP syntax of (and execute) the specified file - - - - &reftitle.description; - - boolphp_check_syntax - stringfilename - stringerror_message - - - Performs a syntax (lint) check on the specified - filename testing for scripting errors. - - - This is similar to using php -l from the commandline except that this - function will execute (but not output) the checked - filename. - - - For example, if a function is defined in filename, - this defined function will be available to the file that executed - php_check_syntax, but output from - filename will be suppressed. - - - - - For technical reasons, this function is deprecated and removed from PHP. - Instead, use php -l somefile.php from the - commandline. - - - - - - &reftitle.parameters; - - - - filename - - - The name of the file being checked. - - - - - error_message - - - If the error_message parameter is used, it will - contain the error message generated by the syntax check. - error_message is passed by - reference. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; if the lint check passed, and &false; if the link check - failed or if filename cannot be opened. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.0.5 - - This function was removed from PHP. - - - - 5.0.3 - - Calling exit after - php_check_syntax resulted in a Segfault. - - - - 5.0.1 - - error_message is passed by reference. - - - - - - - - - - &reftitle.examples; - - - - - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - include - is_readable - - - - - - - diff --git a/reference/misc/functions/sleep.xml b/reference/misc/functions/sleep.xml index 0be8bab044fa..a569d196b675 100644 --- a/reference/misc/functions/sleep.xml +++ b/reference/misc/functions/sleep.xml @@ -57,32 +57,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.4 - - Before PHP 5.3.4, on Windows, sleep always - returns &null; when sleep has occurred, regardless of whether the - sleep was interrupted or not. - - - - - - - - &reftitle.examples; diff --git a/reference/misc/functions/time-nanosleep.xml b/reference/misc/functions/time-nanosleep.xml index d29f63ff3d58..a214a4dc3d67 100644 --- a/reference/misc/functions/time-nanosleep.xml +++ b/reference/misc/functions/time-nanosleep.xml @@ -73,30 +73,6 @@ - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function is now available on Windows platforms. - - - - - - - &reftitle.examples; diff --git a/reference/misc/functions/time-sleep-until.xml b/reference/misc/functions/time-sleep-until.xml index 72caf4e11679..4ef02edd80cf 100644 --- a/reference/misc/functions/time-sleep-until.xml +++ b/reference/misc/functions/time-sleep-until.xml @@ -42,30 +42,6 @@ &return.success; - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function is now available on Windows platforms. - - - - - - - &reftitle.errors; diff --git a/reference/misc/versions.xml b/reference/misc/versions.xml index 17deb25f70b1..073115567207 100644 --- a/reference/misc/versions.xml +++ b/reference/misc/versions.xml @@ -19,7 +19,6 @@ - diff --git a/reference/mnogosearch/book.xml b/reference/mnogosearch/book.xml deleted file mode 100644 index 497c611940be..000000000000 --- a/reference/mnogosearch/book.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - mnoGoSearch - - - - &reftitle.intro; - - These functions allow you to access the mnoGoSearch (former - UdmSearch) free search engine. mnoGoSearch is a full-featured search - engine software for intranet and internet servers, distributed under the - GNU license. mnoGoSearch has a number of unique features, which makes it - appropriate for a wide range of applications from search within your - site to a specialized search system such as cooking recipes or newspaper - search, FTP archive search, news articles search, etc. It offers - full-text indexing and searching for HTML, PDF, and text documents. - mnoGoSearch consists of two parts. The first is an indexing mechanism - (indexer). The purpose of the indexer is to walk through HTTP, FTP, NEWS - servers or local files, recursively grabbing all the documents and - storing meta-data about that documents in an SQL database in a smart and - effective manner. After every document is referenced by its - corresponding URL, meta-data is collected by the indexer for later use - in a search process. The search is performed via Web interface. C, CGI, - PHP and Perl search front ends are included. - - - More information about mnoGoSearch can be found at - &url.mnogo;. - - - - &pecl.moved-ver;5.1.0. - - - ¬e.no-windows.extension; - - - - &reference.mnogosearch.setup; - &reference.mnogosearch.constants; - &reference.mnogosearch.reference; - - - - - diff --git a/reference/mnogosearch/configure.xml b/reference/mnogosearch/configure.xml deleted file mode 100644 index f1ff55c05d97..000000000000 --- a/reference/mnogosearch/configure.xml +++ /dev/null @@ -1,48 +0,0 @@ - - -
- &reftitle.install; - - &pecl.info; - &url.pecl.package;mnogosearch. - - - &pecl.moved-ver;5.1.0 - - - &pecl.windows.download; - - - - PHP contains built-in MySQL access library, which can be used to - access MySQL. It is known that mnoGoSearch is not compatible with - this built-in library and can work only with generic MySQL - libraries. Thus, if you use mnoGoSearch with MySQL, during PHP - configuration you have to indicate the directory of your MySQL - installation, that was used during mnoGoSearch configuration, i.e. for - example: - . - - -
- - diff --git a/reference/mnogosearch/constants.xml b/reference/mnogosearch/constants.xml deleted file mode 100644 index e33297c4536e..000000000000 --- a/reference/mnogosearch/constants.xml +++ /dev/null @@ -1,1052 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - UDM_FIELD_URLID - (integer) - - - - - - - - - - UDM_FIELD_URL - (integer) - - - - - - - - - - UDM_FIELD_CONTENT - (integer) - - - - - - - - - - UDM_FIELD_TITLE - (integer) - - - - - - - - - - UDM_FIELD_KEYWORDS - (integer) - - - - - - - - - - UDM_FIELD_DESC - (integer) - - - - - - - - - - UDM_FIELD_DESCRIPTION - (integer) - - - - - - - - - - UDM_FIELD_TEXT - (integer) - - - - - - - - - - UDM_FIELD_SIZE - (integer) - - - - - - - - - - UDM_FIELD_RATING - (integer) - - - - - - - - - - UDM_FIELD_SCORE - (integer) - - - - - - - - - - UDM_FIELD_MODIFIED - (integer) - - - - - - - - - - UDM_FIELD_ORDER - (integer) - - - - - - - - - - UDM_FIELD_CRC - (integer) - - - - - - - - - - UDM_FIELD_CATEGORY - (integer) - - - - - - - - - - UDM_FIELD_LANG - (integer) - - - - - - - - - - UDM_FIELD_CHARSET - (integer) - - - - - - - - - - UDM_PARAM_PAGE_SIZE - (integer) - - - - - - - - - - UDM_PARAM_PAGE_NUM - (integer) - - - - - - - - - - UDM_PARAM_SEARCH_MODE - (integer) - - - - - - - - - - UDM_PARAM_CACHE_MODE - (integer) - - - - - - - - - - UDM_PARAM_TRACK_MODE - (integer) - - - - - - - - - - UDM_PARAM_PHRASE_MODE - (integer) - - - - - - - - - - UDM_PARAM_CHARSET - (integer) - - - - - - - - - - UDM_PARAM_LOCAL_CHARSET - (integer) - - - - - - - - - - UDM_PARAM_BROWSER_CHARSET - (integer) - - - - - - - - - - UDM_PARAM_STOPTABLE - (integer) - - - - - - - - - - UDM_PARAM_STOP_TABLE - (integer) - - - - - - - - - - UDM_PARAM_STOPFILE - (integer) - - - - - - - - - - UDM_PARAM_STOP_FILE - (integer) - - - - - - - - - - UDM_PARAM_WEIGHT_FACTOR - (integer) - - - - - - - - - - UDM_PARAM_WORD_MATCH - (integer) - - - - - - - - - - UDM_PARAM_MAX_WORD_LEN - (integer) - - - - - - - - - - UDM_PARAM_MAX_WORDLEN - (integer) - - - - - - - - - - UDM_PARAM_MIN_WORD_LEN - (integer) - - - - - - - - - - UDM_PARAM_MIN_WORDLEN - (integer) - - - - - - - - - - UDM_PARAM_ISPELL_PREFIXES - (integer) - - - - - - - - - - UDM_PARAM_ISPELL_PREFIX - (integer) - - - - - - - - - - UDM_PARAM_PREFIXES - (integer) - - - - - - - - - - UDM_PARAM_PREFIX - (integer) - - - - - - - - - - UDM_PARAM_CROSS_WORDS - (integer) - - - - - - - - - - UDM_PARAM_CROSSWORDS - (integer) - - - - - - - - - - UDM_PARAM_VARDIR - (integer) - - - - - - - - - - UDM_PARAM_DATADIR - (integer) - - - - - - - - - - UDM_PARAM_HLBEG - (integer) - - - - - - - - - - UDM_PARAM_HLEND - (integer) - - - - - - - - - - UDM_PARAM_SYNONYM - (integer) - - - - - - - - - - UDM_PARAM_SEARCHD - (integer) - - - - - - - - - - UDM_PARAM_QSTRING - (integer) - - - - - - - - - - UDM_PARAM_REMOTE_ADDR - (integer) - - - - - - - - - - UDM_LIMIT_CAT - (integer) - - - - - - - - - - UDM_LIMIT_URL - (integer) - - - - - - - - - - UDM_LIMIT_TAG - (integer) - - - - - - - - - - UDM_LIMIT_LANG - (integer) - - - - - - - - - - UDM_LIMIT_DATE - (integer) - - - - - - - - - - UDM_PARAM_FOUND - (integer) - - - - - - - - - - UDM_PARAM_NUM_ROWS - (integer) - - - - - - - - - - UDM_PARAM_WORDINFO - (integer) - - - - - - - - - - UDM_PARAM_WORD_INFO - (integer) - - - - - - - - - - UDM_PARAM_SEARCHTIME - (integer) - - - - - - - - - - UDM_PARAM_SEARCH_TIME - (integer) - - - - - - - - - - UDM_PARAM_FIRST_DOC - (integer) - - - - - - - - - - UDM_PARAM_LAST_DOC - (integer) - - - - - - - - - - UDM_MODE_ALL - (integer) - - - - - - - - - - UDM_MODE_ANY - (integer) - - - - - - - - - - UDM_MODE_BOOL - (integer) - - - - - - - - - - UDM_MODE_PHRASE - (integer) - - - - - - - - - - UDM_CACHE_ENABLED - (integer) - - - - - - - - - - UDM_CACHE_DISABLED - (integer) - - - - - - - - - - UDM_TRACK_ENABLED - (integer) - - - - - - - - - - UDM_TRACK_DISABLED - (integer) - - - - - - - - - - UDM_PHRASE_ENABLED - (integer) - - - - - - - - - - UDM_PHRASE_DISABLED - (integer) - - - - - - - - - - UDM_CROSS_WORDS_ENABLED - (integer) - - - - - - - - - - UDM_CROSSWORDS_ENABLED - (integer) - - - - - - - - - - UDM_CROSS_WORDS_DISABLED - (integer) - - - - - - - - - - UDM_CROSSWORDS_DISABLED - (integer) - - - - - - - - - - UDM_PREFIXES_ENABLED - (integer) - - - - - - - - - - UDM_PREFIX_ENABLED - (integer) - - - - - - - - - - UDM_ISPELL_PREFIXES_ENABLED - (integer) - - - - - - - - - - UDM_ISPELL_PREFIX_ENABLED - (integer) - - - - - - - - - - UDM_PREFIXES_DISABLED - (integer) - - - - - - - - - - UDM_PREFIX_DISABLED - (integer) - - - - - - - - - - UDM_ISPELL_PREFIXES_DISABLED - (integer) - - - - - - - - - - UDM_ISPELL_PREFIX_DISABLED - (integer) - - - - - - - - - - UDM_ISPELL_TYPE_AFFIX - (integer) - - - - - - - - - - UDM_ISPELL_TYPE_SPELL - (integer) - - - - - - - - - - UDM_ISPELL_TYPE_DB - (integer) - - - - - - - - - - UDM_ISPELL_TYPE_SERVER - (integer) - - - - - - - - - - UDM_MATCH_WORD - (integer) - - - - - - - - - - UDM_MATCH_BEGIN - (integer) - - - - - - - - - - UDM_MATCH_SUBSTR - (integer) - - - - - - - - - - UDM_MATCH_END - (integer) - - - - - - - - - - - diff --git a/reference/mnogosearch/functions/udm-add-search-limit.xml b/reference/mnogosearch/functions/udm-add-search-limit.xml deleted file mode 100644 index 6e752a2ee66f..000000000000 --- a/reference/mnogosearch/functions/udm-add-search-limit.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - udm_add_search_limit - Add various search limits - - - - &reftitle.description; - - booludm_add_search_limit - resourceagent - intvar - stringval - - - udm_add_search_limit adds search restrictions. - - - - - &reftitle.parameters; - - - - agent - - - A link to Agent, received after call to - udm_alloc_agent. - - - - - var - - - Defines the parameter, indicating limits. - Possible var values: - - - - UDM_LIMIT_URL - defines document URL limitations to limit the search - through subsection of the database. It supports SQL % and _ LIKE wildcards, - where % matches any number of characters, even zero characters, - and _ matches exactly one character. E.g. http://www.example.___/catalog - may stand for http://www.example.com/catalog and http://www.example.net/catalog. - - - - - UDM_LIMIT_TAG - defines site TAG limitations. In indexer-conf you can - assign specific TAGs to various sites and parts of a site. Tags in - mnoGoSearch 3.1.x are lines, that may contain metasymbols % and _. - Metasymbols allow searching among groups of tags. - E.g. there are links with tags ABCD and ABCE, and search restriction - is by ABC_ - the search will be made among both of the tags. - - - - - UDM_LIMIT_LANG - defines document language limitations. - - - - - UDM_LIMIT_CAT - defines document category limitations. Categories are - similar to tag feature, but nested. So you can have one category inside - another and so on. You have to use two characters for each level. Use a - hex number going from 0-F or a 36 base number going from 0-Z. - Therefore a top-level category like 'Auto' would be 01. If it has a - subcategory like 'Ford', then it would be 01 (the parent category) and then - 'Ford' which we will give 01. Put those together and you get 0101. If 'Auto' - had another subcategory named 'VW', then it's id would be 01 because it - belongs to the 'Ford' category and then 02 because it's the next category. - So it's id would be 0102. If VW had a sub category called 'Engine' then it's - id would start at 01 again and it would get the 'VW' id 02 and 'Auto' id of - 01, making it 010201. If you want to search for sites under that category - then you pass it cat=010201 in the URL. - - - - - UDM_LIMIT_DATE - defines limitation by date the document was modified. - - - Format of parameter value: a string with first character < or >, - then with no space - date in unixtime format, for example: - - - - - <programlisting role="php"> -<![CDATA[ -<?php -udm_add_search_limit($udm, UDM_LIMIT_DATE, "<908012006"); -?> -]]> - </programlisting> - </example> - </para> - <para> - If > character is used, then the search will be restricted to those - documents having a modification date greater than entered, if <, then smaller. - </para> - </listitem> - </itemizedlist> - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>val</parameter></term> - <listitem> - <para> - Defines the value of the current parameter. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - &return.success; - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/mnogosearch/functions/udm-alloc-agent-array.xml b/reference/mnogosearch/functions/udm-alloc-agent-array.xml deleted file mode 100644 index 41f481671332..000000000000 --- a/reference/mnogosearch/functions/udm-alloc-agent-array.xml +++ /dev/null @@ -1,76 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.udm-alloc-agent-array"> - <refnamediv> - <refname>udm_alloc_agent_array</refname> - <refpurpose>Allocate mnoGoSearch session</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>resource</type><methodname>udm_alloc_agent_array</methodname> - <methodparam><type>array</type><parameter>databases</parameter></methodparam> - </methodsynopsis> - <para> - <function>udm_alloc_agent_array</function> will create an agent - with multiple database connections. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>databases</parameter></term> - <listitem> - <para> - The array <parameter>databases</parameter> must contain one database - URL per element, analog to the first parameter of - <function>udm_alloc_agent</function>. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns a resource link identifier on success&return.falseforfailure;. - </para> - </refsect1> - - <refsect1 role="seealso"> - &reftitle.seealso; - <para> - <simplelist> - <member><function>udm_alloc_agent</function></member> - </simplelist> - </para> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/mnogosearch/functions/udm-alloc-agent.xml b/reference/mnogosearch/functions/udm-alloc-agent.xml deleted file mode 100644 index 2d2c8230a3fe..000000000000 --- a/reference/mnogosearch/functions/udm-alloc-agent.xml +++ /dev/null @@ -1,112 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.udm-alloc-agent"> - <refnamediv> - <refname>udm_alloc_agent</refname> - <refpurpose>Allocate mnoGoSearch session</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>resource</type><methodname>udm_alloc_agent</methodname> - <methodparam><type>string</type><parameter>dbaddr</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>dbmode</parameter></methodparam> - </methodsynopsis> - <para> - Allocate a mnoGoSearch session. - </para> - </refsect1> - - <refsect1 role="parameters"> - &reftitle.parameters; - <para> - <variablelist> - <varlistentry> - <term><parameter>dbaddr</parameter></term> - <listitem> - <para> - <parameter>dbaddr</parameter> - URL-style database description, with - options (type, host, database name, port, user and password) to connect - to SQL database. Do not matter for built-in text files support. Format for - <parameter>dbaddr</parameter>: - <literal>DBType:[//[DBUser[:DBPass]@]DBHost[:DBPort]]/DBName/</literal>. - Currently supported DBType values are: mysql, pgsql, msql, solid, mssql, oracle, - and ibase. Actually, it does not matter for native libraries support, but - ODBC users should specify one of the supported values. If your database - type is not supported, you may use <literal>unknown</literal> instead. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><parameter>dbmode</parameter></term> - <listitem> - <para> - <parameter>dbmode</parameter> - You may select the SQL database mode of - words storage. Possible values of <parameter>dbmode</parameter> are: - <literal>single</literal>, <literal>multi</literal>, <literal>crc</literal>, - or <literal>crc-multi</literal>. When <literal>single</literal> is - specified, all words are stored in the same table. If <literal>multi - </literal> is selected, words will be located in different tables depending - of their lengths. "multi" mode is usually faster, but requires more tables - in the database. If "crc" mode is selected, mnoGoSearch will store 32 bit - integer word IDs calculated by CRC32 algorithm instead of words. This mode - requires less disk space and it is faster comparing with "single" and - "multi" modes. <literal>crc-multi</literal> uses the same storage structure - with the "crc" mode, but also stores words in different tables depending on - words lengths like in "multi" mode. - </para> - </listitem> - </varlistentry> - </variablelist> - </para> - <note> - <para> - <parameter>dbaddr</parameter> and <parameter>dbmode</parameter> must match - those used during indexing. - </para> - </note> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - Returns a mnogosearch agent identifier on success, &false; on failure. This - function creates a session with database parameters. - </para> - </refsect1> - - <refsect1 role="notes"> - &reftitle.notes; - <note> - <para> - In fact this function does not open a connection to the database and - thus does not check the entered login and password. Establishing a - connection to the database and login/password verification is done by - <function>udm_find</function>. - </para> - </note> - </refsect1> - -</refentry> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -indent-tabs-mode:nil -sgml-parent-document:nil -sgml-default-dtd-file:"~/.phpdoc/manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: -vim600: syn=xml fen fdm=syntax fdl=2 si -vim: et tw=78 syn=sgml -vi: ts=1 sw=1 ---> diff --git a/reference/mnogosearch/functions/udm-api-version.xml b/reference/mnogosearch/functions/udm-api-version.xml deleted file mode 100644 index 56a391491f58..000000000000 --- a/reference/mnogosearch/functions/udm-api-version.xml +++ /dev/null @@ -1,73 +0,0 @@ -<?xml version="1.0" encoding="utf-8"?> -<!-- $Revision$ --> -<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.udm-api-version"> - <refnamediv> - <refname>udm_api_version</refname> - <refpurpose>Get mnoGoSearch API version</refpurpose> - </refnamediv> - - <refsect1 role="description"> - &reftitle.description; - <methodsynopsis> - <type>int</type><methodname>udm_api_version</methodname> - <void/> - </methodsynopsis> - <para> - Gets the mnoGoSearch API version. - </para> - <para> - This function allows the user to identify which API functions are - available, e.g. <function>udm_get_doc_count</function> function is only - available in mnoGoSearch 3.1.11 or later. - </para> - </refsect1> - - <refsect1 role="returnvalues"> - &reftitle.returnvalues; - <para> - <function>udm_api_version</function> returns the mnoGoSearch API version - number. E.g. if mnoGoSearch 3.1.10 API is used, this function will return - <literal>30110</literal>. - </para> - </refsect1> - - <refsect1 role="examples"> - &reftitle.examples; - <para> - <example> - <title><function>udm_api_version</function> example - -= 30111) { - echo "Total number of URLs in database: " . udm_get_doc_count($udm) . "
\n"; -} -?> -]]> - - - - - - - - diff --git a/reference/mnogosearch/functions/udm-cat-list.xml b/reference/mnogosearch/functions/udm-cat-list.xml deleted file mode 100644 index b384e7b4e168..000000000000 --- a/reference/mnogosearch/functions/udm-cat-list.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - udm_cat_list - Get all the categories on the same level with the current one - - - - &reftitle.description; - - arrayudm_cat_list - resourceagent - stringcategory - - - Gets all the categories on the same level with the current one. - - - The function can be useful for developing categories tree browser. - - - - - &reftitle.parameters; - - - - agent - - - A link to Agent, received after call to - udm_alloc_agent. - - - - - category - - - - - - - - - - - &reftitle.returnvalues; - - 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. - - - - - - - - &reftitle.examples; - - Following is an example of displaying links of the current level in format: - - - - - <function>udm_cat_list</function>example - -$name
"; - } -?> -]]> - - - - - - - &reftitle.seealso; - - - udm_cat_path - - - - - - - diff --git a/reference/mnogosearch/functions/udm-cat-path.xml b/reference/mnogosearch/functions/udm-cat-path.xml deleted file mode 100644 index 5c1ce1733fd5..000000000000 --- a/reference/mnogosearch/functions/udm-cat-path.xml +++ /dev/null @@ -1,126 +0,0 @@ - - - - - udm_cat_path - Get the path to the current category - - - - &reftitle.description; - - arrayudm_cat_path - resourceagent - stringcategory - - - Returns an array describing the path in the categories tree from the tree - root to the current one, specified by category. - - - - - &reftitle.parameters; - - - - agent - - - A link to Agent, received after call to - udm_alloc_agent. - - - - - category - - - - - - - - - - - &reftitle.returnvalues; - - 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: - - - - - - - - &reftitle.examples; - - - - Specifying path to the current category in the following format: - '> Root > Sport > Auto > Ferrari' - - - $name "; - } -?> -]]> - - - - - - - &reftitle.seealso; - - - udm_cat_list - - - - - - - diff --git a/reference/mnogosearch/functions/udm-check-charset.xml b/reference/mnogosearch/functions/udm-check-charset.xml deleted file mode 100644 index 802150b1fde0..000000000000 --- a/reference/mnogosearch/functions/udm-check-charset.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - udm_check_charset - Check if the given charset is known to mnogosearch - - - - &reftitle.description; - - booludm_check_charset - resourceagent - stringcharset - - - &warn.undocumented.func; - - - - - - diff --git a/reference/mnogosearch/functions/udm-clear-search-limits.xml b/reference/mnogosearch/functions/udm-clear-search-limits.xml deleted file mode 100644 index a4a86597d3b4..000000000000 --- a/reference/mnogosearch/functions/udm-clear-search-limits.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - udm_clear_search_limits - Clear all mnoGoSearch search restrictions - - - - &reftitle.description; - - booludm_clear_search_limits - resourceagent - - - udm_clear_search_limits resets defined search - limitations. - - - - - &reftitle.parameters; - - - - agent - - - A link to Agent, received after call to - udm_alloc_agent. - - - - - - - - - &reftitle.returnvalues; - - Returns &true;. - - - - - &reftitle.seealso; - - - udm_add_search_limit - - - - - - - diff --git a/reference/mnogosearch/functions/udm-crc32.xml b/reference/mnogosearch/functions/udm-crc32.xml deleted file mode 100644 index 80f988244164..000000000000 --- a/reference/mnogosearch/functions/udm-crc32.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - udm_crc32 - Return CRC32 checksum of given string - - - - &reftitle.description; - - intudm_crc32 - resourceagent - stringstr - - - &warn.undocumented.func; - - - - - - diff --git a/reference/mnogosearch/functions/udm-errno.xml b/reference/mnogosearch/functions/udm-errno.xml deleted file mode 100644 index f71fb2ae1e34..000000000000 --- a/reference/mnogosearch/functions/udm-errno.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - udm_errno - Get mnoGoSearch error number - - - - &reftitle.description; - - intudm_errno - resourceagent - - - Receiving numeric agent error code. - - - - - &reftitle.parameters; - - - - agent - - - A link to Agent, received after call to - udm_alloc_agent. - - - - - - - - - &reftitle.returnvalues; - - Returns the mnoGoSearch error number, zero if no error. - - - - - - diff --git a/reference/mnogosearch/functions/udm-error.xml b/reference/mnogosearch/functions/udm-error.xml deleted file mode 100644 index 55e82229be01..000000000000 --- a/reference/mnogosearch/functions/udm-error.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - udm_error - Get mnoGoSearch error message - - - - &reftitle.description; - - stringudm_error - resourceagent - - - Gets the agent error message. - - - - - &reftitle.parameters; - - - - agent - - - A link to Agent, received after call to - udm_alloc_agent. - - - - - - - - - &reftitle.returnvalues; - - udm_error returns mnoGoSearch error message, - empty string if no error. - - - - - - diff --git a/reference/mnogosearch/functions/udm-find.xml b/reference/mnogosearch/functions/udm-find.xml deleted file mode 100644 index 9df6550df454..000000000000 --- a/reference/mnogosearch/functions/udm-find.xml +++ /dev/null @@ -1,112 +0,0 @@ - - - - - udm_find - Perform search - - - - &reftitle.description; - - resourceudm_find - resourceagent - stringquery - - - Performs a search. - - - The search itself. The first argument - session, the next one - - query itself. To find something just type words you want to find - and press SUBMIT button. For example, "mysql odbc". You should - not use quotes " in query, they are written here only to divide a - query from other text. mnoGoSearch will find all documents that - contain word "mysql" and/or word "odbc". Best documents having - bigger weights will be displayed first. If you use search mode - ALL, search will return documents that contain both (or more) - words you entered. In case you use mode ANY, the search will - return list of documents that contain any of the words you - entered. If you want more advanced results you may use query - language. You should select "bool" match mode in the search - from. - - - - - &reftitle.parameters; - - - - agent - - - A link to Agent, received after call to - udm_alloc_agent. - - - - - query - - - mnoGoSearch understands the following boolean operators: - - - & - logical AND. For example, "mysql & - odbc". mnoGoSearch will find any URLs that contain both - "mysql" and "odbc". - - - | - logical OR. For example "mysql|odbc". mnoGoSearch - will find any URLs, that contain word "mysql" or word - "odbc". - - - ~ - logical NOT. For example "mysql & ~odbc". - mnoGoSearch will find URLs that contain word "mysql" - and do not contain word "odbc" at the same time. Note - that ~ just excludes given word from results. Query - "~odbc" will find nothing! - - - () - group command to compose more complex queries. For example - "(mysql | msql) & ~postgres". Query language is - simple and powerful at the same time. Just consider query as - usual boolean expression. - - - - - - - - - &reftitle.returnvalues; - - Returns a result link identifier on success&return.falseforfailure;. - - - - - - diff --git a/reference/mnogosearch/functions/udm-free-agent.xml b/reference/mnogosearch/functions/udm-free-agent.xml deleted file mode 100644 index 933d7fc62646..000000000000 --- a/reference/mnogosearch/functions/udm-free-agent.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - udm_free_agent - Free mnoGoSearch session - - - - &reftitle.description; - - intudm_free_agent - resourceagent - - - Freeing up memory allocated for agent session. - - - - - &reftitle.parameters; - - - - agent - - - A link to Agent, received after call to - udm_alloc_agent. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/mnogosearch/functions/udm-free-ispell-data.xml b/reference/mnogosearch/functions/udm-free-ispell-data.xml deleted file mode 100644 index 77e10026727b..000000000000 --- a/reference/mnogosearch/functions/udm-free-ispell-data.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - udm_free_ispell_data - Free memory allocated for ispell data - - - - &reftitle.description; - - booludm_free_ispell_data - intagent - - - Frees the memory allocated for ispell data. - - - - - &reftitle.parameters; - - - - agent - - - A link to Agent, received after call to - udm_alloc_agent. - - - - - - - - - &reftitle.returnvalues; - - udm_free_ispell_data always returns &true;. - - - - - &reftitle.notes; - - - This function is supported beginning from version 3.1.12 of - mnoGoSearch and it does not do anything in previous versions. - - - - - - - diff --git a/reference/mnogosearch/functions/udm-free-res.xml b/reference/mnogosearch/functions/udm-free-res.xml deleted file mode 100644 index 40861efba3e2..000000000000 --- a/reference/mnogosearch/functions/udm-free-res.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - - - udm_free_res - Free mnoGoSearch result - - - - &reftitle.description; - - booludm_free_res - resourceres - - - Freeing up memory allocated for results. - - - - - &reftitle.parameters; - - - - res - - - A link to a result identifier, received after call to - udm_find. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/mnogosearch/functions/udm-get-doc-count.xml b/reference/mnogosearch/functions/udm-get-doc-count.xml deleted file mode 100644 index 08744428aee7..000000000000 --- a/reference/mnogosearch/functions/udm-get-doc-count.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - udm_get_doc_count - Get total number of documents in database - - - - - &reftitle.description; - - intudm_get_doc_count - resourceagent - - - udm_get_doc_count returns the number of documents in - the database. - - - - - &reftitle.parameters; - - - - agent - - - A link to Agent, received after call to - udm_alloc_agent. - - - - - - - - - &reftitle.returnvalues; - - Returns the number of documents. - - - - - &reftitle.notes; - - - This function is supported only in mnoGoSearch 3.1.11 or later. - - - - - - - diff --git a/reference/mnogosearch/functions/udm-get-res-field.xml b/reference/mnogosearch/functions/udm-get-res-field.xml deleted file mode 100644 index 5867785ccd72..000000000000 --- a/reference/mnogosearch/functions/udm-get-res-field.xml +++ /dev/null @@ -1,158 +0,0 @@ - - - - - udm_get_res_field - Fetch a result field - - - - &reftitle.description; - - stringudm_get_res_field - resourceres - introw - intfield - - - Fetch a mnoGoSearch result field. - - - - - &reftitle.parameters; - - - - res - - - res - a link to result identifier, received - after call to udm_find. - - - - - row - - - row - the number of the link on the current page. - May have values from 0 to - UDM_PARAM_NUM_ROWS-1. - - - - - field - - - field - field identifier, may have the following values: - - - - UDM_FIELD_URL - document URL field - - - - - UDM_FIELD_CONTENT - document - Content-type field (for example, text/html). - - - - - UDM_FIELD_CATEGORY - document category field. Use - udm_cat_path to get full path to current category - from the categories tree root. (This parameter is available only in PHP - 4.0.6 or later). - - - - - UDM_FIELD_TITLE - document title field. - - - - - UDM_FIELD_KEYWORDS - document keywords field (from META KEYWORDS tag). - - - - - UDM_FIELD_DESC - document description field (from META DESCRIPTION tag). - - - - - UDM_FIELD_TEXT - document body text (the first couple of lines to give an - idea of what the document is about). - - - - - UDM_FIELD_SIZE - document size. - - - - - UDM_FIELD_URLID - unique URL ID of the link. - - - - - UDM_FIELD_RATING - page rating (as calculated by mnoGoSearch). - - - - - UDM_FIELD_MODIFIED - last-modified field in unixtime format. - - - - - UDM_FIELD_ORDER - the number of the current document in set of found documents. - - - - - UDM_FIELD_CRC - document CRC. - - - - - - - - - - - - &reftitle.returnvalues; - - udm_get_res_field returns result field value on - success, &false; on error. - - - - - - diff --git a/reference/mnogosearch/functions/udm-get-res-param.xml b/reference/mnogosearch/functions/udm-get-res-param.xml deleted file mode 100644 index 513041f55aef..000000000000 --- a/reference/mnogosearch/functions/udm-get-res-param.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - udm_get_res_param - Get mnoGoSearch result parameters - - - - &reftitle.description; - - stringudm_get_res_param - resourceres - intparam - - - Gets the mnoGoSearch result parameters. - - - - - &reftitle.parameters; - - - - res - - - res - a link to result identifier, received after - call to udm_find. - - - - - param - - - param - parameter identifier, may have the following values: - - - - UDM_PARAM_NUM_ROWS - number of received found links on the current page. It is equal to - UDM_PARAM_PAGE_SIZE for all search pages, on the last page - the rest of links. - - - - - UDM_PARAM_FOUND - total number of results matching the query. - - - - - UDM_PARAM_WORDINFO - information on the words found. E.g. search for - "a good book" will return "a: stopword, good:5637, book: 120" - - - - - UDM_PARAM_SEARCHTIME - search time in seconds. - - - - - UDM_PARAM_FIRST_DOC - the number of the first document displayed on current page. - - - - - UDM_PARAM_LAST_DOC - the number of the last document displayed on current page. - - - - - - - - - - - - &reftitle.returnvalues; - - udm_get_res_param returns result parameter value on - success, &false; on error. - - - - - - diff --git a/reference/mnogosearch/functions/udm-hash32.xml b/reference/mnogosearch/functions/udm-hash32.xml deleted file mode 100644 index 43e9b970f785..000000000000 --- a/reference/mnogosearch/functions/udm-hash32.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - udm_hash32 - Return Hash32 checksum of given string - - - - &reftitle.description; - - intudm_hash32 - resourceagent - stringstr - - - udm_hash32 will take a string - str and return a quite unique 32-bit hash - number from it. - - - - - &reftitle.parameters; - - - - agent - - - A link to Agent, received after call to - udm_alloc_agent. - - - - - str - - - The input string. - - - - - - - - - &reftitle.returnvalues; - - Returns a 32-bit hash number. - - - - - &reftitle.seealso; - - - udm_alloc_agent - - - - - - - diff --git a/reference/mnogosearch/functions/udm-load-ispell-data.xml b/reference/mnogosearch/functions/udm-load-ispell-data.xml deleted file mode 100644 index bbff30b26e91..000000000000 --- a/reference/mnogosearch/functions/udm-load-ispell-data.xml +++ /dev/null @@ -1,272 +0,0 @@ - - - - - udm_load_ispell_data - Load ispell data - - - - &reftitle.description; - - booludm_load_ispell_data - resourceagent - intvar - stringval1 - stringval2 - intflag - - - udm_load_ispell_data loads ispell data. - - - After using this function to free memory allocated for ispell data, please - use udm_free_ispell_data, even if you use - UDM_ISPELL_TYPE_SERVER mode. - - - - - &reftitle.parameters; - - - - agent - - - A link to Agent, received after call to - udm_alloc_agent. - - - - - var - - - Indicates the source for ispell data. May have the following values: - - - - UDM_ISPELL_TYPE_DB - indicates that ispell data should be loaded from SQL. - In this case, parameters val1 and val2 - are ignored and should be left blank. flag - should be equal to 1. - - - - flag indicates that after loading ispell data - from defined source it should be sorted (it is necessary for correct - functioning of ispell). In case of loading ispell data from files - there may be several calls to udm_load_ispell_data, - and there is no sense to sort data after every call, but only after - the last one. Since in db mode all the data is loaded by one call, - this parameter should have the value 1. In this mode - in case of error, e.g. if ispell tables are absent, the function will - return &false; and code and error message will be accessible through - udm_error and udm_errno. - - - - - - UDM_ISPELL_TYPE_AFFIX - indicates that ispell data should be loaded from - file and initiates loading affixes file. In this case val1 - defines double letter language code for which affixes are loaded, - and val2 - file path. Please note, that if - a relative path entered, the module looks for the file not in UDM_CONF_DIR, - but in relation to current path, i.e. to the path where the script is executed. - In case of error in this mode, e.g. if file is absent, the function will return - &false;, and an error message will be displayed. Error message text cannot be - accessed through udm_error and udm_errno, - since those functions can only return messages associated with SQL. Please, - see flag parameter description in UDM_ISPELL_TYPE_DB. - - - - <function>udm_load_ispell_data</function> example - - -]]> - - - - - - flag is equal to 1 only in the last call. - - - - - - UDM_ISPELL_TYPE_SPELL - indicates that ispell data should be loaded from - file and initiates loading of ispell dictionary file. In this case - val1 defines double letter language code for which - affixes are loaded, - and val2 - file path. Please note, that if a relative - path entered, the module looks for the file not in UDM_CONF_DIR, but in - relation to current path, i.e. to the path where the script is executed. - In case of error in this mode, e.g. if file is absent, the function will - return &false;, and an error message will be displayed. Error message text - cannot be accessed through udm_error and - udm_errno, since those functions can only return messages - associated with SQL. Please, see flag parameter - description in UDM_ISPELL_TYPE_DB. - - - - -]]> - - - - - flag is equal to 1 only in the last call. - - - - - - UDM_ISPELL_TYPE_SERVER - enables spell server support. - val1 parameter indicates - address of the host running spell server. val2 ` - is not used yet, but in future releases it is going to indicate number - of port used by spell server. flag parameter in - this case is not needed since ispell data is stored - on spellserver already sorted. - - - Spelld server reads spell-data from a separate configuration file - (/usr/local/mnogosearch/etc/spelld.conf by default), sorts it and stores in - memory. With clients server communicates in two ways: to indexer all the - data is transferred (so that indexer starts faster), from search.cgi server - receives word to normalize and then passes over to client (search.cgi) list - of normalized word forms. This allows fastest, compared to db and text modes - processing of search queries (by omitting loading and sorting all the spell data). - - - udm_load_ispell_data function in UDM_ISPELL_TYPE_SERVER - mode does not actually load ispell data, but only defines server address. - In fact, server is automatically used by udm_find - function when performing search. In case of errors, e.g. if spellserver - is not running or invalid host indicated, there are no messages returned - and ispell conversion does not work. - - - - This function is available in mnoGoSearch 3.1.12 or later. - - - Example: - - -\n"; - exit; -} -?> -]]> - - - - - - - The fastest mode is UDM_ISPELL_TYPE_SERVER. - UDM_ISPELL_TYPE_TEXT is slower - and UDM_ISPELL_TYPE_DB is the slowest. The above pattern is &true; for - mnoGoSearch 3.1.10 - 3.1.11. It is planned to speed up DB mode in future - versions and it is going to be faster than TEXT mode. - - - - - val1 - - - - - - - val2 - - - - - - - flag - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>udm_load_ispell_data</function> example - - -]]> - - - - - - - - diff --git a/reference/mnogosearch/functions/udm-set-agent-param.xml b/reference/mnogosearch/functions/udm-set-agent-param.xml deleted file mode 100644 index 49799876165c..000000000000 --- a/reference/mnogosearch/functions/udm-set-agent-param.xml +++ /dev/null @@ -1,321 +0,0 @@ - - - - - udm_set_agent_param - Set mnoGoSearch agent session parameters - - - - &reftitle.description; - - booludm_set_agent_param - resourceagent - intvar - stringval - - - Defines mnoGoSearch session parameters. - - - - - &reftitle.parameters; - - - - agent - - - A link to Agent, received after call to - udm_alloc_agent. - - - - - var - - - The following parameters and their values are available: - - - - UDM_PARAM_PAGE_NUM - used to choose search results page number (results - are returned by pages beginning from 0, with UDM_PARAM_PAGE_SIZE results per page). - - - - - UDM_PARAM_PAGE_SIZE - number of search results displayed on one page. - - - - - UDM_PARAM_SEARCH_MODE - search mode. The following values available: UDM_MODE_ALL - - search for all words; UDM_MODE_ANY - search for any word; UDM_MODE_PHRASE - - phrase search; UDM_MODE_BOOL - boolean search. See udm_find - for details on boolean search. - - - - - UDM_PARAM_CACHE_MODE - turns on or off search result cache mode. - When enabled, the search engine will store - search results to disk. In case a similar search is performed later, - the engine will take results from the cache for faster performance. - Available values: UDM_CACHE_ENABLED, - UDM_CACHE_DISABLED. - - - - - UDM_PARAM_TRACK_MODE - turns on or off trackquery mode. Since - version 3.1.2 mnoGoSearch has a query tracking support. - Note that tracking is implemented in SQL version only and not available - in built-in database. - To use tracking, you have to create tables for tracking support. - For MySQL, use create/mysql/track.txt. - When doing a search, front-end uses those tables to store query words, - a number of found documents and current Unix timestamp in seconds. - Available values: UDM_TRACK_ENABLED, - UDM_TRACK_DISABLED. - - - - - UDM_PARAM_PHRASE_MODE - defines whether index database using phrases - ("phrase" parameter in indexer.conf). - Possible values: UDM_PHRASE_ENABLED and UDM_PHRASE_DISABLED. - Please note, that if phrase search is enabled (UDM_PHRASE_ENABLED), - it is still possible to do search in any mode (ANY, ALL, - BOOL or PHRASE). - In 3.1.10 version of mnoGoSearch phrase search is supported only in sql - and built-in database modes, - while beginning with 3.1.11 phrases are supported in cachemode as well. - - - Examples of phrase search: - - - "Arizona desert" - This query returns all indexed documents that contain - "Arizona desert" as a phrase. Notice that you need to put double quotes - around the phrase - - - - - UDM_PARAM_CHARSET - defines local charset. Available values: set of - charsets supported by mnoGoSearch, e.g. koi8-r, cp1251, ... - - - - - UDM_PARAM_STOPFILE - Defines name and path - to stopwords file. (There is a small difference with mnoGoSearch - - while in mnoGoSearch if relative path or no path entered, it - looks for this file in relation to UDM_CONF_DIR, the module looks for - the file in relation to current path, i.e. to the path where the - PHP script is executed.) - - - - - UDM_PARAM_STOPTABLE - Load stop words from the given SQL table. You may use - several StopwordTable commands. - This command has no effect when compiled without SQL database support. - - - - - UDM_PARAM_WEIGHT_FACTOR - represents weight factors for specific document parts. - Currently body, title, keywords, description, url are supported. - To activate this feature please use degrees of 2 in *Weight commands of - the indexer.conf. Let's imagine that we have these weights: - - - URLWeight 1 - BodyWeight 2 - TitleWeight 4 - KeywordWeight 8 - DescWeight 16 - - - - As far as indexer uses bit OR operation for word weights when some - word presents several time in the same document, it is possible at search - time to detect word appearance in different document parts. Word which - appears only in the body will have 00000010 aggregate weight (in binary notation). - Word used in all document parts will have 00011111 aggregate weight. - - - - This parameter's value is a string of hex digits ABCDE. Each digit is a - factor for corresponding bit in word weight. For the given above weights - configuration: - - - E is a factor for weight 1 (URL Weight bit) - D is a factor for weight 2 (BodyWeight bit) - C is a factor for weight 4 (TitleWeight bit) - B is a factor for weight 8 (KeywordWeight bit) - A is a factor for weight 16 (DescWeight bit) - - - Examples: - - - UDM_PARAM_WEIGHT_FACTOR=00001 will search through URLs only. - - - UDM_PARAM_WEIGHT_FACTOR=00100 will search through Titles only. - - - UDM_PARAM_WEIGHT_FACTOR=11100 will search through Title,Keywords,Description - but not through URL and Body. - - - UDM_PARAM_WEIGHT_FACTOR=F9421 will search through: - - - Description with factor 15 (F hex) - Keywords with factor 9 - Title with factor 4 - Body with factor 2 - URL with factor 1 - - - If UDM_PARAM_WEIGHT_FACTOR variable is omitted, original weight value is - taken to sort results. For a given above weight configuration it means - that document description has a most big weight 16. - - - - - UDM_PARAM_WORD_MATCH - word match. You may use this parameter to choose - word match type. This feature works only in "single" and "multi" modes - using SQL based and built-in database. It does not work in cachemode and other modes - since they use word CRC and do not support substring search. Available values: - - UDM_MATCH_BEGIN - word beginning match; - UDM_MATCH_END - word ending match; - UDM_MATCH_WORD - whole word match; - UDM_MATCH_SUBSTR - word substring match. - - - - UDM_PARAM_MIN_WORD_LEN - defines minimal word length. - Any word shorter this limit is considered to be a stopword. Please note - that this parameter value is inclusive, i.e. if UDM_PARAM_MIN_WORD_LEN=3, - a word 3 characters long will not be considered a stopword, while - a word 2 characters long will be. Default value is 1. - - - - - UDM_PARAM_ISPELL_PREFIXES - Possible values: UDM_PREFIXES_ENABLED and - UDM_PREFIXES_DISABLED, that respectively enable or disable using prefixes. - E.g. if a word "tested" is in search query, also words like "test", - "testing", etc. Only suffixes are supported by default. Prefixes usually - change word meanings, for example if somebody is searching for the word "tested" - one hardly wants "untested" to be found. Prefixes support may also be - found useful for site's spelling checking purposes. In order to enable - ispell, you have to load ispell data with udm_load_ispell_data. - - - - - UDM_PARAM_CROSS_WORDS - enables or disables crosswords support. - Possible values: UDM_CROSS_WORDS_ENABLED and UDM_CROSS_WORDS_DISABLED. - - - The crosswords feature allows to assign words between <a href="xxx"> and </a> - also to a document this link leads to. It works in SQL database mode and - is not supported in built-in database and Cachemode. - - - - - UDM_PARAM_VARDIR - specifies a custom path to directory where indexer - stores data when using built-in database and in cache mode. - By default /var directory of - mnoGoSearch installation is used. Can have - only string values. - - - - - - - - val - - - - - - - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 4.1.0 - - UDM_PARAM_VARDIR was added. - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.notes; - - - Crosswords are supported only in mnoGoSearch 3.1.11 or later. - - - - - - - diff --git a/reference/mnogosearch/reference.xml b/reference/mnogosearch/reference.xml deleted file mode 100644 index 1b2830084494..000000000000 --- a/reference/mnogosearch/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - mnoGoSearch &Functions; - - &reference.mnogosearch.entities.functions; - - - - - diff --git a/reference/mnogosearch/setup.xml b/reference/mnogosearch/setup.xml deleted file mode 100644 index 90b931aead3c..000000000000 --- a/reference/mnogosearch/setup.xml +++ /dev/null @@ -1,59 +0,0 @@ - - - - - &reftitle.setup; - - -
- &reftitle.required; - - Download mnoGosearch from - &url.mnogo; and install it on your - system. You need at least version 3.1.10 of mnoGoSearch installed to use - these functions. - -
- - - - &reference.mnogosearch.configure; - - - -
- &reftitle.runtime; - &no.config; -
- - - -
- &reftitle.resources; - &no.resource; -
- - - - - - diff --git a/reference/mnogosearch/versions.xml b/reference/mnogosearch/versions.xml deleted file mode 100644 index cbc3d138c7ec..000000000000 --- a/reference/mnogosearch/versions.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/msession/book.xml b/reference/msession/book.xml deleted file mode 100644 index 55bcf494a56c..000000000000 --- a/reference/msession/book.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - Mohawk Software Session Handler Functions - Msession - - - &reftitle.intro; - - msession is an interface to a high speed session daemon which can run - either locally or remotely. It is designed to provide consistent session - management for a PHP web farm. More Information about msession and the - session server software itself can be found at - &url.msession;. - - ¬e.no-windows.extension; - - - &pecl.moved-ver;5.1.3. - - - - - &reference.msession.setup; - &reference.msession.constants; - &reference.msession.reference; - - - - - diff --git a/reference/msession/configure.xml b/reference/msession/configure.xml deleted file mode 100644 index dbfd262c28d4..000000000000 --- a/reference/msession/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - -
- &reftitle.install; - - &pecl.info.dead; - &url.pecl.vcs;msession. - - - &pecl.moved-ver;5.1.3 - -
- - diff --git a/reference/msession/constants.xml b/reference/msession/constants.xml deleted file mode 100644 index 28c576f56f7a..000000000000 --- a/reference/msession/constants.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - &reftitle.constants; - &no.constants; - - - - diff --git a/reference/msession/functions/msession-connect.xml b/reference/msession/functions/msession-connect.xml deleted file mode 100644 index 14f54cbd1951..000000000000 --- a/reference/msession/functions/msession-connect.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - msession_connect - Connect to msession server - - - &reftitle.description; - - boolmsession_connect - stringhost - stringport - - &warn.undocumented.func; - - - - diff --git a/reference/msession/functions/msession-count.xml b/reference/msession/functions/msession-count.xml deleted file mode 100644 index b01bb56ad68b..000000000000 --- a/reference/msession/functions/msession-count.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - msession_count - Get session count - - - &reftitle.description; - - intmsession_count - - - &warn.undocumented.func; - - - - diff --git a/reference/msession/functions/msession-create.xml b/reference/msession/functions/msession-create.xml deleted file mode 100644 index 811c5c244981..000000000000 --- a/reference/msession/functions/msession-create.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - msession_create - Create a session - - - &reftitle.description; - - boolmsession_create - stringsession - stringclassname - stringdata - - &warn.undocumented.func; - - - - diff --git a/reference/msession/functions/msession-destroy.xml b/reference/msession/functions/msession-destroy.xml deleted file mode 100644 index 5ad8975114f6..000000000000 --- a/reference/msession/functions/msession-destroy.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - msession_destroy - Destroy a session - - - &reftitle.description; - - boolmsession_destroy - stringname - - &warn.undocumented.func; - - - - diff --git a/reference/msession/functions/msession-disconnect.xml b/reference/msession/functions/msession-disconnect.xml deleted file mode 100644 index a136c30da1e0..000000000000 --- a/reference/msession/functions/msession-disconnect.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - msession_disconnect - Close connection to msession server - - - &reftitle.description; - - voidmsession_disconnect - - - &warn.undocumented.func; - - - - diff --git a/reference/msession/functions/msession-find.xml b/reference/msession/functions/msession-find.xml deleted file mode 100644 index bead08044237..000000000000 --- a/reference/msession/functions/msession-find.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - msession_find - Find all sessions with name and value - - - &reftitle.description; - - arraymsession_find - stringname - stringvalue - - &warn.undocumented.func; - - - - diff --git a/reference/msession/functions/msession-get-array.xml b/reference/msession/functions/msession-get-array.xml deleted file mode 100644 index d1ab87849a2a..000000000000 --- a/reference/msession/functions/msession-get-array.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - msession_get_array - Get array of msession variables - - - &reftitle.description; - - arraymsession_get_array - stringsession - - &warn.undocumented.func; - - - - diff --git a/reference/msession/functions/msession-get-data.xml b/reference/msession/functions/msession-get-data.xml deleted file mode 100644 index 21bdac4dbe29..000000000000 --- a/reference/msession/functions/msession-get-data.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - msession_get_data - Get data session unstructured data - - - &reftitle.description; - - stringmsession_get_data - stringsession - - &warn.undocumented.func; - - - - diff --git a/reference/msession/functions/msession-get.xml b/reference/msession/functions/msession-get.xml deleted file mode 100644 index 19d9902af73d..000000000000 --- a/reference/msession/functions/msession-get.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - msession_get - Get value from session - - - &reftitle.description; - - stringmsession_get - stringsession - stringname - stringvalue - - &warn.undocumented.func; - - - - diff --git a/reference/msession/functions/msession-inc.xml b/reference/msession/functions/msession-inc.xml deleted file mode 100644 index 27db13cf0bea..000000000000 --- a/reference/msession/functions/msession-inc.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - msession_inc - Increment value in session - - - &reftitle.description; - - stringmsession_inc - stringsession - stringname - - &warn.undocumented.func; - - - - diff --git a/reference/msession/functions/msession-list.xml b/reference/msession/functions/msession-list.xml deleted file mode 100644 index 6a87d614247b..000000000000 --- a/reference/msession/functions/msession-list.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - msession_list - List all sessions - - - &reftitle.description; - - arraymsession_list - - - &warn.undocumented.func; - - - - diff --git a/reference/msession/functions/msession-listvar.xml b/reference/msession/functions/msession-listvar.xml deleted file mode 100644 index a39ea2d743e3..000000000000 --- a/reference/msession/functions/msession-listvar.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - msession_listvar - List sessions with variable - - - &reftitle.description; - - arraymsession_listvar - stringname - - - Used for searching sessions with common attributes. - - - - - &reftitle.parameters; - - - - name - - - The name being searched. - - - - - - - - - &reftitle.returnvalues; - - Returns an associative array of value/session for all sessions - with a variable named name. - - - - - diff --git a/reference/msession/functions/msession-lock.xml b/reference/msession/functions/msession-lock.xml deleted file mode 100644 index a26b3763afdc..000000000000 --- a/reference/msession/functions/msession-lock.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - msession_lock - Lock a session - - - &reftitle.description; - - intmsession_lock - stringname - - &warn.undocumented.func; - - - - diff --git a/reference/msession/functions/msession-plugin.xml b/reference/msession/functions/msession-plugin.xml deleted file mode 100644 index edf6832e4bbb..000000000000 --- a/reference/msession/functions/msession-plugin.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - msession_plugin - Call an escape function within the msession personality plugin - - - &reftitle.description; - - stringmsession_plugin - stringsession - stringval - stringparam - - &warn.undocumented.func; - - - - diff --git a/reference/msession/functions/msession-randstr.xml b/reference/msession/functions/msession-randstr.xml deleted file mode 100644 index eb53e7b3ee14..000000000000 --- a/reference/msession/functions/msession-randstr.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - msession_randstr - Get random string - - - &reftitle.description; - - stringmsession_randstr - intparam - - &warn.undocumented.func; - - - - diff --git a/reference/msession/functions/msession-set-array.xml b/reference/msession/functions/msession-set-array.xml deleted file mode 100644 index 5af02335498c..000000000000 --- a/reference/msession/functions/msession-set-array.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - msession_set_array - Set msession variables from an array - - - &reftitle.description; - - voidmsession_set_array - stringsession - arraytuples - - &warn.undocumented.func; - - - - diff --git a/reference/msession/functions/msession-set-data.xml b/reference/msession/functions/msession-set-data.xml deleted file mode 100644 index e072df41a71b..000000000000 --- a/reference/msession/functions/msession-set-data.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - msession_set_data - Set data session unstructured data - - - &reftitle.description; - - boolmsession_set_data - stringsession - stringvalue - - &warn.undocumented.func; - - - - diff --git a/reference/msession/functions/msession-set.xml b/reference/msession/functions/msession-set.xml deleted file mode 100644 index fca673d646d9..000000000000 --- a/reference/msession/functions/msession-set.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - msession_set - Set value in session - - - &reftitle.description; - - boolmsession_set - stringsession - stringname - stringvalue - - &warn.undocumented.func; - - - - diff --git a/reference/msession/functions/msession-timeout.xml b/reference/msession/functions/msession-timeout.xml deleted file mode 100644 index 3c65ede6d971..000000000000 --- a/reference/msession/functions/msession-timeout.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - msession_timeout - Set/get session timeout - - - &reftitle.description; - - intmsession_timeout - stringsession - intparam - - &warn.undocumented.func; - - - - diff --git a/reference/msession/functions/msession-uniq.xml b/reference/msession/functions/msession-uniq.xml deleted file mode 100644 index d0cb06eb1fe9..000000000000 --- a/reference/msession/functions/msession-uniq.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - msession_uniq - Get unique id - - - &reftitle.description; - - stringmsession_uniq - intparam - stringclassname - stringdata - - &warn.undocumented.func; - - - - diff --git a/reference/msession/functions/msession-unlock.xml b/reference/msession/functions/msession-unlock.xml deleted file mode 100644 index bad2246dd422..000000000000 --- a/reference/msession/functions/msession-unlock.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - msession_unlock - Unlock a session - - - &reftitle.description; - - intmsession_unlock - stringsession - intkey - - &warn.undocumented.func; - - - - diff --git a/reference/msession/reference.xml b/reference/msession/reference.xml deleted file mode 100644 index 66beccf60e4b..000000000000 --- a/reference/msession/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - Msession &Functions; - - &reference.msession.entities.functions; - - - - - diff --git a/reference/msession/setup.xml b/reference/msession/setup.xml deleted file mode 100644 index c36092a53b2a..000000000000 --- a/reference/msession/setup.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - &reftitle.setup; - -
- &reftitle.required; - &no.requirement; -
- - &reference.msession.configure; - -
- &reftitle.runtime; - &no.config; -
- -
- &reftitle.resources; - &no.resource; -
- - - - - diff --git a/reference/msession/versions.xml b/reference/msession/versions.xml deleted file mode 100644 index a4e2da6fa306..000000000000 --- a/reference/msession/versions.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/msql/functions/msql-fetch-array.xml b/reference/msql/functions/msql-fetch-array.xml index 45ccf107b297..c13159afc229 100644 --- a/reference/msql/functions/msql-fetch-array.xml +++ b/reference/msql/functions/msql-fetch-array.xml @@ -84,30 +84,6 @@ msql_free_result($result); - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.0.4 - - A bug was fixed when retrieving data from columns containing &null; - values. Such columns were not placed into the resulting array. - - - - - - - &reftitle.seealso; diff --git a/reference/msql/functions/msql-fetch-object.xml b/reference/msql/functions/msql-fetch-object.xml index 1c5cf2fd3762..4896d2bb58b0 100644 --- a/reference/msql/functions/msql-fetch-object.xml +++ b/reference/msql/functions/msql-fetch-object.xml @@ -74,30 +74,6 @@ msql_free_result($result); - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.0.4 - - A bug was fixed when retrieving data from columns containing &null; - values. Such columns were not placed into the resulting array. - - - - - - - &reftitle.seealso; diff --git a/reference/msql/functions/msql-fetch-row.xml b/reference/msql/functions/msql-fetch-row.xml index 32b15e069328..3637fbce2afa 100644 --- a/reference/msql/functions/msql-fetch-row.xml +++ b/reference/msql/functions/msql-fetch-row.xml @@ -72,30 +72,6 @@ msql_free_result($result); - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.0.4 - - A bug was fixed when retrieving data from columns containing &null; - values. Such columns were not placed into the resulting array. - - - - - - - &reftitle.seealso; diff --git a/reference/mssql/book.xml b/reference/mssql/book.xml deleted file mode 100644 index afe2df6559bd..000000000000 --- a/reference/mssql/book.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - - Microsoft SQL Server - Mssql - - - - &reftitle.intro; - - - &warn.removed.feature.7-0-0.alternatives; - - PDO_SQLSRV - PDO_ODBC - SQLSRV - Unified ODBC API - - - - - These functions allow you to access MS SQL Server database. - - - This extension is not available anymore on Windows with PHP 5.3 or later. - - - SQLSRV, an alternative extension for MS SQL connectivity is available from - Microsoft: &url.sqlsrv;. - - - - - &reference.mssql.setup; - &reference.mssql.constants; - &reference.mssql.reference; - - - - - diff --git a/reference/mssql/configure.xml b/reference/mssql/configure.xml deleted file mode 100644 index 8082a726b5e3..000000000000 --- a/reference/mssql/configure.xml +++ /dev/null @@ -1,43 +0,0 @@ - - -
- &reftitle.install; - - The MSSQL extension is enabled by adding extension=php_mssql.dll to - &php.ini;. - - - To get these functions to work, you have to compile PHP with - , where DIR is the - FreeTDS install prefix. And FreeTDS should be compiled using - . - - - - MS SQL functions are aliases to Sybase functions if PHP is compiled with - Sybase extension and without MS SQL - extension. - - -
- - diff --git a/reference/mssql/constants.xml b/reference/mssql/constants.xml deleted file mode 100644 index 058490479490..000000000000 --- a/reference/mssql/constants.xml +++ /dev/null @@ -1,178 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - MSSQL_ASSOC - (integer) - - - - Return an associative array. Used on - mssql_fetch_array's - result_type parameter. - - - - - - MSSQL_NUM - (integer) - - - - Return an array with numeric keys. Used on - mssql_fetch_array's - result_type parameter. - - - - - - MSSQL_BOTH - (integer) - - - - Return an array with both numeric keys and - keys with their field name. This is the - default value for mssql_fetch_array's - result_type parameter. - - - - - - SQLTEXT - (integer) - - - - Indicates the 'TEXT' type in MSSQL, used by - mssql_bind's type - parameter. - - - - - - SQLVARCHAR - (integer) - - - - Indicates the 'VARCHAR' type in MSSQL, used by - mssql_bind's type - parameter. - - - - - - SQLCHAR - (integer) - - - - Indicates the 'CHAR' type in MSSQL, used by - mssql_bind's type - parameter. - - - - - - SQLINT1 - (integer) - - - - Represents one byte, with a range of -128 to 127. - - - - - - SQLINT2 - (integer) - - - - Represents two bytes, with a range of -32768 - to 32767. - - - - - - SQLINT4 - (integer) - - - - Represents four bytes, with a range of -2147483648 - to 2147483647. - - - - - - SQLBIT - (integer) - - - - Indicates the 'BIT' type in MSSQL, used by - mssql_bind's type - parameter. - - - - - - SQLFLT4 - (integer) - - - - Represents an four byte float. - - - - - - SQLFLT8 - (integer) - - - - Represents an eight byte float. - - - - - - - diff --git a/reference/mssql/functions/mssql-bind.xml b/reference/mssql/functions/mssql-bind.xml deleted file mode 100644 index 31097d3721da..000000000000 --- a/reference/mssql/functions/mssql-bind.xml +++ /dev/null @@ -1,192 +0,0 @@ - - - - - mssql_bind - Adds a parameter to a stored procedure or a remote stored procedure - - - - - &warn.removed.function.7-0-0.alternatives; - - PDOStatement::bindParam - PDOStatement::bindValue - sqlsrv_prepare - odbc_prepare - - - - - - &reftitle.description; - - boolmssql_bind - resourcestmt - stringparam_name - mixedvar - inttype - boolis_output&false; - boolis_null&false; - intmaxlen-1 - - - Binds a parameter to a stored procedure or a remote stored procedure. - - - - - &reftitle.parameters; - - - - stmt - - - Statement resource, obtained with mssql_init. - - - - - param_name - - - The parameter name, as a string. - - - - You have to include the @ character, like in the - T-SQL syntax. See the explanation included in - mssql_execute. - - - - - - var - - - The PHP variable you'll bind the MSSQL parameter to. It is passed by - reference, to retrieve OUTPUT and RETVAL values after - the procedure execution. - - - - - type - - - One of: SQLTEXT, - SQLVARCHAR, SQLCHAR, - SQLINT1, SQLINT2, - SQLINT4, SQLBIT, - SQLFLT4, SQLFLT8, - SQLFLTN. - - - - - is_output - - - Whether the value is an OUTPUT parameter or not. If it's an OUTPUT - parameter and you don't mention it, it will be treated as a normal - input parameter and no error will be thrown. - - - - - is_null - - - Whether the parameter is &null; or not. Passing the &null; value as - var will not do the job. - - - - - maxlen - - - Used with char/varchar values. You have to indicate the length of the - data so if the parameter is a varchar(50), the type must be - SQLVARCHAR and this value 50. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>mssql_bind</function> example - - -]]> - - - - - - - &reftitle.seealso; - - - mssql_execute - mssql_free_statement - mssql_init - - - - - - - diff --git a/reference/mssql/functions/mssql-close.xml b/reference/mssql/functions/mssql-close.xml deleted file mode 100644 index 05f8ba907a2b..000000000000 --- a/reference/mssql/functions/mssql-close.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - mssql_close - Close MS SQL Server connection - - - - - &warn.removed.function.7-0-0.alternatives; - - sqlsrv_close - odbc_close - odbc_close_all - - - - - - &reftitle.description; - - boolmssql_close - resourcelink_identifier - - - Closes the link to a MS SQL Server database that's associated with the - specified link identifier. If the link identifier isn't specified, the - last opened link is assumed. - - - Note that this isn't usually necessary, as non-persistent open - links are automatically closed at the end of the script's - execution. - - - - - &reftitle.parameters; - - - - link_identifier - - - A MS SQL link identifier, returned by - mssql_connect. - - - This function will not close persistent links generated by - mssql_pconnect. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>mssql_close</function> example - - -]]> - - - - - - - &reftitle.seealso; - - - mssql_connect - mssql_pconnect - - - - - - - diff --git a/reference/mssql/functions/mssql-connect.xml b/reference/mssql/functions/mssql-connect.xml deleted file mode 100644 index ab4a5731614c..000000000000 --- a/reference/mssql/functions/mssql-connect.xml +++ /dev/null @@ -1,174 +0,0 @@ - - - - - mssql_connect - Open MS SQL server connection - - - - - &warn.removed.function.7-0-0.alternatives; - - PDO::__construct - sqlsrv_connect - odbc_connect - - - - - - &reftitle.description; - - resourcemssql_connect - stringservername - stringusername - stringpassword - boolnew_link&false; - - - mssql_connect establishes a connection to a - MS SQL server. - - - The link to the server will be closed as soon as the execution of - the script ends, unless it's closed earlier by explicitly calling - mssql_close. - - - - - &reftitle.parameters; - - - - servername - - - The MS SQL server. It can also include a port number, e.g. - hostname:port (Linux), or - hostname,port (Windows). - - - - - username - - - The username. - - - - - password - - - The password. - - - - - new_link - - - If a second call is made to mssql_connect with the - same arguments, no new link will be established, but instead, the link - identifier of the already opened link will be returned. This parameter - modifies this behavior and makes mssql_connect - always open a new link, even if mssql_connect was - called before with the same parameters. - - - - - - - - - &reftitle.returnvalues; - - Returns a MS SQL link identifier on success, or &false; on error. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.0 - - The new_link parameter was added - - - - - - - - - - &reftitle.examples; - - - <function>mssql_connect</function> example - -\ or -// , when using a non default port number -$server = 'KALLESPC\SQLEXPRESS'; - -// Connect to MSSQL -$link = mssql_connect($server, 'sa', 'phpfi'); - -if (!$link) { - die('Something went wrong while connecting to MSSQL'); -} -?> -]]> - - - - - - - &reftitle.seealso; - - - mssql_close - mssql_pconnect - - - - - - - diff --git a/reference/mssql/functions/mssql-data-seek.xml b/reference/mssql/functions/mssql-data-seek.xml deleted file mode 100644 index df6fcc3500af..000000000000 --- a/reference/mssql/functions/mssql-data-seek.xml +++ /dev/null @@ -1,129 +0,0 @@ - - - - - mssql_data_seek - Moves internal row pointer - - - - - &warn.removed.function.7-0-0.alternatives; - - - Using an OFFSET clause with a query issued through - PDO_SQLSRV, - PDO_ODBC, - SQLSRV, or the - unified ODBC driver. - - - - - - - &reftitle.description; - - boolmssql_data_seek - resourceresult_identifier - introw_number - - - mssql_data_seek moves the internal row - pointer of the MS SQL result associated with the specified result - identifier to point to the specified row number, first row being - number 0. The next call to mssql_fetch_row - would return that row. - - - - - &reftitle.parameters; - - - - result_identifier - - - The result resource that is being evaluated. - - - - - row_number - - - The desired row number of the new result pointer. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>mssql_data_seek</function> example - -= 13'); - -if (!$result) { - die('Query failed.'); -} - -// Select every 4th student in the results -for ($i = mssql_num_rows($result) - 1; $i % 4; $i++) { - if (!mssql_data_seek($result, $i)) { - continue; - } - - // Fetch the row ... -} - -// Free the query result -mssql_free_result($result); -?> -]]> - - - - - - - - diff --git a/reference/mssql/functions/mssql-execute.xml b/reference/mssql/functions/mssql-execute.xml deleted file mode 100644 index b3de31555a89..000000000000 --- a/reference/mssql/functions/mssql-execute.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - mssql_execute - Executes a stored procedure on a MS SQL server database - - - - - &warn.removed.function.7-0-0.alternatives; - - - Using an EXEC query issued through - PDO_SQLSRV, - PDO_ODBC, - SQLSRV, or the - unified ODBC driver. - - - - - - - &reftitle.description; - - mixedmssql_execute - resourcestmt - boolskip_results&false; - - - Executes a stored procedure on a MS SQL server database - - - - - &reftitle.parameters; - - - - stmt - - - Statement handle obtained with mssql_init. - - - - - skip_results - - - Whenever to skip the results or not. - - - - - - - - - &reftitle.examples; - - - <function>mssql_execute</function> example - - -]]> - - - - - - - &reftitle.notes; - - - If the stored procedure returns parameters or a return value these will - be available after the call to mssql_execute unless - the stored procedure returns more than one result set. In that case - use mssql_next_result to shift through the results. - When the last result has been processed the output parameters and return - values will be available. - - - - - - &reftitle.seealso; - - - mssql_bind - mssql_free_statement - mssql_init - - - - - - - diff --git a/reference/mssql/functions/mssql-fetch-array.xml b/reference/mssql/functions/mssql-fetch-array.xml deleted file mode 100644 index 5457ac0db2be..000000000000 --- a/reference/mssql/functions/mssql-fetch-array.xml +++ /dev/null @@ -1,146 +0,0 @@ - - - - - mssql_fetch_array - Fetch a result row as an associative array, a numeric array, or both - - - - - &warn.removed.function.7-0-0.alternatives; - - PDOStatement::fetch - sqlsrv_fetch_array - odbc_fetch_array - - - - - - &reftitle.description; - - arraymssql_fetch_array - resourceresult - intresult_typeMSSQL_BOTH - - - mssql_fetch_array is an extended version of - mssql_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. - - - An important thing to note is that using - mssql_fetch_array is NOT significantly - slower than using mssql_fetch_row, while it - provides a significant added value. - - - - - &reftitle.parameters; - - - - result - - - The result resource that is being evaluated. This result comes from a - call to mssql_query. - - - - - result_type - - - The type of array that is to be fetched. It's a constant and can take - the following values: MSSQL_ASSOC, - MSSQL_NUM, and - MSSQL_BOTH. - - - - - - - - - &reftitle.returnvalues; - - Returns an array that corresponds to the fetched row, or &false; if there - are no more rows. - - - - - &reftitle.examples; - - - <function>mssql_fetch_array</function> example - - -]]> - - - - - - - &reftitle.notes; - &database.field-case; - &database.fetch-null; - - - - &reftitle.seealso; - - - mssql_fetch_row - - - - - - - diff --git a/reference/mssql/functions/mssql-fetch-assoc.xml b/reference/mssql/functions/mssql-fetch-assoc.xml deleted file mode 100644 index e1cd96226a55..000000000000 --- a/reference/mssql/functions/mssql-fetch-assoc.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - mssql_fetch_assoc - Returns an associative array of the current row in the result - - - - - &warn.removed.function.7-0-0.alternatives; - - PDOStatement::fetch - sqlsrv_fetch_array - odbc_fetch_array - - - - - - &reftitle.description; - - arraymssql_fetch_assoc - resourceresult_id - - - Returns an associative array that corresponds to the fetched row and moves - the internal data pointer ahead. mssql_fetch_assoc is - equivalent to calling mssql_fetch_array with - MSSQL_ASSOC for the optional second parameter. - - - - - &reftitle.parameters; - - - - result_id - - - The result resource that is being evaluated. This result comes from a - call to mssql_query. - - - - - - - - - &reftitle.returnvalues; - - Returns an associative array that corresponds to the fetched row, or - &false; if there are no more rows. - - - - - &reftitle.examples; - - - <function>mssql_fetch_assoc</function> example - -'; - - while ($row = mssql_fetch_assoc($query)) { - echo '
  • ' . $row['name'] . ' (' . $row['username'] . ')
    • '; - } - - echo ''; -} - -// Free the query result -mssql_free_result($query); -?> -]]> -     -     -     -     - -     - - diff --git a/reference/mssql/functions/mssql-fetch-batch.xml b/reference/mssql/functions/mssql-fetch-batch.xml deleted file mode 100644 index e426967db5fe..000000000000 --- a/reference/mssql/functions/mssql-fetch-batch.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - mssql_fetch_batch - Returns the next batch of records - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - intmssql_fetch_batch - resourceresult - - - Returns the next batch of records. - - - - - &reftitle.parameters; - - - - result - - - The result resource that is being evaluated. This result comes from a - call to mssql_query. - - - - - - - - - &reftitle.returnvalues; - - Returns the number of rows in the returned batch. - - - - - &reftitle.examples; - - - <function>mssql_fetch_batch</function> example - -= 0) { - while ($row = mssql_fetch_assoc($result)) { - // Do stuff ... - } - - --$records; -} - -if ($batchsize = mssql_fetch_batch($result)) { - // $batchsize is the number of records left - // in the result, but not shown above -} -?> -]]> - - - - - - - - diff --git a/reference/mssql/functions/mssql-fetch-field.xml b/reference/mssql/functions/mssql-fetch-field.xml deleted file mode 100644 index 537cf791a1ef..000000000000 --- a/reference/mssql/functions/mssql-fetch-field.xml +++ /dev/null @@ -1,186 +0,0 @@ - - - - - mssql_fetch_field - Get field information - - - - - &warn.removed.function.7-0-0.alternatives; - - PDOStatement::getColumnMeta - sqlsrv_field_metadata - - The various odbc_field_* functions in the - unified ODBC driver. - - - - - - - &reftitle.description; - - objectmssql_fetch_field - resourceresult - intfield_offset-1 - - - mssql_fetch_field can be used in order to - obtain information about fields in a certain query result. - - - - - &reftitle.parameters; - - - - result - - - The result resource that is being evaluated. This result comes from a - call to mssql_query. - - - - - field_offset - - - The numerical field offset. If the field offset is not specified, the - next field that was not yet retrieved by this function is retrieved. The - field_offset starts at 0. - - - - - - - - - &reftitle.returnvalues; - - Returns an object containing field information. - - - The properties of the object are: - - - - - name - column name. if the column is a result of a function, - this property is set to computed#N, where #N is a serial - number. - - - - - column_source - the table from which the column was taken - - - - - max_length - maximum length of the column - - - - - numeric - 1 if the column is numeric - - - - - type - the column type. - - - - - - - &reftitle.examples; - - - <function>mssql_fetch_field</function> example - -Table structure for \'persons\''; -echo ''; - -// Table header -echo ''; -echo ''; -echo ''; -echo ''; -echo ''; -echo ''; -echo ''; - -// Dump all fields -echo ''; - -for ($i = 0; $i < mssql_num_fields($query); ++$i) { - // Fetch the field information - $field = mssql_fetch_field($query, $i); - - // Print the row - echo ''; - echo ''; - echo ''; - echo ''; - echo ''; -} - -echo ''; -echo '
    Field nameData typeMax length
    ' . $field->name . '' . strtoupper($field->type) . '' . $field->max_length . '
    '; - -// Free the query result -mssql_free_result($query); -?> -]]> -     -     -     -     - - - &reftitle.seealso; - - - mssql_field_seek - - - -     - - diff --git a/reference/mssql/functions/mssql-fetch-object.xml b/reference/mssql/functions/mssql-fetch-object.xml deleted file mode 100644 index b53437fb23ca..000000000000 --- a/reference/mssql/functions/mssql-fetch-object.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - mssql_fetch_object - Fetch row as object - - - - - &warn.removed.function.7-0-0.alternatives; - - PDOStatement::fetchObject - sqlsrv_fetch_object - odbc_fetch_object - - - - - - &reftitle.description; - - objectmssql_fetch_object - resourceresult - - - mssql_fetch_object is similar to - mssql_fetch_array, with one difference - an - object is returned, instead of an array. Indirectly, that means - that you can only access the data by the field names, and not by - their offsets (numbers are illegal property names). - - - Speed-wise, the function is identical to - mssql_fetch_array, and almost as quick as - mssql_fetch_row (the difference is - insignificant). - - - - - &reftitle.parameters; - - - - result - - - The result resource that is being evaluated. This result comes from a - call to mssql_query. - - - - - - - - - &reftitle.returnvalues; - - Returns an object with properties that correspond to the fetched row, or - &false; if there are no more rows. - - - - - &reftitle.examples; - - - <function>mssql_fetch_object</function> example - -'; - - while ($row = mssql_fetch_object($query)) { - echo '
  • ' . $row->name . ' (' . $row->username . ')
    • '; - } - - echo ''; -} - -// Free the query result -mssql_free_result($query); -?> -]]> -     -     -     -     - - - &reftitle.notes; - &database.field-case; - &database.fetch-null; - - - - &reftitle.seealso; - - - mssql_fetch_array - mssql_fetch_row - - - - -     - - diff --git a/reference/mssql/functions/mssql-fetch-row.xml b/reference/mssql/functions/mssql-fetch-row.xml deleted file mode 100644 index 7843a6006422..000000000000 --- a/reference/mssql/functions/mssql-fetch-row.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - mssql_fetch_row - Get row as enumerated array - - - - - &warn.removed.function.7-0-0.alternatives; - - PDOStatement::fetch - sqlsrv_fetch_array - odbc_fetch_row - - - - - - &reftitle.description; - - arraymssql_fetch_row - resourceresult - - - mssql_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. - - - Subsequent call to mssql_fetch_row would - return the next row in the result set, or &false; if there are no - more rows. - - - - - &reftitle.parameters; - - - - result - - - The result resource that is being evaluated. This result comes from a - call to mssql_query. - - - - - - - - - &reftitle.returnvalues; - - Returns an array that corresponds to the fetched row, or &false; if there - are no more rows. - - - - - &reftitle.examples; - - - <function>mssql_fetch_row</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.notes; - &database.fetch-null; - - - - &reftitle.seealso; - - - mssql_fetch_array - mssql_fetch_object - mssql_data_seek - mssql_result - - - - - - - diff --git a/reference/mssql/functions/mssql-field-length.xml b/reference/mssql/functions/mssql-field-length.xml deleted file mode 100644 index c29cd44b1464..000000000000 --- a/reference/mssql/functions/mssql-field-length.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - mssql_field_length - Get the length of a field - - - - - &warn.removed.function.7-0-0.alternatives; - - PDOStatement::getColumnMeta - sqlsrv_field_metadata - odbc_field_len - - - - - - &reftitle.description; - - intmssql_field_length - resourceresult - intoffset-1 - - - Returns the length of field no. offset in - result. - - - - - &reftitle.parameters; - - - - result - - - The result resource that is being evaluated. This result comes from a - call to mssql_query. - - - - - offset - - - The field offset, starts at 0. If omitted, the current field is used. - - - - - - - - - &reftitle.returnvalues; - - The length of the specified field index on success&return.falseforfailure;. - - - - - &reftitle.examples; - - - <function>mssql_field_length</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.notes; - - Note to Windows Users - - Due to a limitation in the underlying API used by PHP (MS DBLib C API), - the length of VARCHAR fields is limited to - 255. If you need to store more data, use a - TEXT field instead. - - - - - - &reftitle.seealso; - - - mssql_field_name - mssql_field_type - - - - - - - diff --git a/reference/mssql/functions/mssql-field-name.xml b/reference/mssql/functions/mssql-field-name.xml deleted file mode 100644 index 0c76d61391b8..000000000000 --- a/reference/mssql/functions/mssql-field-name.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - mssql_field_name - Get the name of a field - - - - - &warn.removed.function.7-0-0.alternatives; - - PDOStatement::getColumnMeta - sqlsrv_field_metadata - odbc_field_name - - - - - - &reftitle.description; - - stringmssql_field_name - resourceresult - intoffset-1 - - - Returns the name of field no. offset in - result. - - - - - &reftitle.parameters; - - - - result - - - The result resource that is being evaluated. This result comes from a - call to mssql_query. - - - - - offset - - - The field offset, starts at 0. If omitted, the current field is used. - - - - - - - - - &reftitle.returnvalues; - - The name of the specified field index on success&return.falseforfailure;. - - - - - &reftitle.examples; - - - <function>mssql_field_name</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - mssql_field_length - mssql_field_type - - - - - - - diff --git a/reference/mssql/functions/mssql-field-seek.xml b/reference/mssql/functions/mssql-field-seek.xml deleted file mode 100644 index 0cc8c22f628d..000000000000 --- a/reference/mssql/functions/mssql-field-seek.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - mssql_field_seek - Seeks to the specified field offset - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - boolmssql_field_seek - resourceresult - intfield_offset - - - Seeks to the specified field offset. If the next call to - mssql_fetch_field won't include a field - offset, this field would be returned. - - - - - &reftitle.parameters; - - - - result - - - The result resource that is being evaluated. This result comes from a - call to mssql_query. - - - - - field_offset - - - The field offset, starts at 0. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Using <function>mssql_field_seek</function> on the example for <function>mssql_fetch_field</function> - -Table structure for \'persons\''; -echo ''; - -// Table header -echo ''; -echo ''; -echo ''; -echo ''; -echo ''; -echo ''; -echo ''; - -// Dump all fields -echo ''; - -for ($i = 0; $i < mssql_num_fields($query); ++$i) { - // Fetch the field information, notice the - // field_offset parameter is not set. See - // the mssql_field_seek call below - $field = mssql_fetch_field($query); - - // Print the row - echo ''; - echo ''; - echo ''; - echo ''; - echo ''; - - // Move the internal seek pointer to the next - // row in the result set - mssql_field_seek($query, $i + 1); -} - -echo ''; -echo '
    Field nameData typeMax length
    ' . $field->name . '' . strtoupper($field->type) . '' . $field->max_length . '
    '; - -// Free the query result -mssql_free_result($query); -?> -]]> -     -     -     -     - - - &reftitle.seealso; - - - mssql_fetch_field - - - -     - - diff --git a/reference/mssql/functions/mssql-field-type.xml b/reference/mssql/functions/mssql-field-type.xml deleted file mode 100644 index 267fa306fbeb..000000000000 --- a/reference/mssql/functions/mssql-field-type.xml +++ /dev/null @@ -1,131 +0,0 @@ - - - - - mssql_field_type - Gets the type of a field - - - - - &warn.removed.function.7-0-0.alternatives; - - PDOStatement::getColumnMeta - sqlsrv_field_metadata - odbc_field_type - - - - - - &reftitle.description; - - stringmssql_field_type - resourceresult - intoffset-1 - - - Returns the type of field no. offset in - result. - - - - - &reftitle.parameters; - - - - result - - - The result resource that is being evaluated. This result comes from a - call to mssql_query. - - - - - offset - - - The field offset, starts at 0. If omitted, the current field is used. - - - - - - - - - &reftitle.returnvalues; - - The type of the specified field index on success&return.falseforfailure;. - - - - - &reftitle.examples; - - - <function>mssql_field_type</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - mssql_field_length - mssql_field_name - - - - - - - diff --git a/reference/mssql/functions/mssql-free-result.xml b/reference/mssql/functions/mssql-free-result.xml deleted file mode 100644 index 52fe7f27ec8a..000000000000 --- a/reference/mssql/functions/mssql-free-result.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - mssql_free_result - Free result memory - - - - - &warn.removed.function.7-0-0.alternatives; - - odbc_free_result - - - - - - &reftitle.description; - - boolmssql_free_result - resourceresult - - - mssql_free_result only needs to be called - if you are worried about using too much memory while your script - is running. All result memory will automatically be freed when - the script ends. You may call mssql_free_result - with the result identifier as an argument and the associated - result memory will be freed. - - - - - &reftitle.parameters; - - - - result - - - The result resource that is being freed. This result comes from a - call to mssql_query. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>mssql_free_result</function> example - - -]]> - - - - - - - &reftitle.seealso; - - - mssql_free_statement - - - - - - - diff --git a/reference/mssql/functions/mssql-free-statement.xml b/reference/mssql/functions/mssql-free-statement.xml deleted file mode 100644 index 415bc586c15a..000000000000 --- a/reference/mssql/functions/mssql-free-statement.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - mssql_free_statement - Free statement memory - - - - - &warn.removed.function.7-0-0.alternatives; - - sqlsrv_free_stmt - - - - - - &reftitle.description; - - boolmssql_free_statement - resourcestmt - - - mssql_free_statement only needs to be called - if you are worried about using too much memory while your script - is running. All statement memory will automatically be freed when - the script ends. You may call mssql_free_statement - with the statement identifier as an argument and the associated - statement memory will be freed. - - - - - &reftitle.parameters; - - - - stmt - - - Statement resource, obtained with mssql_init. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>mssql_free_statement</function> example - - -]]> - - - - - - - &reftitle.seealso; - - - mssql_bind - mssql_execute - mssql_init - mssql_free_result - - - - - - - diff --git a/reference/mssql/functions/mssql-get-last-message.xml b/reference/mssql/functions/mssql-get-last-message.xml deleted file mode 100644 index 02fd4197dafa..000000000000 --- a/reference/mssql/functions/mssql-get-last-message.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - mssql_get_last_message - Returns the last message from the server - - - - - &warn.removed.function.7-0-0.alternatives; - - PDOStatement::errorInfo - sqlsrv_errors - odbc_errormsg - - - - - - &reftitle.description; - - stringmssql_get_last_message - - - - Gets the last message from the MS-SQL server - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - Returns last error message from server, or an empty string if - no error messages are returned from MSSQL. - - - - - &reftitle.examples; - - - <function>mssql_get_last_message</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - mssql_min_error_severity - mssql_min_message_severity - - - - - - - diff --git a/reference/mssql/functions/mssql-guid-string.xml b/reference/mssql/functions/mssql-guid-string.xml deleted file mode 100644 index 551e46fac61e..000000000000 --- a/reference/mssql/functions/mssql-guid-string.xml +++ /dev/null @@ -1,102 +0,0 @@ - - - - - mssql_guid_string - Converts a 16 byte binary GUID to a string - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - stringmssql_guid_string - stringbinary - boolshort_format&false; - - - Converts a 16 byte binary GUID to a string. - - - - - &reftitle.parameters; - - - - binary - - - A 16 byte binary GUID. - - - - - short_format - - - Whenever to use short format. - - - - - - - - - &reftitle.returnvalues; - - Returns the converted string on success. - - - - - &reftitle.examples; - - - <function>mssql_guid_string</function> example - - -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/mssql/functions/mssql-init.xml b/reference/mssql/functions/mssql-init.xml deleted file mode 100644 index 6ff6730e1112..000000000000 --- a/reference/mssql/functions/mssql-init.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - mssql_init - Initializes a stored procedure or a remote stored procedure - - - - - &warn.removed.function.7-0-0.alternatives; - - - Using an EXEC query issued through - PDO_SQLSRV, - PDO_ODBC, - SQLSRV, or the - unified ODBC driver. - - - - - - - &reftitle.description; - - resourcemssql_init - stringsp_name - resourcelink_identifier - - - Initializes a stored procedure or a remote stored procedure. - - - - - &reftitle.parameters; - - - - sp_name - - - Stored procedure name, like ownew.sp_name or - otherdb.owner.sp_name. - - - - - link_identifier - - - A MS SQL link identifier, returned by - mssql_connect. - - - - - - - - - &reftitle.returnvalues; - - Returns a resource identifier "statement", used in subsequent calls to - mssql_bind and mssql_execute, - or &false; on errors. - - - - - &reftitle.examples; - - - <function>mssql_init</function> example - - -]]> - - - - - - - &reftitle.seealso; - - - mssql_bind - mssql_execute - mssql_free_statement - - - - - - - diff --git a/reference/mssql/functions/mssql-min-error-severity.xml b/reference/mssql/functions/mssql-min-error-severity.xml deleted file mode 100644 index 7611aaafb4e2..000000000000 --- a/reference/mssql/functions/mssql-min-error-severity.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - mssql_min_error_severity - Sets the minimum error severity - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - voidmssql_min_error_severity - intseverity - - - Sets the minimum error severity. - - - - - &reftitle.parameters; - - - - severity - - - The new error severity. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>mssql_min_error_severity</function> example - - -]]> - - - - - - - - diff --git a/reference/mssql/functions/mssql-min-message-severity.xml b/reference/mssql/functions/mssql-min-message-severity.xml deleted file mode 100644 index 6b54ace2be27..000000000000 --- a/reference/mssql/functions/mssql-min-message-severity.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - mssql_min_message_severity - Sets the minimum message severity - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - voidmssql_min_message_severity - intseverity - - - Sets the minimum message severity. - - - - - &reftitle.parameters; - - - - severity - - - The new message severity. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - <function>mssql_min_message_severity</function> example - - -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/mssql/functions/mssql-next-result.xml b/reference/mssql/functions/mssql-next-result.xml deleted file mode 100644 index 8a4d570dfb5f..000000000000 --- a/reference/mssql/functions/mssql-next-result.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - mssql_next_result - Move the internal result pointer to the next result - - - - - &warn.removed.function.7-0-0.alternatives; - - PDOStatement::nextRowset - sqlsrv_next_result - odbc_next_result - - - - - - &reftitle.description; - - boolmssql_next_result - resourceresult_id - - - When sending more than one SQL statement to the server or - executing a stored procedure with multiple results, it will cause - the server to return multiple result sets. This function will - test for additional results available form the server. If an - additional result set exists it will free the existing result set - and prepare to fetch the rows from the new result set. - - - - - &reftitle.parameters; - - - - result_id - - - The result resource that is being evaluated. This result comes from a - call to mssql_query. - - - - - - - - - &reftitle.returnvalues; - - Returns &true; if an additional result set was available or &false; - otherwise. - - - - - &reftitle.examples; - - - <function>mssql_next_result</function> example - - -]]> - - - - - - - - diff --git a/reference/mssql/functions/mssql-num-fields.xml b/reference/mssql/functions/mssql-num-fields.xml deleted file mode 100644 index d2e84121d3f7..000000000000 --- a/reference/mssql/functions/mssql-num-fields.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - mssql_num_fields - Gets the number of fields in result - - - - - &warn.removed.function.7-0-0.alternatives; - - PDOStatement::columnCount - sqlsrv_num_fields - odbc_num_fields - - - - - - &reftitle.description; - - intmssql_num_fields - resourceresult - - - mssql_num_fields returns the number of - fields in a result set. - - - - - &reftitle.parameters; - - - - result - - - The result resource that is being evaluated. This result comes from a - call to mssql_query. - - - - - - - - - &reftitle.returnvalues; - - Returns the number of fields, as an integer. - - - - - &reftitle.examples; - - - <function>mssql_num_fields</function> example - -'; - -$header = false; - -// Iterate through returned results -while ($row = mssql_fetch_array($data)) { - // Build the table header - if (!$header) { - echo ''; - echo ''; - - for ($i = 1; ($i + 1) <= mssql_num_fields($data); ++$i) { - echo '' . ucfirst($row[$i]) . ''; - } - - echo ''; - echo ''; - echo ''; - - $header = true; - } - - // Build the row - echo ''; - - foreach($row as $value) { - echo '' . $value . ''; - } - - echo ''; -} - -// Close table -echo ''; -echo ''; - -// Clean up -mssql_free_result($data); -mssql_close($link); -?> -]]> - - - - - - - &reftitle.seealso; - - - mssql_query - mssql_fetch_field - mssql_num_rows - - - - - - - diff --git a/reference/mssql/functions/mssql-num-rows.xml b/reference/mssql/functions/mssql-num-rows.xml deleted file mode 100644 index e1f34406a2f0..000000000000 --- a/reference/mssql/functions/mssql-num-rows.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - mssql_num_rows - Gets the number of rows in result - - - - - &warn.removed.function.7-0-0.alternatives; - - PDOStatement::rowCount - sqlsrv_num_rows - odbc_num_rows - - - - - - &reftitle.description; - - intmssql_num_rows - resourceresult - - - mssql_num_rows returns the number of rows in - a result set. - - - - - &reftitle.parameters; - - - - result - - - The result resource that is being evaluated. This result comes from a - call to mssql_query. - - - - - - - - - &reftitle.returnvalues; - - Returns the number of rows, as an integer. - - - - - &reftitle.examples; - - - <function>mssql_num_rows</function> example - - -]]> - - - - - - - &reftitle.seealso; - - - mssql_query - mssql_fetch_row - - - - - - - diff --git a/reference/mssql/functions/mssql-pconnect.xml b/reference/mssql/functions/mssql-pconnect.xml deleted file mode 100644 index fe90f83d1860..000000000000 --- a/reference/mssql/functions/mssql-pconnect.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - mssql_pconnect - Open persistent MS SQL connection - - - - - &warn.removed.function.7-0-0.alternatives; - - PDO::__construct - sqlsrv_connect - odbc_pconnect - - - - - - &reftitle.description; - - resourcemssql_pconnect - stringservername - stringusername - stringpassword - boolnew_link&false; - - - mssql_pconnect acts very much like - mssql_connect with two major differences. - - - First, when connecting, the function would first try to find a - (persistent) link that's already open with the same host, - username and password. If one is found, an identifier for it - will be returned instead of opening a new connection. - - - Second, the connection to the SQL server will not be closed when - the execution of the script ends. Instead, the link will remain - open for future use (mssql_close will not - close links established by mssql_pconnect). - - - This type of links is therefore called 'persistent'. - - - - - &reftitle.parameters; - - - - servername - - - The MS SQL server. It can also include a port number. e.g. - hostname:port. - - - - - username - - - The username. - - - - - password - - - The password. - - - - - new_link - - - If a second call is made to mssql_pconnect with - the same arguments, no new link will be established, but instead, the - link identifier of the already opened link will be returned. This - parameter modifies this behavior and makes - mssql_pconnect always open a new link, even if - mssql_pconnect was called before with the same - parameters. - - - - - - - - - &reftitle.returnvalues; - - Returns a positive MS SQL persistent link identifier on success, or - &false; on error. - - - - - &reftitle.examples; - - - <function>mssql_pconnect</function> using the <parameter>new_link</parameter> parameter - - -]]> - - - - - - - - diff --git a/reference/mssql/functions/mssql-query.xml b/reference/mssql/functions/mssql-query.xml deleted file mode 100644 index 68e0e969c4a5..000000000000 --- a/reference/mssql/functions/mssql-query.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - mssql_query - Send MS SQL query - - - - - &warn.removed.function.7-0-0.alternatives; - - PDO::query - sqlsrv_query - odbc_exec - - - - - - &reftitle.description; - - mixedmssql_query - stringquery - resourcelink_identifier - intbatch_size0 - - - mssql_query sends a query to the currently active - database on the server that's associated with the specified link - identifier. - - - - - &reftitle.parameters; - - - - query - - - An SQL query. - - - - - link_identifier - - - A MS SQL link identifier, returned by - mssql_connect or - mssql_pconnect. - - - If the 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 mssql_connect was called, and use it. - - - - - batch_size - - - The number of records to batch in the buffer. - - - - - - - - - &reftitle.returnvalues; - - Returns a MS SQL result resource on success, &true; if no rows were - returned, or &false; on error. - - - - - &reftitle.examples; - - - <function>mssql_query</function> example - - -]]> - - - - - - - &reftitle.notes; - - - If the query returns multiple results then it is necessary to fetch all - results by mssql_next_result or free the results by - mssql_free_result before executing next query. - - - - - - &reftitle.seealso; - - - mssql_select_db - mssql_connect - - - - - - - diff --git a/reference/mssql/functions/mssql-result.xml b/reference/mssql/functions/mssql-result.xml deleted file mode 100644 index 80a18450dbf7..000000000000 --- a/reference/mssql/functions/mssql-result.xml +++ /dev/null @@ -1,192 +0,0 @@ - - - - - mssql_result - Get result data - - - - - &warn.removed.function.7-0-0.alternatives; - - odbc_result - - - - - - &reftitle.description; - - stringmssql_result - resourceresult - introw - mixedfield - - - mssql_result returns the contents of one cell from a - MS SQL result set. - - - - - &reftitle.parameters; - - - - result - - - The result resource that is being evaluated. This result comes from a - call to mssql_query. - - - - - row - - - The row number. - - - - - field - - - Can be the field's offset, the field's name or the field's table dot - field's name (tablename.fieldname). If the column name has been - aliased ('select foo as bar from...'), it uses the alias instead of - the column name. - - - - Specifying a numeric offset for the field - argument is much quicker than specifying a - fieldname or - tablename.fieldname argument. - - - - - - - - - - &reftitle.returnvalues; - - Returns the contents of the specified cell. - - - - - &reftitle.examples; - - - <function>mssql_result</function> example - - -]]> - - &example.outputs.similar; - - - - - - - - Faster alternative to above example - - -]]> - - - - - - - &reftitle.notes; - - - When working on large result sets, you should consider using one of the - functions that fetch an entire row (specified below). As these functions - return the contents of multiple cells in one function call, they're MUCH - quicker than mssql_result. - - - - - - &reftitle.seealso; - - Recommended high-performance alternatives: - - mssql_fetch_row - mssql_fetch_array - mssql_fetch_assoc - mssql_fetch_object - - - - - - - diff --git a/reference/mssql/functions/mssql-rows-affected.xml b/reference/mssql/functions/mssql-rows-affected.xml deleted file mode 100644 index 08826665e9a6..000000000000 --- a/reference/mssql/functions/mssql-rows-affected.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - mssql_rows_affected - Returns the number of records affected by the query - - - - - &warn.removed.function.7-0-0.alternatives; - - PDOStatement::rowCount - sqlsrv_rows_affected - - - - - - &reftitle.description; - - intmssql_rows_affected - resourcelink_identifier - - - Returns the number of records affected by the last write query. - - - - - &reftitle.parameters; - - - - link_identifier - - - A MS SQL link identifier, returned by - mssql_connect or - mssql_pconnect. - - - - - - - - - &reftitle.returnvalues; - - Returns the number of records affected by last operation. - - - - - &reftitle.examples; - - - <function>mssql_rows_affected</function> example - - -]]> - - - - - - - - diff --git a/reference/mssql/functions/mssql-select-db.xml b/reference/mssql/functions/mssql-select-db.xml deleted file mode 100644 index 4ffbc86d679d..000000000000 --- a/reference/mssql/functions/mssql-select-db.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - mssql_select_db - Select MS SQL database - - - - - &warn.removed.function.7-0-0.alternatives; - - - PDO_SQLSRV DSN - - - PDO_ODBC DSN - - sqlsrv_connect - odbc_connect - - - - - - &reftitle.description; - - boolmssql_select_db - stringdatabase_name - resourcelink_identifier - - - mssql_select_db sets the current active - database on the server that's associated with the specified link - identifier. - - - Every subsequent call to mssql_query will be - made on the active database. - - - - - &reftitle.parameters; - - - - database_name - - - The database name. - - - To escape the name of a database that contains spaces, hyphens ("-"), - or any other exceptional characters, the database name must be - enclosed in brackets, as is shown in the example, below. This - technique must also be applied when selecting a database name that is - also a reserved word (such as primary). - - - - - link_identifier - - - A MS SQL link identifier, returned by - mssql_connect or - mssql_pconnect. - - - If no link identifier is specified, the last opened link is assumed. - If no link is open, the function will try to establish a link as if - mssql_connect was called, and use it. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>mssql_select_db</function> example - - -]]> - - - - - - Escaping the database name with square brackets - - -]]> - - - - - - - &reftitle.seealso; - - - mssql_connect - mssql_pconnect - mssql_query - - - - - - - diff --git a/reference/mssql/ini.xml b/reference/mssql/ini.xml deleted file mode 100644 index 9fd7e8b47797..000000000000 --- a/reference/mssql/ini.xml +++ /dev/null @@ -1,136 +0,0 @@ - - -
    - &reftitle.runtime; - &extension.runtime; - - - MS SQL Server configuration options - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - mssql.allow_persistent - "1" - PHP_INI_SYSTEM - - - - mssql.max_persistent - "-1" - PHP_INI_SYSTEM - - - - mssql.max_links - "-1" - PHP_INI_SYSTEM - - - - mssql.min_error_severity - "10" - PHP_INI_ALL - - - - mssql.min_message_severity - "10" - PHP_INI_ALL - - - - mssql.compatibility_mode - "0" - PHP_INI_ALL - - - - mssql.connect_timeout - "5" - PHP_INI_ALL - - - - mssql.timeout - "60" - PHP_INI_ALL - Available since PHP 4.1.0. - - - mssql.textsize - "-1" - PHP_INI_ALL - - - - mssql.textlimit - "-1" - PHP_INI_ALL - - - - mssql.batchsize - "0" - PHP_INI_ALL - Available since PHP 4.0.4. - - - mssql.datetimeconvert - "1" - PHP_INI_ALL - Available since PHP 4.2.0. - - - mssql.secure_connection - "0" - PHP_INI_SYSTEM - Available since PHP 4.3.0. - - - mssql.max_procs - "-1" - PHP_INI_ALL - Available since PHP 4.3.0. - - - mssql.charset - "" - PHP_INI_ALL - Available since PHP 5.1.2 when built with FreeTDS 7.0 or greater. - - - -
    - &ini.php.constants; -     -
    - - - diff --git a/reference/mssql/reference.xml b/reference/mssql/reference.xml deleted file mode 100644 index fd1639f83a92..000000000000 --- a/reference/mssql/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - Mssql &Functions; - -&reference.mssql.entities.functions; - - - - - diff --git a/reference/mssql/setup.xml b/reference/mssql/setup.xml deleted file mode 100644 index 0e66b824f277..000000000000 --- a/reference/mssql/setup.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Requirements for Win32 platforms. - - - The extension requires the MS SQL Client Tools to be installed - on the system where PHP is installed. The Client Tools can - be installed from the MS SQL Server CD or by copying - ntwdblib.dll from - \winnt\system32 on the server to - \winnt\system32 on the PHP box. - Copying ntwdblib.dll will only provide access - through named pipes. - Configuration of the client will require installation of all the tools. - - - This extension is not available anymore on Windows with PHP 5.3 or later. - - - SqlSrv, an alternative driver for MS SQL is available from Microsoft: &url.sqlsrv;. - - - Requirements for Unix/Linux platforms. - - - To use the MSSQL extension on Unix/Linux, you first need to build and - install the FreeTDS library. Source code and installation instructions - are available at the FreeTDS home page: - &url.freetds; - - - - On Windows, the DBLIB from Microsoft is used. Functions that return a - column name are based on the dbcolname() function - in DBLIB. DBLIB was developed for SQL Server 6.x where the max - identifier length is 30. For this reason, the maximum column length - is 30 characters. On platforms where FreeTDS is used (Linux), this is - not a problem. - - - - - On Windows, if you're using MSSQL 2005 or greater you must copy the - ntwdblib.dll into the directory where you have - installed php and overwrite the one thats already in there. This is - due to the version distributed is old and outdated. Alternatively you - can use the &url.sqlsrv;, - ODBC, - PDO_DBLIB or - PDO_ODBC extensions, to talk to MSSQL. - - -
    - - - - &reference.mssql.configure; - - - - &reference.mssql.ini; - - - -
    - &reftitle.resources; -
    - mssql link - - A connection link returned by mssql_connect - and mssql_pconnect. - -
    -
    - mssql result - - A result handle returned by mssql_query on - SELECT queries. - -
    -
    - mssql statement - - A statement handle returned by mssql_init. - -
    -
    - - -     - - - diff --git a/reference/mssql/versions.xml b/reference/mssql/versions.xml deleted file mode 100644 index 448d1ecf903e..000000000000 --- a/reference/mssql/versions.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/mysql/functions/mysql-db-query.xml b/reference/mysql/functions/mysql-db-query.xml index 6bd6177902fc..6ecb397e8b1d 100644 --- a/reference/mysql/functions/mysql-db-query.xml +++ b/reference/mysql/functions/mysql-db-query.xml @@ -69,30 +69,6 @@     - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function now throws an E_DEPRECATED notice. - - - - - - - - &reftitle.examples; diff --git a/reference/mysql/functions/mysql-escape-string.xml b/reference/mysql/functions/mysql-escape-string.xml index 2fc8b8c8574f..598124abc7d5 100644 --- a/reference/mysql/functions/mysql-escape-string.xml +++ b/reference/mysql/functions/mysql-escape-string.xml @@ -59,37 +59,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function now throws an E_DEPRECATED notice. - - - - 4.3.0 - - This function became deprecated, do not use this function. Instead, - use mysql_real_escape_string. - - - - - - - - &reftitle.examples; diff --git a/reference/mysql/versions.xml b/reference/mysql/versions.xml index dcf4156c20b7..71455b957c84 100644 --- a/reference/mysql/versions.xml +++ b/reference/mysql/versions.xml @@ -14,13 +14,11 @@ - - @@ -55,7 +53,6 @@ - diff --git a/reference/mysqli/mysqli/construct.xml b/reference/mysqli/mysqli/construct.xml index 42e8dc3803ce..a5e9c516d18f 100644 --- a/reference/mysqli/mysqli/construct.xml +++ b/reference/mysqli/mysqli/construct.xml @@ -129,30 +129,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - Added the ability of persistent connections. - - - - - - - - &reftitle.examples; diff --git a/reference/mysqli/mysqli/options.xml b/reference/mysqli/mysqli/options.xml index 9eeb696ba8e3..8c55868d9287 100644 --- a/reference/mysqli/mysqli/options.xml +++ b/reference/mysqli/mysqli/options.xml @@ -139,40 +139,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.5.0 - - The MYSQLI_SERVER_PUBLIC_KEY option was added. - - - - 5.3.0 - - The MYSQLI_OPT_INT_AND_FLOAT_NATIVE, - MYSQLI_OPT_NET_CMD_BUFFER_SIZE, - MYSQLI_OPT_NET_READ_BUFFER_SIZE, and - MYSQLI_OPT_SSL_VERIFY_SERVER_CERT options were - added. - - - - - - - - &reftitle.examples; diff --git a/reference/mysqli/mysqli/query.xml b/reference/mysqli/mysqli/query.xml index 55ad0eb8ecec..d772d70cfef0 100644 --- a/reference/mysqli/mysqli/query.xml +++ b/reference/mysqli/mysqli/query.xml @@ -118,30 +118,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - Added the ability of async queries. - - - - - - - - &reftitle.examples; diff --git a/reference/mysqli/mysqli_driver/report-mode.xml b/reference/mysqli/mysqli_driver/report-mode.xml index 10a50a5c9c7c..5145407c2726 100644 --- a/reference/mysqli/mysqli_driver/report-mode.xml +++ b/reference/mysqli/mysqli_driver/report-mode.xml @@ -83,36 +83,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.4 - - Changing the reporting mode is now be per-request, rather than per-process. - - - - 5.2.15 - - Changing the reporting mode is now be per-request, rather than per-process. - - - - - - - - &reftitle.examples; diff --git a/reference/mysqlnd_qc/book.xml b/reference/mysqlnd_qc/book.xml index f759333749ce..bc1b3317296b 100644 --- a/reference/mysqlnd_qc/book.xml +++ b/reference/mysqlnd_qc/book.xml @@ -97,7 +97,7 @@ - APC + APC diff --git a/reference/mysqlnd_qc/ini.xml b/reference/mysqlnd_qc/ini.xml index aa9bea5ba33f..650915df0e1b 100644 --- a/reference/mysqlnd_qc/ini.xml +++ b/reference/mysqlnd_qc/ini.xml @@ -221,13 +221,9 @@ Use PHP global request time to avoid gettimeofday() system calls? If using - - APC - storage handler + APC storage handler it should be set to the value of - - apc.use_request_time - , if not + apc.use_request_time, if not warnings will be generated. @@ -329,9 +325,7 @@ Activates handler based slam defense (cache stampeding protection) if available. Supported by Default and - - APC - storage handler + APC storage handler @@ -344,10 +338,7 @@ TTL for stale cache entries which are served while another client updates the entries. Supported by - - APC - - storage handler. + APC storage handler. @@ -385,9 +376,7 @@ The - - APC - storage handler stores data in the + APC storage handler stores data in the APC user cache. The setting sets a prefix to be used for cache entries. diff --git a/reference/mysqlnd_qc/setup.xml b/reference/mysqlnd_qc/setup.xml index 1cf1f07b0137..897945f995de 100644 --- a/reference/mysqlnd_qc/setup.xml +++ b/reference/mysqlnd_qc/setup.xml @@ -15,16 +15,6 @@ mysql, or PDO_MYSQL) must enable the mysqlnd library. - - For using the APC storage handler with PECL/mysqlnd_qc 1.0 - APC 3.1.3p1-beta or newer. - PECL/mysqlnd_qc 1.2 has been tested with APC 3.1.13-beta. - The APC storage handler cannot be used with a shared build. You cannot use the PHP - configuration directive extension to load the APC and PECL/mysqlnd_qc - extensions if PECL/mysqlnd_qc will use APC as a storage handler. For using - the APC storage handler, you have to statically compile PHP with APC and PECL/mysqlnd_qc - support into PHP. - For using MEMCACHE storage handler: diff --git a/reference/net_gopher/book.xml b/reference/net_gopher/book.xml deleted file mode 100644 index 6d6e5b88fba8..000000000000 --- a/reference/net_gopher/book.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - Net Gopher - Gopher - - - - &reftitle.intro; - - The gopher protocol, as defined by RFC 1436, - is generally considered the ancestor of the modern HTTP protocol. - However, gopher was also intended to provide references to non-gopher - resources including telnet, wais, nntp, and even http. This extension - adds gopher support to PHP's URL Wrappers, - and provides a helper function gopher_parsedir to - make sense of gopher formatted directory listings. - - - - - &reference.net-gopher.setup; - &reference.net-gopher.constants; - &reference.net-gopher.examples; - &reference.net-gopher.reference; - - - - - diff --git a/reference/net_gopher/configure.xml b/reference/net_gopher/configure.xml deleted file mode 100644 index b02ca8076762..000000000000 --- a/reference/net_gopher/configure.xml +++ /dev/null @@ -1,30 +0,0 @@ - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;net_gopher - -
    - - diff --git a/reference/net_gopher/constants.xml b/reference/net_gopher/constants.xml deleted file mode 100644 index bbb86c58ab38..000000000000 --- a/reference/net_gopher/constants.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - Net_Gopher constants - - - - Constant - Value - Description - - - - - GOPHER_DOCUMENT - 0 - Standard text/plain document. - - - GOPHER_DIRECTORY - 1 - A resource containing a gopher formatted directory listing. - - - GOPHER_BINHEX - 4 - A BinHex encoded binary file. - - - GOPHER_DOSBINARY - 5 - A DOS formatted binary archive. - - - GOPHER_UUENCODED - 6 - A UUEncoded file. - - - GOPHER_BINARY - 9 - A generic binary file. - - - GOPHER_INFO - 255 - An Informational entry - - - GOPHER_HTTP - 254 - A reference to an HTTP resource. - - - GOPHER_UNKNOWN - -1 - - An unrecognized entry. - - - - -
    -     - - diff --git a/reference/net_gopher/examples.xml b/reference/net_gopher/examples.xml deleted file mode 100644 index 7ba999c2cbb0..000000000000 --- a/reference/net_gopher/examples.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - &reftitle.examples; -
    - Basic Example - - - -]]> - - -
    -     - - - - diff --git a/reference/net_gopher/functions/gopher-parsedir.xml b/reference/net_gopher/functions/gopher-parsedir.xml deleted file mode 100644 index 974dfb19a98b..000000000000 --- a/reference/net_gopher/functions/gopher-parsedir.xml +++ /dev/null @@ -1,227 +0,0 @@ - - - - - - gopher_parsedir - Translate a gopher formatted directory entry into an associative array - - - - &reftitle.description; - - arraygopher_parsedir - stringdirent - - - gopher_parsedir parses a gopher formatted directory - entry into an associative array. - - - While gopher returns text/plain documents for - actual document requests. A request to a directory (such as /) will - return specially encoded series of lines with each line being one - directory entry or information line. - - - - - &reftitle.parameters; - - - - dirent - - - The directory entry. - - - - - - - - - &reftitle.returnvalues; - - Returns an associative array whose components are: - - - - type - One of the - GOPHER_XXX constants. - - - - - title - The name of the resource. - - - - - path - The path of the resource. - - - - - host - The domain name of the host that has - this document (or directory). - - - - - port - The port at which to connect on - host. - - - - - - Upon failure, the additional data entry of the - returned array will hold the parsed line. - - - - - &reftitle.examples; - - - Hypothetical output from <literal>gopher://gopher.example.com/</literal> - - - - - - - In the example above, the root directory at gopher.example.com knows about - one DOCUMENT identified by 0 located at - gopher://gopher.example.com:70/allabout.txt. It also knows - about two other directory (which have their own listing files) at - gopher://gopher.exmaple.com:70/stories and at - gopher://gopher.ejemplo.co.es:70/. - In addition there is a binary file, a link to an HTTP url, and several - informative lines. - - - By passing each line of the directory listing into - gopher_parsedir, an associative array is formed containing - a parsed out version of the data. - - - - Using <function>gopher_parsedir</function> - - -]]> - - &example.outputs; - - 0 - [title] => All about my gopher site. - [path] => /allabout.txt - [host] => gopher.example.com - [port] => 70 -) -Array ( - [type] => 9 - [title] => A picture of my cat. - [path] => /pics/cat.png - [host] => gopher.example.com - [port] => 70 -) -Array ( - [type] => 1 - [title] => A collection of my writings. - [path] => /stories - [host] => gopher.example.com - [port] => 70 -) -Array ( - [type] => 254 - [title] => The HTTP version of this site. - [path] => URL:http://www.example.com - [host] => gopher.example.com - [port] => 70 -) -Array ( - [type] => 1 - [title] => Mirror of this site in Spain. - [path] => / - [host] => gopher.ejemplo.co.es - [port] => 70 -) -Array ( - [type] => 255 - [title] => Welcome to my gopher site. - [path] => - [host] => error.host - [port] => 1 -) -Array ( - [type] => 255 - [title] => Please select one of the options above. - [path] => - [host] => error.host - [port] => 1 -) -Array ( - [type] => 255 - [title] => Send complaints to /dev/null - [path] => - [host] => error.host - [port] => 1 -) -Array ( - [type] => 255 - [title] => Long live gopher! - [path] => - [host] => error.host - [port] => 1 -) -]]> - - - - - - - - diff --git a/reference/net_gopher/reference.xml b/reference/net_gopher/reference.xml deleted file mode 100644 index 22989c6440eb..000000000000 --- a/reference/net_gopher/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - Gopher &Functions; - -&reference.net-gopher.entities.functions; - - - - - diff --git a/reference/net_gopher/setup.xml b/reference/net_gopher/setup.xml deleted file mode 100644 index cb9b080ee84a..000000000000 --- a/reference/net_gopher/setup.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - &no.requirement; -
    - - - - &reference.net-gopher.configure; - - - -
    - &reftitle.runtime; - &no.config; -
    - - - -
    - &reftitle.resources; - &no.resource; -
    - - -     - - - diff --git a/reference/net_gopher/versions.xml b/reference/net_gopher/versions.xml deleted file mode 100644 index 6e1d3b4ed877..000000000000 --- a/reference/net_gopher/versions.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - - \ No newline at end of file diff --git a/reference/network/functions/checkdnsrr.xml b/reference/network/functions/checkdnsrr.xml index 995d8270f06e..0a8053da5f9c 100644 --- a/reference/network/functions/checkdnsrr.xml +++ b/reference/network/functions/checkdnsrr.xml @@ -53,36 +53,6 @@     - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function is now available on Windows platforms. - - - - 5.2.4 - - TXT type was added. - - - - - - - - &reftitle.notes; diff --git a/reference/network/functions/dns-get-record.xml b/reference/network/functions/dns-get-record.xml index c888ddc757b6..388f8f09277d 100644 --- a/reference/network/functions/dns-get-record.xml +++ b/reference/network/functions/dns-get-record.xml @@ -312,26 +312,6 @@ Added support for CAA record type. - - 5.4.0 - - Added raw parameter. - - - - 5.3.0 - - This function is now available on Windows platforms. - - - - 5.3.0 - - Prior to this release, if the authns parameter - was given, the addtl parameter was also - required. - - diff --git a/reference/network/functions/getmxrr.xml b/reference/network/functions/getmxrr.xml index 255d6b76dea7..f744150e8857 100644 --- a/reference/network/functions/getmxrr.xml +++ b/reference/network/functions/getmxrr.xml @@ -62,30 +62,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function is now available on Windows platforms. - - - - - - - - &reftitle.notes; diff --git a/reference/network/functions/header.xml b/reference/network/functions/header.xml index c6c5886b1472..1e502f241628 100644 --- a/reference/network/functions/header.xml +++ b/reference/network/functions/header.xml @@ -141,31 +141,6 @@ header('WWW-Authenticate: NTLM', false); - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.2 - - This function now prevents more than one header to be sent at once as - a protection against header injection attacks. - - - - - - - - &reftitle.examples; diff --git a/reference/network/functions/inet-ntop.xml b/reference/network/functions/inet-ntop.xml index fbfbf7c8363f..132ad837073a 100644 --- a/reference/network/functions/inet-ntop.xml +++ b/reference/network/functions/inet-ntop.xml @@ -68,30 +68,6 @@ echo $expanded; - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function is now available on Windows platforms. - - - - - - - - &reftitle.seealso; diff --git a/reference/network/functions/inet-pton.xml b/reference/network/functions/inet-pton.xml index 6ca6b9735b7e..abe968eec418 100644 --- a/reference/network/functions/inet-pton.xml +++ b/reference/network/functions/inet-pton.xml @@ -63,30 +63,6 @@ $in6_addr = inet_pton('::1'); - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function is now available on Windows platforms. - - - - - - - - &reftitle.seealso; diff --git a/reference/network/functions/ip2long.xml b/reference/network/functions/ip2long.xml index ba99587c7c1d..5193541965e6 100644 --- a/reference/network/functions/ip2long.xml +++ b/reference/network/functions/ip2long.xml @@ -48,40 +48,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.5.0 - - Prior to this version, on Windows ip2long would sometimes return - a valid number even if passed a value which was not an (IPv4) Internet Protocol - dotted address. - - - - 5.2.10 - - Prior to this version, ip2long would sometimes return - a valid number even if passed a value which was not an (IPv4) Internet Protocol - dotted address. - - - - - - - - &reftitle.examples; diff --git a/reference/network/functions/setcookie.xml b/reference/network/functions/setcookie.xml index 5669eb0af553..df7d2188d14f 100644 --- a/reference/network/functions/setcookie.xml +++ b/reference/network/functions/setcookie.xml @@ -307,19 +307,6 @@ one : cookieone SameSite cookie attribute. - - 5.5.0 - - A Max-Age attribute is now included in the Set-Cookie header sent to - the client. - - - - 5.2.0 - - The httponly parameter was added. - - diff --git a/reference/network/functions/setrawcookie.xml b/reference/network/functions/setrawcookie.xml index b2772903230a..cba567e1f288 100644 --- a/reference/network/functions/setrawcookie.xml +++ b/reference/network/functions/setrawcookie.xml @@ -66,19 +66,6 @@ SameSite cookie attribute. - - 5.5.0 - - A Max-Age attribute is now included in the Set-Cookie header sent to - the client. - - - - 5.2.0 - - The httponly parameter was added. - - diff --git a/reference/newt/book.xml b/reference/newt/book.xml deleted file mode 100644 index add71fbd01d7..000000000000 --- a/reference/newt/book.xml +++ /dev/null @@ -1,49 +0,0 @@ - - - - - - Newt - - - - &reftitle.intro; - - This is a PHP language extension for RedHat Newt library, a terminal-based - window and widget library for writing applications with user friendly interface. - Once this extension is enabled in PHP it will provide the use of Newt - widgets, such as windows, buttons, checkboxes, radiobuttons, labels, - editboxes, scrolls, textareas, scales, etc. Use of this extension is very - similar to the original Newt API of C programming language. - - - - - &reference.newt.setup; - &reference.newt.constants; - &reference.newt.examples; - &reference.newt.reference; - - - - - diff --git a/reference/newt/configure.xml b/reference/newt/configure.xml deleted file mode 100644 index 9ce9f2750804..000000000000 --- a/reference/newt/configure.xml +++ /dev/null @@ -1,49 +0,0 @@ - - -
    - &reftitle.install; - - &pecl.moved; - &pecl.info; - &url.pecl.package;newt. - - - In order to use these functions you must compile CGI or CLI PHP with - newt support by using the - configure option. - - - - This extension is not available for Windows platform. - - - You may need also curses and slang - libraries, in order to compile this extension. To specify locations - of these libraries, use the following configuration options: - - --with-curses-dir=/path/to/libcurses - --with-slang-dir=/path/to/libslang - - -
    - - diff --git a/reference/newt/constants.xml b/reference/newt/constants.xml deleted file mode 100644 index 2e2101548cb2..000000000000 --- a/reference/newt/constants.xml +++ /dev/null @@ -1,674 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - -
    - Newt form exit reasons - - Newt form exit reasons - - - - constant - meaning - - - - - NEWT_EXIT_HOTKEY - hotkey defined by newt_form_add_hot_key was pressed - - - NEWT_EXIT_COMPONENT - some component has caused form to exit - - - NEWT_EXIT_FDREADY - file descriptor specified in - newt_form_watch_fd is ready to be read or written - to - - - NEWT_EXIT_TIMER - time specified in newt_form_set_timer has - elapsed - - - -
    -
    - -
    - Newt colorsets - - Newt colorsets - - - - constant - meaning - - - - - NEWT_COLORSET_ROOT - - - - NEWT_COLORSET_BORDER - - - - NEWT_COLORSET_WINDOW - - - - NEWT_COLORSET_SHADOW - - - - NEWT_COLORSET_TITLE - - - - NEWT_COLORSET_BUTTON - - - - NEWT_COLORSET_ACTBUTTON - - - - NEWT_COLORSET_CHECKBOX - - - - NEWT_COLORSET_ACTCHECKBOX - - - - NEWT_COLORSET_ENTRY - - - - NEWT_COLORSET_LABEL - - - - NEWT_COLORSET_LISTBOX - - - - NEWT_COLORSET_ACTLISTBOX - - - - NEWT_COLORSET_TEXTBOX - - - - NEWT_COLORSET_ACTTEXTBOX - - - - NEWT_COLORSET_HELPLINE - - - - NEWT_COLORSET_ROOTTEXT - - - - NEWT_COLORSET_EMPTYSCALE - - - - NEWT_COLORSET_FULLSCALE - - - - NEWT_COLORSET_DISENTRY - - - - NEWT_COLORSET_COMPACTBUTTON - - - - NEWT_COLORSET_ACTSELLISTBOX - - - - NEWT_COLORSET_SELLISTBOX - - - - -
    -
    - -
    - Newt argument flags - - Newt argument flags - - - - constant - meaning - - - - - NEWT_ARG_LAST - - - - NEWT_ARG_APPEND - - - - -
    -
    - -
    - Newt Flags Sense - - Newt Flags Sense - - - - constant - meaning - - - - - NEWT_FLAGS_SET - - - - NEWT_FLAGS_RESET - - - - NEWT_FLAGS_TOGGLE - - - - -
    -
    - -
    - Newt Components Flags - - Newt Components Flags - - - - constant - meaning - - - - - NEWT_FLAG_RETURNEXIT - Exit form, when component is activated - - - NEWT_FLAG_HIDDEN - Component is hidden - - - NEWT_FLAG_SCROLL - Component is scrollable - - - NEWT_FLAG_DISABLED - Component is disabled - - - NEWT_FLAG_BORDER - - - - NEWT_FLAG_WRAP - Wrap text - - - NEWT_FLAG_NOF12 - Don't exit form on pressing F12 - - - NEWT_FLAG_MULTIPLE - - - - NEWT_FLAG_SELECTED - Component is selected - - - NEWT_FLAG_CHECKBOX - Component is checkbox - - - NEWT_FLAG_PASSWORD - Entry component is password entry - - - NEWT_FLAG_SHOWCURSOR - Show cursor - - - -
    -
    - -
    - File Descriptor Flags - - File Descriptor Flags - - - - constant - meaning - - - - - NEWT_FD_READ - - - - NEWT_FD_WRITE - - - - NEWT_FD_EXCEPT - - - - -
    -
    - -
    - Checkbox Tree Flags - - Checkbox Tree Flags - - - - constant - meaning - - - - - NEWT_CHECKBOXTREE_UNSELECTABLE - - - - NEWT_CHECKBOXTREE_HIDE_BOX - - - - NEWT_CHECKBOXTREE_COLLAPSED - - - - NEWT_CHECKBOXTREE_EXPANDED - - - - NEWT_CHECKBOXTREE_UNSELECTED - - - - NEWT_CHECKBOXTREE_SELECTED - - - - -
    -
    - -
    - Entry Flags - - Entry Flags - - - - constant - meaning - - - - - NEWT_ENTRY_SCROLL - - - - NEWT_ENTRY_HIDDEN - - - - NEWT_ENTRY_RETURNEXIT - - - - NEWT_ENTRY_DISABLED - - - - -
    -
    - -
    - Listbox Flags - - Listbox Flags - - - - constant - meaning - - - - - NEWT_LISTBOX_RETURNEXIT - - - - -
    -
    - -
    - Textbox Flags - - Textbox Flags - - - - constant - meaning - - - - - NEWT_TEXTBOX_WRAP - Wrap text in the textbox - - - NEWT_TEXTBOX_SCROLL - Scroll text in the textbox - - - -
    -
    - -
    - Form Flags - - Form Flags - - - - constant - meaning - - - - - NEWT_FORM_NOF12 - Don't exit form on F12 press - - - -
    -
    - -
    - Newt Keys - - Newt Keys - - - - constant - meaning - - - - - NEWT_KEY_TAB - - - - NEWT_KEY_ENTER - - - - NEWT_KEY_SUSPEND - - - - NEWT_KEY_ESCAPE - - - - NEWT_KEY_RETURN - - - - NEWT_KEY_EXTRA_BASE - - - - NEWT_KEY_UP - - - - NEWT_KEY_DOWN - - - - NEWT_KEY_LEFT - - - - NEWT_KEY_RIGHT - - - - NEWT_KEY_BKSPC - - - - NEWT_KEY_DELETE - - - - NEWT_KEY_HOME - - - - NEWT_KEY_END - - - - NEWT_KEY_UNTAB - - - - NEWT_KEY_PGUP - - - - NEWT_KEY_PGDN - - - - NEWT_KEY_INSERT - - - - NEWT_KEY_F1 - - - - NEWT_KEY_F2 - - - - NEWT_KEY_F3 - - - - NEWT_KEY_F4 - - - - NEWT_KEY_F5 - - - - NEWT_KEY_F6 - - - - NEWT_KEY_F7 - - - - NEWT_KEY_F8 - - - - NEWT_KEY_F9 - - - - NEWT_KEY_F10 - - - - NEWT_KEY_F11 - - - - NEWT_KEY_F12 - - - - NEWT_KEY_RESIZE - - - - -
    -
    - -
    - Newt Anchors - - Newt Anchors - - - - constant - meaning - - - - - NEWT_ANCHOR_LEFT - - - - NEWT_ANCHOR_RIGHT - - - - NEWT_ANCHOR_TOP - - - - NEWT_ANCHOR_BOTTOM - - - - -
    -
    - -
    - Grid Flags - - Grid Flags - - - - constant - meaning - - - - - NEWT_GRID_FLAG_GROWX - - - - NEWT_GRID_FLAG_GROWY - - - - NEWT_GRID_EMPTY - - - - NEWT_GRID_COMPONENT - - - - NEWT_GRID_SUBGRID - - - - -
    -
    - -     - - diff --git a/reference/newt/examples.xml b/reference/newt/examples.xml deleted file mode 100644 index ed93b251cd59..000000000000 --- a/reference/newt/examples.xml +++ /dev/null @@ -1,83 +0,0 @@ - - - - -&reftitle.examples; -
    - Basic usage - - This example is a PHP port of RedHat 'setup' utility dialog, executed in text - mode. - - - Newt Usage Example - - -]]> - - -
    -     - - - diff --git a/reference/newt/functions/newt-bell.xml b/reference/newt/functions/newt-bell.xml deleted file mode 100644 index 7765fd539175..000000000000 --- a/reference/newt/functions/newt-bell.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - newt_bell - Send a beep to the terminal - - - &reftitle.description; - - voidnewt_bell - - - - This function sends a beep to the terminal. - - - - Depending on the terminal's settings, this beep may or may not - be audible. - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/newt/functions/newt-button-bar.xml b/reference/newt/functions/newt-button-bar.xml deleted file mode 100644 index 65004269f828..000000000000 --- a/reference/newt/functions/newt-button-bar.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - newt_button_bar - This function returns a grid containing the buttons created - - - &reftitle.description; - - resourcenewt_button_bar - arraybuttons - - - This function returns a grid containing the buttons created. - - - - &reftitle.parameters; - - - - buttons - - - - - - - - - - - &reftitle.returnvalues; - - Returns grid containing the buttons created. - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-button.xml b/reference/newt/functions/newt-button.xml deleted file mode 100644 index 3f8a24e56fc2..000000000000 --- a/reference/newt/functions/newt-button.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - - newt_button - Create a new button - - - - &reftitle.description; - - resourcenewt_button - intleft - inttop - stringtext - - - Creates a new button. - - - - - &reftitle.parameters; - - - - left - - - X-coordinate of the button. - - - - - top - - - Y-coordinate of the button. - - - - - text - - - The text which should be displayed in the button. - - - - - - - - - &reftitle.returnvalues; - - Returns a resource link to the created button component, or &false; on - error. - - - - - &reftitle.examples; - - - A <function>newt_button</function> example - - -]]> - - - - - - - &reftitle.seealso; - - - newt_button_bar - - - - - - - diff --git a/reference/newt/functions/newt-centered-window.xml b/reference/newt/functions/newt-centered-window.xml deleted file mode 100644 index 892eccf98f62..000000000000 --- a/reference/newt/functions/newt-centered-window.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - newt_centered_window - Open a centered window of the specified size - - - &reftitle.description; - - intnewt_centered_window - intwidth - intheight - stringtitle - - Open a centered window of the specified size. - - - &reftitle.parameters; - - - - width - - - Window width - - - - - height - - - Window height - - - - - title - - - Window title - - - - - - - - - &reftitle.returnvalues; - - Undefined value. - - - - - &reftitle.seealso; - - - newt_pop_window - newt_open_window - - - - - - - diff --git a/reference/newt/functions/newt-checkbox-get-value.xml b/reference/newt/functions/newt-checkbox-get-value.xml deleted file mode 100644 index 28bd4692c474..000000000000 --- a/reference/newt/functions/newt-checkbox-get-value.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - newt_checkbox_get_value - Retreives value of checkox resource - - - &reftitle.description; - - stringnewt_checkbox_get_value - resourcecheckbox - - - This function returns the character in the sequence which indicates the current value - of the checkbox. - - - - &reftitle.parameters; - - - - checkbox - - - - - - - - - - - &reftitle.returnvalues; - - Returns character indicating the value of the checkbox. - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-checkbox-set-flags.xml b/reference/newt/functions/newt-checkbox-set-flags.xml deleted file mode 100644 index 80711d57e114..000000000000 --- a/reference/newt/functions/newt-checkbox-set-flags.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - newt_checkbox_set_flags - Configures checkbox resource - - - &reftitle.description; - - voidnewt_checkbox_set_flags - resourcecheckbox - intflags - intsense - - - This function allows to set various flags on checkbox resource. - - - - &reftitle.parameters; - - - - checkbox - - - - - - - flags - - - - - - - sense - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-checkbox-set-value.xml b/reference/newt/functions/newt-checkbox-set-value.xml deleted file mode 100644 index 1561985426fe..000000000000 --- a/reference/newt/functions/newt-checkbox-set-value.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - newt_checkbox_set_value - Sets the value of the checkbox - - - &reftitle.description; - - voidnewt_checkbox_set_value - resourcecheckbox - stringvalue - - - This function allows to set the current value of the checkbox resource. - - - - &reftitle.parameters; - - - - checkbox - - - - - - - value - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-checkbox-tree-add-item.xml b/reference/newt/functions/newt-checkbox-tree-add-item.xml deleted file mode 100644 index 6ede6f4b8b73..000000000000 --- a/reference/newt/functions/newt-checkbox-tree-add-item.xml +++ /dev/null @@ -1,174 +0,0 @@ - - - - - newt_checkbox_tree_add_item - Adds new item to the checkbox tree - - - &reftitle.description; - - voidnewt_checkbox_tree_add_item - resourcecheckboxtree - stringtext - mixeddata - intflags - intindex - int... - - - This function allows to add new item to the checkbox tree. - - - - &reftitle.parameters; - - - - checkboxtree - - - - - - - text - - - - - - - data - - - - - - - flags - - - - - - - index - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-checkbox-tree-find-item.xml b/reference/newt/functions/newt-checkbox-tree-find-item.xml deleted file mode 100644 index 6455068b8a03..000000000000 --- a/reference/newt/functions/newt-checkbox-tree-find-item.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - newt_checkbox_tree_find_item - Finds an item in the checkbox tree - - - &reftitle.description; - - arraynewt_checkbox_tree_find_item - resourcecheckboxtree - mixeddata - - - Finds an item in the checkbox tree by item's data. - - - - &reftitle.parameters; - - - - checkboxtree - - - - - - - data - - - - - - - - - - - &reftitle.returnvalues; - - Returns checkbox tree item resource, or &null; if it wasn't found. - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-checkbox-tree-get-current.xml b/reference/newt/functions/newt-checkbox-tree-get-current.xml deleted file mode 100644 index 3108a21aebc7..000000000000 --- a/reference/newt/functions/newt-checkbox-tree-get-current.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - newt_checkbox_tree_get_current - Returns checkbox tree selected item - - - &reftitle.description; - - mixednewt_checkbox_tree_get_current - resourcecheckboxtree - - - This method returns checkbox tree selected tem. - - - - &reftitle.parameters; - - - - checkboxtree - - - - - - - - - - - &reftitle.returnvalues; - - Returns current (selected) checkbox tree item. - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-checkbox-tree-get-entry-value.xml b/reference/newt/functions/newt-checkbox-tree-get-entry-value.xml deleted file mode 100644 index 065d1b891e3a..000000000000 --- a/reference/newt/functions/newt-checkbox-tree-get-entry-value.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - newt_checkbox_tree_get_entry_value - - - - &reftitle.description; - - stringnewt_checkbox_tree_get_entry_value - resourcecheckboxtree - mixeddata - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - checkboxtree - - - - - - - data - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-checkbox-tree-get-multi-selection.xml b/reference/newt/functions/newt-checkbox-tree-get-multi-selection.xml deleted file mode 100644 index 381d8cb0a019..000000000000 --- a/reference/newt/functions/newt-checkbox-tree-get-multi-selection.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - newt_checkbox_tree_get_multi_selection - - - - &reftitle.description; - - arraynewt_checkbox_tree_get_multi_selection - resourcecheckboxtree - stringseqnum - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - checkboxtree - - - - - - - seqnum - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-checkbox-tree-get-selection.xml b/reference/newt/functions/newt-checkbox-tree-get-selection.xml deleted file mode 100644 index ced3668021b6..000000000000 --- a/reference/newt/functions/newt-checkbox-tree-get-selection.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - newt_checkbox_tree_get_selection - - - - &reftitle.description; - - arraynewt_checkbox_tree_get_selection - resourcecheckboxtree - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - checkboxtree - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-checkbox-tree-multi.xml b/reference/newt/functions/newt-checkbox-tree-multi.xml deleted file mode 100644 index 3232f43e9d0b..000000000000 --- a/reference/newt/functions/newt-checkbox-tree-multi.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - newt_checkbox_tree_multi - - - - &reftitle.description; - - resourcenewt_checkbox_tree_multi - intleft - inttop - intheight - stringseq - intflags - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - left - - - - - - - top - - - - - - - height - - - - - - - seq - - - - - - - flags - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-checkbox-tree-set-current.xml b/reference/newt/functions/newt-checkbox-tree-set-current.xml deleted file mode 100644 index 80a016743eef..000000000000 --- a/reference/newt/functions/newt-checkbox-tree-set-current.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - newt_checkbox_tree_set_current - - - - &reftitle.description; - - voidnewt_checkbox_tree_set_current - resourcecheckboxtree - mixeddata - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - checkboxtree - - - - - - - data - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-checkbox-tree-set-entry-value.xml b/reference/newt/functions/newt-checkbox-tree-set-entry-value.xml deleted file mode 100644 index 64ccfcfc0e3e..000000000000 --- a/reference/newt/functions/newt-checkbox-tree-set-entry-value.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - newt_checkbox_tree_set_entry_value - - - - &reftitle.description; - - voidnewt_checkbox_tree_set_entry_value - resourcecheckboxtree - mixeddata - stringvalue - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - checkboxtree - - - - - - - data - - - - - - - value - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-checkbox-tree-set-entry.xml b/reference/newt/functions/newt-checkbox-tree-set-entry.xml deleted file mode 100644 index b965fc830bc3..000000000000 --- a/reference/newt/functions/newt-checkbox-tree-set-entry.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - newt_checkbox_tree_set_entry - - - - &reftitle.description; - - voidnewt_checkbox_tree_set_entry - resourcecheckboxtree - mixeddata - stringtext - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - checkboxtree - - - - - - - data - - - - - - - text - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-checkbox-tree-set-width.xml b/reference/newt/functions/newt-checkbox-tree-set-width.xml deleted file mode 100644 index 44bf63f054c3..000000000000 --- a/reference/newt/functions/newt-checkbox-tree-set-width.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - newt_checkbox_tree_set_width - - - - &reftitle.description; - - voidnewt_checkbox_tree_set_width - resourcecheckbox_tree - intwidth - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - checkbox_tree - - - - - - - width - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-checkbox-tree.xml b/reference/newt/functions/newt-checkbox-tree.xml deleted file mode 100644 index ee1bac7417bf..000000000000 --- a/reference/newt/functions/newt-checkbox-tree.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - - newt_checkbox_tree - - - - &reftitle.description; - - resourcenewt_checkbox_tree - intleft - inttop - intheight - intflags - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - left - - - - - - - top - - - - - - - height - - - - - - - flags - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-checkbox.xml b/reference/newt/functions/newt-checkbox.xml deleted file mode 100644 index 316e0dc69983..000000000000 --- a/reference/newt/functions/newt-checkbox.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - newt_checkbox - - - - &reftitle.description; - - resourcenewt_checkbox - intleft - inttop - stringtext - stringdef_value - stringseq - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - left - - - - - - - top - - - - - - - text - - - - - - - def_value - - - - - - - seq - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-clear-key-buffer.xml b/reference/newt/functions/newt-clear-key-buffer.xml deleted file mode 100644 index d4fbb73e040a..000000000000 --- a/reference/newt/functions/newt-clear-key-buffer.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - newt_clear_key_buffer - Discards the contents of the terminal's input buffer without - waiting for additional input - - - &reftitle.description; - - voidnewt_clear_key_buffer - - - - Discards the contents of the terminal's input buffer without waiting for - additional input. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - newt_wait_for_key - - - - - - - diff --git a/reference/newt/functions/newt-cls.xml b/reference/newt/functions/newt-cls.xml deleted file mode 100644 index f3050592800f..000000000000 --- a/reference/newt/functions/newt-cls.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - newt_cls - - - - &reftitle.description; - - voidnewt_cls - - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-compact-button.xml b/reference/newt/functions/newt-compact-button.xml deleted file mode 100644 index 2f1c58383d52..000000000000 --- a/reference/newt/functions/newt-compact-button.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - newt_compact_button - - - - &reftitle.description; - - resourcenewt_compact_button - intleft - inttop - stringtext - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - left - - - - - - - top - - - - - - - text - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-component-add-callback.xml b/reference/newt/functions/newt-component-add-callback.xml deleted file mode 100644 index a1125bd6b25c..000000000000 --- a/reference/newt/functions/newt-component-add-callback.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - newt_component_add_callback - - - - &reftitle.description; - - voidnewt_component_add_callback - resourcecomponent - mixedfunc_name - mixeddata - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - component - - - - - - - func_name - - - - - - - data - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-component-takes-focus.xml b/reference/newt/functions/newt-component-takes-focus.xml deleted file mode 100644 index 9b771184b284..000000000000 --- a/reference/newt/functions/newt-component-takes-focus.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - newt_component_takes_focus - - - - &reftitle.description; - - voidnewt_component_takes_focus - resourcecomponent - booltakes_focus - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - component - - - - - - - takes_focus - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-create-grid.xml b/reference/newt/functions/newt-create-grid.xml deleted file mode 100644 index e30ffab58d18..000000000000 --- a/reference/newt/functions/newt-create-grid.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - newt_create_grid - - - - &reftitle.description; - - resourcenewt_create_grid - intcols - introws - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - cols - - - - - - - rows - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-cursor-off.xml b/reference/newt/functions/newt-cursor-off.xml deleted file mode 100644 index d068c3eb044b..000000000000 --- a/reference/newt/functions/newt-cursor-off.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - newt_cursor_off - - - - &reftitle.description; - - voidnewt_cursor_off - - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-cursor-on.xml b/reference/newt/functions/newt-cursor-on.xml deleted file mode 100644 index 2fc46ea6a42b..000000000000 --- a/reference/newt/functions/newt-cursor-on.xml +++ /dev/null @@ -1,127 +0,0 @@ - - - - - newt_cursor_on - - - - &reftitle.description; - - voidnewt_cursor_on - - - - &warn.undocumented.func; - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-delay.xml b/reference/newt/functions/newt-delay.xml deleted file mode 100644 index cc6ff51774f4..000000000000 --- a/reference/newt/functions/newt-delay.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - newt_delay - - - - &reftitle.description; - - voidnewt_delay - intmicroseconds - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - microseconds - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-draw-form.xml b/reference/newt/functions/newt-draw-form.xml deleted file mode 100644 index 4e87e8f0a697..000000000000 --- a/reference/newt/functions/newt-draw-form.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - newt_draw_form - - - - &reftitle.description; - - voidnewt_draw_form - resourceform - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - form - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-draw-root-text.xml b/reference/newt/functions/newt-draw-root-text.xml deleted file mode 100644 index fee2bdbadcf4..000000000000 --- a/reference/newt/functions/newt-draw-root-text.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - newt_draw_root_text - Displays the string text at the position indicated - - - &reftitle.description; - - voidnewt_draw_root_text - intleft - inttop - stringtext - - Displays the string text at the position indicated. - - - &reftitle.parameters; - - - - left - - - Column number - - - - If left is negative, the position is measured from the opposite side of the screen. - - - - - - top - - - Line number - - - - If top is negative, the position is measured from the opposite side of the screen. - - - - - - text - - - Text to display. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - A <function>newt_draw_root_text</function> example - - This code demonstrates drawing of titles in the both corners of the screen. - - - -]]> - - - - - - - &reftitle.seealso; - - - newt_push_help_line - newt_pop_help_line - - - - - - - diff --git a/reference/newt/functions/newt-entry-get-value.xml b/reference/newt/functions/newt-entry-get-value.xml deleted file mode 100644 index 3ebcb95803b4..000000000000 --- a/reference/newt/functions/newt-entry-get-value.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - newt_entry_get_value - - - - &reftitle.description; - - stringnewt_entry_get_value - resourceentry - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - entry - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-entry-set-filter.xml b/reference/newt/functions/newt-entry-set-filter.xml deleted file mode 100644 index cf70ebf73564..000000000000 --- a/reference/newt/functions/newt-entry-set-filter.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - newt_entry_set_filter - - - - &reftitle.description; - - voidnewt_entry_set_filter - resourceentry - callablefilter - mixeddata - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - entry - - - - - - - filter - - - - - - - data - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-entry-set-flags.xml b/reference/newt/functions/newt-entry-set-flags.xml deleted file mode 100644 index ecf62e5f2b7a..000000000000 --- a/reference/newt/functions/newt-entry-set-flags.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - newt_entry_set_flags - - - - &reftitle.description; - - voidnewt_entry_set_flags - resourceentry - intflags - intsense - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - entry - - - - - - - flags - - - - - - - sense - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-entry-set.xml b/reference/newt/functions/newt-entry-set.xml deleted file mode 100644 index 75e47075bb79..000000000000 --- a/reference/newt/functions/newt-entry-set.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - newt_entry_set - - - - &reftitle.description; - - voidnewt_entry_set - resourceentry - stringvalue - boolcursor_at_end - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - entry - - - - - - - value - - - - - - - cursor_at_end - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-entry.xml b/reference/newt/functions/newt-entry.xml deleted file mode 100644 index 43bf59cf2907..000000000000 --- a/reference/newt/functions/newt-entry.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - newt_entry - - - - &reftitle.description; - - resourcenewt_entry - intleft - inttop - intwidth - stringinit_value - intflags - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - left - - - - - - - top - - - - - - - width - - - - - - - init_value - - - - - - - flags - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-finished.xml b/reference/newt/functions/newt-finished.xml deleted file mode 100644 index 9ea39fb6aa57..000000000000 --- a/reference/newt/functions/newt-finished.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - newt_finished - Uninitializes newt interface - - - &reftitle.description; - - intnewt_finished - - - - Uninitializes newt interface. This function be called, when program is ready - to exit. - - - - - &reftitle.returnvalues; - - Returns 1 on success, 0 on failure. - - - - - &reftitle.seealso; - - - newt_init - - - - - - - diff --git a/reference/newt/functions/newt-form-add-component.xml b/reference/newt/functions/newt-form-add-component.xml deleted file mode 100644 index 75a6e12a2281..000000000000 --- a/reference/newt/functions/newt-form-add-component.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - newt_form_add_component - Adds a single component to the form - - - - &reftitle.description; - - voidnewt_form_add_component - resourceform - resourcecomponent - - - Adds a single component to the form. - - - - - &reftitle.parameters; - - - - form - - - Form to which component will be added - - - - - component - - - Component to add to the form - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - A <function>newt_form_add_component</function> example - - -]]> - - - - - - - &reftitle.seealso; - - - newt_form_add_components - - - - - - - diff --git a/reference/newt/functions/newt-form-add-components.xml b/reference/newt/functions/newt-form-add-components.xml deleted file mode 100644 index da7e5e783c80..000000000000 --- a/reference/newt/functions/newt-form-add-components.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - newt_form_add_components - Add several components to the form - - - - &reftitle.description; - - voidnewt_form_add_components - resourceform - arraycomponents - - - Adds several components to the form. - - - - - &reftitle.parameters; - - - - form - - - Form to which components will be added - - - - - components - - - Array of components to add to the form - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - A <function>newt_form_add_components</function> example - - -]]> - - - - - - - &reftitle.seealso; - - - newt_form_add_component - - - - - - - diff --git a/reference/newt/functions/newt-form-add-hot-key.xml b/reference/newt/functions/newt-form-add-hot-key.xml deleted file mode 100644 index be60ddf21b28..000000000000 --- a/reference/newt/functions/newt-form-add-hot-key.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - newt_form_add_hot_key - - - - &reftitle.description; - - voidnewt_form_add_hot_key - resourceform - intkey - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - form - - - - - - - key - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-form-destroy.xml b/reference/newt/functions/newt-form-destroy.xml deleted file mode 100644 index 3a8aed927178..000000000000 --- a/reference/newt/functions/newt-form-destroy.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - newt_form_destroy - Destroys a form - - - &reftitle.description; - - voidnewt_form_destroy - resourceform - - - This function frees the memory resources used by the form and all of the - components which have been added to the form (including those components - which are on subforms). Once a form has been destroyed, none of the form's - components can be used. - - - - &reftitle.parameters; - - - - form - - - Form component, which is going to be destroyed - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - newt_form_run - newt_run_form - - - - - - - diff --git a/reference/newt/functions/newt-form-get-current.xml b/reference/newt/functions/newt-form-get-current.xml deleted file mode 100644 index 04ba558f9004..000000000000 --- a/reference/newt/functions/newt-form-get-current.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - newt_form_get_current - - - - &reftitle.description; - - resourcenewt_form_get_current - resourceform - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - form - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-form-run.xml b/reference/newt/functions/newt-form-run.xml deleted file mode 100644 index 776ce5e875e3..000000000000 --- a/reference/newt/functions/newt-form-run.xml +++ /dev/null @@ -1,119 +0,0 @@ - - - - - newt_form_run - Runs a form - - - &reftitle.description; - - voidnewt_form_run - resourceform - arrayexit_struct - - - This function runs the form passed to it. - - - - &reftitle.parameters; - - - - form - - - Form component - - - - - exit_struct - - - Array, used for returning information after running the form component. - Keys and values are described in the following table: - - Form Exit Structure - - - - Index Key - Value Type - Description - - - - - reason - integer - - The reason, why the form has been exited. Possible values are - defined here. - - - - watch - resource - Resource link, specified in - newt_form_watch_fd - - - key - integer - Hotkey - - - component - resource - Component, which caused the form to exit - - - -
    -     -     -     -     -     -     - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - newt_run_form - - - - -     - - diff --git a/reference/newt/functions/newt-form-set-background.xml b/reference/newt/functions/newt-form-set-background.xml deleted file mode 100644 index e5b679a07cc4..000000000000 --- a/reference/newt/functions/newt-form-set-background.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - newt_form_set_background - - - - &reftitle.description; - - voidnewt_form_set_background - resourcefrom - intbackground - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - from - - - - - - - background - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-form-set-height.xml b/reference/newt/functions/newt-form-set-height.xml deleted file mode 100644 index 6f0d2abc0def..000000000000 --- a/reference/newt/functions/newt-form-set-height.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - newt_form_set_height - - - - &reftitle.description; - - voidnewt_form_set_height - resourceform - intheight - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - form - - - - - - - height - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-form-set-size.xml b/reference/newt/functions/newt-form-set-size.xml deleted file mode 100644 index 7a47ec0bb8a4..000000000000 --- a/reference/newt/functions/newt-form-set-size.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - newt_form_set_size - - - - &reftitle.description; - - voidnewt_form_set_size - resourceform - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - form - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-form-set-timer.xml b/reference/newt/functions/newt-form-set-timer.xml deleted file mode 100644 index 8e011d0e61f0..000000000000 --- a/reference/newt/functions/newt-form-set-timer.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - newt_form_set_timer - - - - &reftitle.description; - - voidnewt_form_set_timer - resourceform - intmilliseconds - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - form - - - - - - - milliseconds - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-form-set-width.xml b/reference/newt/functions/newt-form-set-width.xml deleted file mode 100644 index 39be6011371b..000000000000 --- a/reference/newt/functions/newt-form-set-width.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - newt_form_set_width - - - - &reftitle.description; - - voidnewt_form_set_width - resourceform - intwidth - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - form - - - - - - - width - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-form-watch-fd.xml b/reference/newt/functions/newt-form-watch-fd.xml deleted file mode 100644 index aae70e521946..000000000000 --- a/reference/newt/functions/newt-form-watch-fd.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - newt_form_watch_fd - - - - &reftitle.description; - - voidnewt_form_watch_fd - resourceform - resourcestream - intflags - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - form - - - - - - - stream - - - - - - - flags - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-form.xml b/reference/newt/functions/newt-form.xml deleted file mode 100644 index 2654f447aaf7..000000000000 --- a/reference/newt/functions/newt-form.xml +++ /dev/null @@ -1,128 +0,0 @@ - - - - - - newt_form - Create a form - - - - &reftitle.description; - - resourcenewt_form - resourcevert_bar - stringhelp - intflags - - - Create a new form. - - - - - &reftitle.parameters; - - - - vert_bar - - - Vertical scrollbar which should be associated with the form - - - - - help - - - Help text string - - - - - flags - - - Various flags - - - - - - - - - &reftitle.returnvalues; - - Returns a resource link to the created form component, or &false; on - error. - - - - - &reftitle.examples; - - - A <function>newt_form</function> example - - Displays a single button "Quit", which closes the application once it's - pressed. - - - -]]> - - - - - - - &reftitle.seealso; - - - newt_form_run - newt_run_form - newt_form_add_component - newt_form_add_components - newt_form_destroy - - - - - - - diff --git a/reference/newt/functions/newt-get-screen-size.xml b/reference/newt/functions/newt-get-screen-size.xml deleted file mode 100644 index aa118dded651..000000000000 --- a/reference/newt/functions/newt-get-screen-size.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - newt_get_screen_size - Fills in the passed references with the current size of the - terminal - - - &reftitle.description; - - voidnewt_get_screen_size - intcols - introws - - - Fills in the passed references with the current size of the terminal. - - - - &reftitle.parameters; - - - - cols - - - Number of columns in the terminal - - - - - rows - - - Number of rows in the terminal - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - A <function>newt_get_screen_size</function> example - - This code prints out the screen size of your terminal. - - - -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/newt/functions/newt-grid-add-components-to-form.xml b/reference/newt/functions/newt-grid-add-components-to-form.xml deleted file mode 100644 index c8219e31ff7e..000000000000 --- a/reference/newt/functions/newt-grid-add-components-to-form.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - newt_grid_add_components_to_form - - - - &reftitle.description; - - voidnewt_grid_add_components_to_form - resourcegrid - resourceform - boolrecurse - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - grid - - - - - - - form - - - - - - - recurse - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-grid-basic-window.xml b/reference/newt/functions/newt-grid-basic-window.xml deleted file mode 100644 index 9a7c99a70df4..000000000000 --- a/reference/newt/functions/newt-grid-basic-window.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - newt_grid_basic_window - - - - &reftitle.description; - - resourcenewt_grid_basic_window - resourcetext - resourcemiddle - resourcebuttons - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - text - - - - - - - middle - - - - - - - buttons - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-grid-free.xml b/reference/newt/functions/newt-grid-free.xml deleted file mode 100644 index 8b16bb237b15..000000000000 --- a/reference/newt/functions/newt-grid-free.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - newt_grid_free - - - - &reftitle.description; - - voidnewt_grid_free - resourcegrid - boolrecurse - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - grid - - - - - - - recurse - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-grid-get-size.xml b/reference/newt/functions/newt-grid-get-size.xml deleted file mode 100644 index 95aba1483702..000000000000 --- a/reference/newt/functions/newt-grid-get-size.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - newt_grid_get_size - - - - &reftitle.description; - - voidnewt_grid_get_size - resoucegrid - intwidth - intheight - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - grid - - - - - - - width - - - - - - - height - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-grid-h-close-stacked.xml b/reference/newt/functions/newt-grid-h-close-stacked.xml deleted file mode 100644 index 4cee8987906a..000000000000 --- a/reference/newt/functions/newt-grid-h-close-stacked.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - newt_grid_h_close_stacked - - - - &reftitle.description; - - resourcenewt_grid_h_close_stacked - intelement1_type - resourceelement1 - int... - resource... - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - element1_type - - - - - - - element1 - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-grid-h-stacked.xml b/reference/newt/functions/newt-grid-h-stacked.xml deleted file mode 100644 index 9f84fb9d9169..000000000000 --- a/reference/newt/functions/newt-grid-h-stacked.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - newt_grid_h_stacked - - - - &reftitle.description; - - resourcenewt_grid_h_stacked - intelement1_type - resourceelement1 - int... - resource... - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - element1_type - - - - - - - element1 - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-grid-place.xml b/reference/newt/functions/newt-grid-place.xml deleted file mode 100644 index de162867c7d8..000000000000 --- a/reference/newt/functions/newt-grid-place.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - newt_grid_place - - - - &reftitle.description; - - voidnewt_grid_place - resourcegrid - intleft - inttop - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - grid - - - - - - - left - - - - - - - top - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-grid-set-field.xml b/reference/newt/functions/newt-grid-set-field.xml deleted file mode 100644 index 27afa3f973dc..000000000000 --- a/reference/newt/functions/newt-grid-set-field.xml +++ /dev/null @@ -1,221 +0,0 @@ - - - - - newt_grid_set_field - - - - &reftitle.description; - - voidnewt_grid_set_field - resourcegrid - intcol - introw - inttype - resourceval - intpad_left - intpad_top - intpad_right - intpad_bottom - intanchor - intflags - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - grid - - - - - - - col - - - - - - - row - - - - - - - type - - - - - - - val - - - - - - - pad_left - - - - - - - pad_top - - - - - - - pad_right - - - - - - - pad_bottom - - - - - - - anchor - - - - - - - flags - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-grid-simple-window.xml b/reference/newt/functions/newt-grid-simple-window.xml deleted file mode 100644 index e4fa8ad631f9..000000000000 --- a/reference/newt/functions/newt-grid-simple-window.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - newt_grid_simple_window - - - - &reftitle.description; - - resourcenewt_grid_simple_window - resourcetext - resourcemiddle - resourcebuttons - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - text - - - - - - - middle - - - - - - - buttons - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-grid-v-close-stacked.xml b/reference/newt/functions/newt-grid-v-close-stacked.xml deleted file mode 100644 index 58819ed60993..000000000000 --- a/reference/newt/functions/newt-grid-v-close-stacked.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - newt_grid_v_close_stacked - - - - &reftitle.description; - - resourcenewt_grid_v_close_stacked - intelement1_type - resourceelement1 - int... - resource... - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - element1_type - - - - - - - element1 - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-grid-v-stacked.xml b/reference/newt/functions/newt-grid-v-stacked.xml deleted file mode 100644 index d4b80e3a5dea..000000000000 --- a/reference/newt/functions/newt-grid-v-stacked.xml +++ /dev/null @@ -1,150 +0,0 @@ - - - - - newt_grid_v_stacked - - - - &reftitle.description; - - resourcenewt_grid_v_stacked - intelement1_type - resourceelement1 - int... - resource... - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - element1_type - - - - - - - element1 - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-grid-wrapped-window-at.xml b/reference/newt/functions/newt-grid-wrapped-window-at.xml deleted file mode 100644 index f3072b83902e..000000000000 --- a/reference/newt/functions/newt-grid-wrapped-window-at.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - - newt_grid_wrapped_window_at - - - - &reftitle.description; - - voidnewt_grid_wrapped_window_at - resourcegrid - stringtitle - intleft - inttop - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - grid - - - - - - - title - - - - - - - left - - - - - - - top - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-grid-wrapped-window.xml b/reference/newt/functions/newt-grid-wrapped-window.xml deleted file mode 100644 index 1cd499c7f5d4..000000000000 --- a/reference/newt/functions/newt-grid-wrapped-window.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - newt_grid_wrapped_window - - - - &reftitle.description; - - voidnewt_grid_wrapped_window - resourcegrid - stringtitle - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - grid - - - - - - - title - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-init.xml b/reference/newt/functions/newt-init.xml deleted file mode 100644 index 8eec27597f62..000000000000 --- a/reference/newt/functions/newt-init.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - newt_init - Initialize newt - - - &reftitle.description; - - intnewt_init - - - - Initializes the newt interface. This function must be called before any other newt function. - - - - - &reftitle.returnvalues; - - Returns 1 on success, 0 on failure. - - - - - &reftitle.seealso; - - - newt_finished - - - - - - - diff --git a/reference/newt/functions/newt-label-set-text.xml b/reference/newt/functions/newt-label-set-text.xml deleted file mode 100644 index 8ae40d7c7f5b..000000000000 --- a/reference/newt/functions/newt-label-set-text.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - newt_label_set_text - - - - &reftitle.description; - - voidnewt_label_set_text - resourcelabel - stringtext - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - label - - - - - - - text - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-label.xml b/reference/newt/functions/newt-label.xml deleted file mode 100644 index 872284db2ea3..000000000000 --- a/reference/newt/functions/newt-label.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - newt_label - - - - &reftitle.description; - - resourcenewt_label - intleft - inttop - stringtext - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - left - - - - - - - top - - - - - - - text - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-listbox-append-entry.xml b/reference/newt/functions/newt-listbox-append-entry.xml deleted file mode 100644 index d146e630e493..000000000000 --- a/reference/newt/functions/newt-listbox-append-entry.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - newt_listbox_append_entry - - - - &reftitle.description; - - voidnewt_listbox_append_entry - resourcelistbox - stringtext - mixeddata - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - listbox - - - - - - - text - - - - - - - data - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-listbox-clear-selection.xml b/reference/newt/functions/newt-listbox-clear-selection.xml deleted file mode 100644 index 3d8284df8629..000000000000 --- a/reference/newt/functions/newt-listbox-clear-selection.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - newt_listbox_clear_selection - - - - &reftitle.description; - - voidnewt_listbox_clear_selection - resourcelistbox - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - listbox - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-listbox-clear.xml b/reference/newt/functions/newt-listbox-clear.xml deleted file mode 100644 index 2b39a5c1aa96..000000000000 --- a/reference/newt/functions/newt-listbox-clear.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - newt_listbox_clear - - - - &reftitle.description; - - voidnewt_listbox_clear - resourcelistobx - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - listobx - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-listbox-delete-entry.xml b/reference/newt/functions/newt-listbox-delete-entry.xml deleted file mode 100644 index 4266adfbf085..000000000000 --- a/reference/newt/functions/newt-listbox-delete-entry.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - newt_listbox_delete_entry - - - - &reftitle.description; - - voidnewt_listbox_delete_entry - resourcelistbox - mixedkey - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - listbox - - - - - - - key - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-listbox-get-current.xml b/reference/newt/functions/newt-listbox-get-current.xml deleted file mode 100644 index 0afeac48b77b..000000000000 --- a/reference/newt/functions/newt-listbox-get-current.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - newt_listbox_get_current - - - - &reftitle.description; - - stringnewt_listbox_get_current - resourcelistbox - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - listbox - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-listbox-get-selection.xml b/reference/newt/functions/newt-listbox-get-selection.xml deleted file mode 100644 index 7471f5e79c95..000000000000 --- a/reference/newt/functions/newt-listbox-get-selection.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - newt_listbox_get_selection - - - - &reftitle.description; - - arraynewt_listbox_get_selection - resourcelistbox - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - listbox - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-listbox-insert-entry.xml b/reference/newt/functions/newt-listbox-insert-entry.xml deleted file mode 100644 index 91c5cfc18526..000000000000 --- a/reference/newt/functions/newt-listbox-insert-entry.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - - newt_listbox_insert_entry - - - - &reftitle.description; - - voidnewt_listbox_insert_entry - resourcelistbox - stringtext - mixeddata - mixedkey - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - listbox - - - - - - - text - - - - - - - data - - - - - - - key - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-listbox-item-count.xml b/reference/newt/functions/newt-listbox-item-count.xml deleted file mode 100644 index c5c7435212f5..000000000000 --- a/reference/newt/functions/newt-listbox-item-count.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - newt_listbox_item_count - - - - &reftitle.description; - - intnewt_listbox_item_count - resourcelistbox - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - listbox - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-listbox-select-item.xml b/reference/newt/functions/newt-listbox-select-item.xml deleted file mode 100644 index 414887f6acd6..000000000000 --- a/reference/newt/functions/newt-listbox-select-item.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - newt_listbox_select_item - - - - &reftitle.description; - - voidnewt_listbox_select_item - resourcelistbox - mixedkey - intsense - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - listbox - - - - - - - key - - - - - - - sense - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-listbox-set-current-by-key.xml b/reference/newt/functions/newt-listbox-set-current-by-key.xml deleted file mode 100644 index 878ebced70fb..000000000000 --- a/reference/newt/functions/newt-listbox-set-current-by-key.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - newt_listbox_set_current_by_key - - - - &reftitle.description; - - voidnewt_listbox_set_current_by_key - resourcelistbox - mixedkey - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - listbox - - - - - - - key - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-listbox-set-current.xml b/reference/newt/functions/newt-listbox-set-current.xml deleted file mode 100644 index 7a6c5c83c54e..000000000000 --- a/reference/newt/functions/newt-listbox-set-current.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - newt_listbox_set_current - - - - &reftitle.description; - - voidnewt_listbox_set_current - resourcelistbox - intnum - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - listbox - - - - - - - num - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-listbox-set-data.xml b/reference/newt/functions/newt-listbox-set-data.xml deleted file mode 100644 index 64cba16323a3..000000000000 --- a/reference/newt/functions/newt-listbox-set-data.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - newt_listbox_set_data - - - - &reftitle.description; - - voidnewt_listbox_set_data - resourcelistbox - intnum - mixeddata - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - listbox - - - - - - - num - - - - - - - data - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-listbox-set-entry.xml b/reference/newt/functions/newt-listbox-set-entry.xml deleted file mode 100644 index fce88fc2558e..000000000000 --- a/reference/newt/functions/newt-listbox-set-entry.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - newt_listbox_set_entry - - - - &reftitle.description; - - voidnewt_listbox_set_entry - resourcelistbox - intnum - stringtext - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - listbox - - - - - - - num - - - - - - - text - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-listbox-set-width.xml b/reference/newt/functions/newt-listbox-set-width.xml deleted file mode 100644 index 3cdf4e8c82aa..000000000000 --- a/reference/newt/functions/newt-listbox-set-width.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - newt_listbox_set_width - - - - &reftitle.description; - - voidnewt_listbox_set_width - resourcelistbox - intwidth - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - listbox - - - - - - - width - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-listbox.xml b/reference/newt/functions/newt-listbox.xml deleted file mode 100644 index af5816f022c4..000000000000 --- a/reference/newt/functions/newt-listbox.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - - newt_listbox - - - - &reftitle.description; - - resourcenewt_listbox - intleft - inttop - intheight - intflags - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - left - - - - - - - top - - - - - - - height - - - - - - - flags - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-listitem-get-data.xml b/reference/newt/functions/newt-listitem-get-data.xml deleted file mode 100644 index b4abe5efa248..000000000000 --- a/reference/newt/functions/newt-listitem-get-data.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - newt_listitem_get_data - - - - &reftitle.description; - - mixednewt_listitem_get_data - resourceitem - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - item - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-listitem-set.xml b/reference/newt/functions/newt-listitem-set.xml deleted file mode 100644 index 63eab0d3ac07..000000000000 --- a/reference/newt/functions/newt-listitem-set.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - newt_listitem_set - - - - &reftitle.description; - - voidnewt_listitem_set - resourceitem - stringtext - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - item - - - - - - - text - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-listitem.xml b/reference/newt/functions/newt-listitem.xml deleted file mode 100644 index 9e201aa6c862..000000000000 --- a/reference/newt/functions/newt-listitem.xml +++ /dev/null @@ -1,188 +0,0 @@ - - - - - newt_listitem - - - - &reftitle.description; - - resourcenewt_listitem - intleft - inttop - stringtext - boolis_default - resouceprev_item - mixeddata - intflags - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - left - - - - - - - top - - - - - - - text - - - - - - - is_default - - - - - - - prev_item - - - - - - - data - - - - - - - flags - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-open-window.xml b/reference/newt/functions/newt-open-window.xml deleted file mode 100644 index 48970fde0278..000000000000 --- a/reference/newt/functions/newt-open-window.xml +++ /dev/null @@ -1,108 +0,0 @@ - - - - - newt_open_window - Open a window of the specified size and position - - - &reftitle.description; - - intnewt_open_window - intleft - inttop - intwidth - intheight - stringtitle - - - Open a window of the specified size and position. - - - - &reftitle.parameters; - - - - left - - - Location of the upper left-hand corner of the window (column number) - - - - - top - - - Location of the upper left-hand corner of the window (row number) - - - - - width - - - Window width - - - - - height - - - Window height - - - - - title - - - Window title - - - - - - - - - &reftitle.returnvalues; - - Returns 1 on success, 0 on failure. - - - - - &reftitle.seealso; - - - newt_pop_window - newt_centered_window - - - - - - - diff --git a/reference/newt/functions/newt-pop-help-line.xml b/reference/newt/functions/newt-pop-help-line.xml deleted file mode 100644 index c99f210bc3f0..000000000000 --- a/reference/newt/functions/newt-pop-help-line.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - newt_pop_help_line - Replaces the current help line with the one from the stack - - - &reftitle.description; - - voidnewt_pop_help_line - - - - Replaces the current help line with the one from the stack. - - - - It's important not to call to newt_pop_help_line more - than newt_push_help_line. - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - newt_push_help_line - - - - - - - diff --git a/reference/newt/functions/newt-pop-window.xml b/reference/newt/functions/newt-pop-window.xml deleted file mode 100644 index 06b412328837..000000000000 --- a/reference/newt/functions/newt-pop-window.xml +++ /dev/null @@ -1,56 +0,0 @@ - - - - - newt_pop_window - Removes the top window from the display - - - &reftitle.description; - - voidnewt_pop_window - - - Removes the top window from the display, and redraws the display areas - which the window overwrote. - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - newt_open_window - newt_centered_window - - - - - - - diff --git a/reference/newt/functions/newt-push-help-line.xml b/reference/newt/functions/newt-push-help-line.xml deleted file mode 100644 index 8d6316cb559d..000000000000 --- a/reference/newt/functions/newt-push-help-line.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - newt_push_help_line - Saves the current help line on a stack, and displays the new line - - - &reftitle.description; - - voidnewt_push_help_line - stringtext - - - Saves the current help line on a stack, and displays the new line. - - - - - &reftitle.parameters; - - - - text - - - New help text message - - - If not specified, the help line is cleared. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - newt_pop_help_line - - - - - - - diff --git a/reference/newt/functions/newt-radio-get-current.xml b/reference/newt/functions/newt-radio-get-current.xml deleted file mode 100644 index 288e381eb624..000000000000 --- a/reference/newt/functions/newt-radio-get-current.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - newt_radio_get_current - - - - &reftitle.description; - - resourcenewt_radio_get_current - resourceset_member - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - set_member - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-radiobutton.xml b/reference/newt/functions/newt-radiobutton.xml deleted file mode 100644 index e210164e144e..000000000000 --- a/reference/newt/functions/newt-radiobutton.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - newt_radiobutton - - - - &reftitle.description; - - resourcenewt_radiobutton - intleft - inttop - stringtext - boolis_default - resourceprev_button - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - left - - - - - - - top - - - - - - - text - - - - - - - is_default - - - - - - - prev_button - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-redraw-help-line.xml b/reference/newt/functions/newt-redraw-help-line.xml deleted file mode 100644 index 0e0d7a990216..000000000000 --- a/reference/newt/functions/newt-redraw-help-line.xml +++ /dev/null @@ -1,132 +0,0 @@ - - - - - newt_redraw_help_line - - - - &reftitle.description; - - voidnewt_redraw_help_line - - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-reflow-text.xml b/reference/newt/functions/newt-reflow-text.xml deleted file mode 100644 index b15559e51360..000000000000 --- a/reference/newt/functions/newt-reflow-text.xml +++ /dev/null @@ -1,180 +0,0 @@ - - - - - newt_reflow_text - - - - &reftitle.description; - - stringnewt_reflow_text - stringtext - intwidth - intflex_down - intflex_up - intactual_width - intactual_height - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - text - - - - - - - width - - - - - - - flex_down - - - - - - - flex_up - - - - - - - actual_width - - - - - - - actual_height - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-refresh.xml b/reference/newt/functions/newt-refresh.xml deleted file mode 100644 index 796f8bb4560b..000000000000 --- a/reference/newt/functions/newt-refresh.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - newt_refresh - Updates modified portions of the screen - - - &reftitle.description; - - voidnewt_refresh - - - - To increase performance, newt only updates the display when it needs to, - not when the program tells it to write to the terminal. Applications can - force newt to immediately update modified portions of the screen by calling - this function. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - diff --git a/reference/newt/functions/newt-resize-screen.xml b/reference/newt/functions/newt-resize-screen.xml deleted file mode 100644 index 94d00a6e5be7..000000000000 --- a/reference/newt/functions/newt-resize-screen.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - newt_resize_screen - - - - &reftitle.description; - - voidnewt_resize_screen - boolredraw - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - redraw - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-resume.xml b/reference/newt/functions/newt-resume.xml deleted file mode 100644 index 09a31c9d3944..000000000000 --- a/reference/newt/functions/newt-resume.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - newt_resume - Resume using the newt interface after calling - newt_suspend - - - &reftitle.description; - - voidnewt_resume - - - - Resume using the newt interface after calling - newt_suspend. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - newt_suspend - - - - - - - diff --git a/reference/newt/functions/newt-run-form.xml b/reference/newt/functions/newt-run-form.xml deleted file mode 100644 index a746a92b42d9..000000000000 --- a/reference/newt/functions/newt-run-form.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - newt_run_form - Runs a form - - - &reftitle.description; - - resourcenewt_run_form - resourceform - - - This function runs the form passed to it. - - - - &reftitle.parameters; - - - - form - - - Form component - - - - - - - - &reftitle.returnvalues; - - The component which caused the form to stop running. - - - - 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. - - - - - - &reftitle.seealso; - - - newt_form_run - newt_form_destroy - - - - - - - diff --git a/reference/newt/functions/newt-scale-set.xml b/reference/newt/functions/newt-scale-set.xml deleted file mode 100644 index c4c0afc5496a..000000000000 --- a/reference/newt/functions/newt-scale-set.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - newt_scale_set - - - - &reftitle.description; - - voidnewt_scale_set - resourcescale - intamount - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - scale - - - - - - - amount - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-scale.xml b/reference/newt/functions/newt-scale.xml deleted file mode 100644 index 9f06f8fa5739..000000000000 --- a/reference/newt/functions/newt-scale.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - - newt_scale - - - - &reftitle.description; - - resourcenewt_scale - intleft - inttop - intwidth - intfull_value - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - left - - - - - - - top - - - - - - - width - - - - - - - full_value - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-scrollbar-set.xml b/reference/newt/functions/newt-scrollbar-set.xml deleted file mode 100644 index b52f5c96facd..000000000000 --- a/reference/newt/functions/newt-scrollbar-set.xml +++ /dev/null @@ -1,157 +0,0 @@ - - - - - newt_scrollbar_set - - - - &reftitle.description; - - voidnewt_scrollbar_set - resourcescrollbar - intwhere - inttotal - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - scrollbar - - - - - - - where - - - - - - - total - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-set-help-callback.xml b/reference/newt/functions/newt-set-help-callback.xml deleted file mode 100644 index f7a30221d616..000000000000 --- a/reference/newt/functions/newt-set-help-callback.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - newt_set_help_callback - - - - &reftitle.description; - - voidnewt_set_help_callback - mixedfunction - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - function - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-set-suspend-callback.xml b/reference/newt/functions/newt-set-suspend-callback.xml deleted file mode 100644 index 2ab026b48fed..000000000000 --- a/reference/newt/functions/newt-set-suspend-callback.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - - newt_set_suspend_callback - Set a callback function which gets invoked when user - presses the suspend key - - - - &reftitle.description; - - voidnewt_set_suspend_callback - callablefunction - mixeddata - - - Set a callback function which gets invoked when user presses the suspend - key (normally ^Z). If no suspend callback is registered, the suspend - keystroke is ignored. - - - - - &reftitle.parameters; - - - - function - - - A callback function, which accepts one argument: data - - - - - data - - - This data is been passed to the callback function - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - newt_suspend - newt_resume - - - - - - - diff --git a/reference/newt/functions/newt-suspend.xml b/reference/newt/functions/newt-suspend.xml deleted file mode 100644 index 97286fee3c2a..000000000000 --- a/reference/newt/functions/newt-suspend.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - newt_suspend - Tells newt to return the terminal to its initial state - - - &reftitle.description; - - voidnewt_suspend - - - - Tells newt to return the terminal to its initial state. Once this is - done, the application can suspend itself (by sending itself a SIGTSTP, fork - a child program, or do whatever else it likes). - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - newt_resume - - - - - - - diff --git a/reference/newt/functions/newt-textbox-get-num-lines.xml b/reference/newt/functions/newt-textbox-get-num-lines.xml deleted file mode 100644 index 6f7e79c3066b..000000000000 --- a/reference/newt/functions/newt-textbox-get-num-lines.xml +++ /dev/null @@ -1,140 +0,0 @@ - - - - - newt_textbox_get_num_lines - - - - &reftitle.description; - - intnewt_textbox_get_num_lines - resourcetextbox - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - textbox - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-textbox-reflowed.xml b/reference/newt/functions/newt-textbox-reflowed.xml deleted file mode 100644 index 5edd6c326fdc..000000000000 --- a/reference/newt/functions/newt-textbox-reflowed.xml +++ /dev/null @@ -1,188 +0,0 @@ - - - - - newt_textbox_reflowed - - - - &reftitle.description; - - resourcenewt_textbox_reflowed - intleft - inttop - char*text - intwidth - intflex_down - intflex_up - intflags - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - left - - - - - - - top - - - - - - - *text - - - - - - - width - - - - - - - flex_down - - - - - - - flex_up - - - - - - - flags - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-textbox-set-height.xml b/reference/newt/functions/newt-textbox-set-height.xml deleted file mode 100644 index 5a201d03d9ec..000000000000 --- a/reference/newt/functions/newt-textbox-set-height.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - newt_textbox_set_height - - - - &reftitle.description; - - voidnewt_textbox_set_height - resourcetextbox - intheight - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - textbox - - - - - - - height - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-textbox-set-text.xml b/reference/newt/functions/newt-textbox-set-text.xml deleted file mode 100644 index 9cef5805eec8..000000000000 --- a/reference/newt/functions/newt-textbox-set-text.xml +++ /dev/null @@ -1,149 +0,0 @@ - - - - - newt_textbox_set_text - - - - &reftitle.description; - - voidnewt_textbox_set_text - resourcetextbox - stringtext - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - textbox - - - - - - - text - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-textbox.xml b/reference/newt/functions/newt-textbox.xml deleted file mode 100644 index ac2655dbe6ae..000000000000 --- a/reference/newt/functions/newt-textbox.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - newt_textbox - - - - &reftitle.description; - - resourcenewt_textbox - intleft - inttop - intwidth - intheight - intflags - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - left - - - - - - - top - - - - - - - width - - - - - - - height - - - - - - - flags - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-vertical-scrollbar.xml b/reference/newt/functions/newt-vertical-scrollbar.xml deleted file mode 100644 index 85151e400b4a..000000000000 --- a/reference/newt/functions/newt-vertical-scrollbar.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - newt_vertical_scrollbar - - - - &reftitle.description; - - resourcenewt_vertical_scrollbar - intleft - inttop - intheight - intnormal_colorset - intthumb_colorset - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - left - - - - - - - top - - - - - - - height - - - - - - - normal_colorset - - - - - - - thumb_colorset - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-wait-for-key.xml b/reference/newt/functions/newt-wait-for-key.xml deleted file mode 100644 index 69eae01f83d0..000000000000 --- a/reference/newt/functions/newt-wait-for-key.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - newt_wait_for_key - Doesn't return until a key has been pressed - - - &reftitle.description; - - voidnewt_wait_for_key - - - - This function doesn't return until a key has been pressed. The keystroke - is then ignored. If a key is already in the terminal's buffer, this - function discards a keystroke and returns immediately. - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.seealso; - - - newt_clear_key_buffer - - - - - - - diff --git a/reference/newt/functions/newt-win-choice.xml b/reference/newt/functions/newt-win-choice.xml deleted file mode 100644 index 8b3f2d0587bd..000000000000 --- a/reference/newt/functions/newt-win-choice.xml +++ /dev/null @@ -1,173 +0,0 @@ - - - - - newt_win_choice - - - - &reftitle.description; - - intnewt_win_choice - stringtitle - stringbutton1_text - stringbutton2_text - stringformat - mixedargs - mixed... - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - title - - - - - - - button1_text - - - - - - - button2_text - - - - - - - format - - - - - - - args - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-win-entries.xml b/reference/newt/functions/newt-win-entries.xml deleted file mode 100644 index fe2d34878be1..000000000000 --- a/reference/newt/functions/newt-win-entries.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - newt_win_entries - - - - &reftitle.description; - - intnewt_win_entries - stringtitle - stringtext - intsuggested_width - intflex_down - intflex_up - intdata_width - arrayitems - stringbutton1 - string... - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - title - - - - - - - text - - - - - - - suggested_width - - - - - - - flex_down - - - - - - - flex_up - - - - - - - data_width - - - - - - - items - - - - - - - button1 - - - - - - - button2 - - - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.examples; - - - A <function>newt_win_entries</function> example - - 'First name:', 'value' => &$f_name); -$entries[] = array('text' => 'Last name:', 'value' => &$l_name); - -$rc = newt_win_entries("User information", "Please enter your credentials:", 50, 7, 7, 30, $entries, "Ok", "Back"); -newt_finished (); - -if ($rc != 2) { - echo "Your name is: $f_name $l_name\n"; -} -?> -]]> - - - - - - - - diff --git a/reference/newt/functions/newt-win-menu.xml b/reference/newt/functions/newt-win-menu.xml deleted file mode 100644 index 6a6ed62ec7ff..000000000000 --- a/reference/newt/functions/newt-win-menu.xml +++ /dev/null @@ -1,206 +0,0 @@ - - - - - newt_win_menu - - - - &reftitle.description; - - intnewt_win_menu - stringtitle - stringtext - intsuggestedWidth - intflexDown - intflexUp - intmaxListHeight - arrayitems - intlistItem - stringbutton1 - string... - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - title - - - - - - - text - - - - - - - suggestedWidth - - - - - - - flexDown - - - - - - - flexUp - - - - - - - maxListHeight - - - - - - - items - - - - - - - listItem - - - - - - - button1 - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-win-message.xml b/reference/newt/functions/newt-win-message.xml deleted file mode 100644 index f71b0e8873e6..000000000000 --- a/reference/newt/functions/newt-win-message.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - newt_win_message - - - - &reftitle.description; - - voidnewt_win_message - stringtitle - stringbutton_text - stringformat - mixedargs - mixed... - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - title - - - - - - - button_text - - - - - - - format - - - - - - - args - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-win-messagev.xml b/reference/newt/functions/newt-win-messagev.xml deleted file mode 100644 index 5584c5a1453c..000000000000 --- a/reference/newt/functions/newt-win-messagev.xml +++ /dev/null @@ -1,165 +0,0 @@ - - - - - newt_win_messagev - - - - &reftitle.description; - - voidnewt_win_messagev - stringtitle - stringbutton_text - stringformat - arrayargs - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - title - - - - - - - button_text - - - - - - - format - - - - - - - args - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/functions/newt-win-ternary.xml b/reference/newt/functions/newt-win-ternary.xml deleted file mode 100644 index ffe80d13c0ac..000000000000 --- a/reference/newt/functions/newt-win-ternary.xml +++ /dev/null @@ -1,188 +0,0 @@ - - - - - newt_win_ternary - - - - &reftitle.description; - - intnewt_win_ternary - stringtitle - stringbutton1_text - stringbutton2_text - stringbutton3_text - stringformat - mixedargs - mixed... - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - title - - - Its description - - - - - button1_text - - - Its description - - - - - button2_text - - - Its description - - - - - button3_text - - - Its description - - - - - format - - - Its description - - - - - args - - - Its description - - - - - - - - &reftitle.returnvalues; - - What the function returns, first on success, then on failure. See - also the &return.success; entity - - - - - - - - - - - - - - - - - - diff --git a/reference/newt/reference.xml b/reference/newt/reference.xml deleted file mode 100644 index f06a00eeb675..000000000000 --- a/reference/newt/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - Newt &Functions; - - &reference.newt.entities.functions; - - - diff --git a/reference/newt/setup.xml b/reference/newt/setup.xml deleted file mode 100644 index 8f30f8ab61b1..000000000000 --- a/reference/newt/setup.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - This module uses the functions of the RedHat Newt library. - You need libnewt version >= 0.51.0. - -
    - - - - &reference.newt.configure; - - - -
    - &reftitle.runtime; - &no.config; -
    - - - -
    - &reftitle.resources; - - This extension uses two resource types: "newt component" and "newt grid". - - - Resource type "newt component" is returned by functions, which create - common newt widgets (for example: newt_button) - - - Resource type "newt grid" is a special link identifier for components, - returned by newt grid factory functions (for example: newt_create_grid) - -
    - - -     - - - diff --git a/reference/newt/versions.xml b/reference/newt/versions.xml deleted file mode 100644 index 5c4ab3c130b3..000000000000 --- a/reference/newt/versions.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/nis/book.xml b/reference/nis/book.xml deleted file mode 100644 index b02d63594e7b..000000000000 --- a/reference/nis/book.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - YP/NIS - - - - &reftitle.intro; - - NIS (formerly called Yellow Pages) allows network management of - important administrative files (e.g. the password file). For more - information refer to the NIS manpage and - The Linux NIS(YP)/NYS/NIS+ HOWTO. There is also a book called Managing NFS and NIS by Hal Stern. - - - - &pecl.moved-ver;5.1.0. - - - ¬e.no-windows.extension; - - - - &reference.nis.setup; - &reference.nis.constants; - &reference.nis.reference; - - - - - diff --git a/reference/nis/configure.xml b/reference/nis/configure.xml deleted file mode 100644 index 1dd6dc8f92c7..000000000000 --- a/reference/nis/configure.xml +++ /dev/null @@ -1,31 +0,0 @@ - - -
    - &reftitle.install; - - &pecl.info.dead; - &url.pecl.vcs;yp - -
    - - - diff --git a/reference/nis/constants.xml b/reference/nis/constants.xml deleted file mode 100644 index c1a0d7701977..000000000000 --- a/reference/nis/constants.xml +++ /dev/null @@ -1,205 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - YPERR_ACCESS - (integer) - - - - access violation (this has only been added recently and is only available from PECL SVN for now) - - - - - - YPERR_BADARGS - (integer) - - - - The function arguments are bad - - - - - - YPERR_BADDB - (integer) - - - - YP database is bad - - - - - - YPERR_BUSY - (integer) - - - - Database busy - - - - - - YPERR_DOMAIN - (integer) - - - - cannot bind to server in this domain - - - - - - YPERR_KEY - (integer) - - - - no such key in map - - - - - - YPERR_MAP - (integer) - - - - no such map in server's domain - - - - - - YPERR_NODOM - (integer) - - - - Local domain name not set - - - - - - YPERR_NOMORE - (integer) - - - - No more records in map database - - - - - - YPERR_PMAP - (integer) - - - - Can't communicate with portmapper - - - - - - YPERR_RESRC - (integer) - - - - resource allocation failure - - - - - - YPERR_RPC - (integer) - - - - RPC failure - domain has been unbound - - - - - - YPERR_YPBIND - (integer) - - - - Can't communicate with ypbind - - - - - - YPERR_YPERR - (integer) - - - - internal yp server or client error - - - - - - YPERR_YPSERV - (integer) - - - - Can't communicate with ypserv - - - - - - YPERR_VERS - (integer) - - - - YP version mismatch - - - - - - - diff --git a/reference/nis/functions/yp-all.xml b/reference/nis/functions/yp-all.xml deleted file mode 100644 index f3adeaaf5825..000000000000 --- a/reference/nis/functions/yp-all.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - yp_all - Traverse the map and call a function on each entry - - - - &reftitle.description; - - voidyp_all - stringdomain - stringmap - stringcallback - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - - domain - - - The NIS domain name. - - - - - map - - - The NIS map. - - - - - callback - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - diff --git a/reference/nis/functions/yp-cat.xml b/reference/nis/functions/yp-cat.xml deleted file mode 100644 index b8e8dcab08f5..000000000000 --- a/reference/nis/functions/yp-cat.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - yp_cat - Return an array containing the entire map - - - - &reftitle.description; - - arrayyp_cat - stringdomain - stringmap - - - Returns all map entries. - - - - - &reftitle.parameters; - - - - domain - - - The NIS domain name. - - - - - map - - - The NIS map. - - - - - - - - - &reftitle.returnvalues; - - Returns an array of all map entries, the maps key values as array indices - and the maps entries as array data. - - - - - diff --git a/reference/nis/functions/yp-err-string.xml b/reference/nis/functions/yp-err-string.xml deleted file mode 100644 index 7e9ce04c117c..000000000000 --- a/reference/nis/functions/yp-err-string.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - yp_err_string - Returns the error string associated with the given error code - - - - &reftitle.description; - - stringyp_err_string - interrorcode - - - Returns the error message associated with the given error code. - Useful to indicate what exactly went wrong. - - - - - &reftitle.parameters; - - - - errorcode - - - The error code. - - - - - - - - - &reftitle.returnvalues; - - Returns the error message, as a string. - - - - - &reftitle.examples; - - - Example for NIS errors - - -]]> - - - - - - - &reftitle.seealso; - - - yp_errno - - - - - - diff --git a/reference/nis/functions/yp-errno.xml b/reference/nis/functions/yp-errno.xml deleted file mode 100644 index 7db64eef1f1e..000000000000 --- a/reference/nis/functions/yp-errno.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - yp_errno - Returns the error code of the previous operation - - - - &reftitle.description; - - intyp_errno - - - - Returns the error code of the previous operation. - - - - - &reftitle.returnvalues; - - Returns one of the YPERR_XXX error constants. - - - - - &reftitle.seealso; - - - yp_err_string - - - - - - - diff --git a/reference/nis/functions/yp-first.xml b/reference/nis/functions/yp-first.xml deleted file mode 100644 index 1aff28834c77..000000000000 --- a/reference/nis/functions/yp-first.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - yp_first - Returns the first key-value pair from the named map - - - - &reftitle.description; - - arrayyp_first - stringdomain - stringmap - - - Gets the first key-value pair from the named map - in the named domain. - - - - - &reftitle.parameters; - - - - domain - - - The NIS domain name. - - - - - map - - - The NIS map. - - - - - - - - - &reftitle.returnvalues; - - Returns the first key-value pair as an array on success, or &false; on - errors. - - - - - &reftitle.examples; - - - Example for the NIS first - - -]]> - - - - - - - &reftitle.seealso; - - - yp_next - yp_get_default_domain - - - - - - - diff --git a/reference/nis/functions/yp-get-default-domain.xml b/reference/nis/functions/yp-get-default-domain.xml deleted file mode 100644 index 4eb5ea3bf9c3..000000000000 --- a/reference/nis/functions/yp-get-default-domain.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - yp_get_default_domain - Fetches the machine's default NIS domain - - - - &reftitle.description; - - stringyp_get_default_domain - - - - Returns the default domain of the node. Can be used as the domain - parameter for successive NIS calls. - - - A NIS domain can be described a group of NIS maps. Every host that needs - to look up information binds itself to a certain domain. Refer to the - documents mentioned at the beginning for more detailed information. - - - - - &reftitle.returnvalues; - - Returns the default domain of the node or &false;. Can be used as the - domain parameter for successive NIS calls. - - - - - &reftitle.examples; - - - Example for the default domain - - -]]> - - - - - - - - diff --git a/reference/nis/functions/yp-master.xml b/reference/nis/functions/yp-master.xml deleted file mode 100644 index 5e7b49c7e1f1..000000000000 --- a/reference/nis/functions/yp-master.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - yp_master - Returns the machine name of the master NIS server for a map - - - - &reftitle.description; - - stringyp_master - stringdomain - stringmap - - - Returns the machine name of the master NIS server for a - map. - - - - - &reftitle.parameters; - - - - domain - - - The NIS domain name. - - - - - map - - - The NIS map. - - - - - - - - - &reftitle.returnvalues; - - - - - - &reftitle.examples; - - - Example for the NIS master - - -]]> - - - - - - - &reftitle.seealso; - - - yp_get_default_domain - - - - - - - diff --git a/reference/nis/functions/yp-match.xml b/reference/nis/functions/yp-match.xml deleted file mode 100644 index acb15570c9ac..000000000000 --- a/reference/nis/functions/yp-match.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - yp_match - Returns the matched line - - - - &reftitle.description; - - stringyp_match - stringdomain - stringmap - stringkey - - - Returns the value associated with the passed key - out of the specified map. - - - - - &reftitle.parameters; - - - - domain - - - The NIS domain name. - - - - - map - - - The NIS map. - - - - - key - - - This key must be exact. - - - - - - - - - &reftitle.returnvalues; - - Returns the value, or &false; on errors. - - - - - &reftitle.examples; - - - Example for NIS match - - -]]> - - &example.outputs.similar; - - - - - - - - - &reftitle.seealso; - - - yp_get_default_domain - - - - - - - diff --git a/reference/nis/functions/yp-next.xml b/reference/nis/functions/yp-next.xml deleted file mode 100644 index 76a0127ba07b..000000000000 --- a/reference/nis/functions/yp-next.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - yp_next - Returns the next key-value pair in the named map - - - - &reftitle.description; - - arrayyp_next - stringdomain - stringmap - stringkey - - - Returns the next key-value pair in the named map - after the specified key. - - - - - &reftitle.parameters; - - - - domain - - - - - - - map - - - - - - - key - - - - - - - - - - - &reftitle.returnvalues; - - Returns the next key-value pair as an array, or &false; on errors. - - - - - &reftitle.examples; - - - Example for NIS next - -"; -} - -$key = key($entry); - -echo "The next entry after joe has key " . $key - . " and value " . $entry[$key]; -?> -]]> - - - - - - - &reftitle.seealso; - - - yp_first - yp_get_default_domain - - - - - - - diff --git a/reference/nis/functions/yp-order.xml b/reference/nis/functions/yp-order.xml deleted file mode 100644 index 14f0a39191a7..000000000000 --- a/reference/nis/functions/yp-order.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - yp_order - Returns the order number for a map - - - - &reftitle.description; - - intyp_order - stringdomain - stringmap - - - Gets the order number for a map. - - - - - &reftitle.parameters; - - - - domain - - - - - - - map - - - - - - - - - - - &reftitle.returnvalues; - - Returns the order number for a map or &false; on error. - - - - - &reftitle.examples; - - - Example for the NIS order - - -]]> - - - - - - - &reftitle.seealso; - - - yp_get_default_domain - - - - - - - diff --git a/reference/nis/reference.xml b/reference/nis/reference.xml deleted file mode 100644 index 6d0888b84ea7..000000000000 --- a/reference/nis/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - YP/NIS &Functions; - - &reference.nis.entities.functions; - - - - - diff --git a/reference/nis/setup.xml b/reference/nis/setup.xml deleted file mode 100644 index 8fdcb85f2555..000000000000 --- a/reference/nis/setup.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - None besides functions from standard Unix libraries which are - always available (either libc or - libnsl, configure will detect which one to use). - -
    - - - - &reference.nis.configure; - - - -
    - &reftitle.runtime; - &no.config; -
    - - - -
    - &reftitle.resources; - &no.resource; -
    - - -     - - - diff --git a/reference/nis/versions.xml b/reference/nis/versions.xml deleted file mode 100644 index 97ac2b9797fb..000000000000 --- a/reference/nis/versions.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/oci8/functions/oci-set-prefetch.xml b/reference/oci8/functions/oci-set-prefetch.xml index 93a0ad3a175a..0b22badc04af 100644 --- a/reference/oci8/functions/oci-set-prefetch.xml +++ b/reference/oci8/functions/oci-set-prefetch.xml @@ -109,13 +109,13 @@ - 5.3.2 (PECL OCI8 1.4) + PECL OCI8 1.4 Before this release, rows must be >= 1. - 5.3.0 (PECL OCI8 1.3.4) + PECL OCI8 1.3.4 Before this release, prefetching was limited to the lesser of rows rows and 1024 diff --git a/reference/oggvorbis/book.xml b/reference/oggvorbis/book.xml deleted file mode 100644 index 19c70c6d790f..000000000000 --- a/reference/oggvorbis/book.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - OGG/Vorbis - oggvorbis - - - - &reftitle.intro; - - The OGG/Vorbis file format, as defined by &url.ogg.vorbis;, is a scheme - for compressing audio streams by multiple factors with a minimum of - quality loss. This extension adds Ogg Vorbis support to PHP's - URL Wrappers. When used in read mode, - compressed OGG/Vorbis data is expanded to raw PCM audio in one of six PCM - encoding formats listed in the predefined - constants section. - - - - - &reference.oggvorbis.setup; - &reference.oggvorbis.constants; - &reference.oggvorbis.contexts; - &reference.oggvorbis.examples; - - - - - diff --git a/reference/oggvorbis/configure.xml b/reference/oggvorbis/configure.xml deleted file mode 100644 index 873c16639b96..000000000000 --- a/reference/oggvorbis/configure.xml +++ /dev/null @@ -1,31 +0,0 @@ - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;oggvorbis - -
    - - - diff --git a/reference/oggvorbis/constants.xml b/reference/oggvorbis/constants.xml deleted file mode 100644 index f922826db682..000000000000 --- a/reference/oggvorbis/constants.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - OGG/Vorbis supports PCM encodings in the following formats - - - - Constant - Definition - - - - - OGGVORBIS_PCM_U8 - Unsigned 8-bit PCM. - - - OGGVORBIS_PCM_S8 - Signed 8-bit PCM. - - - OGGVORBIS_PCM_U16_LE - Unsigned 16-bit PCM. Little Endian byte order. - - - OGGVORBIS_PCM_U16_BE - Unsigned 16-bit PCM. Big Endian byte order. - - - OGGVORBIS_PCM_S16_LE - Signed 16-bit PCM. Little Endian byte order. - - - OGGVORBIS_PCM_S16_BE - Signed 16-bit PCM. Big Endian byte order. - - - -
    -     - - diff --git a/reference/oggvorbis/contexts.xml b/reference/oggvorbis/contexts.xml deleted file mode 100644 index fe409f94fdcc..000000000000 --- a/reference/oggvorbis/contexts.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - Context options - - OGG/Vorbis tuning options - - - - Option - Definition - Relevance - Default - - - - - pcm_mode - PCM byte encoding used. See constants below. - Read / Write - OGGVORBIS_PCM_S16_LE - - - rate - PCM Sampling rate. Measured in Hz. - Write only - 44100 - - - bitrate - - Vorbis Average Bitrate Encoding / Variable Bitrate Encoding. - Measured in bps (ABR) or Quality level (VBR: 0.0 to 1.0). - 128000 ABR is rough equal to 0.4 VBR. - - Write only - 128000 - - - channels - Number of PCM channels. 1 == Mono, 2 == Stereo. - Write only - 2 - - - serialno - - Serial Number of stream within file. Must be unique within file. - Because of the potential to select a duplicate serial number within - a chained file, make efforts to manually assign unique numbers when - encoding. - - Write only - Random - - - comments - - Associative array of file comments. - Will be translated to strtoupper($name) . "=$value". - Note: This context option is not available in oggvorbis-0.1 - - Write only - array('ENCODER' => 'PHP/OggVorbis, http://pear.php.net/oggvorbis') - - - -
    -     - - diff --git a/reference/oggvorbis/examples.xml b/reference/oggvorbis/examples.xml deleted file mode 100644 index 0e38bd11bb37..000000000000 --- a/reference/oggvorbis/examples.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - &reftitle.examples; -
    - Examples on using the ogg:// wrapper. - - - Reading an OGG/Vorbis file - - -]]> - - - - - - - Encode an audio file to OGG/Vorbis - -array( - 'pcm_mode' => OGGVORBIS_PCM_S8, /* Signed 8bit audio */ - 'rate' => 44100, /* 44kHz CD quality */ - 'bitrate' => 0.5, /* Midquality VBR */ - 'channels' => 1, /* Mono */ - 'serialno' => 12345))); /* Unique within our stream */ - -/* Open file for appending. This will "chain" a second OGG stream at the end of the first. */ -$ogg = fopen('ogg://mysong.ogg', 'a', false, $context); - -$pcm = fopen('mysample.pcm', 'r'); - -/* Compress the raw PCM audio from mysample.pcm into mysong.ogg */ -stream_copy_to_stream($pcm, $ogg); - -fclose($pcm); -fclose($ogg); -?> -]]> - - - -
    -     - - - diff --git a/reference/oggvorbis/setup.xml b/reference/oggvorbis/setup.xml deleted file mode 100644 index 1727cce97abf..000000000000 --- a/reference/oggvorbis/setup.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - This extension requires PHP >= 4.3.0, - libogg >= 1.0, and - libvorbis >= 1.0. - -
    - - - - &reference.oggvorbis.configure; - - - -
    - &reftitle.runtime; - &no.config; -
    - - - -
    - &reftitle.resources; - &no.resource; -
    - - -     - - - diff --git a/reference/openssl/functions/openssl-decrypt.xml b/reference/openssl/functions/openssl-decrypt.xml index db1d90133a39..695d1583c79d 100644 --- a/reference/openssl/functions/openssl-decrypt.xml +++ b/reference/openssl/functions/openssl-decrypt.xml @@ -135,18 +135,6 @@ 7.1.0 The tag and aad parameters were added.     - - 5.4.0 - - The raw_output was changed to options. - - - - 5.3.3 - - The iv parameter was added. - - diff --git a/reference/openssl/functions/openssl-encrypt.xml b/reference/openssl/functions/openssl-encrypt.xml index 0333d27deb0e..18aa0c61d415 100644 --- a/reference/openssl/functions/openssl-encrypt.xml +++ b/reference/openssl/functions/openssl-encrypt.xml @@ -134,18 +134,6 @@ 7.1.0 The tag, aad and tag_length parameters were added. - - 5.4.0 - - The raw_output was changed to options. - - - - 5.3.3 - - The iv parameter was added. - - diff --git a/reference/openssl/functions/openssl-open.xml b/reference/openssl/functions/openssl-open.xml index 64190f1f7712..10f20c55a51e 100644 --- a/reference/openssl/functions/openssl-open.xml +++ b/reference/openssl/functions/openssl-open.xml @@ -90,34 +90,6 @@     - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 7.0.0 - - The iv has been added. - - - - 5.3.0 - - The method has been added. - - - - - - - &reftitle.examples; diff --git a/reference/openssl/functions/openssl-pkcs7-verify.xml b/reference/openssl/functions/openssl-pkcs7-verify.xml index b2f14ec13eb5..55a4349727de 100644 --- a/reference/openssl/functions/openssl-pkcs7-verify.xml +++ b/reference/openssl/functions/openssl-pkcs7-verify.xml @@ -125,12 +125,6 @@ The p7bfilename parameter was added. - - 5.1.0 - - The content parameter was added. - - diff --git a/reference/openssl/functions/openssl-seal.xml b/reference/openssl/functions/openssl-seal.xml index 36ff29d518a0..4701346be272 100644 --- a/reference/openssl/functions/openssl-seal.xml +++ b/reference/openssl/functions/openssl-seal.xml @@ -96,34 +96,6 @@ - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 7.0.0 - - The iv has been added. - - - - 5.3.0 - - The method has been added. - - - - - - - &reftitle.examples; diff --git a/reference/openssl/functions/openssl-verify.xml b/reference/openssl/functions/openssl-verify.xml index 51dbd6933a89..e5f6c8fd47b4 100644 --- a/reference/openssl/functions/openssl-verify.xml +++ b/reference/openssl/functions/openssl-verify.xml @@ -79,30 +79,6 @@ MIIBCgK..." - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.0 - - The signature_alg parameter was added. - - - - - - - - &reftitle.examples; diff --git a/reference/outcontrol/functions/ob-start.xml b/reference/outcontrol/functions/ob-start.xml index 01b040f1b279..3e07d7776ea8 100644 --- a/reference/outcontrol/functions/ob-start.xml +++ b/reference/outcontrol/functions/ob-start.xml @@ -204,55 +204,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 7.0.0 - - In case ob_start is used inside an output buffer - callback, this function will no longer issue an E_ERROR - but instead an E_RECOVERABLE_ERROR, allowing custom - error handlers to catch such errors. - - - - 5.4.0 - - The third parameter of ob_start changed from a - boolean parameter called erase - (which, if set to &false;, would prevent the output buffer from being - deleted until the script finished executing) to an - integer parameter called flags. - Unfortunately, this results in an API compatibility break for code - written prior to PHP 5.4.0 that uses the third parameter. See - the flags example - for an example of how to handle this with code that needs to be - compatible with both. - - - - 5.4.0 - - A chunk size of 1 now results in chunks of 1 byte - being sent to the output buffer. - - - - - - - - &reftitle.examples; diff --git a/reference/parsekit/book.xml b/reference/parsekit/book.xml deleted file mode 100644 index 90926bcfec1c..000000000000 --- a/reference/parsekit/book.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - Parsekit - - - &reftitle.intro; - - These functions allow runtime analysis of opcodes compiled from PHP scripts. - - - - &reference.parsekit.setup; - &reference.parsekit.constants; - &reference.parsekit.reference; - - - - - diff --git a/reference/parsekit/configure.xml b/reference/parsekit/configure.xml deleted file mode 100644 index ac32ff8c36da..000000000000 --- a/reference/parsekit/configure.xml +++ /dev/null @@ -1,37 +0,0 @@ - - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;parsekit. - - - &pecl.windows.download; - -
    - - - diff --git a/reference/parsekit/constants.xml b/reference/parsekit/constants.xml deleted file mode 100644 index 05f791d56602..000000000000 --- a/reference/parsekit/constants.xml +++ /dev/null @@ -1,1890 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - - PARSEKIT_QUIET - (int) - - - - Return full detail, but without unnecessary NULL entries. - - - - - - - PARSEKIT_SIMPLE - (int) - - - - Return shorthand opcode notation. - - - - - - - PARSEKIT_EXTENDED_VALUE - (int) - - - - Opnode Flag - - - - - - - PARSEKIT_RESULT_CONST - (int) - - - - Opnode Flag - - - - - - - PARSEKIT_RESULT_EA_TYPE - (int) - - - - Opnode Flag - - - - - - - PARSEKIT_RESULT_JMP_ADDR - (int) - - - - Opnode Flag - - - - - - - PARSEKIT_RESULT_OPARRAY - (int) - - - - Opnode Flag - - - - - - - PARSEKIT_RESULT_OPLINE - (int) - - - - Opnode Flag - - - - - - - PARSEKIT_RESULT_VAR - (int) - - - - Opnode Flag - - - - - - - PARSEKIT_USAGE_UNKNOWN - (int) - - - - Opnode Flag - - - - - - - PARSEKIT_ZEND_INTERNAL_CLASS - (int) - - - - Class Type - - - - - - - PARSEKIT_ZEND_USER_CLASS - (int) - - - - Class Type - - - - - - - PARSEKIT_ZEND_EVAL_CODE - (int) - - - - Function Type - - - - - - - PARSEKIT_ZEND_INTERNAL_FUNCTION - (int) - - - - Function Type - - - - - - - PARSEKIT_ZEND_OVERLOADED_FUNCTION - (int) - - - - Function Type - - - - - - - PARSEKIT_ZEND_OVERLOADED_FUNCTION_TEMPORARY - (int) PHP >= 5.0.0 - - - - Function Type - - - - - - - PARSEKIT_ZEND_USER_FUNCTION - (int) - - - - Function Type - - - - - - - PARSEKIT_IS_CONST - (int) - - - - Node Type - - - - - - - PARSEKIT_IS_TMP_VAR - (int) - - - - Node Type - - - - - - - PARSEKIT_IS_UNUSED - (int) - - - - Node Type - - - - - - - PARSEKIT_IS_VAR - (int) - - - - Node Type - - - - - - - PARSEKIT_ZEND_ADD - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_ADD_ARRAY_ELEMENT - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_ADD_CHAR - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_ADD_INTERFACE - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_ADD_STRING - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_ADD_VAR - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_ASSIGN - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_ASSIGN_ADD - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_ASSIGN_BW_AND - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_ASSIGN_BW_OR - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_ASSIGN_BW_XOR - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_ASSIGN_CONCAT - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_ASSIGN_DIM - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_ASSIGN_DIV - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_ASSIGN_MOD - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_ASSIGN_MUL - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_ASSIGN_OBJ - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_ASSIGN_REF - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_ASSIGN_SL - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_ASSIGN_SR - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_ASSIGN_SUB - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_BEGIN_SILENCE - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_BOOL - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_BOOL_NOT - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_BOOL_XOR - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_BRK - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_BW_AND - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_BW_NOT - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_BW_OR - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_BW_XOR - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_CASE - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_CAST - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_CATCH - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_CLONE - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_CONCAT - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_CONT - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_DECLARE_CLASS - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_DECLARE_FUNCTION - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_DECLARE_INHERITED_CLASS - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_DIV - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_DO_FCALL - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_DO_FCALL_BY_NAME - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_ECHO - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_END_SILENCE - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_EXIT - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_EXT_FCALL_BEGIN - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_EXT_FCALL_END - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_EXT_NOP - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_EXT_STMT - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_FETCH_CLASS - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_FETCH_CONSTANT - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_FETCH_DIM_FUNC_ARG - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_FETCH_DIM_IS - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_FETCH_DIM_R - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_FETCH_DIM_RW - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_FETCH_DIM_TMP_VAR - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_FETCH_DIM_UNSET - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_FETCH_DIM_W - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_FETCH_FUNC_ARG - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_FETCH_IS - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_FETCH_OBJ_FUNC_ARG - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_FETCH_OBJ_IS - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_FETCH_OBJ_R - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_FETCH_OBJ_RW - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_FETCH_OBJ_UNSET - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_FETCH_OBJ_W - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_FETCH_R - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_FETCH_RW - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_FETCH_UNSET - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_FETCH_W - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_FE_FETCH - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_FE_RESET - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_FREE - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_HANDLE_EXCEPTION - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_IMPORT_CLASS - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_IMPORT_CONST - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_IMPORT_FUNCTION - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_INCLUDE_OR_EVAL - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_INIT_ARRAY - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_INIT_CTOR_CALL - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_INIT_FCALL_BY_NAME - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_INIT_METHOD_CALL - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_INIT_STATIC_METHOD_CALL - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_INIT_STRING - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_INSTANCEOF - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_ISSET_ISEMPTY - (int) PHP < 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_ISSET_ISEMPTY_DIM_OBJ - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_ISSET_ISEMPTY_PROP_OBJ - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_ISSET_ISEMPTY_VAR - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_IS_EQUAL - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_IS_IDENTICAL - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_IS_NOT_EQUAL - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_IS_NOT_IDENTICAL - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_IS_SMALLER - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_IS_SMALLER_OR_EQUAL - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_JMP - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_JMPNZ - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_JMPNZ_EX - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_JMPZ - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_JMPZNZ - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_JMPZ_EX - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_JMP_NO_CTOR - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_MOD - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_MUL - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_NEW - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_NOP - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_OP_DATA - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_POST_DEC - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_POST_DEC_OBJ - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_POST_INC - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_POST_INC_OBJ - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_PRE_DEC - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_PRE_DEC_OBJ - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_PRE_INC - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_PRE_INC_OBJ - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_PRINT - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_QM_ASSIGN - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_RAISE_ABSTRACT_ERROR - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_RECV - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_RECV_INIT - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_RETURN - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_SEND_REF - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_SEND_VAL - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_SEND_VAR - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_SEND_VAR_NO_REF - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_SL - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_SR - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_SUB - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_SWITCH_FREE - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_THROW - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - PARSEKIT_ZEND_TICKS - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_UNSET_DIM_OBJ - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_UNSET_VAR - (int) - - - - Opcode - - - - - - - PARSEKIT_ZEND_VERIFY_ABSTRACT_CLASS - (int) PHP >= 5.0.0 - - - - Opcode - - - - - - - - diff --git a/reference/parsekit/functions/parsekit-compile-file.xml b/reference/parsekit/functions/parsekit-compile-file.xml deleted file mode 100644 index 8c2dbb6d4546..000000000000 --- a/reference/parsekit/functions/parsekit-compile-file.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - parsekit_compile_file - Compile a PHP file and return the resulting op array - - - &reftitle.description; - - arrayparsekit_compile_file - stringfilename - arrayerrors - intoptionsPARSEKIT_QUIET - - &warn.experimental.func; - - - &reftitle.parameters; - - - - filename - - - A string containing the name of the file to compile. - Similar to the argument to include. - - - - - errors - - - A 2D hash of errors (including fatal errors) encountered during compilation. - Returned by reference. - - - - - options - - - One of either PARSEKIT_QUIET or - PARSEKIT_SIMPLE. To produce varying - degrees of verbosity in the returned output. - - - - - - - - &reftitle.returnvalues; - - Returns a complex multi-layer array structure as detailed below. - - - - - &reftitle.examples; - - - <function>parsekit_compile_file</function> example - - -]]> - - &example.outputs; - - - string(37) "ZEND_ECHO UNUSED 'Hello World' UNUSED" - [1]=> - string(30) "ZEND_RETURN UNUSED NULL UNUSED" - [2]=> - string(42) "ZEND_HANDLE_EXCEPTION UNUSED UNUSED UNUSED" - ["function_table"]=> - NULL - ["class_table"]=> - NULL -} -]]> - - - - - - &reftitle.seealso; - - - parsekit_compile_string - - - - - - diff --git a/reference/parsekit/functions/parsekit-compile-string.xml b/reference/parsekit/functions/parsekit-compile-string.xml deleted file mode 100644 index 8d08cc0d2a38..000000000000 --- a/reference/parsekit/functions/parsekit-compile-string.xml +++ /dev/null @@ -1,209 +0,0 @@ - - - - - parsekit_compile_string - Compile a string of PHP code and return the resulting op array - - - &reftitle.description; - - arrayparsekit_compile_string - stringphpcode - arrayerrors - intoptionsPARSEKIT_QUIET - - &warn.experimental.func; - - - &reftitle.parameters; - - - - phpcode - - - A string containing phpcode. Similar to the argument to eval. - - - - - errors - - - A 2D hash of errors (including fatal errors) encountered during compilation. - Returned by reference. - - - - - options - - - One of either PARSEKIT_QUIET or - PARSEKIT_SIMPLE. To produce varying - degrees of verbosity in the returned output. - - - - - - - - &reftitle.returnvalues; - - Returns a complex multi-layer array structure as detailed below. - - - - - &reftitle.examples; - - - <function>parsekit_compile_string</function> example - - -]]> - - &example.outputs; - - - int(4) - ["type_name"]=> - string(14) "ZEND_EVAL_CODE" - ["fn_flags"]=> - int(0) - ["num_args"]=> - int(0) - ["required_num_args"]=> - int(0) - ["pass_rest_by_reference"]=> - bool(false) - ["uses_this"]=> - bool(false) - ["line_start"]=> - int(0) - ["line_end"]=> - int(0) - ["return_reference"]=> - bool(false) - ["refcount"]=> - int(1) - ["last"]=> - int(3) - ["size"]=> - int(3) - ["T"]=> - int(0) - ["last_brk_cont"]=> - int(0) - ["current_brk_cont"]=> - int(-1) - ["backpatch_count"]=> - int(0) - ["done_pass_two"]=> - bool(true) - ["filename"]=> - string(17) "Parsekit Compiler" - ["opcodes"]=> - array(3) { - [8594800]=> - array(5) { - ["opcode"]=> - int(40) - ["opcode_name"]=> - string(9) "ZEND_ECHO" - ["flags"]=> - int(768) - ["op1"]=> - array(3) { - ["type"]=> - int(1) - ["type_name"]=> - string(8) "IS_CONST" - ["constant"]=> - &string(4) "Foo -" - } - ["lineno"]=> - int(2) - } - ["859484C"]=> - array(6) { - ["opcode"]=> - int(62) - ["opcode_name"]=> - string(11) "ZEND_RETURN" - ["flags"]=> - int(16777984) - ["op1"]=> - array(3) { - ["type"]=> - int(1) - ["type_name"]=> - string(8) "IS_CONST" - ["constant"]=> - &NULL - } - ["extended_value"]=> - int(0) - ["lineno"]=> - int(3) - } - [8594898]=> - array(4) { - ["opcode"]=> - int(149) - ["opcode_name"]=> - string(21) "ZEND_HANDLE_EXCEPTION" - ["flags"]=> - int(0) - ["lineno"]=> - int(3) - } - } -} -]]> - - - - - - &reftitle.seealso; - - - parsekit_compile_file - - - - - - diff --git a/reference/parsekit/functions/parsekit-func-arginfo.xml b/reference/parsekit/functions/parsekit-func-arginfo.xml deleted file mode 100644 index bf8548d157b0..000000000000 --- a/reference/parsekit/functions/parsekit-func-arginfo.xml +++ /dev/null @@ -1,122 +0,0 @@ - - - - - parsekit_func_arginfo - Return information regarding function argument(s) - - - &reftitle.description; - - arrayparsekit_func_arginfo - mixedfunction - - &warn.experimental.func; - - - &reftitle.parameters; - - - - function - - - A string describing a function, or an array describing a class/method. - - - - - - - - &reftitle.returnvalues; - - Returns an array containing argument information. - - - - - &reftitle.examples; - - - <function>parsekit_func_arginfo</function> example - - -]]> - - &example.outputs; - - - array(3) { - ["name"]=> - string(3) "bar" - ["allow_null"]=> - bool(true) - ["pass_by_reference"]=> - bool(false) - } - [1]=> - array(4) { - ["name"]=> - string(3) "baz" - ["class_name"]=> - string(8) "stdClass" - ["allow_null"]=> - bool(false) - ["pass_by_reference"]=> - bool(false) - } - [2]=> - array(3) { - ["name"]=> - string(4) "bomb" - ["allow_null"]=> - bool(true) - ["pass_by_reference"]=> - bool(true) - } - [3]=> - array(3) { - ["name"]=> - string(5) "bling" - ["allow_null"]=> - bool(true) - ["pass_by_reference"]=> - bool(false) - } -} -]]> - - - - - - - diff --git a/reference/parsekit/ini.xml b/reference/parsekit/ini.xml deleted file mode 100644 index 2db4b85df184..000000000000 --- a/reference/parsekit/ini.xml +++ /dev/null @@ -1,27 +0,0 @@ - - -
    - &reftitle.runtime; - &no.config; -
    - - diff --git a/reference/parsekit/reference.xml b/reference/parsekit/reference.xml deleted file mode 100644 index dc9becc657f7..000000000000 --- a/reference/parsekit/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - Parsekit &Functions; - - &reference.parsekit.entities.functions; - - - - diff --git a/reference/parsekit/setup.xml b/reference/parsekit/setup.xml deleted file mode 100644 index d9d948a4d58b..000000000000 --- a/reference/parsekit/setup.xml +++ /dev/null @@ -1,43 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - &no.requirement; -
    - - &reference.parsekit.configure; - - &reference.parsekit.ini; - -
    - &reftitle.resources; - &no.resource; -
    - -     - - - diff --git a/reference/parsekit/versions.xml b/reference/parsekit/versions.xml deleted file mode 100644 index a623a5911215..000000000000 --- a/reference/parsekit/versions.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/pcre/functions/preg-match-all.xml b/reference/pcre/functions/preg-match-all.xml index 3eac39614ab5..8beb73fa1fef 100644 --- a/reference/pcre/functions/preg-match-all.xml +++ b/reference/pcre/functions/preg-match-all.xml @@ -304,30 +304,6 @@ Array $flags parameter. - - 5.4.0 - - The matches parameter became optional. - - - - 5.3.6 - - Returns &false; if offset - is higher than - subject length. - - - - 5.2.2 - - Named subpatterns now accept the - syntax (?<name>) - and (?'name') as well - as (?P<name>). Previous versions - accepted only (?P<name>). - - diff --git a/reference/pcre/functions/preg-match.xml b/reference/pcre/functions/preg-match.xml index 5f9513228328..48b408dc3681 100644 --- a/reference/pcre/functions/preg-match.xml +++ b/reference/pcre/functions/preg-match.xml @@ -273,23 +273,6 @@ Array $flags parameter. - - 5.3.6 - - Returns &false; if offset is higher than - subject length. - - - - 5.2.2 - - Named subpatterns now accept the - syntax (?<name>) - and (?'name') as well - as (?P<name>). Previous versions - accepted only (?P<name>). - - diff --git a/reference/pcre/functions/preg-quote.xml b/reference/pcre/functions/preg-quote.xml index db0cdeb11623..6aae6b63ff71 100644 --- a/reference/pcre/functions/preg-quote.xml +++ b/reference/pcre/functions/preg-quote.xml @@ -87,12 +87,6 @@ The # character is now quoted - - 5.3.0 - - The - character is now quoted - - diff --git a/reference/pcre/functions/preg-replace-callback.xml b/reference/pcre/functions/preg-replace-callback.xml index 69a51fcb265f..8f27f132a2d7 100644 --- a/reference/pcre/functions/preg-replace-callback.xml +++ b/reference/pcre/functions/preg-replace-callback.xml @@ -166,12 +166,6 @@ fclose($fp); The flags parameter was added. - - 5.1.0 - - The count parameter was added. - - diff --git a/reference/pcre/functions/preg-replace.xml b/reference/pcre/functions/preg-replace.xml index bebb2737ce1a..b774ca3b5d2d 100644 --- a/reference/pcre/functions/preg-replace.xml +++ b/reference/pcre/functions/preg-replace.xml @@ -151,46 +151,6 @@     - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 7.0.0 - - Support for the /e modifier has been removed. - Use preg_replace_callback instead. - - - - 5.5.0 - - The /e modifier is deprecated. Use - preg_replace_callback instead. See the - PREG_REPLACE_EVAL - documentation for additional information about security risks. - - - - 5.1.0 - - Added the count parameter - - - - - - - - &reftitle.examples; diff --git a/reference/pdo/pdo/construct.xml b/reference/pdo/pdo/construct.xml index 079a4128c3ae..3a7a1a2c6199 100644 --- a/reference/pdo/pdo/construct.xml +++ b/reference/pdo/pdo/construct.xml @@ -209,32 +209,6 @@ try { - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - Classes which extends PDO and implements the __call - magic method will now receive the method name in the declared casing. Previously this was always - lower case. - - - - - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - PDO_DBLIB driver support added - - - 5.2.3 - table field - - - - - - - &reftitle.examples; diff --git a/reference/pdo_mysql/reference.xml b/reference/pdo_mysql/reference.xml index 668475c9d569..1fe56d69ef94 100644 --- a/reference/pdo_mysql/reference.xml +++ b/reference/pdo_mysql/reference.xml @@ -159,30 +159,6 @@ $dbh = new PDO($dsn, $username, $password, $options); - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.6 - - Prior to version 5.3.6, charset was ignored. - - - - - - - - &reftitle.examples; diff --git a/reference/pgsql/functions/pg-escape-bytea.xml b/reference/pgsql/functions/pg-escape-bytea.xml index ab83f349a3bc..2d12fed3cb45 100644 --- a/reference/pgsql/functions/pg-escape-bytea.xml +++ b/reference/pgsql/functions/pg-escape-bytea.xml @@ -73,28 +73,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.0 - connection added - - - - - - - &reftitle.examples; diff --git a/reference/pgsql/functions/pg-escape-string.xml b/reference/pgsql/functions/pg-escape-string.xml index 1337ab8fd65c..23040fbe6913 100644 --- a/reference/pgsql/functions/pg-escape-string.xml +++ b/reference/pgsql/functions/pg-escape-string.xml @@ -68,28 +68,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.0 - connection added - - - - - - - &reftitle.examples; diff --git a/reference/pgsql/functions/pg-lo-create.xml b/reference/pgsql/functions/pg-lo-create.xml index a1dc7bf08940..f00d82d951c2 100644 --- a/reference/pgsql/functions/pg-lo-create.xml +++ b/reference/pgsql/functions/pg-lo-create.xml @@ -82,30 +82,6 @@ A large object OID or &false; on error. - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - The optional object_id was added. - - - - - - - &reftitle.examples; diff --git a/reference/pgsql/functions/pg-lo-import.xml b/reference/pgsql/functions/pg-lo-import.xml index b8bbd4f2038b..8c2d7953257b 100644 --- a/reference/pgsql/functions/pg-lo-import.xml +++ b/reference/pgsql/functions/pg-lo-import.xml @@ -80,30 +80,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - The optional object_id was added. - - - - - - - - &reftitle.examples; diff --git a/reference/phar/Phar/setStub.xml b/reference/phar/Phar/setStub.xml index 19663071c4e4..27dc4ab5820f 100644 --- a/reference/phar/Phar/setStub.xml +++ b/reference/phar/Phar/setStub.xml @@ -126,30 +126,6 @@ string(83) " - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - Added len parameter. - - - - - - - - &reftitle.seealso; diff --git a/reference/phar/PharData/setStub.xml b/reference/phar/PharData/setStub.xml index 2c15a37cab07..4649b9e12d12 100644 --- a/reference/phar/PharData/setStub.xml +++ b/reference/phar/PharData/setStub.xml @@ -60,30 +60,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - Added len parameter. - - - - - - - - &reftitle.seealso; diff --git a/reference/phdfs/book.xml b/reference/phdfs/book.xml deleted file mode 100644 index 61e407dbdd59..000000000000 --- a/reference/phdfs/book.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - Phdfs - Phdfs - - - The phdfs extensions is using PHP to manipulate Hadoop HDFS - phdfs requires PHP 5.3 or greater. Earlier versions may not work. - For a quick start guide, please refer to the Tutorials section. - - - - &reference.phdfs.setup; - &reference.phdfs.constants; - &reference.phdfs.phdfs; - - - - diff --git a/reference/phdfs/configure.xml b/reference/phdfs/configure.xml deleted file mode 100644 index 81fac450cfde..000000000000 --- a/reference/phdfs/configure.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - -
    - &reftitle.install; - - - Use when compiling PHP. - - -
    - - diff --git a/reference/phdfs/constants.xml b/reference/phdfs/constants.xml deleted file mode 100644 index 314a90101237..000000000000 --- a/reference/phdfs/constants.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - &reftitle.constants; - &extension.constants; - - - - - O_WRONLY - (integer) - - - - - - - - - O_CREAT - (integer) - - - - - - - - - O_APPEND - (integer) - - - - - - - - - - - diff --git a/reference/phdfs/phdfs.xml b/reference/phdfs/phdfs.xml deleted file mode 100644 index af16e6cbac27..000000000000 --- a/reference/phdfs/phdfs.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - The phdfs class - phdfs - - - - -
    - &reftitle.intro; - - - -
    - - -
    - &reftitle.classsynopsis; - - - - phdfs - - - - - phdfs - - - - &Properties; - - static - host - - - static - port - - - - &Methods; - - - - -
    - - - -
    - &reftitle.properties; - - - host - - - - - - port - - - - - -
    - - - -     - - &reference.phdfs.entities.phdfs; - -     - - diff --git a/reference/phdfs/phdfs/connect.xml b/reference/phdfs/phdfs/connect.xml deleted file mode 100644 index bd75271a9983..000000000000 --- a/reference/phdfs/phdfs/connect.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - phdfs::connect - Description - - - - &reftitle.description; - - public boolphdfs::connect - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/phdfs/phdfs/construct.xml b/reference/phdfs/phdfs/construct.xml deleted file mode 100644 index 4f37ad346479..000000000000 --- a/reference/phdfs/phdfs/construct.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - phdfs::__construct - Description - - - - &reftitle.description; - - public phdfs::__construct - stringip - stringport - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - ip - - - - - - - - port - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/phdfs/phdfs/copy.xml b/reference/phdfs/phdfs/copy.xml deleted file mode 100644 index 2bebf08f6a75..000000000000 --- a/reference/phdfs/phdfs/copy.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - phdfs::copy - Description - - - - &reftitle.description; - - public boolphdfs::copy - stringsource_file - stringdestination_file - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - source_file - - - - - - - - destination_file - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/phdfs/phdfs/create-directory.xml b/reference/phdfs/phdfs/create-directory.xml deleted file mode 100644 index 78a30a82063f..000000000000 --- a/reference/phdfs/phdfs/create-directory.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - phdfs::create_directory - Description - - - - &reftitle.description; - - public boolphdfs::create_directory - stringpath - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - path - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/phdfs/phdfs/delete.xml b/reference/phdfs/phdfs/delete.xml deleted file mode 100644 index f3367e3fc245..000000000000 --- a/reference/phdfs/phdfs/delete.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - phdfs::delete - Description - - - - &reftitle.description; - - public boolphdfs::delete - stringpath - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - path - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/phdfs/phdfs/destruct.xml b/reference/phdfs/phdfs/destruct.xml deleted file mode 100644 index ae2157bb744e..000000000000 --- a/reference/phdfs/phdfs/destruct.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - phdfs::__destruct - Description - - - - &reftitle.description; - - public voidphdfs::__destruct - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.void; - - - - - - - diff --git a/reference/phdfs/phdfs/disconnect.xml b/reference/phdfs/phdfs/disconnect.xml deleted file mode 100644 index 2851b700f611..000000000000 --- a/reference/phdfs/phdfs/disconnect.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - phdfs::disconnect - Description - - - - &reftitle.description; - - public boolphdfs::disconnect - - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - &no.function.parameters; - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/phdfs/phdfs/exists.xml b/reference/phdfs/phdfs/exists.xml deleted file mode 100644 index 28cf4f4b5474..000000000000 --- a/reference/phdfs/phdfs/exists.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - phdfs::exists - Description - - - - &reftitle.description; - - public boolphdfs::exists - stringpath - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - path - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/phdfs/phdfs/file-info.xml b/reference/phdfs/phdfs/file-info.xml deleted file mode 100644 index d1e1bb82bba5..000000000000 --- a/reference/phdfs/phdfs/file-info.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - phdfs::file_info - Description - - - - &reftitle.description; - - public arrayphdfs::file_info - stringpath - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - path - - - - - - - - - - - &reftitle.returnvalues; - - Returns array on success&return.falseforfailure;. - - - - - - - diff --git a/reference/phdfs/phdfs/list-directory.xml b/reference/phdfs/phdfs/list-directory.xml deleted file mode 100644 index 2f592130e9d9..000000000000 --- a/reference/phdfs/phdfs/list-directory.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - phdfs::list_directory - Description - - - - &reftitle.description; - - public arrayphdfs::list_directory - stringpath - intlevel0 - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - path - - - - - - - - level - - - - - - - - - - - &reftitle.returnvalues; - - Returns array on success&return.falseforfailure;. - - - - - - - diff --git a/reference/phdfs/phdfs/read.xml b/reference/phdfs/phdfs/read.xml deleted file mode 100644 index 98e00ee206bf..000000000000 --- a/reference/phdfs/phdfs/read.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - phdfs::read - Description - - - - &reftitle.description; - - public stringphdfs::read - stringpath - intlength0 - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - path - - - - - - - - length - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/phdfs/phdfs/rename.xml b/reference/phdfs/phdfs/rename.xml deleted file mode 100644 index bb0c02caf24d..000000000000 --- a/reference/phdfs/phdfs/rename.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - phdfs::rename - Description - - - - &reftitle.description; - - public boolphdfs::rename - stringold_path - stringnew_path - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - old_path - - - - - - - - new_path - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/phdfs/phdfs/tell.xml b/reference/phdfs/phdfs/tell.xml deleted file mode 100644 index 5b3a9841e20c..000000000000 --- a/reference/phdfs/phdfs/tell.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - phdfs::tell - Description - - - - &reftitle.description; - - public intphdfs::tell - stringpath - intread_length1024 - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - path - - - - - - - - read_length - - - - - - - - - - - &reftitle.returnvalues; - - - - - - - - - diff --git a/reference/phdfs/phdfs/write.xml b/reference/phdfs/phdfs/write.xml deleted file mode 100644 index 2061e929c312..000000000000 --- a/reference/phdfs/phdfs/write.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - phdfs::write - Description - - - - &reftitle.description; - - public boolphdfs::write - stringpath - stringbuffer - intmode0 - - - - - - &warn.undocumented.func; - - - - - &reftitle.parameters; - - - path - - - - - - - - buffer - - - - - - - - mode - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - diff --git a/reference/phdfs/setup.xml b/reference/phdfs/setup.xml deleted file mode 100644 index d10a98de795c..000000000000 --- a/reference/phdfs/setup.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - PHP Version: PHP 5.3+ - - - ZTS Enabled ( Thread Safety ) - - - need to install hadoop - -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;phdfs. - -
    - -
    - &no.config; -
    - -
    - &reftitle.resources; - &no.resource; - - - -
    - -     - - diff --git a/reference/phdfs/versions.xml b/reference/phdfs/versions.xml deleted file mode 100644 index c77f2d532d35..000000000000 --- a/reference/phdfs/versions.xml +++ /dev/null @@ -1,46 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/reflection/reflectionfunction/construct.xml b/reference/reflection/reflectionfunction/construct.xml index 00a95298591d..ef0434543f52 100644 --- a/reference/reflection/reflectionfunction/construct.xml +++ b/reference/reflection/reflectionfunction/construct.xml @@ -49,30 +49,6 @@     - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - name can now be a closure. - - - - - - - - &reftitle.examples; diff --git a/reference/rpmreader/book.xml b/reference/rpmreader/book.xml deleted file mode 100644 index 27e3458041cf..000000000000 --- a/reference/rpmreader/book.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - RPM Header Reading - RPM Reader - - - - &reftitle.intro; - - This module allows you to read the meta information stored in the - headers of a RedHat - Package Manager (RPM) - file. - - - - - &reference.rpmreader.setup; - &reference.rpmreader.constants; - &reference.rpmreader.examples; - &reference.rpmreader.reference; - - - - - diff --git a/reference/rpmreader/configure.xml b/reference/rpmreader/configure.xml deleted file mode 100644 index b350d02e2d17..000000000000 --- a/reference/rpmreader/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; &url.pecl.package;rpmreader. - -
    - - - diff --git a/reference/rpmreader/constants.xml b/reference/rpmreader/constants.xml deleted file mode 100644 index c0907e91aceb..000000000000 --- a/reference/rpmreader/constants.xml +++ /dev/null @@ -1,1244 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - The following list of constants are used to obtain information using - the rpm_get_tag function. These constants - represent the tag number to be retrieved from the RPM file's header - section. Descriptions are given below as to what data the tag - number constants reference. - - - - - - RPMREADER_MINIMUM - (integer) - - - - The minimum valid value of any RPM tag number. - - - - - - RPMREADER_NAME - (integer) - - - - The name of the RPM package. - - - - - - RPMREADER_VERSION - (integer) - - - - The version of the RPM package. - - - - - - RPMREADER_RELEASE - (integer) - - - - The release of the RPM package. - - - - - - RPMREADER_EPOCH - (integer) - - - - - - - - - RPMREADER_SERIAL - (integer) - - - - - - - - - RPMREADER_SUMMARY - (integer) - - - - The summary text of the RPM package. - - - - - - RPMREADER_DESCRIPTION - (integer) - - - - The full description text of the RPM package. - - - - - - RPMREADER_BUILDTIME - (integer) - - - - The date and time when the RPM package was built. - - - - - - RPMREADER_BUILDHOST - (integer) - - - - The name of the host on which the RPM package was built. - - - - - - RPMREADER_INSTALLTIME - (integer) - - - - - - - - - RPMREADER_SIZE - (integer) - - - - The size of the RPM package. - - - - - - RPMREADER_DISTRIBUTION - (integer) - - - - - - - - - RPMREADER_VENDOR - (integer) - - - - - - - - - RPMREADER_GIF - (integer) - - - - - - - - - RPMREADER_XPM - (integer) - - - - - - - - - RPMREADER_LICENSE - (integer) - - - - - - - - - RPMREADER_COPYRIGHT - (integer) - - - - - - - - - RPMREADER_PACKAGER - (integer) - - - - - - - - - RPMREADER_GROUP - (integer) - - - - - - - - - RPMREADER_SOURCE - (integer) - - - - - - - - - RPMREADER_PATCH - (integer) - - - - - - - - - RPMREADER_URL - (integer) - - - - - - - - - RPMREADER_OS - (integer) - - - - - - - - - RPMREADER_ARCH - (integer) - - - - - - - - - RPMREADER_PREIN - (integer) - - - - - - - - - RPMREADER_POSTIN - (integer) - - - - - - - - - RPMREADER_PREUN - (integer) - - - - - - - - - RPMREADER_POSTUN - (integer) - - - - - - - - - RPMREADER_OLDFILENAMES - (integer) - - - - The list of files in an RPM package (deprecated format). The - correct way is now to use a combination of 3 tags - (RPMREADER_BASENAMES, RPMREADER_DIRINDEXES, RPMREADER_DIRNAMES) - in what RPM now calls "CompressedFileNames". This tag is still - used in older RPM files that did not use the - "CompressedFileNames" method and is maintained for backward - compatibility. - - - - - - RPMREADER_FILESIZES - (integer) - - - - - - - - - RPMREADER_FILESTATES - (integer) - - - - - - - - - RPMREADER_FILEMODES - (integer) - - - - - - - - - RPMREADER_FILERDEVS - (integer) - - - - - - - - - RPMREADER_FILEMTIMES - (integer) - - - - - - - - - RPMREADER_FILEMD5S - (integer) - - - - - - - - - RPMREADER_FILELINKTOS - (integer) - - - - - - - - - RPMREADER_FILEFLAGS - (integer) - - - - - - - - - RPMREADER_FILEUSERNAME - (integer) - - - - - - - - - RPMREADER_FILEGROUPNAME - (integer) - - - - - - - - - RPMREADER_ICON - (integer) - - - - - - - - - RPMREADER_SOURCERPM - (integer) - - - - - - - - - RPMREADER_FILEVERIFYFLAGS - (integer) - - - - - - - - - RPMREADER_ARCHIVESIZE - (integer) - - - - - - - - - RPMREADER_PROVIDENAME - (integer) - - - - - - - - - RPMREADER_PROVIDES - (integer) - - - - - - - - - RPMREADER_REQUIREFLAGS - (integer) - - - - - - - - - RPMREADER_REQUIRENAME - (integer) - - - - - - - - - RPMREADER_REQUIREVERSION - (integer) - - - - - - - - - RPMREADER_CONFLICTFLAGS - (integer) - - - - - - - - - RPMREADER_CONFLICTNAME - (integer) - - - - - - - - - RPMREADER_CONFLICTVERSION - (integer) - - - - - - - - - RPMREADER_EXCLUDEARCH - (integer) - - - - - - - - - RPMREADER_EXCLUDEOS - (integer) - - - - - - - - - RPMREADER_EXCLUSIVEARCH - (integer) - - - - - - - - - RPMREADER_EXCLUSIVEOS - (integer) - - - - - - - - - RPMREADER_RPMVERSION - (integer) - - - - - - - - - RPMREADER_TRIGGERSCRIPTS - (integer) - - - - - - - - - RPMREADER_TRIGGERNAME - (integer) - - - - - - - - - RPMREADER_TRIGGERVERSION - (integer) - - - - - - - - - RPMREADER_TRIGGERFLAGS - (integer) - - - - - - - - - RPMREADER_TRIGGERINDEX - (integer) - - - - - - - - - RPMREADER_VERIFYSCRIPT - (integer) - - - - - - - - - RPMREADER_CHANGELOGTIME - (integer) - - - - The list of dates from changelog entries. - - - - - - RPMREADER_CHANGELOGNAME - (integer) - - - - The list of changelog entry names. - - - - - - RPMREADER_CHANGELOGTEXT - (integer) - - - - The list of the text from changelog entries. - - - - - - RPMREADER_PREINPROG - (integer) - - - - - - - - - RPMREADER_POSTINPROG - (integer) - - - - - - - - - RPMREADER_PREUNPROG - (integer) - - - - - - - - - RPMREADER_POSTUNPROG - (integer) - - - - - - - - - RPMREADER_BUILDARCHS - (integer) - - - - - - - - - RPMREADER_OBSOLETENAME - (integer) - - - - - - - - - RPMREADER_OBSOLETES - (integer) - - - - - - - - - RPMREADER_VERIFYSCRIPTPROG - (integer) - - - - - - - - - RPMREADER_TRIGGERSCRIPTPROG - (integer) - - - - - - - - - RPMREADER_COOKIE - (integer) - - - - - - - - - RPMREADER_FILEDEVICES - (integer) - - - - - - - - - RPMREADER_FILEINODES - (integer) - - - - - - - - - RPMREADER_FILELANGS - (integer) - - - - - - - - - RPMREADER_PREFIXES - (integer) - - - - - - - - - RPMREADER_INSTPREFIXES - (integer) - - - - - - - - - RPMREADER_PROVIDEFLAGS - (integer) - - - - - - - - - RPMREADER_PROVIDEVERSION - (integer) - - - - - - - - - RPMREADER_OBSOLETEFLAGS - (integer) - - - - - - - - - RPMREADER_OBSOLETEVERSION - (integer) - - - - - - - - - RPMREADER_DIRINDEXES - (integer) - - - - The list of indices that relate directory names to files in the - RPM package. This tag is used in conjunction with - RPMREADER_BASENAMES and RPMREADER_DIRNAMES to reconstruct - filenames in the RPM package stored with the new - "CompressedFileNames" method in RPM. - - - - - - RPMREADER_BASENAMES - (integer) - - - - The list of the names of files in the RPM package without path - information. This tag is used in conjunction with - RPMREADER_DIRINDEXES and RPMREADER_DIRNAMES to reconstruct - filenames in the RPM package stored with the new - "CompressedFileNames" method in RPM. - - - - - - RPMREADER_DIRNAMES - (integer) - - - - The list of directory names used by files in the RPM package. - This tag is used in conjunction with RPMREADER_BASENAMES and - RPMREADER_DIRINDEXES to reconstruct filenames in the RPM - package stored with the new "CompressedFileNames" method in - RPM. - - - - - - RPMREADER_OPTFLAGS - (integer) - - - - - - - - - RPMREADER_DISTURL - (integer) - - - - - - - - - RPMREADER_PAYLOADFORMAT - (integer) - - - - - - - - - RPMREADER_PAYLOADCOMPRESSOR - (integer) - - - - - - - - - RPMREADER_PAYLOADFLAGS - (integer) - - - - - - - - - RPMREADER_INSTALLCOLOR - (integer) - - - - - - - - - RPMREADER_INSTALLTID - (integer) - - - - - - - - - RPMREADER_REMOVETID - (integer) - - - - - - - - - RPMREADER_RHNPLATFORM - (integer) - - - - - - - - - RPMREADER_PLATFORM - (integer) - - - - - - - - - RPMREADER_PATCHESNAME - (integer) - - - - - - - - - RPMREADER_PATCHESFLAGS - (integer) - - - - - - - - - RPMREADER_PATCHESVERSION - (integer) - - - - - - - - - RPMREADER_CACHECTIME - (integer) - - - - - - - - - RPMREADER_CACHEPKGPATH - (integer) - - - - - - - - - RPMREADER_CACHEPKGSIZE - (integer) - - - - - - - - - RPMREADER_CACHEPKGMTIME - (integer) - - - - - - - - - RPMREADER_FILECOLORS - (integer) - - - - - - - - - RPMREADER_FILECLASS - (integer) - - - - - - - - - RPMREADER_CLASSDICT - (integer) - - - - - - - - - RPMREADER_FILEDEPENDSX - (integer) - - - - - - - - - RPMREADER_FILEDEPENDSN - (integer) - - - - - - - - - RPMREADER_DEPENDSDICT - (integer) - - - - - - - - - RPMREADER_SOURCEPKGID - (integer) - - - - - - - - - RPMREADER_FILECONTEXTS - (integer) - - - - - - - - - RPMREADER_FSCONTEXTS - (integer) - - - - - - - - - RPMREADER_RECONTEXTS - (integer) - - - - - - - - - RPMREADER_POLICIES - (integer) - - - - - - - - - RPMREADER_MAXIMUM - (integer) - - - - The maximum valid value of any RPM tag number. - - - - - - - - - diff --git a/reference/rpmreader/examples.xml b/reference/rpmreader/examples.xml deleted file mode 100644 index 6707b4efb946..000000000000 --- a/reference/rpmreader/examples.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - -&reftitle.examples; -
    - Basic usage - - This example will open an RPM file and read the name, version, and - release from the RPM file, echo the results, and close the RPM file. - - - Basic RPMReader Example - -\n"; - -// close file -rpm_close($rpmr); - -?> -]]> - - -
    -     - - - diff --git a/reference/rpmreader/functions/rpm-close.xml b/reference/rpmreader/functions/rpm-close.xml deleted file mode 100644 index da43d84818cd..000000000000 --- a/reference/rpmreader/functions/rpm-close.xml +++ /dev/null @@ -1,89 +0,0 @@ - - - - - rpm_close - Closes an RPM file - - - &reftitle.description; - - boolrpm_close - resourcerpmr - - - rpm_close will close an RPM file pointer. - - - - &reftitle.parameters; - - - - rpmr - - - A file pointer resource successfully opened by - rpm_open. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - <function>rpm_close</function> example - - -]]> - - - - - - &reftitle.seealso; - - - rpm_open - - - - - - diff --git a/reference/rpmreader/functions/rpm-get-tag.xml b/reference/rpmreader/functions/rpm-get-tag.xml deleted file mode 100644 index e024504d4e0f..000000000000 --- a/reference/rpmreader/functions/rpm-get-tag.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - rpm_get_tag - Retrieves a header tag from an RPM file - - - &reftitle.description; - - mixedrpm_get_tag - resourcerpmr - inttagnum - - - rpm_get_tag will retrieve a given tag from - the RPM file's header and return it. - - - - &reftitle.parameters; - - - - rpmr - - - A file pointer resource successfully opened by - rpm_open. - - - - - tagnum - - - The tag number to retrieve from the RPM header. This value - can be specified using the list of constants defined by this - module. - - - - - - - - &reftitle.returnvalues; - - The return value can be of various types depending on the - tagnum supplied to the function. - - - - &reftitle.examples; - - - <function>rpm_get_tag</function> example - -\n"; - -rpm_close($rpmr); - -?> -]]> - - - - - - &reftitle.seealso; - - - rpm_open - rpm_close - - - - - - diff --git a/reference/rpmreader/functions/rpm-is-valid.xml b/reference/rpmreader/functions/rpm-is-valid.xml deleted file mode 100644 index 438e05d2c5c3..000000000000 --- a/reference/rpmreader/functions/rpm-is-valid.xml +++ /dev/null @@ -1,88 +0,0 @@ - - - - - rpm_is_valid - Tests a filename for validity as an RPM file - - - &reftitle.description; - - boolrpm_is_valid - stringfilename - - - rpm_is_valid will test an RPM file for - validity as an RPM file. This is not the same as - rpm_open as it only checks the file for - validity but does not return a file pointer to be used by further - functions. - - - - &reftitle.parameters; - - - - filename - - - The filename of the RPM file you wish to check for validity. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - &reftitle.examples; - - - <function>rpm_is_valid</function> example - -\n"; -} -else { - echo "File is not recognized as an RPM file.
    \n"; -} - -?> -]]> -     -     -     -     -     - - diff --git a/reference/rpmreader/functions/rpm-open.xml b/reference/rpmreader/functions/rpm-open.xml deleted file mode 100644 index 209bbe0ba94d..000000000000 --- a/reference/rpmreader/functions/rpm-open.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - rpm_open - Opens an RPM file - - - &reftitle.description; - - resourcerpm_open - stringfilename - - - rpm_open will open an RPM file and will - determine if the file is a valid RPM file. - - - - &reftitle.parameters; - - - - filename - - - The filename of the RPM file you wish to open. - - - - - - - - &reftitle.returnvalues; - - 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;. - - - - &reftitle.examples; - - - <function>rpm_open</function> example - - -]]> - - - - - - &reftitle.seealso; - - - rpm_close - - - - - - diff --git a/reference/rpmreader/functions/rpm-version.xml b/reference/rpmreader/functions/rpm-version.xml deleted file mode 100644 index e1d72cefdbb3..000000000000 --- a/reference/rpmreader/functions/rpm-version.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - rpm_version - Returns a string representing the current version of the - rpmreader extension - - - &reftitle.description; - - stringrpm_version - - - - rpm_version will return the current version of the - rpmreader extension. - - - - &reftitle.returnvalues; - - rpm_version will return a string representing the - rpmreader version currently loaded in PHP. - - - - &reftitle.examples; - - - <function>rpm_version</function> example - -\n"; - -?> -]]> - - - - - - - diff --git a/reference/rpmreader/ini.xml b/reference/rpmreader/ini.xml deleted file mode 100644 index 1af6326dd812..000000000000 --- a/reference/rpmreader/ini.xml +++ /dev/null @@ -1,27 +0,0 @@ - - -
    - &reftitle.runtime; - &no.config; -
    - - diff --git a/reference/rpmreader/reference.xml b/reference/rpmreader/reference.xml deleted file mode 100644 index fc6c3c2be760..000000000000 --- a/reference/rpmreader/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - RPM Reader &Functions; - - &reference.rpmreader.entities.functions; - - - - - diff --git a/reference/rpmreader/setup.xml b/reference/rpmreader/setup.xml deleted file mode 100644 index f51330428e53..000000000000 --- a/reference/rpmreader/setup.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - The RPMReader extension requires PHP 5. - -
    - - - - &reference.rpmreader.configure; - - - -
    - &reftitle.runtime; - &no.config; -
    - - - -
    - &reftitle.resources; - - There is one resource type used by the RPMReader module. The - resource is a file pointer which identifies the RPM file with - which to work. - -
    - - -     - - - diff --git a/reference/rpmreader/versions.xml b/reference/rpmreader/versions.xml deleted file mode 100644 index dbee1e81e368..000000000000 --- a/reference/rpmreader/versions.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/runkit/book.xml b/reference/runkit/book.xml deleted file mode 100644 index 51564bf35652..000000000000 --- a/reference/runkit/book.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - runkit - - - &reftitle.intro; - - The runkit extension provides means to modify constants, - user-defined functions, and user-defined classes. - It also provides for custom superglobal variables - and embeddable sub-interpreters via sandboxing. - - - - This package is meant as a feature added replacement for the - classkit package. - When compiled with the --enable-runkit=classkit - option to ./configure, it will export classkit compatible function definitions - and constants. - - - - &reference.runkit.constants; - &reference.runkit.setup; - &reference.runkit.reference; - - - - - diff --git a/reference/runkit/constants.xml b/reference/runkit/constants.xml deleted file mode 100644 index 2b2733094093..000000000000 --- a/reference/runkit/constants.xml +++ /dev/null @@ -1,238 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - RUNKIT_IMPORT_FUNCTIONS - (integer) - - - - runkit_import flag indicating - that normal functions should be imported from the - specified file. - - - - - - RUNKIT_IMPORT_CLASS_METHODS - (integer) - - - - runkit_import flag indicating - that class methods should be imported from the - specified file. - - - - - - RUNKIT_IMPORT_CLASS_CONSTS - (integer) - - - - runkit_import flag indicating - that class constants should be imported from the - specified file. Note that this flag is only meaningful - in PHP versions 5.1.0 and above. - - - - - - RUNKIT_IMPORT_CLASS_PROPS - (integer) - - - - runkit_import flag indicating - that class standard properties should be imported - from the specified file. - - - - - - RUNKIT_IMPORT_CLASS_STATIC_PROPS - (integer) - - - - runkit_import flag indicating - that class static properties should be imported - from the specified file. Available since Runkit 1.0.1. - - - - - - RUNKIT_IMPORT_CLASSES - (integer) - - - - runkit_import flag representing - a bitwise OR of the RUNKIT_IMPORT_CLASS_* - constants. - - - - - - RUNKIT_IMPORT_OVERRIDE - (integer) - - - - runkit_import flag indicating that - if any of the imported functions, methods, constants, - or properties already exist, they should be replaced with - the new definitions. If this flag is not set, then any - imported definitions which already exist will be discarded. - - - - - - RUNKIT_ACC_PUBLIC - (integer) - - - - PHP 5 specific flag to runkit_method_add and runkit_method_redefine - - - - - - RUNKIT_ACC_PROTECTED - (integer) - - - - PHP 5 specific flag to runkit_method_add and runkit_method_redefine - - - - - - RUNKIT_ACC_PRIVATE - (integer) - - - - PHP 5 specific flag to runkit_method_add and runkit_method_redefine - - - - - - RUNKIT_ACC_STATIC - (integer) - - - - PHP 5 specific flag to runkit_method_add and runkit_method_redefine. Available since Runkit 1.0.1. - - - - - - CLASSKIT_ACC_PUBLIC - (integer) - - - - PHP 5 specific flag to classkit_method_add - Only defined when classkit compatibility is enabled. - - - - - - CLASSKIT_ACC_PROTECTED - (integer) - - - - PHP 5 specific flag to classkit_method_add - Only defined when classkit compatibility is enabled. - - - - - - CLASSKIT_ACC_PRIVATE - (integer) - - - - PHP 5 specific flag to classkit_method_add - Only defined when classkit compatibility is enabled. - - - - - - CLASSKIT_AGGREGATE_OVERRIDE - (integer) - - - - PHP 5 specific flag to classkit_import - Only defined when classkit compatibility is enabled. - - - - - - RUNKIT_VERSION - (string) - - - - Defined to the current version of the runkit package. - - - - - - CLASSKIT_VERSION - (string) - - - - Defined to the current version of the runkit package. - Only defined when classkit compatibility is enabled. - - - - - - - diff --git a/reference/runkit/functions/runkit-class-adopt.xml b/reference/runkit/functions/runkit-class-adopt.xml deleted file mode 100644 index 1fc3eb77d314..000000000000 --- a/reference/runkit/functions/runkit-class-adopt.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - - runkit_class_adopt - - Convert a base class to an inherited class, add ancestral methods when appropriate - - - - &reftitle.description; - - boolrunkit_class_adopt - stringclassname - stringparentname - - - - - &reftitle.parameters; - - - - classname - - - Name of class to be adopted - - - - - parentname - - - Parent class which child class is extending - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - A <function>runkit_class_adopt</function> example - - -]]> - - &example.outputs; - - - - - - - - - - &reftitle.seealso; - - - runkit_class_emancipate - - - - - - - diff --git a/reference/runkit/functions/runkit-class-emancipate.xml b/reference/runkit/functions/runkit-class-emancipate.xml deleted file mode 100644 index bf827e8ed96b..000000000000 --- a/reference/runkit/functions/runkit-class-emancipate.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - runkit_class_emancipate - - Convert an inherited class to a base class, removes any method whose scope is ancestral - - - - &reftitle.description; - - boolrunkit_class_emancipate - stringclassname - - - - - &reftitle.parameters; - - - - classname - - - Name of class to emancipate - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - A <function>runkit_class_emancipate</function> example - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - runkit_class_adopt - - - - - - - diff --git a/reference/runkit/functions/runkit-constant-add.xml b/reference/runkit/functions/runkit-constant-add.xml deleted file mode 100644 index 5be648e373ba..000000000000 --- a/reference/runkit/functions/runkit-constant-add.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - runkit_constant_add - - Similar to define(), but allows defining in class definitions as well - - - - &reftitle.description; - - boolrunkit_constant_add - stringconstname - mixedvalue - - - - &reftitle.parameters; - - - - constname - - - Name of constant to declare. Either a string to indicate a global constant, - or classname::constname to indicate a class constant. - - - - - value - - - NULL, Bool, Long, Double, String, or Resource value to store in the new constant. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - define - runkit_constant_redefine - runkit_constant_remove - - - - - - - diff --git a/reference/runkit/functions/runkit-constant-redefine.xml b/reference/runkit/functions/runkit-constant-redefine.xml deleted file mode 100644 index 0b341d99418e..000000000000 --- a/reference/runkit/functions/runkit-constant-redefine.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - runkit_constant_redefine - - Redefine an already defined constant - - - - &reftitle.description; - - boolrunkit_constant_redefine - stringconstname - mixednewvalue - - - - - &reftitle.parameters; - - - - constname - - - Constant to redefine. Either string indicating global constant, - or classname::constname indicating class constant. - - - - - newvalue - - - New value to assign to constant. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - runkit_constant_add - runkit_constant_remove - - - - - - - diff --git a/reference/runkit/functions/runkit-constant-remove.xml b/reference/runkit/functions/runkit-constant-remove.xml deleted file mode 100644 index ab0c8ec2bd0a..000000000000 --- a/reference/runkit/functions/runkit-constant-remove.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - - runkit_constant_remove - - Remove/Delete an already defined constant - - - - &reftitle.description; - - boolrunkit_constant_remove - stringconstname - - - - - &reftitle.parameters; - - - - constname - - - Name of constant to remove. Either a string indicating a global constant, - or classname::constname indicating a class constant. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - define - runkit_constant_add - runkit_constant_redefine - - - - - - - diff --git a/reference/runkit/functions/runkit-function-add.xml b/reference/runkit/functions/runkit-function-add.xml deleted file mode 100644 index 7538de36371e..000000000000 --- a/reference/runkit/functions/runkit-function-add.xml +++ /dev/null @@ -1,180 +0,0 @@ - - - - - - runkit_function_add - - Add a new function, similar to create_function - - - - - &reftitle.description; - - boolrunkit_function_add - stringfuncname - stringarglist - stringcode - boolreturn_by_reference&null; - stringdoc_comment&null; - - - boolrunkit_function_add - stringfuncname - Closureclosure - stringdoc_comment&null; - - - - - &reftitle.parameters; - - - - funcname - - - Name of function to be created - - - - - arglist - - - Comma separated argument list - - - - - code - - - Code making up the function - - - - - closure - - - A closure that defines the function. - - - - - return_by_reference - - - Whether the function should return by reference. - - - - - doc_comment - - - The doc comment of the function. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - runkit 1.0.4 - - An alternative syntax expecting a closure has been added. - - - - runkit 1.0.4 - - The optional parameters return_by_reference and - doc_comment have been added. - - - - - - - - - &reftitle.examples; - - - A <function>runkit_function_add</function> example - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - create_function - runkit_function_redefine - runkit_function_copy - runkit_function_rename - runkit_function_remove - runkit_method_add - - - - - - - diff --git a/reference/runkit/functions/runkit-function-copy.xml b/reference/runkit/functions/runkit-function-copy.xml deleted file mode 100644 index 60339bef33c0..000000000000 --- a/reference/runkit/functions/runkit-function-copy.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - - runkit_function_copy - - Copy a function to a new function name - - - - &reftitle.description; - - boolrunkit_function_copy - stringfuncname - stringtargetname - - - - - &reftitle.parameters; - - - - funcname - - - Name of existing function - - - - - targetname - - - Name of new function to copy definition to - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - A <function>runkit_function_copy</function> example - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - runkit_function_add - runkit_function_redefine - runkit_function_rename - runkit_function_remove - - - - - - - diff --git a/reference/runkit/functions/runkit-function-redefine.xml b/reference/runkit/functions/runkit-function-redefine.xml deleted file mode 100644 index 9ced20868277..000000000000 --- a/reference/runkit/functions/runkit-function-redefine.xml +++ /dev/null @@ -1,185 +0,0 @@ - - - - - - runkit_function_redefine - - Replace a function definition with a new implementation - - - - &reftitle.description; - - boolrunkit_function_redefine - stringfuncname - stringarglist - stringcode - boolreturn_by_reference&null; - stringdoc_comment&null; - - - boolrunkit_function_redefine - stringfuncname - Closureclosure - stringdoc_comment&null; - - - ¬e.runkit.internal-override; - - - - - &reftitle.parameters; - - - - funcname - - - Name of function to redefine - - - - - arglist - - - New list of arguments to be accepted by function - - - - - code - - - New code implementation - - - - - closure - - - A closure that defines the function. - - - - - return_by_reference - - - Whether the function should return by reference. - - - - - doc_comment - - - The doc comment of the function. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - runkit 1.0.4 - - An alternative syntax expecting a closure has been added. - - - - runkit 1.0.4 - - The optional parameters return_by_reference and - doc_comment have been added. - - - - - - - - - &reftitle.examples; - - - A <function>runkit_function_redefine</function> example - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - runkit_function_add - runkit_function_copy - runkit_function_rename - runkit_function_remove - runkit_method_redefine - - - - - - - diff --git a/reference/runkit/functions/runkit-function-remove.xml b/reference/runkit/functions/runkit-function-remove.xml deleted file mode 100644 index 89f9b2bb788a..000000000000 --- a/reference/runkit/functions/runkit-function-remove.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - - runkit_function_remove - - Remove a function definition - - - - &reftitle.description; - - boolrunkit_function_remove - stringfuncname - - - ¬e.runkit.internal-override; - - - - - &reftitle.parameters; - - - - funcname - - - Name of function to be deleted - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - runkit_function_add - runkit_function_copy - runkit_function_redefine - runkit_function_rename - - - - - - - diff --git a/reference/runkit/functions/runkit-function-rename.xml b/reference/runkit/functions/runkit-function-rename.xml deleted file mode 100644 index e23f876a6ebc..000000000000 --- a/reference/runkit/functions/runkit-function-rename.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - runkit_function_rename - - Change a function's name - - - - &reftitle.description; - - boolrunkit_function_rename - stringfuncname - stringnewname - - - ¬e.runkit.internal-override; - - - - - &reftitle.parameters; - - - - funcname - - - Current function name - - - - - newname - - - New function name - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - runkit_function_add - runkit_function_copy - runkit_function_redefine - runkit_function_remove - - - - - - - diff --git a/reference/runkit/functions/runkit-import.xml b/reference/runkit/functions/runkit-import.xml deleted file mode 100644 index 0837d0b90fbf..000000000000 --- a/reference/runkit/functions/runkit-import.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - runkit_import - - Process a PHP file importing function and class definitions, overwriting where appropriate - - - - &reftitle.description; - - boolrunkit_import - stringfilename - intflagsRUNKIT_IMPORT_CLASS_METHODS - - - Similar to include however any code residing outside - of a function or class is simply ignored. - Additionally, depending on the value of flags, - any functions or classes which already exist in the currently running environment - may be automatically overwritten by their new definitions. - - - - - &reftitle.parameters; - - - - filename - - - Filename to import function and class definitions from - - - - - flags - - - Bitwise OR of the RUNKIT_IMPORT_* - family of constants. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>runkit_import</function> example - - -]]> - - - - - - - diff --git a/reference/runkit/functions/runkit-lint-file.xml b/reference/runkit/functions/runkit-lint-file.xml deleted file mode 100644 index c97e5b1d0f74..000000000000 --- a/reference/runkit/functions/runkit-lint-file.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - runkit_lint_file - - Check the PHP syntax of the specified file - - - - &reftitle.description; - - boolrunkit_lint_file - stringfilename - - - The runkit_lint_file function performs a syntax (lint) check - on the specified filename testing for scripting errors. This is similar to using php -l - from the commandline. - - - ¬e.runkit.sandbox; - - - - &reftitle.parameters; - - - - filename - - - File containing PHP Code to be lint checked - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - runkit_lint - - - - - - - diff --git a/reference/runkit/functions/runkit-lint.xml b/reference/runkit/functions/runkit-lint.xml deleted file mode 100644 index 688085973a78..000000000000 --- a/reference/runkit/functions/runkit-lint.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - runkit_lint - - Check the PHP syntax of the specified php code - - - - &reftitle.description; - - boolrunkit_lint - stringcode - - - The runkit_lint function performs a syntax (lint) - check on the specified php code testing for scripting errors. - This is similar to using php -l from the command line except - runkit_lint accepts actual code rather than a filename. - - - ¬e.runkit.sandbox; - - - - - &reftitle.parameters; - - - - code - - - PHP Code to be lint checked - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - runkit_lint_file - - - - - - - diff --git a/reference/runkit/functions/runkit-method-add.xml b/reference/runkit/functions/runkit-method-add.xml deleted file mode 100644 index bb34c948bbed..000000000000 --- a/reference/runkit/functions/runkit-method-add.xml +++ /dev/null @@ -1,204 +0,0 @@ - - - - - runkit_method_add - Dynamically adds a new method to a given class - - - &reftitle.description; - - boolrunkit_method_add - stringclassname - stringmethodname - stringargs - stringcode - intflagsRUNKIT_ACC_PUBLIC - stringdoc_comment&null; - - - boolrunkit_method_add - stringclassname - stringmethodname - Closureclosure - intflagsRUNKIT_ACC_PUBLIC - stringdoc_comment&null; - - - - &reftitle.parameters; - - - - classname - - - The class to which this method will be added - - - - - methodname - - - The name of the method to add - - - - - args - - - Comma-delimited list of arguments for the newly-created method - - - - - code - - - The code to be evaluated when methodname - is called - - - - - closure - - - A closure that defines the method. - - - - - flags - - - The type of method to create, can be - RUNKIT_ACC_PUBLIC, - RUNKIT_ACC_PROTECTED or - RUNKIT_ACC_PRIVATE optionally combined via bitwise OR with - RUNKIT_ACC_STATIC (since 1.0.1) - - - - - doc_comment - - - The doc comment of the function. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - runkit 1.0.4 - - An alternative syntax expecting a closure has been added. - - - - runkit 1.0.4 - - The optional parameter doc_comment has been added. - - - - - - - - - &reftitle.examples; - - - <function>runkit_method_add</function> example - -add(12, 4); -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - - runkit_method_copy - runkit_method_redefine - runkit_method_remove - runkit_method_rename - runkit_function_add - - - - - - diff --git a/reference/runkit/functions/runkit-method-copy.xml b/reference/runkit/functions/runkit-method-copy.xml deleted file mode 100644 index d347675c34f2..000000000000 --- a/reference/runkit/functions/runkit-method-copy.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - runkit_method_copy - Copies a method from class to another - - - &reftitle.description; - - boolrunkit_method_copy - stringdClass - stringdMethod - stringsClass - stringsMethod - - - - &reftitle.parameters; - - - - dClass - - - Destination class for copied method - - - - - dMethod - - - Destination method name - - - - - sClass - - - Source class of the method to copy - - - - - sMethod - - - Name of the method to copy from the source class. If this parameter is - omitted, the value of dMethod is assumed. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>runkit_method_copy</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - - runkit_method_add - runkit_method_redefine - runkit_method_remove - runkit_method_rename - runkit_function_copy - - - - - - diff --git a/reference/runkit/functions/runkit-method-redefine.xml b/reference/runkit/functions/runkit-method-redefine.xml deleted file mode 100644 index 420c07c18b14..000000000000 --- a/reference/runkit/functions/runkit-method-redefine.xml +++ /dev/null @@ -1,209 +0,0 @@ - - - - - runkit_method_redefine - Dynamically changes the code of the given method - - - &reftitle.description; - - boolrunkit_method_redefine - stringclassname - stringmethodname - stringargs - stringcode - intflagsRUNKIT_ACC_PUBLIC - stringdoc_comment&null; - - - boolrunkit_method_redefine - stringclassname - stringmethodname - Closureclosure - intflagsRUNKIT_ACC_PUBLIC - stringdoc_comment&null; - - ¬e.runkit.selfmanipulation; - - - &reftitle.parameters; - - - - classname - - - The class in which to redefine the method - - - - - methodname - - - The name of the method to redefine - - - - - args - - - Comma-delimited list of arguments for the redefined method - - - - - code - - - The new code to be evaluated when methodname - is called - - - - - closure - - - A closure that defines the method. - - - - - flags - - - The redefined method can be - RUNKIT_ACC_PUBLIC, - RUNKIT_ACC_PROTECTED or - RUNKIT_ACC_PRIVATE optionally combined via bitwise OR with - RUNKIT_ACC_STATIC (since 1.0.1) - - - - - doc_comment - - - The doc comment of the function. - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - runkit 1.0.4 - - An alternative syntax expecting a closure has been added. - - - - runkit 1.0.4 - - The optional parameter doc_comment has been added. - - - - - - - - - &reftitle.examples; - - - <function>runkit_method_redefine</function> example - -foo(); - -// Redefine the 'foo' method -runkit_method_redefine( - 'Example', - 'foo', - '', - 'return "bar!\n";', - RUNKIT_ACC_PUBLIC -); - -// output Example::foo() (after redefine) -echo "After: " . $e->foo(); -?> -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - - runkit_method_add - runkit_method_copy - runkit_method_remove - runkit_method_rename - runkit_function_redefine - - - - - - diff --git a/reference/runkit/functions/runkit-method-remove.xml b/reference/runkit/functions/runkit-method-remove.xml deleted file mode 100644 index ddb12f22443d..000000000000 --- a/reference/runkit/functions/runkit-method-remove.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - runkit_method_remove - Dynamically removes the given method - - - &reftitle.description; - - boolrunkit_method_remove - stringclassname - stringmethodname - - ¬e.runkit.selfmanipulation; - - - &reftitle.parameters; - - - - classname - - - The class in which to remove the method - - - - - methodname - - - The name of the method to remove - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>runkit_method_remove</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - - runkit_method_add - runkit_method_copy - runkit_method_redefine - runkit_method_rename - runkit_function_remove - - - - - - diff --git a/reference/runkit/functions/runkit-method-rename.xml b/reference/runkit/functions/runkit-method-rename.xml deleted file mode 100644 index 283d437666e0..000000000000 --- a/reference/runkit/functions/runkit-method-rename.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - runkit_method_rename - Dynamically changes the name of the given method - - - &reftitle.description; - - boolrunkit_method_rename - stringclassname - stringmethodname - stringnewname - - ¬e.runkit.selfmanipulation; - - - &reftitle.parameters; - - - - classname - - - The class in which to rename the method - - - - - methodname - - - The name of the method to rename - - - - - newname - - - The new name to give to the renamed method - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>runkit_method_rename</function> example - - -]]> - - &example.outputs; - - - - - - - - &reftitle.seealso; - - - runkit_method_add - runkit_method_copy - runkit_method_redefine - runkit_method_remove - runkit_function_rename - - - - - - diff --git a/reference/runkit/functions/runkit-return-value-used.xml b/reference/runkit/functions/runkit-return-value-used.xml deleted file mode 100644 index acdc9b1c45b8..000000000000 --- a/reference/runkit/functions/runkit-return-value-used.xml +++ /dev/null @@ -1,73 +0,0 @@ - - - - - runkit_return_value_used - Determines if the current functions return value will be used - - - &reftitle.description; - - boolrunkit_return_value_used - - - - - - &reftitle.returnvalues; - - Returns &true; if the function's return value is used by the calling scope, - otherwise &false; - - - - - &reftitle.examples; - - - <function>runkit_return_value_used</function> example - - -]]> - - &example.outputs; - - - - - - - - - - diff --git a/reference/runkit/functions/runkit-sandbox-output-handler.xml b/reference/runkit/functions/runkit-sandbox-output-handler.xml deleted file mode 100644 index c8e9f0b74c3d..000000000000 --- a/reference/runkit/functions/runkit-sandbox-output-handler.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - runkit_sandbox_output_handler - - Specify a function to capture and/or process output from a runkit sandbox - - - - &reftitle.description; - - mixedrunkit_sandbox_output_handler - objectsandbox - mixedcallback - - - Ordinarily, anything output (such as with echo - or print) will be output as though it were printed - from the parent's scope. Using runkit_sandbox_output_handler - however, output generated by the sandbox (including errors), can be captured - by a function outside of the sandbox. - - - ¬e.runkit.sandbox; - - - Deprecated - - As of runkit version 0.5, this function is deprecated and is scheduled to - be removed from the package prior to a 1.0 release. The output handler for - a given Runkit_Sandbox instance may be read/set using the array offset syntax - shown on the Runkit_Sandbox class definition page. - - - - - - - &reftitle.parameters; - - - - sandbox - - - Object instance of Runkit_Sandbox class on which to set output handling. - - - - - callback - - - Name of a function which expects one parameter. - Output generated by sandbox will be passed - to this callback. Anything returned by the callback will be displayed - normally. If this parameter is not passed then output handling will not be changed. - If a non-truth value is passed, output handling will be disabled and will revert to - direct display. - - - - - - - - - &reftitle.returnvalues; - - Returns the name of the previously defined output handler callback, or - &false; if no handler was previously defined. - - - - - - &reftitle.examples; - - - Feeding output to a variable - -echo("Hello\n"); -$php->eval('var_dump("Excuse me");'); -$php->die("I lost myself."); -unset($php); - -echo "Sandbox Complete\n\n"; -echo $sandbox_output; -?> -]]> - - &example.outputs; - - - - - - - - - - - diff --git a/reference/runkit/functions/runkit-superglobals.xml b/reference/runkit/functions/runkit-superglobals.xml deleted file mode 100644 index c1fec272d2b7..000000000000 --- a/reference/runkit/functions/runkit-superglobals.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - - runkit_superglobals - - Return numerically indexed array of registered superglobals - - - - &reftitle.description; - - arrayrunkit_superglobals - - - - - - &reftitle.returnvalues; - - Returns a numerically indexed array of the currently registered superglobals. - i.e. _GET, _POST, _REQUEST, _COOKIE, _SESSION, _SERVER, _ENV, _FILES - - - - - &reftitle.seealso; - - - Variable Scope - - - - - - - diff --git a/reference/runkit/ini.xml b/reference/runkit/ini.xml deleted file mode 100644 index 1d132fc3dd41..000000000000 --- a/reference/runkit/ini.xml +++ /dev/null @@ -1,111 +0,0 @@ - - -
    - &reftitle.runtime; - &extension.runtime; - - - Runkit Configuration Options - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - runkit.superglobal - "" - PHP_INI_PERDIR - - - - runkit.internal_override - "0" - PHP_INI_SYSTEM - - - - -
    - &ini.php.constants; -     - -&ini.descriptions.title; - - - - - - runkit.superglobal - string - - - - Comma-separated list of variable names to be treated as superglobals. - This value should be set in the systemwide php.ini file, but may work - in perdir configuration contexts depending on your SAPI. - - - Custom Superglobals with runkit.superglobal=_FOO,_BAR in php.ini - - -]]> - - - - - - - - runkit.internal_override - boolean - - - - Enables ability to modify/rename/remove internal functions. - - - - - - -
    - - diff --git a/reference/runkit/reference.xml b/reference/runkit/reference.xml deleted file mode 100644 index 7a3758d84c25..000000000000 --- a/reference/runkit/reference.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - runkit &Functions; - - &reference.runkit.sandbox; - &reference.runkit.sandbox-parent; - - &reference.runkit.entities.functions; - - - diff --git a/reference/runkit/sandbox-parent.xml b/reference/runkit/sandbox-parent.xml deleted file mode 100644 index 4f7affcad761..000000000000 --- a/reference/runkit/sandbox-parent.xml +++ /dev/null @@ -1,179 +0,0 @@ - - - - - - Runkit_Sandbox_Parent - - Runkit Anti-Sandbox Class - - - - &reftitle.description; - - - voidRunkit_Sandbox_Parent::__construct - - - - - Instantiating the Runkit_Sandbox_Parent - class from within a sandbox environment created from the - Runkit_Sandbox class provides some - (controlled) means for a sandbox child to access its parent. - - - ¬e.runkit.sandbox; - - - In order for any of the Runkit_Sandbox_Parent - features to function. Support must be enabled on a per-sandbox basis - by enabling the parent_access flag from the parent's - context. - - - - Working with variables in a sandbox - - -]]> - - - - - - - Accessing the Parent's Variables - - Just as with sandbox variable access, a sandbox parent's - variables may be read from and written to as properties of - the Runkit_Sandbox_Parent class. - Read access to parental variables may be enabled with - the parent_read setting (in addition - to the base parent_access setting). - Write access, in turn, is enabled through the - parent_write setting. - - - - Unlike sandbox child variable access, the variable scope - is not limited to globals only. By setting the - parent_scope setting to an appropriate - integer value, other scopes in the active call stack may - be inspected instead. A value of 0 (Default) will direct - variable access at the global scope. 1 will point variable - access at whatever variable scope was active at the time the - current block of sandbox code was executed. Higher values - progress back through the functions that called the functions - that led to the sandbox executing code that tried to access - its own parent's variables. - - - - Accessing parental variables - -eval('$PARENT = new Runkit_Sandbox_Parent;'); - -$php['parent_scope'] = 0; -one(); - -$php['parent_scope'] = 1; -one(); - -$php['parent_scope'] = 2; -one(); - -$php['parent_scope'] = 3; -one(); - -$php['parent_scope'] = 4; -one(); - -$php['parent_scope'] = 5; -one(); - -function one() { - $test = "one()"; - two(); -} - -function two() { - $test = "two()"; - three(); -} - -function three() { - $test = "three()"; - $GLOBALS['php']->eval('var_dump($PARENT->test);'); -} -?> -]]> - - - &example.outputs; - - - - - - - Calling the Parent's Functions - - Just as with sandbox access, a sandbox may access its parents - functions providing that the proper settings have been enabled. - Enabling parent_call will allow the sandbox - to call all functions available to the parent scope. Language - constructs are each controlled by their own setting: - print and echo are - enabled with parent_echo. - die and exit are - enabled with parent_die. - eval is enabled with parent_eval - while include, include_once, - require, and require_once - are enabled through parent_include. - - - - - - - diff --git a/reference/runkit/sandbox.xml b/reference/runkit/sandbox.xml deleted file mode 100644 index 459f468d0f74..000000000000 --- a/reference/runkit/sandbox.xml +++ /dev/null @@ -1,437 +0,0 @@ - - - - - - Runkit_Sandbox - - Runkit Sandbox Class -- PHP Virtual Machine - - - - &reftitle.description; - - - Instantiating the Runkit_Sandbox - class creates a new thread with its own scope - and program stack. Using a set of options passed to the constructor, this environment - may be restricted to a subset of what the primary interpreter can do and provide a - safer environment for executing user supplied code. - - - ¬e.runkit.sandbox; - - - - Constructor - - voidRunkit_Sandbox::__construct - arrayoptions - - - - options is an associative array containing - any combination of the special ini options listed below. - - - - - - safe_mode - - - If the outer script which is instantiating the - Runkit_Sandbox class - is configured with safe_mode = off, then safe_mode - may be turned on for the sandbox environment. This setting can not - be used to disable safe_mode when it's already - enabled in the outer script. - - - - - safe_mode_gid - - - If the outer script which is instantiating the - Runkit_Sandbox class - is configured with safe_mode_gid = on, then safe_mode_gid - may be turned off for the sandbox environment. This setting can not - be used to enable safe_mode_gid when it's already - disabled in the outer script. - - - - - safe_mode_include_dir - - - If the outer script which is instantiating the - Runkit_Sandbox class - is configured with a safe_mode_include_dir, - then a new safe_mode_include_dir may be set for sandbox environments - below the currently defined value. safe_mode_include_dir may also be - cleared to indicate that the bypass feature is disabled. - If safe_mode_include_dir was blank in the outer script, but safe_mode - was not enabled, then any arbitrary safe_mode_include_dir may be set - while turning safe_mode on. - - - - - open_basedir - - - open_basedir may be set to any path below the - current setting of open_basedir. If - open_basedir is not set within the global scope, - then it is assumed to be the root directory and may be set to any location. - - - - - allow_url_fopen - - - Like safe_mode, this setting can only be made more restrictive, - in this case by setting it to &false; when it is previously set to &true; - - - - - disable_functions - - - Comma separated list of functions to disable within the sandbox sub-interpreter. - This list need not contain the names of the currently disabled functions, - they will remain disabled whether listed here or not. - - - - - disable_classes - - - Comma separated list of classes to disable within the sandbox sub-interpreter. - This list need not contain the names of the currently disabled classes, - they will remain disabled whether listed here or not. - - - - - runkit.superglobal - - - Comma separated list of variables to be treated as superglobals within the - sandbox sub-interpreter. These variables will be used in addition to any - variables defined internally or through the global runkit.superglobal setting. - - - - - runkit.internal_override - - - Ini option runkit.internal_override may be disabled - (but not re-enabled) within sandboxes. - - - - - - - - Instantiating a restricted sandbox - -true, - 'open_basedir'=>'/var/www/users/jdoe/', - 'allow_url_fopen'=>'false', - 'disable_functions'=>'exec,shell_exec,passthru,system', - 'disable_classes'=>'myAppClass'); -$sandbox = new Runkit_Sandbox($options); -/* Non-protected ini settings may set normally */ -$sandbox->ini_set('html_errors',true); -?> -]]> - - - - - - Accessing Variables - - All variables in the global scope of the sandbox environment - are accessible as properties of the sandbox object. - The first thing to note is that because of the way memory - between these two threads is managed, object and resource - variables can not currently be exchanged between interpreters. - Additionally, all arrays are deep copied and any references - will be lost. This also means that references between - interpreters are not possible. - - - - Working with variables in a sandbox - -foo = 'bar'; -$sandbox->eval('echo "$foo\n"; $bar = $foo . "baz";'); -echo "{$sandbox->bar}\n"; -if (isset($sandbox->foo)) unset($sandbox->foo); -$sandbox->eval('var_dump(isset($foo));'); -?> -]]> - - - &example.outputs; - - - - - - - Calling PHP Functions - - Any function defined within the sandbox may be called as - a method on the sandbox object. This also includes a few - pseudo-function language constructs: eval, - include, include_once, - require, require_once, - echo, print, - die, and exit. - - - - Calling sandbox functions - -str_replace('a','f','abc'); -?> -]]> - - - &example.outputs; - - - - - - When passing arguments to a sandbox function, the arguments - are taken from the outer instance of PHP. If you wish to pass - arguments from the sandbox's scope, be sure to access them as - properties of the sandbox object as illustrated above. - - - - Passing arguments to sandbox functions - -foo = 'baz'; -echo $sandbox->str_replace('a',$foo,'a'); -echo $sandbox->str_replace('a',$sandbox->foo,'a'); -?> -]]> - - - &example.outputs; - - - - - - - Changing Sandbox Settings - - As of runkit version 0.5, certain Sandbox settings may - be modified on the fly using ArrayAccess syntax. - Some settings, such as active - are read-only and meant to provide status information. - Other settings, such as output_handler - may be set and read much like a normal array offset. - Future settings may be write-only, however no such - settings currently exist. - - - - - Sandbox Settings / Status Indicators - - - - Setting - Type - Purpose - Default - - - - - active - Boolean (Read Only) - - &true; if the Sandbox is still in a usable state, - &false; if the request is in bailout due to a - call to die(), exit(), or because of a fatal - error condition. - - &true; (Initial) - - - output_handler - Callback - - When set to a valid callback, all output generated - by the Sandbox instance will be processed through - the named function. - Sandbox output handlers follow the same calling - conventions as the system-wide output handler. - - None - - - parent_access - Boolean - - May the sandbox use instances of the - Runkit_Sandbox_Parent class? - Must be enabled for other - Runkit_Sandbox_Parent - related settings to work. - - &false; - - - parent_read - Boolean - - May the sandbox read variables in its parent's context? - - &false; - - - parent_write - Boolean - - May the sandbox modify variables in its parent's context? - - &false; - - - parent_eval - Boolean - - May the sandbox evaluate arbitrary code in its - parent's context? DANGEROUS - - &false; - - - parent_include - Boolean - - May the sandbox include php code files in its - parent's context? DANGEROUS - - &false; - - - parent_echo - Boolean - - May the sandbox echo data in its parent's context - effectively bypassing its own output_handler? - - &false; - - - parent_call - Boolean - - May the sandbox call functions in its - parent's context? - - &false; - - - parent_die - Boolean - - May the sandbox kill its own parent? (And thus itself) - - &false; - - - parent_scope - Integer - - What scope will parental property access look at? - 0 == Global scope, 1 == Calling scope, - 2 == Scope preceding calling scope, - 3 == The scope before that, etc..., etc... - - 0 (Global) - - - parent_scope - String - - When parent_scope is set to - a string value, it refers to a named array variable - in the global scope. If the named variable does not - exist at the time of access it will be created as an - empty array. If the variable exists but it not an array, - a dummy array will be created containing a reference - to the named global variable. - - - - - -
    -     -     - -     - - diff --git a/reference/runkit/setup.xml b/reference/runkit/setup.xml deleted file mode 100644 index c6539dad28e2..000000000000 --- a/reference/runkit/setup.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - Modifying Constants, Functions, Classes, and Methods - as well as Custom Superglobals - works with all releases of PHP 5. No special requirements are - necessary. - - - - Sandboxing requires PHP 5.1.0 or later, or - PHP 5.0.0 with a special TSRM patch applied. - Regardless of which version of PHP is in use it must be compiled with the - --enable-maintainer-zts option. - See the README file in the runkit package for additional information. - -
    - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;runkit. - - - &pecl.windows.download.avail; - -
    - - &reference.runkit.ini; - -
    - &reftitle.resources; - &no.resource; -
    - -     - - - diff --git a/reference/runkit/versions.xml b/reference/runkit/versions.xml deleted file mode 100644 index ded199968be7..000000000000 --- a/reference/runkit/versions.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/runkit7/ini.xml b/reference/runkit7/ini.xml index 2563133330c1..9a2d25e9bb1e 100644 --- a/reference/runkit7/ini.xml +++ b/reference/runkit7/ini.xml @@ -5,7 +5,88 @@ &reftitle.runtime; &extension.runtime; - Currently the same as Runkit Configuration Options + + Runkit Configuration Options + + + + &Name; + &Default; + &Changeable; + &Changelog; + + + + + runkit.superglobal + "" + PHP_INI_PERDIR + + + + runkit.internal_override + "0" + PHP_INI_SYSTEM + + + + +
    + &ini.php.constants; +     + + &ini.descriptions.title; + + + + + + runkit.superglobal + string + + + + Comma-separated list of variable names to be treated as superglobals. + This value should be set in the systemwide php.ini file, but may work + in perdir configuration contexts depending on your SAPI. + + + Custom Superglobals with runkit.superglobal=_FOO,_BAR in php.ini + + +]]> + + + + + + + + runkit.internal_override + boolean + + + + Enables ability to modify/rename/remove internal functions. + + + + + diff --git a/reference/sam/SAMConnection/commit.xml b/reference/sam/SAMConnection/commit.xml deleted file mode 100644 index c1197164a881..000000000000 --- a/reference/sam/SAMConnection/commit.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - SAMConnection::commit - - Commits (completes) the current unit of work - - - - &reftitle.description; - - boolSAMConnection::commit - - - Calling the "commit" method on a Connection object commits (completes) all - in-flight transactions that are part of the current unit of work. - - - - - &reftitle.returnvalues; - - This method returns &false; if an error occurs. - - - - - &reftitle.examples; - - - Committing the current unit of work - -commit()) { - // The commit failed! - echo "Commit failed ($conn->errno) $conn->error"; - } -?> -]]> - - - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/sam/SAMConnection/connect.xml b/reference/sam/SAMConnection/connect.xml deleted file mode 100644 index 11633d444653..000000000000 --- a/reference/sam/SAMConnection/connect.xml +++ /dev/null @@ -1,311 +0,0 @@ - - - - - SAMConnection::connect - - Establishes a connection to a Messaging Server - - - - - &reftitle.description; - - boolSAMConnection::connect - stringprotocol - arrayproperties - - - Calling the "connect" method on a SAMConnection object connects the PHP - script to a messaging server. No messages can be sent or received until a - connection is made. - - - - - &reftitle.parameters; - - - - - - - &reftitle.returnvalues; - - This method returns &false; if an error occurs. - - - - - &reftitle.examples; - - - - Creating a connection to a Messaging Server using the IBM MQSeries - protocol (WMQ) - - -connect(SAM_WMQ, array(SAM_HOST => 'Myhost.myco.com', SAM_PORT => 1506, SAM_BROKER => 'MyBroker')); - -?> -]]> - - - - - - - Creating a connection with application transaction control and default - host and port values - - -connect(SAM_WMQ, array(SAM_BROKER => 'MyBroker', SAM_TRANSACTIONS => SAM_MANUAL)); - -?> -]]> - - - - - - - Creating a connection to a Messaging Server using the IBM WebSphere - Platform Messaging protocol (WPM) - - -connect(SAM_WPM, array(SAM_ENDPOINTS => 'localhost:7278:BootstrapBasicMessaging', - SAM_BUS => 'Bus1', SAM_TARGETCHAIN => 'InboundBasicMessaging')); - -?> -]]> - - - - - - - &reftitle.seealso; - - - - - - - - - - - diff --git a/reference/sam/SAMConnection/construct.xml b/reference/sam/SAMConnection/construct.xml deleted file mode 100644 index f1d01409b7c0..000000000000 --- a/reference/sam/SAMConnection/construct.xml +++ /dev/null @@ -1,61 +0,0 @@ - - - - - SAMConnection::__construct - - Creates a new connection to a Messaging Server - - - - - &reftitle.description; - - SAMConnection::__construct - - - - Creates a new SAMConnection object. - - - - - &reftitle.examples; - - - Creating a connection object and connecting to a Messaging Server - -connect(SAM_WMQ, array(SAM_HOST => localhost, SAM_PORT => 1414, SAM_BROKER => 'bull')); - -?> -]]> - - - - - - - diff --git a/reference/sam/SAMConnection/disconnect.xml b/reference/sam/SAMConnection/disconnect.xml deleted file mode 100644 index e1953884b1dd..000000000000 --- a/reference/sam/SAMConnection/disconnect.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - SAMConnection::disconnect - - Disconnects from a Messaging Server - - - - - &reftitle.description; - - boolSAMConnection::disconnect - - - Calling the "disconnect" method on a SAMConnection object disconnects the - PHP script from a messaging server. No messages can be sent or received - after a connection has been disconnected. - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - Disconnecting from a Messaging Server - -disconnect(); - -?> -]]> - - - - - - - &reftitle.seealso; - - - - - - - - - - - diff --git a/reference/sam/SAMConnection/errno.xml b/reference/sam/SAMConnection/errno.xml deleted file mode 100644 index acc2bc8c5c75..000000000000 --- a/reference/sam/SAMConnection/errno.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - SAMConnection::errno - Contains the unique numeric error code of the last executed SAM operation - - - - Description - intSAMConnection->errno - - Contains the numeric error code of the last executed SAM operation on this - connection. If the last operation completed successfully this property - contains 0. - - - - - &reftitle.returnvalues; - - An integer greater than zero indicates the last error type encountered on - the connection. Zero indicates that the last operation on this connection - completed successfully. - - - - - &reftitle.examples; - - - Using the error number and description properties - -connect(SAM_WMQ, array(SAM_HOST => 'localhost', SAM_PORT => 1506)); -$msg = new SAMMessage('This is a simple text item'); -if (!$conn->send('topic://test', $msg)) { - // The Send failed! - echo "Send failed ($conn->errno) $conn->error"; -} -?> -]]> - - - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/sam/SAMConnection/error.xml b/reference/sam/SAMConnection/error.xml deleted file mode 100644 index 3d1391aa42a1..000000000000 --- a/reference/sam/SAMConnection/error.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - SAMConnection::error - Contains the text description of the last failed SAM operation - - - - &reftitle.description; - stringSAMConnection->error - - Contains the text description of the last failed SAM operation on this - connection. If the last operation completed successfully this property - contains an empty string. - - - - - &reftitle.returnvalues; - - A string containing the text description of the last error type encountered - on the connection. An empty string indicates that the last operation on - this connection completed successfully. - - - - - &reftitle.examples; - - - Using the error number and description properties - -connect(SAM_WMQ, array(SAM_HOST => 'localhost', SAM_PORT => 1506)); -$msg = new SAMMessage('This is a simple text item'); -if (!$conn->send('topic://test', $msg)) { - // The Send failed! - echo "Send failed ($conn->errno) $conn->error"; -} -?> -]]> - - - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/sam/SAMConnection/isConnected.xml b/reference/sam/SAMConnection/isConnected.xml deleted file mode 100644 index 670d0b3292ec..000000000000 --- a/reference/sam/SAMConnection/isConnected.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - SAMConnection::isConnected - - Queries whether a connection is established to a Messaging Server - - - - - &reftitle.description; - - boolSAMConnection::isConnected - - - - Calling the "isConnected" method on a Connection object will check whether - the PHP script is connected to a messaging server. No messages can be sent - or received unless a connection has been established with a Messaging - server. - - - - - &reftitle.returnvalues; - - This method returns &true; if the SAMConnection object is successfully - connected to a Messaging server or &false; otherwise. - - - - - &reftitle.examples; - - - Checking whether there us a connection to a Messaging Server - -isConnected()) { - echo 'Connection is active.'; -} else { - echo 'No active connection!'; -} - -?> -]]> - - - - - - - &reftitle.seealso; - - - - - - - - - - - diff --git a/reference/sam/SAMConnection/peek.xml b/reference/sam/SAMConnection/peek.xml deleted file mode 100644 index d638d52d07d4..000000000000 --- a/reference/sam/SAMConnection/peek.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - SAMConnection::peek - - Read a message from a queue without removing it from the queue - - - - - &reftitle.description; - - SAMMessageSAMConnection::peek - stringtarget - arrayproperties - - - - - &reftitle.parameters; - - - - target - - - The identity of the queue from which to peek the message. - - - - - properties - - - An optional associative array of properties describing other - parameters to control the peek operation. - - - - - Property name - Possible values - - - - - SAM_CORRELID - - This is the target correlation id string of the message. This - would typically have been returned by a "send" request. - - - - SAM_MESSAGEID - - This is the message id string of the message which is to be - peeked. - - - - - - - - - - - - - - &reftitle.returnvalues; - - This method returns a SAMMessage object or &false; if an error occurs. - - - - - &reftitle.examples; - - - Retrieve the next message from a queue without removing it - -peek('queue://receive/test'); - -if (!$msg) { - // The peek failed! - echo "Peek failed ($conn->errno) $conn->error"; -} -?> -]]> - - - - - - Retrieve a specific message from a queue without removing it from the queue - -peek('queue://receive/test', array(SAM_MESSAGEID => $messageId)); - -?> -]]> - - - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/sam/SAMConnection/peekAll.xml b/reference/sam/SAMConnection/peekAll.xml deleted file mode 100644 index 43102b60a7cb..000000000000 --- a/reference/sam/SAMConnection/peekAll.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - SAMConnection::peekAll - - Read one or more messages from a queue without removing it from the queue - - - - - &reftitle.description; - - arraySAMConnection::peekAll - stringtarget - arrayproperties - - - - - &reftitle.parameters; - - - - target - - - The identity of the queue from which messages should be peeked. - - - - - properties - - - An optional associative array of properties describing other - parameters to control the peek operation. - - - - - Property name - Possible values - - - - - SAM_CORRELID - - This is the target correlation id string of messages to be - peeked. This would typically have been returned by a "send" - request. - - - - SAM_MESSAGEID - - This is the message id string of a message which is to be peeked. - - - - - - - - - - - - - - &reftitle.returnvalues; - - This method returns an array of SAMMessage objects or &false; if an error - occurs. - - - - - &reftitle.examples; - - - Retrieve all messages in a queue without removing them - -peekAll('queue://receive/test'); -if ($msgArray) { - foreach ( $msgArray as $key => $msg) { - echo "Message $key: body = $msg->body\n"; - } -} else { - echo "PeekAll failed ($conn->errno) $conn->error"; -} -?> -]]> - - - - - - - Retrieve all messages from a queue with a matching correlation id - - -peekAll('queue://receive/test', array(SAM_CORRELID => $correlId )); - if ($msgArray) { - - foreach ( $msgArray as $key => $msg) { - echo "Message $key: body = $msg->body\n"; - } - } else { - echo "PeekAll failed ($conn->errno) $conn->error"; - } - -?> -]]> - - - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/sam/SAMConnection/receive.xml b/reference/sam/SAMConnection/receive.xml deleted file mode 100644 index 2b957c32ce76..000000000000 --- a/reference/sam/SAMConnection/receive.xml +++ /dev/null @@ -1,184 +0,0 @@ - - - - - SAMConnection::receive - - Receive a message from a queue or subscription - - - - - &reftitle.description; - - SAMMessageSAMConnection::receive - stringtarget - arrayproperties - - - - - &reftitle.parameters; - - - - target - - - The identity of the queue, topic or subscription from which to receive - the message. - - - - - properties - - - An optional associative array of properties describing other - parameters to control the receive operation. - - - - - Property name - Possible values - - - - - SAM_CORRELID - - Used to request selection of the message to receive based upon - the correlation id string of the message. - - - - SAM_MESSAGEID - - Used to request selection of the message to receive based upon - the message id string of the message. - - - - SAM_WAIT - - Timeout value in milliseconds to control how long the request - should block waiting to receive a message before returning with - a failure if no message is available on the queue or topic. The - default value is 0 meaning wait indefinitely and should be used - with caution as the request may wait until the overall PHP script - processing time limit has expired if no message becomes available. - - - - - - - - - - - - - - &reftitle.returnvalues; - - This method returns a SAMMessage object or &false; if an error occurs. - - - - - &reftitle.examples; - - - Receiving a message from a queue - -receive('queue://receive/test'); - -if (!$msg) { - // The receive failed! - echo "Receive failed ($conn->errno) $conn->error"; -} -?> -]]> - - - - - - Receiving a message from a queue with options - - In this example the SAM_CORRELID option is used to specify a correlation - id string to be used to identify the message to receive. A wait timeout - of 10 seconds is also specified. - - -receive('queue://receive/test', array(SAM_CORRELID => $token, SAM_WAIT => 10000)); - -?> -]]> - - - - - - Receiving a message from a subscription - - In this example we show how to receive a message from a subscription id. - - -receive($subscriptionName); - -if (!$msg) { - // The receive failed! - echo "Receive failed ($conn->errno) $conn->error"; -} -?> -]]> - - - Please note that $subscriptionName is a subscription id returned from an - earlier subscribe call. - - - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/sam/SAMConnection/remove.xml b/reference/sam/SAMConnection/remove.xml deleted file mode 100644 index 71880232251f..000000000000 --- a/reference/sam/SAMConnection/remove.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - SAMConnection::remove - - Remove a message from a queue - - - - - &reftitle.description; - - SAMMessageSAMConnection::remove - stringtarget - arrayproperties - - - Removes a message from a queue. - - - - - &reftitle.parameters; - - - - target - - - The identity of the queue from which to remove the message. - - - - - properties - - - An optional associative array of properties describing other - parameters to control the remove operation. - - - - - Property name - Possible values - - - - - SAM_CORRELID - - This is the target correlation id string of the message. - This would typically have been returned by a "send" request. - - - - SAM_MESSAGEID - - This is the message id string of the message which is to be - removed. - - - - - - - - - - - - - - &reftitle.returnvalues; - - This method returns &false; if an error occurs. - - - - - &reftitle.examples; - - - Removing a message from a queue by message id - -remove('queue://receive/test', array(SAM_MESSAGEID => $messageId))) { - // The remove failed! - echo "Remove failed ($conn->errno) $conn->error"; -} -?> -]]> - - - - - - - diff --git a/reference/sam/SAMConnection/rollback.xml b/reference/sam/SAMConnection/rollback.xml deleted file mode 100644 index 77738ca8e1e3..000000000000 --- a/reference/sam/SAMConnection/rollback.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - SAMConnection::rollback - - Cancels (rolls back) an in-flight unit of work - - - - - &reftitle.description; - - boolSAMConnection::rollback - - - Rolls back an in-flight unit of work. - - - - - &reftitle.returnvalues; - - This method returns &false; if an error occurs. - - - - - &reftitle.examples; - - - Cancelling an in-flight unit of work - -rollback()) { - // The rollback failed! - echo "Rollback failed ($conn->errno) $conn->error"; -} -?> -]]> - - - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/sam/SAMConnection/send.xml b/reference/sam/SAMConnection/send.xml deleted file mode 100644 index 86637ba5c790..000000000000 --- a/reference/sam/SAMConnection/send.xml +++ /dev/null @@ -1,234 +0,0 @@ - - - - - SAMConnection::send - - Send a message to a queue or publish an item to a topic - - - - - &reftitle.description; - - stringSAMConnection::send - stringtarget - SAMMessagemsg - arrayproperties - - - The "send" method is used to send a message to a specific queue or to - publish to a specific topic. The method returns a correlation id that can - be used as a selector to identify reply or response messages when these - are requested. - - - - - &reftitle.parameters; - - - - target - - - If sending a message, the identity of the queue (queue://queuename) - or if publishing to a topic the identity of the topic - (topic://topicname) to which the message is to be delivered. - - - - - msg - - - The message to be sent or published. - - - - - properties - - - An optional associative array of properties describing other - parameters to control the receive operation. - - - - - Property name - Possible values - - - - - SAM_DELIVERYMODE - - Indicates whether the messaging server should ensure delivery or - whether it is acceptable for messages to be lost in the case of - system failures. The value of this property may be set to either - SAM_PERSISTENT, to indicate that message - loss is not acceptable, or - SAM_NON_PERSISTENT, if message loss is - acceptable. The resulting behaviour of the send will vary - depending on the capabilities of the messaging server the PHP - script is currently connected to. If the server does not support - persistent messages and SAM_PERSISTENT is - specified the send request will fail with an error indication - showing the capability is not available. - - - - SAM_PRIORITY - - A numeric value between 0 and 9 indicating the desired message - delivery priority. A priority value of 0 indicates the lowest - priority while 9 indicates highest priority. If no priority is - specified a default will be assigned which is dependent on the - messaging server being used. - - - - SAM_CORRELID - - A string to be assigned as a correlation id for this message. If - no value is given the messaging server may assign a value - automatically. - - - - SAM_TIMETOLIVE - - A time in milliseconds indicating how long the messaging server - should retain the message on a queue before discarding it. The - default value is 0 indicating the message should be retained - indefinitely. - - - - SAM_WMQ_TARGET_CLIENT - - This property is only valid when using WebSphere MQ and indicates - whether or not an RFH2 header should be included with the - message. This option may be set to either 'jms' or 'mq'. The - default is 'jms' which means that an RFH2 header is included. - If the value 'mq' is specified then no RFH2 is included with the - message. - - - - - - - - - - - - - - &reftitle.returnvalues; - - A correlation id string that can be used in a subsequent receive call as a - selector to obtain any reply or response that has been requested or &false; - if an error occurred. - - - - A correlation id will only be returned for a successful send to a queue - destination (queue://xxxx) in which case it will reflect the message - identity of the message on the queue. In the case of a send being used - to publish data to a topic the return value will be &true; as no - correlation id is available for return. - - - - - - &reftitle.examples; - - - Send a message to a queue - -send('queue://send/test', $msg); -if (!$correlId) { - // The send failed! - echo "Send failed ($conn->errno) $conn->error"; -} - -?> -]]> - - - - - - Publish a message to a topic - -send('topic://test', $msg)) { - // The Send failed! - echo "Send failed ($conn->errno) $conn->error"; -} -?> -]]> - - - - Send a request and receive a response - -header->SAM_REPLY_TO = 'queue://receive/test'; -$correlid = $conn->send('queue://send/test', $msg); - -if (!$correlid) { - // The Send failed! - echo "Send failed ($conn->errno) $conn->error"; -} else { - $resp = $conn->receive('queue://receive/test', array(SAM_CORRELID => $correlid)); -} -?> -]]> - - - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/sam/SAMConnection/setDebug.xml b/reference/sam/SAMConnection/setDebug.xml deleted file mode 100644 index 4130be3e5e1c..000000000000 --- a/reference/sam/SAMConnection/setDebug.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - SAMConnection::setDebug - - Turn on or off additional debugging output - - - - - &reftitle.description; - - The "setdebug" method is used to turn on or off additional debugging output. The SAM framework will provide method/function - entry and exit trace data plus additional information. Protocol specific implementations also provide extra output. - - - voidSAMConnection::setDebug - boolswitch - - - - - &reftitle.parameters; - - - - switch - - - If this parameter is set to &true; additional debugging output will be provided. If the value is set to &false; output - of additional information will be stopped. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.examples; - - - Turn on debugging output - -setdebug(TRUE); -?> -]]> - - - - - - Turn off debugging output - -setdebug(FALSE); -?> -]]> - - - - - - - diff --git a/reference/sam/SAMConnection/subscribe.xml b/reference/sam/SAMConnection/subscribe.xml deleted file mode 100644 index 699dc2442605..000000000000 --- a/reference/sam/SAMConnection/subscribe.xml +++ /dev/null @@ -1,98 +0,0 @@ - - - - - SAMConnection::subscribe - - Create a subscription to a specified topic - - - - - &reftitle.description; - - stringSAMConnection::subscribe - stringtargetTopic - - - The "subscribe" method is used to create a new subscription to a specified topic. - - - - - &reftitle.parameters; - - - - targetTopic - - - The identity of the topic (topic://topicname) to subscribe to. - - - - - - - - - &reftitle.returnvalues; - - A subscription identifier that can be used in a subsequent receive call as - a selector to obtain any topic data or &false; if an error occurred. The - subscription identifier should be used in the receive call in place of the - simple topic name. - - - - - &reftitle.examples; - - - Subscribe to a topic - -subscribe('topic://A'); -if (!$subid) { - // The subscribe failed! - echo "Subscribe failed ($conn->errno) $conn->error"; -} -?> -]]> - - - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/sam/SAMConnection/unsubscribe.xml b/reference/sam/SAMConnection/unsubscribe.xml deleted file mode 100644 index 947df6e87e40..000000000000 --- a/reference/sam/SAMConnection/unsubscribe.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - SAMConnection::unsubscribe - - Cancel a subscription to a specified topic - - - - - &reftitle.description; - - boolSAMConnection::unsubscribe - stringsubscriptionId - stringtargetTopic - - - The "unsubscribe" method is used to delete an existing subscription to a - specified topic. - - - - - &reftitle.parameters; - - - - subscriptionId - - - The identifier of an existing subscription as returned by a call to - the subscribe method. - - - - - - - - - &reftitle.returnvalues; - - This method returns &false; if an error occurs. - - - - - &reftitle.examples; - - - Delete a subscription - -unsubscribe($subid)) { - // The unsubscribe failed! - echo "Unsubscribe failed ($conn->errno) $conn->error"; -} -?> -]]> - - - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/sam/SAMMessage/body.xml b/reference/sam/SAMMessage/body.xml deleted file mode 100644 index e3cfd7934089..000000000000 --- a/reference/sam/SAMMessage/body.xml +++ /dev/null @@ -1,67 +0,0 @@ - - - - - SAMMessage::body - - The body of the message - - - - &reftitle.description; - stringSAMMessage->body - - The "body" property contains the actual body of the message. - It may not always be set. - - - - - &reftitle.examples; - - - Setting a text string into the body of a message - -body = 'This is a simple message'; - -?> -]]> - - - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/sam/SAMMessage/construct.xml b/reference/sam/SAMMessage/construct.xml deleted file mode 100644 index 7e87a3d1a512..000000000000 --- a/reference/sam/SAMMessage/construct.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - SAMMessage::__construct - - Creates a new Message object - - - - &reftitle.description; - - SAMMessage::__construct - mixedbody - - - Creates a new SAMMessage object optionally specifying a message body. - - - - - &reftitle.parameters; - - - - body - - - The optional body for the message. - - - - - - - - - &reftitle.examples; - - - Creating a message - - -]]> - - - - - - Creating a message with a simple text payload - - -]]> - - - - - - - - diff --git a/reference/sam/SAMMessage/header.xml b/reference/sam/SAMMessage/header.xml deleted file mode 100644 index b642c62a6e34..000000000000 --- a/reference/sam/SAMMessage/header.xml +++ /dev/null @@ -1,294 +0,0 @@ - - - - - SAMMessage::header - - The header properties of the message - - - - &reftitle.description; - objectSAMMessage->header - - The header property is a container for any system or - user properties that area associated with the message. - - - Properties may be assigned by the sender of a message to control the way - the messaging systems handles it or may be assigned by the messaging - system itself to tell the recipient extra information about the message or - the way in which it has been handled. - - - Some properties are understood by SAM in which case constants have been - defined for them. The majority of properties however are ignored by the - SAM implementation and simply passed through to the underlying messaging - systems allowing the application to use messaging specific property names - or to define its own "user" properties. - - - The SAM defined properties are as follows: - - - - - Property name - Possible values - - - - - SAM_MESSAGEID - - When a message is received this field contains the unique - identifier of the message as allocated by the underlying - messaging system. When sending a message this field is ignored. - - - - SAM_REPLY_TO - - A string providing the identity of the queue on to which - responses to this message should be posted. - - - - SAM_TYPE - - - An indication of the type of message to be sent. The value may be - SAM_TEXT indicating the contents of the - message body is a text string, or SAM_BYTES - indicating the contents of the message body are some application - defined format. - - - The way in which this property is used may depend on the underlying - messaging server. For instance a messaging server that supports the - JMS (Java Message Service) specification may - interpret this value and send messages of type "jms_text" - and "jms_bytes". In addition, if the - SAM_TYPE property is set to SAM_TEXT - the data provided for the message body is expected to be a UTF8 encoded - string. - - - - - - - - - When setting the values of properties it is often useful to give a hint as - to the format in which the property should be delivered to the messaging - system. By default property values are delivered as text and the - following simple syntax may be used to set a value: - - - - Setting a text format property using the default syntax - -header->myPropertyName = 'textData'; -?> -]]> - - - - - If it is desired to pass type information an alternative syntax may be - used where the value and the type hint are passed in an associative - array: - - - - Setting a text format property using a type hint - -header->myPropertyName = array('textData', SAM_STRING); -?> -]]> - - - - - When passing a type hint the type entry should be one of the SAM defined - constant values as defined by the following table: - - - - - Constant - Type description - - - - - SAM_BOOLEAN - - Any value passed will be interpreted as logical true or false. - If the value cannot be interpreted as a PHP boolean value the value - passed to the messaging system is undefined. - - - - SAM_BYTE - - An 8-bit signed integer value. SAM will attempt to convert the - property value specified into a single byte value to pass to the - messaging system. If a string value is passed an attempt will be - made to interpret the string as a numeric value. If the numeric - value cannot be expressed as an 8-bit signed binary value data may - be lost in the conversion. - - - - SAM_DOUBLE - - A long floating point value. SAM will attempt to convert the - property value specified into a floating point value with 15 digits - of precision. If a string value is passed an attempt will be made to - interpret the string as a numeric value. If the passed value cannot - be expressed as a 15 digit floating point value data may be lost in - the conversion. - - - - SAM_FLOAT - - A short floating point value. SAM will attempt to convert the - property value specified into a floating point value with 7 digits of - precision. If a string value is passed an attempt will be made to - interpret the string as a numeric value. If the passed value cannot - be expressed as a 7 digit floating point value data may be lost in - the conversion. - - - - SAM_INT - - An 32-bit signed integer value. SAM will attempt to convert the - property value specified into a 32-bit value to pass to the messaging - system. If a string value is passed an attempt will be made to - interpret the string as a numeric value. If the numeric value cannot - be expressed as an 32-bit signed binary value data may be lost in the - conversion. - - - - SAM_LONG - - An 64-bit signed integer value. SAM will attempt to convert the - property value specified into a 64-bit value to pass to the messaging - system. If a string value is passed an attempt will be made to - interpret the string as a numeric value. If the numeric value cannot - be expressed as an 64-bit signed binary value data may be lost in the - conversion. - - - - SAM_STRING - - SAM will interpret the property value specified as a string and pass - it to the messaging system accordingly. - - - - - - - - - - &reftitle.examples; - - - Setting properties as the sender of a message - -header->SAM_REPLY_TO = 'queue://test/replyQueue'; - -// defining arbitrary properties... -// -// a default string property -$msg->header->myStringProp1 = 'a string property'; -// a string property with a type hint -$msg->header->myStringProp2 = array('another string property', SAM_STRING); - -// a boolean property -$msg->header->myBoolProp = array(FALSE, SAM_BOOL); - -// numeric format properties -$msg->header->myIntProp = array(32768, SAM_INT); -$msg->header->myLongProp = array(9876543, SAM_LONG); -$msg->header->myByteProp1 = array(123, SAM_BYTE); -$msg->header->myByteProp2 = array('12', SAM_BYTE); -$msg->header->myFloatProp = array(3.141592, SAM_FLOAT); -$msg->header->myDoubleProp = array(3.14159265358979, SAM_DOUBLE); -?> -]]> - - - - - - Retreiving property values from a message - -header->MyIntProp; - -// accessing a messaging system specific property -$encoding = $msg->header->JMS_IBM_Msgtype; - -?> -]]> - - - - - - - &reftitle.seealso; - - - - - - - - - - diff --git a/reference/sam/book.xml b/reference/sam/book.xml deleted file mode 100644 index 3d90c24e4241..000000000000 --- a/reference/sam/book.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - Simple Asynchronous Messaging - SAM - - - - &reftitle.intro; - - This extension provides access to the functionality of messaging and - queueing systems, such as the IBM WebSphere MQSeries family of products, - from PHP scripts. The interface is designed to make it extremely simple - to do the more commonly required tasks such as deliver simple text - messages to queues while still allowing skilled users to do more complex - messaging operations. For many users the complexities of setting up - numerous options can be simply ignored. - - - The SAM extension is a framework that provides a very simple API that can be used to - access a number of messaging middleware systems. Currently the package - includes built-in support for the MQTT (MQ Telemetry Transport) messaging protocol and support for the IBM - Messaging and Queuing middleware products. SAM is designed to be readily extended to - support other messaging systems and extension modules may be written in C or PHP. - - - - - &reference.sam.setup; - &reference.sam.constants; - &reference.sam.examples; - &reference.sam.reference; - - - - - diff --git a/reference/sam/constants.xml b/reference/sam/constants.xml deleted file mode 100644 index bd14666a1cd1..000000000000 --- a/reference/sam/constants.xml +++ /dev/null @@ -1,451 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - SAM_AUTO - (string) - - - - Automatic behaviour - - - - - - SAM_BOOLEAN - (string) - - - - Type specifier used when setting properties on SAM_Message objects. - - - - - - SAM_BUS - (string) - - - - Connect attribute used to set the name of the enterprise service bus to - connect to. - - - - - - SAM_BYTE - (string) - - - - Type specifier used when setting properties on SAM_Message objects. - - - - - - SAM_BYTES - (string) - - - - Message body type descriptor. - - - - - - SAM_CORRELID - (string) - - - - Attribute used on receive, send and remove requests to identify specific - messages. - - - - - - SAM_DELIVERYMODE - (string) - - - - Message header property. - - - - - - SAM_DOUBLE - (string) - - - - Type specifier used when setting properties on SAM_Message objects. - - - - - - SAM_ENDPOINTS - (string) - - - - Connect attribute used to define the possible endpoints to connect to. - - - - - - SAM_FLOAT - (string) - - - - Type specifier used when setting properties on SAM_Message objects. - - - - - - SAM_HOST - (string) - - - - Connect attribute used to set the hostname of the required messaging - server. - - - - - - SAM_INT - (string) - - - - Type specifier used when setting properties on SAM_Message objects. - - - - - - SAM_LONG - (string) - - - - Type specifier used when setting properties on SAM_Message objects. - - - - - - SAM_MANUAL - (string) - - - - Manual (script controlled) behaviour - - - - - - SAM_MESSAGEID - (string) - - - - Attribute used on receive and remove requests to identify specific - messages. - - - - - - SAM_MQTT - (string) - - - - Connect protocol definition for selecting the MQTT (MQ Telemetry Transport) protocol. - - - - - - SAM_MQTT_CLEANSTART - (bool) - - - - Optional connect option to indicate to an MQTT server that all previous connection data - for this client should be removed and that subscriptions should be deleted when the client - disconnects explicitly or unexpectedly. - - - - - - SAM_NON_PERSISTENT - (string) - - - - Connect attribute value used to request messages are not made persistent - on the messaging server. - - - - - - SAM_PASSWORD - (string) - - - - Connect attribute used to define the password to be used for the user - account being used to connect to a messaging server that requires - authorisation for connections. - - - - - - SAM_PERSISTENT - (string) - - - - Connect attribute value used to request messages are made persistent - on the messaging server to protect against loss of messages in the - event of failure. - - - - - - SAM_PORT - (string) - - - - Connect attribute used to set the port number on which to communicate - with the messaging server. - - - - - - SAM_PRIORITY - (string) - - - - Option name used on send requests to specify a delivery priority value. - - - - - - SAM_REPLY_TO - (string) - - - - Message property used to specify the queue identity on to which the - script expects response or reply messages to be posted. - - - - - - SAM_RTT - (string) - - - - Connect protocol definition for selecting the IBM Realtime Transport - protocol for communication with a business integration messaging server. - - - - - - SAM_STRING - (string) - - - - Type specifier used when setting properties on SAM_Message objects. - - - - - - SAM_TARGETCHAIN - (string) - - - - Connection attribute used to set the required target chain identifier. - - - - - - SAM_TEXT - (string) - - - - Message body type descriptor. - - - - - - SAM_TIMETOLIVE - (string) - - - - Message send option name used to specify the length of time a message - should be retained in milliseconds. - - - - - - SAM_TRANSACTIONS - (string) - - - - Connection attribute used to set required transactional behaviour. May - be set to SAM_AUTO (default) or SAM_MANUAL. - - - - - - SAM_USERID - (string) - - - - Connect attribute used to define the account to being used to - connect to a messaging server that requires authorisation for connections. - - - - - - SAM_WAIT - (string) - - - - Receive property used to specify the wait timeout to be used when - receiving a message from a queue or subscription. - - - - - - SAM_WMQ - (string) - - - - Connect protocol definition for selecting the IBM WebSphere MQSeries - protocol for communication with the desired messaging server. - - - - - - SAM_WMQ_BINDINGS - (string) - - - - Connect protocol definition for selecting the IBM WebSphere MQSeries - protocol for communication with a local messaging server. - - - - - - SAM_WMQ_CLIENT - (string) - - - - Connect protocol definition for selecting the IBM WebSphere MQSeries - protocol for communication with a remote messaging server. - - - - - - SAM_WMQ_TARGET_CLIENT - (string) - - - - Option name used on send requests to specify the target client mode. - This can either be default to 'jms' or 'mq'. The default is 'jms' which - means an RFH2 header is sent with the message whereas the 'mq' setting - means no RFH2 is included. - - - - - - SAM_WPM - (string) - - - - Connect protocol definition for selecting the IBM WebSphere Platform - Messaging protocol for communication with a WebSphere Application Server - messaging server. - - - - - - - diff --git a/reference/sam/examples.xml b/reference/sam/examples.xml deleted file mode 100644 index 3d1b11061fe4..000000000000 --- a/reference/sam/examples.xml +++ /dev/null @@ -1,357 +0,0 @@ - - - - - &reftitle.examples; -
    - Connections - - In order to perform any messaging and queueing functions a connection - must be established with a messaging server by creating a SAMConnection - object and calling its "connect" method, with a set of connection - properties, to connect the PHP script to the messaging server. Until - such time as the SAMConnection object is destroyed the connection - will be maintained and available for use. All SAMConnection objects - are destroyed when the PHP script exits. - - - A set of default properties may be used in connecting to a messaging - server but as a minimum the PHP script must specify a protocol to be - used. - - - - Creating a connection and connecting to a remote WebSphere MQSeries Messaging Server - -connect(SAM_WMQ, array(SAM_HOST => 'myhost.mycompany.com', - SAM_PORT => 1506, - SAM_BROKER => 'mybroker')); -?> -]]> - - - - - - Creating a connection and connecting to a remote WebSphere Application Server - -connect(SAM_WPM, array(SAM_ENDPOINTS => 'localhost:7278:BootstrapBasicMessaging', - SAM_BUS => 'Bus1', - SAM_TARGETCHAIN => 'InboundBasicMessaging')); -?> -]]> - - - - - - Creating a connection and connecting to an MQTT server - -connect(SAM_MQTT, array(SAM_HOST => 'myhost.mycompany.com', - SAM_PORT => 1883)); -?> -]]> - - - -
    - -
    - Messages - - Messages sent to and received from queues are represented by the - SAMMessage object. The SAMMessage object encapsulates the body of - the message (if one exists) and the header properties associated with - the message. A SAMMessage object is either supplied as a parameter to - a messaging operation or returned as a result. - - - - Creating a message with a simple text body - - -]]> - - - - - Messages may have header properties associated with them that provide - control over the transport of the message or further information to the - receiving application. By default message properties are delivered to - the underlying messaging system as strings and in this case they may be - set with the following simple syntax: - - - - Setting a text format property using the default syntax - -header->myPropertyName = 'textData'; -?> -]]> - - - - - If it is desired to pass type information an alternative syntax may be - used where the value and the type hint are passed in an associative - array: - - - - Setting a property using a type hint - -header->myPropertyName = array(3.14159, SAM_FLOAT); -?> -]]> - - - - - Properties may also be extracted from the header of a message. - - - - Retrieving a property from a message header - -header->myPropertyName; -?> -]]> - - - -
    - -
    - Messaging operations - - All messaging operations are performed through calls to methods on the - connection object. - To add a message to a queue the "send" method is used, to obtain a - message from a queue the "receive" method is used. Other methods - provide publish and subscribe functionality and control of transaction - boundaries. - - - - Adding a message to a queue and receiving a response - -header->SAM_REPLY_TO = 'queue://receive/test'; -$correlid = $conn->send('queue://send/test', $msg); - -if (!$correlid) { - // The Send failed! - echo "Send failed ($conn->errno) $conn->error"; -} else { - $resp = $conn->receive('queue://receive/test', array(SAM_CORRELID => $correlid)); -} -?> -]]> - - - -
    - -
    - Publish/Subscribe and subscriptions to topics - - SAM allows messages to be sent either to queues or, for WebSphere MQ - and WPM, to publish/subscribe topics. - A topic destination is specified to SAM in the usual way, i.e. in the - form 'topic://fred', rather than the form 'queue://AQUEUE' used for - point to point operation. To use publish/subscribe it is simply - necessary to specify the correct broker name on the SAMConnect - "connect" call and the desired topic in the destination argument to - the SAMConnect "send" and "receive" calls. The PHP interface is - otherwise identical to the point to point model. - - - By default, SAM creates non-durable subscriptions when using - publish/subscribe. This means that if a client application is - inactive when messages are published to a topic, then it will not - receive them when it subsequently restarted. SAM does also allow - durable subscriptions to be made to topics when using WPM or WebSphere - MQ publish/subscribe. The purpose of these subscriptions is to allow - data to be received by a client application even if that client was not - active at the time the data was published. - - - Durable subscriptions are specified by using the SAMConnect "subscribe" - call. This method takes the destination topic as an input parameter and - returns a subscription identifier that may be used on subsequent - "receive" calls. When the subscription is no longer required the - SAMConnection "unsubscribe" method should be used to delete the - subscription. - - - - Creating a durable subscription to a topic - -subscribe('topic://A'); - -if (!$subName) { - echo "Subscribe failed"; -} else { - # Subscribe was OK - // ... -} -?> -]]> - - - - - - Subscribing to a topic using a WebSphere Platform Messaging (WPM) server - -connect(SAM_WMQ, array(SAM_ENDPOINTS => 'localhost:7278:BootstrapBasicMessaging', - SAM_BUS => 'Bus1', - SAM_TARGETCHAIN => 'InboundBasicMessaging', - SAM_WPM_DUR_SUB_HOME => 'MyMachineNode01.server1-Bus1')); - -$subName = $conn->subscribe('topic://A'); - -if (!$subName) { - echo "Subscribe failed"; -} else { - # Subscribe was OK - // ... -} -?> -]]> - - - - - - Receiving published data using a durable subscription - -receive($subName); -if ($msg) { - echo "Received a message OK"; -} else { - echo "The receive failed"; -} - -?> -]]> - - - - - - Deleting a durable subscription to a topic - -unsubscribe($subName)) { - echo "Unsubscribe failed"; -} - -?> -]]> - - - -
    - -
    - Error handling - - All SAMConnection methods that provide access to messaging operations - return &false; if an error occurred in processing the request. - In addition the SAMConnection object has two properties, "errno" - and "error", that provide respectively the error number and - text description of the last error to occur on the connection. - - - - Handling an error from a method that returns no result - -commit()) { - // The commit failed! - echo "Commit failed ($conn->errno) $conn->error"; -} -?> -]]> - - - - - - Handling an error from a method that returns a result - -send('queue://send/test', $msg); - -if (!$correlid) { - // The Send failed! - echo "Send failed ($conn->errno) $conn->error"; -} else { - /* ... */ -} -?> -]]> - - - -
    - -     - - - diff --git a/reference/sam/reference.xml b/reference/sam/reference.xml deleted file mode 100644 index 43badc760291..000000000000 --- a/reference/sam/reference.xml +++ /dev/null @@ -1,207 +0,0 @@ - - - - SAM &Functions; - - - - - -
    - &reftitle.classes; - - -
    - <classname>SAMConnection</classname> - - Object representing a connection to a Messaging Server - - -
    - &reftitle.constructor; - - - - new SAMConnection - construct a new connection object to allow connection to a messaging infrastructure. - - - -
    - -
    - &reftitle.methods; - - - - commit - - a method that commits (successfully completes) an in-flight unit - of work. - - - - - connect - - a method that connects a PHP script to a messaging server. - - - - - disconnect - - a method that disconnects a PHP script from a messaging server. - - - - - isConnected - - a method that checks whether a PHP script is connected to a - messaging server. - - - - - peek - - a method that receives a message from a queue without removing it - from the queue. - - - - - peekAll - - a method that receives one or messages from a queue without - removing them from the queue. - - - - - receive - - a method that receives a message from a queue or subscription. - - - - - remove - - a method that removes a message from a queue. - - - - - rollback - - a method that cancels (rolls back) an in-flight unit of work. - - - - - send - - a method that sends a message to a queue or posts to a topic - - - - - setDebug - - a method that switches additional debugging output on or off - - - - - subscribe - - a method that creates a subscription to one or more topics - - - - - unsubscribe - - a method that destroys a subscription to one or more topics - - - -
    - -
    - &reftitle.properties; - - - - errno - the - numeric error code for the last encountered error on this - connection. This property is set to 0 if the last operation was - successful. - - - - - error - the - text description for the last encountered error on this connection - - - -
    -
    - - -
    - <classname>SAMMessage</classname> - - Object representing a message to be sent or received - - -
    - &reftitle.constructor; - - - - new SAMMessage - construct a - new message. - - - -
    - -
    - &reftitle.properties; - - - - body - the body of - the message. - - - - - header - the - header properties of the message. - - - -
    -
    - -
    - - -     - - - &reference.sam.entities.SAMConnection; - &reference.sam.entities.SAMMessage; - -     - diff --git a/reference/sam/setup.xml b/reference/sam/setup.xml deleted file mode 100644 index 3af0fbfd8b6d..000000000000 --- a/reference/sam/setup.xml +++ /dev/null @@ -1,361 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - The SAM extension interfaces to the IBM Messaging and Queuing - middleware products using a set of libraries and some client side code - referred to as XMS. This package is available as a free download in - the guise of IBM support pack IA94. There is a description of this - package and download links in the article - Introducing XMS - The IBM Message Service API. - - - If you intend to use SAM to access the Messaging and Queuing - infrastructure within WebSphere MQ then you will also need to have - installed a local MQ queue manager or installed the WebSphere MQ - clients package. The clients package is freely available as a support - pack (MQC6). - - - If you are only aiming to experiment with sending messages to and from - WebSphere Application Server queues using the WebSphere Platform - Messaging protocol (WPM) then you do not need to install the MQC6 - package. - - - After installing these packages you will need to ensure the XMS binary - and, if you are using it, the MQ client bin directory are included in - the PATH environment variable so that Apache and PHP can - find the dependent .DLLs/libraries. - -
    - - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;sam. - - - The SAM framework and MQTT support can be built and used without any other prerequisites. - Support for protocols other than MQTT is provided via a set of libraries and some client - side code referred to as XMS. - - - If you only intend to use the built-in MQTT support then you can build and - configure SAM as an extension or simply refer to - php_sam.php with a require or - require_once clause in your PHP script. In this case - you need only install the code without building the extension using the pear - installer: - - - - - - -
    - Linux installation steps - - The sam extension is supplied as a PECL module, which - you should be able to download and install in one step as follows: - - - - (Depending on your php environment, you will probably need to be root - to do this.) - - - Make sure that the module is loaded by PHP, by adding following line - to &php.ini;: - - - - If you intend to use the XMS support to access the IBM Messaging and Queuing family - you must also enable the SAM XMS extension. - - - - - - If you cannot use the PEAR installer, you can download the extension - and build it manually: - -.tgz -tar -xzf sam-.tgz -cd sam- -phpize -./configure -make -make install #you may need to be root for this step -]]> - - - - To work with the very latest source, you'll need to extract it from - SVN and build manually as above. - -
    - - -
    - Windows installation steps - - You will probably need to build the sam extension for Windows as there - are only a limited range of pre-built binaries available from the SAM website. - The extension can be built using the standard Windows extension build procedures. - - - You will need the PHP source tree for the version of PHP you wish to - build the SAM extension against which you can obtain from php.net. - This should be unpacked into a working directory of your choice. - - - You will also need the libraries and headers used by PHP extensions - available from http://www.php.net/extra/win32build.zip and this - should be unzipped so that is in your working directory. - - - You should have something like: - - - - - - You will need a compiler such as the free version of Visual Studio C++ - Express from the Microsoft web site. Also you need the Microsoft - SDK Microsoft Windows Platform which again can be - downloaded from the Microsoft web site. - - - Obtain the SAM extension source using pear (pecl download sam) or by using - SVN and copy the files to a new "sam" directory under the "ext" directory - in your PHP source tree. - - - To build the extension open a build environment window by going to the - start menu->all programs->microsoft platform SDK for windows-> - open build environment window->windows 200 build environment-> - set windows 2000 build environment (retail) - - - This should open a command prompt with all the environment variables - set up to access the platform SDK etc. You then need to set the - environment variables for Visual Studio by issuing the command - vcvars32.bat in the window. - - - Change directory to your working directory e.g. - cd c:\php-build. Then - make sure the win32build tools are accessible by adding them to the - PATH environment variable: - - - - - - Run the buildconf.bat command. This should rebuild the - configure.js file. - - - Run the cscript command with the appropriate options. To build just the - SAM extension framework and MQTT support use: - - - - To build the SAM framework and the XMS support use: - - - - - - The additional parameter passed for sam_xms is the installation path to the - XMS libraries and runtime that were installed as described under prerequisites - at the top of this page. - - - You can specify whatever other cscript parameters you require to - include or exclude items from the php build or select options. - - - Assuming all has gone well so far you can now finally run a make for the SAM framework! - - - - Also if you are using the XMS support you must make the sam_xms extensions: - - - - - - If you have used Visual Studio 2005 to build the DLLs please see below for additional steps that - must be carried out before proceeding further. - - - The DLLs created (php_sam.dll and optionally - php_sam_xms.dll) can now be copied to the subdirectory - appropriate for your PHP set-up. Make sure that the module(s) are loaded by - PHP, by adding following line to &php.ini;: - - - - If you intend to use the XMS support to access the IBM Messaging and Queuing family - you must also enable the SAM XMS extension. - - - - -
    - - -
    - Additional steps for Visual Studio 2005 - - If you build the SAM extension with the Microsoft Visual Studio 2005 - compiler and tools you need to perform an additional step in the build - process to ensure the php_sam.dll is able to link - with the C runtime libraries at runtime. This step includes the - dependancy manifest into the DLL. Switch to the directory where the - php_sam.dll has been generated (usually - Release_TS or Debug_TS below the php source directory) and issue the - following magic incantation: - - - - If you are using the XMS capabilities you will need to do the same with the - SAM XMS DLL: - - - - - - If you build the SAM extension using the compiler and libraries from - Microsoft Visual Studio 2005 you will also need to ensure that the - runtime components are installed on the system on which you intend to - use SAM. This can be accomplished by installing Visual Studio 2005 or - by using the freely distributable - runtime package. - -
    - -
    - - - -
    - &reftitle.runtime; -
    - Protocol support and mapping - - The SAM framework can be extended to support other messaging protocols and connection mechanisms. To add - support for a new protocol or connection library a support class has to be defined, either as a C extension - or as a PHP script, and a "factory" script must be created. The support class must implement all the - methods of the SAMConnection class though it should not inherit from SAMConnection. The factory script - will be called by the SAM framework to create an instance of the implemented class. The way SAM chooses - which factory to call is based on the protocol specified as the first parameter of the "connect" call. - - - By default the built-in MQTT support will be used if a connect call specifies a protocol of SAM_MQTT ("mqtt"), for - any other protocol SAM will attempt to use the XMS support extension. To add support for additional - protocols or to modify the default behavior entries may be added to &php.ini; in the [sam] section. The - default mapping is equivalent to the following entries: - - - - As can be seen from these examples the entries take the form of "sam.factory.pppp=xxx" where pppp is the protocol - string specified on the connect call and xxx is a factory suffix. Note: SAM defines constants for these protocol - strings such that SAM_WMQ=wmq, - SAM_WPM=wpm, SAM_RTT=rtt, - SAM_MQTT=mqtt, etc. - - - When identifying the support code to use on a connect call SAM looks up the protocol name in the &php.ini; entries - and then invokes a factory script named sam_factory_xxx.php. If no entry is found the support will default to XMS. - -
    -
    - - - -
    - &reftitle.resources; - &no.resource; -
    - - -     - - - diff --git a/reference/sam/versions.xml b/reference/sam/versions.xml deleted file mode 100644 index 831bf516ed33..000000000000 --- a/reference/sam/versions.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/sca/SCA/createDataObject.xml b/reference/sca/SCA/createDataObject.xml deleted file mode 100644 index 8db66111511a..000000000000 --- a/reference/sca/SCA/createDataObject.xml +++ /dev/null @@ -1,167 +0,0 @@ - - - - - - SCA::createDataObject - Create an SDO - - - &reftitle.description; - - SDO_DataObject - SCA::createDataObject - - string - type_namespace_uri - - - string - type_name - - - - &warn.experimental.func; - - This method is used inside an SCA component that needs to create - an SDO to return. The parameters are the desired SDO's namespace URI - and type name. The namespace and type must be defined in one of the - schema files which are specified on the @types annotation within the - component. - - - - &reftitle.parameters; - - - - - type_namespace_uri - - - The namespace of the type. - - - - - type_name - - - The name of the type. - - - - - - - &reftitle.returnvalues; - Returns the newly created SDO_DataObject. - - - - &reftitle.errors; - - - - - SDO_TypeNotFoundException - - - Thrown if the namespaceURI and typeName do not correspond - to a type in any of the schema files specified in the @types - annotations. - - - - - - - - - - - - - - - diff --git a/reference/sca/SCA/getService.xml b/reference/sca/SCA/getService.xml deleted file mode 100644 index 4e694cd80460..000000000000 --- a/reference/sca/SCA/getService.xml +++ /dev/null @@ -1,184 +0,0 @@ - - - - - - SCA::getService - - Obtain a proxy for a service - - - - &reftitle.description; - - mixed - SCA::getService - - string - target - - - string - binding - - - array - config - - - - &warn.experimental.func; - - Examine the target and initialize and return a proxy of the appropriate - sort. If the target is for a local PHP component the returned proxy will be an - SCA_LocalProxy. If the target is for a WSDL file, the returned proxy will be a - SCA_SoapProxy. - - - - &reftitle.parameters; - - - - - target - - - An absolute or relative path to the target service or service - description (e.g. a URL to a json-rpc service description, a PHP - component, a WSDL file, and so on.). A relative path, if specified, - is resolved relative to the location of the script issuing the - getService call, and not against the include_path - or current working directory. - - - - - binding - - - The binding (i.e. protocol) to use to communicate with the service - (e.g binding.jsonrpc for a json-rpc service). Note, some service types - can be deduced from the target parameter (e.g. if the target parameter - ends in .wsdl then SCA will assume binding.soap). Any binding which - can be specified in an annotation can be specified here. For example - 'binding.soap' is equivalent to the '@binding.soap' annotation. - - - - - config - - - Any additional configuration properties for the binding (e.g. - array('location' => 'http://example.org')). Any binding configuration - which can be specified in an annotation can be specified here. For - example, 'location' is equivalent to the '@location' annotation to - configure the location of a target soap service. - - - - - - - &reftitle.returnvalues; - - The SCA_LocalProxy or SCA_SoapProxy. - - - - - - - - - - - &reftitle.examples; - - - An <function>SCA::getService</function> example - - This example shows how to get a proxy to an email soap service described - by EmailService.wsdl and located at - http://example.org. - - - 'http://example.org')); -$service->send(...); -?> -]]> - - &example.outputs; - - - - - - - - - - - diff --git a/reference/sca/SCA_LocalProxy/createDataObject.xml b/reference/sca/SCA_LocalProxy/createDataObject.xml deleted file mode 100644 index 778ba557c5a4..000000000000 --- a/reference/sca/SCA_LocalProxy/createDataObject.xml +++ /dev/null @@ -1,170 +0,0 @@ - - - - - - SCA_LocalProxy::createDataObject - Create an SDO - - - &reftitle.description; - - SDO_DataObject - SCA_LocalProxy::createDataObject - - string - type_namespace_uri - - - string - type_name - - - - &warn.experimental.func; - - This method is used inside either an ordinary PHP script or an SCA - component that needs to create an SDO to pass to a local service. The - parameters are the desired SDO's namespace URI and type name. The - namespace and type must be defined in the interface of the component - that is to be called, so the namespace and type must be defined in one of - the schema files which are specified on the @types annotation within - the component for which the SCA_LocalProxy object is a proxy. - - - - &reftitle.parameters; - - - - - type_namespace_uri - - - The namespace of the type. - - - - - type_name - - - The name of the type. - - - - - - - &reftitle.returnvalues; - Returns the newly created SDO_DataObject. - - - - &reftitle.errors; - - - - - SDO_TypeNotFoundException - - - Thrown if the namespaceURI and typeName do not correspond - to a type in any of the schema files specified in the @types - annotations within the component for which the SCA_LocalProxy - object is a proxy.. - - - - - - - - - - - - - - - diff --git a/reference/sca/SCA_SoapProxy/createDataObject.xml b/reference/sca/SCA_SoapProxy/createDataObject.xml deleted file mode 100644 index 8a12a471568a..000000000000 --- a/reference/sca/SCA_SoapProxy/createDataObject.xml +++ /dev/null @@ -1,171 +0,0 @@ - - - - - - SCA_SoapProxy::createDataObject - Create an SDO - - - &reftitle.description; - - SDO_DataObject - SCA_SoapProxy::createDataObject - - string - type_namespace_uri - - - string - type_name - - - - &warn.experimental.func; - - This method is used inside either an ordinary PHP script or an SCA - component that needs to create an SDO to pass to a web service. The - parameters are the desired SDO's namespace URI and type name. The - namespace and type must be defined in the interface of the component - that is to be called, so the namespace and type must be defined within - the WSDL for the web service. If the web service is also an SCA component - then the types will have been defined within one of the schema files - which are specified on the @types annotation within the component for - which the SCA_SoapProxy object is a proxy. - - - - &reftitle.parameters; - - - - - type_namespace_uri - - - The namespace of the type. - - - - - type_name - - - The name of the type. - - - - - - - &reftitle.returnvalues; - Returns the newly created SDO_DataObject. - - - - &reftitle.errors; - - - - - SDO_TypeNotFoundException - - - Thrown if the namespaceURI and typeName do not correspond - to a type found in the WSDL that was used to initialise this - SCA_SoapProxy. - - - - - - - - - - - - - - - diff --git a/reference/sca/book.xml b/reference/sca/book.xml deleted file mode 100644 index 905358357e23..000000000000 --- a/reference/sca/book.xml +++ /dev/null @@ -1,174 +0,0 @@ - - - - - - SCA - - - - &reftitle.intro; - &warn.experimental; - - SCA for PHP makes it possible for a PHP programmer to write - reusable components, which can be called in a variety of ways, with an - identical interface and with a minimum of fuss. At present - components can call each other either locally or via Web services, - but in the future it is expected that other ways will be possible. It - provides the programmer with a way of doing this which will look as - natural as possible in PHP. - - - - SCA components use phpDocumentor-style (see - http://www.phpdoc.org/) annotations to declare dependencies on - other SCA components or Web services. The SCA for PHP runtime - resolves these dependencies at runtime on behalf of the components, - and thus allows the PHP programmer to focus on the business logic - rather than on locating and obtaining references to dependencies. - - - - The SCA for PHP programming model can be extended to support a - number of service types, such as REST and Atompub. However, Web - services (more accurately, WSDL defined, SOAP/HTTP services), are - the only type currently specified. - - - - Components also use annotations to define the interface which - they expose as a service. The SCA for PHP runtime will automatically - generate WSDL from these annotations, so that an SCA component is - easily exposed as a web service. These annotations are a natural - extension to those provided by phpDocumentor. Deploying a Web - service can be as simple as placing a PHP component under the document - root of a web server. - - - - Components also use annotations to specify data structures - (expressed using XML schema complex types) which are then handled - using Service Data Objects (SDOs). - - - - A PHP script which is not an SCA component and which contains no - annotations can use the services of an SCA component. A PHP script or - component can make calls to a web service that is not an SCA component, - but using the same system of calls or annotations to obtain a - reference. - - - - First we show a single SCA component, ConvertedStockQuote - which illustrates many of the features of SCA for PHP. It has one - method, - getQuote, which given a stock "ticker" - obtains a price quote for that stock, converted to a given currency. - We shall be using this example as a basis for explaining the SCA for PHP - throughout the rest of this document. - - - - - A sample SCA component - -stock_quote->getQuote($ticker); - $rate = $this->exchange_rate->getRate($currency); - return $rate * $quote; - } -} -?> -]]> - - - - - - In this example, we see that an SCA component is implemented by a - script containing a PHP class and includes - SCA.php. The class contains a mixture of - business logic and references to other components or services. In - the illustrated - getQuote method there is only business - logic, but it relies on the instance variables - $stock_quote and - $exchange_rate having been initialized. - These refer to two other components and will be initialized by the SCA - runtime with proxies for these two services, whenever this - component executes. The annotations for these two services show one - to be a local component, which will be called within the same PHP - runtime, and one to be a remote component which will be called via a - SOAP request. This component also exposes the - getQuote method both locally and as a web - service, so it in turn can be called either locally or remotely. - - - - - &reference.sca.setup; - &reference.sca.constants; - &reference.sca.examples; - &reference.sca.reference; - - - - - diff --git a/reference/sca/constants.xml b/reference/sca/constants.xml deleted file mode 100644 index a9cb621a3556..000000000000 --- a/reference/sca/constants.xml +++ /dev/null @@ -1,28 +0,0 @@ - - - - - &reftitle.constants; - &no.constants; - - - diff --git a/reference/sca/examples.xml b/reference/sca/examples.xml deleted file mode 100644 index dfeae51997c6..000000000000 --- a/reference/sca/examples.xml +++ /dev/null @@ -1,1223 +0,0 @@ - - - - - &reftitle.examples; - - The examples in the subsequent sections illustrate the - following aspects of PHP for SCA: - - - - - - - How PHP annotations are used to define PHP classes as SCA - components, and how annotations are used to define the - services. - - - - - How an SCA component can be exposed as a Web service - - - - - How an SCA component can consume a Web service, whether - provided by another SCA component or by some other service which - knows nothing of SCA - - - - - How an SCA component can call another SCA component locally - (within the same process and on the same call stack) - - - - - How a client script which is not an SCA component can use the - getService call to obtain a proxy for an SCA component. - - - - - How data structures such as Addresses, or Puchase Orders, - are represented as Service Data Objects, and handled. - - - - - How SCA components are deployed, and in particular how and - when WSDL is generated for a service. - - - - - How parameters are always passed by value (and not by - reference) between components, even when the calls are local. - This ensures that the semantics of a call do not change depending on - the location of a component. - - - - - How positional parameters to a service are supported, even - when the underlying WSDL is document literal wrapped, and - naturally supports only named parameters. - - - - - How business and runtime exceptions are handled. - - - - - - - -
    - The structure of a Service Component - - A service component is implemented by a class. To identify it - as a service component, it contains an @service annotation. The SCA - runtime will use the file name of the script to determine the - component name, by convention. The class and script file must - therefore share the same name. - - - - PHP SCA components always expose a service, and there is no way - for a component to be invoked other than to be called as a result of a - Web service request, or called directly from another component or - from a script. For this reason a valid PHP SCA component will always - contain an @service annotation and at least one public method. - - - - Each SCA Component requires that the SCA.php script is - included. As well as containing the definition of the SCA class, - this script contains executable PHP code that will run whenever the - script is called, and which will be responsible for making the - component behave as needed. - - - - - - It is very important that if your file contains other - includes, they come before the include for SCA.php. If there are - includes after the include for SCA.php, they will not have been - processed when the SCA runtime runs your class. - - - - - The example below illustrates this overall structure - - - - - The structure of an SCA for PHP component - - - -]]> - - - -
    - - - -
    - Obtaining a proxy for another Service Component - - One SCA component can call the service provided by another SCA - component. The service a component provides is made up of all of its - public methods. SCA for PHP currently provides two ways for one - component to call another: either locally (i.e. within the same PHP - run-time, and on the same call stack) or remotely if the called - component exposes a Web service binding. - - - - In order for one component to call another, the calling - component needs a proxy for the called component. This proxy is - usually provided as an instance variable in the calling component, - though proxies can also be obtained with the SCA::getService() - call, as we shall see later. When a component is constructed, - proxies are constructed for any instance variable which refer to - another component, and these proxies are "injected" into the - instance variables. Proxies are always used, whether the - component is local or remote, in order to provide identical calling - behavior between remote and local calls (for example, local calls - are made to always pass data by-value). The proxies know how to - locate the required component and to pass the calls made on to them. - - - - Instance variables which are intended to hold proxies for - services are indicated by the two PHPDocumentor-style - annotations, @reference and @binding. Both annotations are - placed in the documentation section for a class instance variable, - as shown by the code below. - - - - The @reference annotation before an instance variable - indicates that the instance variable is to be initialized with a - proxy to a component. - - - - The @binding annotation has two forms @binding.php and - @binding.soap, and indicates that the proxy is either for a local - component or for a Web service respectively. For both @binding.php - and @binding.soap, the annotation gives a target URI. - - - - At the moment, with the annotation-based method of - specifying dependencies, the only way to alter the intended target - of a reference is to alter the annotation within the component. - - - - In our ConvertedStockQuote example, the - $exchange_rate instance variable will be - initialized with a proxy to the local ExchangeRate component - whenever an instance of the ConvertedStockQuote is constructed. - - - - - Obtaining a proxy for a local PHP class - - - -]]> - - - - - - For @binding.php, the URI identifies the location of the - script containing the implementation of the component. The - component will be called locally. The service provided is the set of - public methods of the component. The URI must be a simple pathname, - either absolute or relative. The component will be loaded with the - PHP include directive, after testing to see if it is already loaded - with - class_exists. If the URI is a relative - path, it is resolved relative to the component containing the - annotation. Note that this is different from the normal PHP - behaviour where scripts would be looked for along the PHP - include_path, This is intended to provide some - location-independence for cross-component references. - - - - If this ExchangeRate service were remote and to be called as a - Web service, only the @binding line changes. Instead of giving the - location of a PHP class, it gives the location of the WSDL describing - the web service. In our example component, this is illustrated by - the second reference: - - - - - Obtaining a proxy for a web service - - -]]> - - - - - - The StockQuote component will be called via a Web service - request. In this case the URI for the WSDL can be a simple pathname, or - may contain a PHP wrapper and begin, for example, with - file:// or - http://. In the event that it is a simple - pathname, it can be absolute or relative, and if relative will be - resolved relative to the component containing the annotation. - Note that this is like the behaviour for @binding.php, and - different from the normal PHP behaviour where the file would be - looked for relative to the PHP current working directory, which - would usually be the location of the first script to be called. This - behaviour is intended to give consistency across the different - bindings and to provide some location-independence for - references between components. - - -
    - - - -
    - Calling another Service Component - - - The ConvertedStockQuote example also calls the proxies for - the two components to which it refers. - - - - - Calling services - -stock_quote->getQuote($ticker); -$rate = $this->exchange_rate->getRate($currency); -?> -]]> - - - - - - The call to the StockQuote service is a call to a local service; - the call to the ExchangeRate service is a call to a remote service. - Note that the way the call is made looks the same regardless of - whether the call is to a local service or a remote one. - - - - The proxies which have been injected ensure that the way calls - to components look and behave are the same way regardless of whether - they are to a local or remote service, so that components are not - sensitive to whether a call is to a local or a remote service. For - example, the proxy for a local service takes copies of the arguments - and passes only those copies, to ensure that calls are made to be - pass-by-value, as they would be for a remote call. Also, the proxy - for a remote service takes the arguments from a positional - parameter list and ensures they are packaged properly in a SOAP - request and converted back to a positional parameter list at the far - end. - - - - In the example above, the - - $ticker and - - $currency are clearly PHP scalar types. - Components can pass the PHP scalar types string, integer, float and - boolean, but data structures on service calls are always passed as - Service Data Objects (SDOs). A later section describes how a - component can create an SDO to pass on a local or Web service call, or - how a component can create an SDO to return. The PHP SDO project - documentation describes how to work with the SDO APIs (see - the SDO pages). - - -
    - - - -
    - Locating and calling services from a script which is not an - SCA Component - - - SCA components obtain proxies for other components or - services as instance variables annotated with @reference, but - this is not possible for a script that is not itself also a component. - A client script which is not a component must use the - SCA::getService static method to obtain a - proxy for a service, whether local or remote. The - getService method takes a URI as the - argument. Typically this is the location of a local PHP script - containing a component, or of a wsdl file, and is used in exactly the - same way as the targets of the @binding annotations described in the - previous section: that is, relative URIs are resolved against the - location of the client script and not against the PHP include_path - or current working directory. - - - - For example, a script that needed to obtain proxies for the - ExchangeRate and StockQuote services but was not a component would - use the - getService method as follows: - - - - - Obtaining a proxy using getService - - -]]> - - - - - - Methods on services can then be called on the returned proxy, - just as they can in a component. - - - - Making calls on the proxy - -getQuote($ticker); -$rate = $exchange_rate->getRate($currency); -?> -]]> - - - - -
    - - - -
    - Exposing a Service Component as a Web service - - - SCA for PHP can generate WSDL from the annotations within a - service component, so that it can be easily deployed and exposed as a - Web service. To provide SCA with the information it needs to - generate the WSDL, it is necessary to add the annotation - @binding.soap under the @service annotation and to specify the - parameters and return values of the methods using the @param and - @return annotations. These annotations will be read when WSDL is - generated, and the order and types of the parameters determine the - contents of the - <schema> section of the WSDL. - - - - SCA for PHP always generates document/literal wrapped WSDL - for components that are exposing a Web service. Note that this does - not stop components from consuming Web services which are not SCA - components and which are documented with WSDL written in a - different style. - - - - The scalar types which can be used in the @param annotation are - the four common PHP scalar types: boolean, integer, float and - string. These are simply mapped to the XML schema types of the same - name in the WSDL. The example below, which is a trivial - implementation of the StockQuote service that the - ConvertedStockQuote component calls, illustrates string and - float types. - - - - - StockQuote Service - - -]]> - - - - - - WSDL much like the following (though with a service location - other than 'localhost', probably) would be generated from this - service: - - - - - Generated WSDL - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -]]> - - - - - -
    - - - -
    - Deploying an SCA component - - There are no special steps needed to deploy a PHP SCA - component. It is sufficient to place the component PHP script in its - proper place under the web server document root, just like any other - PHP script. It is the - SCA::initComponent executable line - within each component that will be executed whenever the script is - called, and which will be responsible for making the component - respond appropriately to Web service calls, local calls, or - requests for WSDL. - - -
    - - - -
    - Obtaining the WSDL for an SCA component offering a Service as - a Web service - - - SCA components that expose a Web service interface (i.e. have - an @binding.soap annotation) will return their WSDL definition in - response to an HTTP request with a get parameter of "wsdl". The usual - way to obtain this is with "?wsdl" on the end of a URL. The example - below uses - file_get_contents to obtain WSDL from a - service and writes it to a temporary file before then obtaining a - proxy for the service in the usual way. You could of course also - obtain the WSDL in a browser, or by some other means, and save the file - yourself. - - - - - Generated WSDL - - -]]> - - - - - - NOTE: If the wsdl requires imported xsds, these will need to be - fetched separately. - - -
    - - - -
    - Understanding how the WSDL is generated - - SCA for PHP generates WSDL for components which contain an - @binding.soap annotation after the @service annotation. To - generate WSDL, the SCA runtime reflects on the component and - examines the @param and @return annotations for each public - method, as well as any @types annotations within the component. The - information from the @param and @return annotations is used to - build the <types> section of the WSDL. Any @types - annotations which specify a separate schema file will result in an - <import> element for that schema within the WSDL. - - -
    - Location attribute of the <service> element - - At the bottom of the WSDL is the <service> element - which uses the location attribute to identify the URL of the - service. For example this might look as follows: - - - - - location attribute - - -]]> - - - - - Note that this location is relative to the document root of - the web server, and cannot be worked out in advance. It can only be - worked out once the component is in its proper place under a running - web server, when the hostname and port can be known and placed in the - WSDL. Detail from the URL that requests the WSDL is used, so for - example if the WSDL is generated in response to a request to - http://www.example.com:1111/ConvertedStockQuote/ConvertedStockQuote.php?wsdl, - a location of - http://www.example.com:1111/ConvertedStockQuote/ConvertedStockQuote.php - is what will be inserted into the location attribute in the WSDL. - -
    - - -
    - Document/literal wrapped WSDL and positional - parameters - - SCA for PHP generates WSDL in the document/literal wrapped - style. This style encloses the parameters and return types of a - method in 'wrappers' which are named after the corresponding - method. The <types> element at the top of the WSDL defines - each of these wrappers. If we consider the - getQuote method of the - ConvertedStockQuote example: - - - - - method with two arguments - -stock_quote->getQuote($ticker); - $rate = $this->exchange_rate->getRate($currency); - return $rate * $quote; - } -?> -]]> - - - - - - - The WSDL generated to define this method will name both the - method and the parameters, and give an XML schema type for the - parameters. The types section of the WSDL looks like this: - - - - - types section illustrating named parameters - - - - - - - - - - - - - - - - - - - - -]]> - - - - - - The SCA run-time has special processing to handle how - positional parameter lists in the interface are converted to XML - containing named parameters in the soap request, and then back to - positional parameter lists again. To see why this matters, - consider how a PHP script which used a different interface to make a - SOAP call would need to construct the parameter list. A PHP script - using the PHP SoapClient, for example, would need to pass the - SoapClient a single parameter giving the values for "ticker" and - "currency", perhaps as an associative array. To insist that SCA - components construct parameter lists to make Web service calls in - this way would be to make local and remote calls look different, so a - different approach is needed. - - - - When SCA generates WSDL for an SCA component it includes a - comment in the WSDL which marks that WSDL as being the interface for - an SCA component. In this case, when one SCA component calls - another through a Web service, the SCA runtime on the calling end - takes the positional parameter list from the call and assigns the - values one by one to the named elements in the soap message. For - example a call to the - getQuote method defined above that - passes the values 'IBM' and 'USD' and looks like this: - - - - -getQuote('IBM','USD'); -?> -]]> - - - - - will result in a soap message containing the - following: - - - - - - IBM - USD - -]]> - - - - - On the service-providing end, the SCA run-time takes the - parameters one by one from the soap message and forms a positional - parameter list from them, re-forming the argument list - ('IBM','USD'). - - - - - - At both ends the SCA runtime relies on the order in which the - parameters appear in the soap message being the same as that in the - target method's parameter list. This is ultimately determined - by the order of the @param annotations: this determines the order - in which the parameters appear in the WSDL and thereby the order in - which they appear in the soap message. Therefore it is essential - that the order of the @param annotations matches that of the - parameters in the method's parameter list. - - - -
    - - -
    - - -
    - Working with Data Structures - - SCA components can pass and return the four PHP scalar types - boolean, integer, float and string, but to pass or return data - structures, SCA components use Service Data Objects (SDOs). SDOs - are described in much more detail in - the SDO pages of this manual. - Readers familiar with SDOs will know that they are suitable for - representing the sort of structured and semi-structured data that - is frequently modeled in XML, and that they serialize very - naturally for passing between remote components, or in Web - services. SDOs are presently the only supported way to pass and - return data structures. It is not possible to pass or return PHP - objects, or PHP arrays. - - - - The SCA runtime always assures data is passed by-value, even - for local calls. To do this, the SCA runtime copies any SDOs in the - parameter list before passing them on, just as it does for scalar - types. - - -
    - How data structures are defined to SCA components - - Currently the only mechanism for specifying the location of - a data structure definition is by specifying the types in an XML - schema file. However, in the future it may be possible to define - types in other ways, such as based on PHP classes or interfaces, or - based on definitions expressed as associative arrays. - - - - To illustrate the use of SDOs we introduce a new component. - The PortfolioMangement service below returns an SDO - representing a stock portfolio for a given customer. - - - - - A Component that uses Data Structures - -createDataObject('holding'); - $holding->ticker = 'AAPL'; - $holding->number = 100.5; - $holding = $portfolio->createDataObject('holding'); - $holding->ticker = 'INTL'; - $holding->number = 100.5; - $holding = $portfolio->createDataObject('holding'); - $holding->ticker = 'IBM'; - $holding->number = 100.5; - return $portfolio; - } - -} -?> -]]> - - - - - - The @types annotation: - - - - - -]]> - - - - - indicates that types in the namespace - http://www.example.org/Portfolio will be found in the schema - file located by the URI PortfolioTypes.xsd. The generated WSDL - would reproduce this information with an import statement as - follows: - - - - - -]]> - - - - - so the URI, absolute or relative, must be one that can be - resolved when included in the schemaLocation attribute. - - -
    - - -
    - Creating SDOs - - Readers familiar with SDOs will know that they are always - created according to a description of the permitted structure - (sometimes referred to as the 'schema' or 'model') and that, - rather than creating them directly using 'new', some form of data - factory is needed. Often, an existing data object can be used as the - data factory, but sometimes, and especially in order to get the - first data object, something else must act as the data factory. - - - - In SCA, either the SCA runtime class or the proxies for - services, whether local or remote, can act as the data factories - for SDOs. The choice of which to use, and when, is described in the - next two sections. - - - We switch to a new example in order to illustrate the creation - of SDOs, both to pass to a service, and to be returned from a service. - -
    - - -
    - Creating an SDO to pass to a service - - A caller of a service which requires a data structure to be - passed in to it uses the proxy to the service as the data factory for - the corresponding SDOs. For example, suppose a component makes - use of a proxy for a service provided by a local AddressBook - component. - - - - - -]]> - - - - The AddressBook component that it wishes to call is defined - as follows: - - - - -]]> - - - - - The AddressBook component provides a service method called - - lookupAddress which uses types from the - http://addressbook namespace. The lookupAddress method takes a - personType data structure and returns an addressType. Both types - are defined in the schema file addressbook.xsd. - - - - Once the component that wishes to use the AddressBook - component has been constructed, so that the - $address_book instance variable contains - a proxy for the service, the calling component can use the proxy in - $address_book to create the person SDO, as - shown below: - - - - -createDataObject('http://addressbook','personType'); -$william_shakespeare ->name = "William Shakespeare"; -$address = $address_book->lookupAddress($william_shakespeare); -?> -]]> - - - - - Note, the use of the proxy as the means to create the SDO is not - limited to SCA components. If a service is being called from a - general PHP script, and the proxy was obtained with - getService then the same approach is - used. - - - - -createDataObject('http://addressbook','personType'); -?> -]]> - - - - -
    - - -
    - Creating an SDO to return from a component - - A component that needs to create a data object for return to a - caller will not have a proxy to use as a data object, In this case it - uses the - createDataObject static method on - SCA.php. Hence if the AddressBook - component described above needed to create an object of type - addressType within the namespace - http://addressbook, it might do so as follows: - - - - - -]]> - - - -
    - -
    - - -
    - Error handling - - This section describes how errors are handled. There are two - types of errors: - - - - - SCA runtime exceptions are those that signal problems in - the management of the execution of components, and in the - interaction with remote services. These might occur due to - network or configuration problems. - - - - - - Business exceptions are those that are defined by the - programmer. They extend the PHP Exception class, and are thrown - and caught deliberately as part of the business logic. - - - - - -
    - Handling of Runtime exceptions - - There are two types of SCA runtime exception: - - - - - - SCA_RuntimeException - signals a problem found by or - perhaps occurring within the SCA runtime. This can be thrown for - a variety of reasons, many of which can occur regardless of - whether a connection is being made to a local or a remote service: - an error in one of the annotations within a component, a missing - WSDL or php file, and so on. In the case of Web services, an - SCA_RuntimeException can also be thrown if a SoapFault is - received from a remote Web service and the fault code in the - SoapFault indicates that a retry is unlikely to be successful. - - - - - - SCA_ServiceUnavailableException - this is a subclass of - SCA_RuntimeException and signals a problem in connecting to or - using a remote service, but one which might succeed if retried. - In the case of Web services, this exception is thrown if a - SoapFault is received with a fault code that indicates that a - retry might be successful. - - - - -
    - -
    - Handling of Business exceptions - - Business exceptions may be defined and thrown by a component - in the normal way, regardless of whether the component has been - called locally or remotely. The SCA runtime does not catch - business exceptions that have been thrown by a component called - locally, so they will be returned to a caller in the normal way. If a - component has been called via a Web service, on the other hand, the - SCA runtime on the service providing end does catch business - exceptions, and will ensure these are passed back to the calling - end and re-thrown. Assuming that the calling end has a definition - of the exception (that is, is able to include a file containing the - PHP class defining the exception) the re-thrown exception will - contain the same details as the original, so that the - getLine and - getFile methods for example will contain - the location where the exception was thrown within the business - logic. The exception will be passed in the detail field of a soap - fault with a fault code of "Client". - -
    - - -
    - - -     - - - diff --git a/reference/sca/reference.xml b/reference/sca/reference.xml deleted file mode 100644 index da562e775da9..000000000000 --- a/reference/sca/reference.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - - SCA &Functions; - - - - -
    - &reftitle.classes; - - Most of the interface to SCA is through the annotations within - SCA components so there are few public classes and methods. The only - SCA classes that scripts or components can call are the SCA - class itself, and the proxy classes SCA_LocalProxy - and SCA_SoapProxy. - - -
    - <classname>SCA</classname> - - Much of the work of the SCA class is performed when the file - SCA.php is included within an SCA component. - However, a PHP script may include - SCA.php and call the - getService method on the SCA class in order - to obtain a proxy for a service. A component will not need to do this as - proxies are obtained instead by defining an instance variable with - the @reference annotation. - - - Components that need to create an SDO to return to a caller will - need a data factory to call. For this purpose the SCA class supports - the - createDataObject method, which will - create an SDO according to the model defined by the component's - @types annotations. The arguments to - createDataObject are the same as those to - SDO's XML Data Access Service. - - -
    - &reftitle.methods; - - - - - getService - obtain a proxy for a service - - - - - - createDataObject - create an SDO - - - -
    -
    - -
    - - <classname>SCA_LocalProxy</classname> - - - When - getService is called with the target of a - local PHP component, a local proxy is returned. A local proxy is also - injected into the instance variables of a component that are - defined with an @reference and an @binding.php anotation. When the - script or component makes calls on the local proxy, they are passed - on to the target component itself. - - - Components that need to create an SDO to pass to a component - will need a data factory to call. For this purpose the - SCA_LocalProxy class supports the createDataObject method, - which will create an SDO according to the model defined by the - components' @types annotations. The arguments to the - createDataObject are the same as those to SDO's XML Data Access - Service. - - -
    - &reftitle.methods; - - - - - createDataObject - create an SDO - - - -
    -
    - -
    - - <classname>SCA_SoapProxy</classname> - - - When - getService is called with the target of a - WSDL file, a SOAP proxy is returned. A SOAP proxy is also injected - into the instance variables of a component that are defined with an - @reference and an @binding.soap anotations. When the script or - component makes calls on the SOAP proxy, they are formed into Web - service SOAP requests and passed on to the target component, with - the help of the PHP Soap extension. - - - Components that need to create an SDO to pass to a component - will need a data factory to call. For this purpose the - SCA_SoapProxy class supports the - createDataObject method, which will create an - SDO according to the model defined within the target WSDL. The - arguments to the createDataObject are the same - as those to SDO's XML Data Access Service. - - -
    - &reftitle.methods; - - - - - createDataObject - create an SDO - - - -
    -
    -
    - - -     - - &reference.sca.entities.SCA; - &reference.sca.entities.SCA-LocalProxy; - &reference.sca.entities.SCA-SoapProxy; - -     - - diff --git a/reference/sca/setup.xml b/reference/sca/setup.xml deleted file mode 100644 index 67b9afa25456..000000000000 --- a/reference/sca/setup.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - If you want to use SCA to consume or produce Web services then you - need PHP 5.2.0 or later, built with the soap extension enabled. If you - just want to use local components, and do not wish to use the Web - service bindings, then this version of SCA for PHP will also run with - PHP 5.1.6. - - - SCA is packaged along with SDO in one combined package on PECL. - See http://www.php.net/sdo#sdo.installation for installing the - SCA_SDO package from PECL. The SCA code must be on the include path of - your PHP installation, for example if it is installed as - /usr/local/lib/php/SCA, the include_path directive must include - /usr/local/lib/php - -
    - - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;sca. - - - &pecl.windows.download; - -
    - - - -
    - &reftitle.runtime; - &no.config; -
    - - - -
    - &reftitle.resources; - &no.resource; -
    - - -     - - - diff --git a/reference/sca/versions.xml b/reference/sca/versions.xml deleted file mode 100644 index 1b6f6bdcd28a..000000000000 --- a/reference/sca/versions.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/scream/book.xml b/reference/scream/book.xml deleted file mode 100644 index ca03a33e7f1c..000000000000 --- a/reference/scream/book.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - Break the silence operator - scream - - - &reftitle.intro; - - The scream extension gives the possibility to disable the silencing - error control operator - so all errors are being reported. This feature is controlled by an ini setting. - - - - &reference.scream.setup; - &reference.scream.examples; - - - - - diff --git a/reference/scream/configure.xml b/reference/scream/configure.xml deleted file mode 100644 index 1e3bbe0db92c..000000000000 --- a/reference/scream/configure.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - -
    - &reftitle.install; - - - &pecl.info; - &url.pecl.package;scream - -
    - - - diff --git a/reference/scream/examples.xml b/reference/scream/examples.xml deleted file mode 100644 index 2b01ef7fb620..000000000000 --- a/reference/scream/examples.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - &reftitle.examples; - -
    - Example that shows the effect of scream - - This example demonstrates how scream affects the behaviour of PHP's error handler. - - - - Enabling and disabling scream at runtime - - -]]> - - &example.outputs.similar; - - - - - - - - Usually one would set this in the php.ini configuration file - instead of changing the code. - - -
    -     - - - diff --git a/reference/scream/ini.xml b/reference/scream/ini.xml deleted file mode 100644 index 25db997f2825..000000000000 --- a/reference/scream/ini.xml +++ /dev/null @@ -1,76 +0,0 @@ - - - -
    - &reftitle.runtime; - &extension.runtime; - - - - scream &ConfigureOptions; - - - - &Name; - &Default; - &Changeable; - Changelog - - - - - scream.enabled - Off - PHP_INI_ALL - - - - -
    - - &ini.php.constants; - -     - - &ini.descriptions.title; - - - - - - - scream.enabled - int - - - - Whether or not to enable scream. - - - - - - -
    - - - diff --git a/reference/scream/setup.xml b/reference/scream/setup.xml deleted file mode 100644 index 2bca927b98a4..000000000000 --- a/reference/scream/setup.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - PHP version 5.2.0 or greater. - -
    - - &reference.scream.configure; - &reference.scream.ini; - -
    - &reftitle.resources; - &no.resource; -
    - -     - - - diff --git a/reference/sem/functions/shm-attach.xml b/reference/sem/functions/shm-attach.xml index e001eb148331..67d3c7e733e2 100644 --- a/reference/sem/functions/shm-attach.xml +++ b/reference/sem/functions/shm-attach.xml @@ -71,31 +71,6 @@     - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function now returns a &resource; instead of an - integer. - - - - - - - - &reftitle.notes; diff --git a/reference/session/functions/session-get-cookie-params.xml b/reference/session/functions/session-get-cookie-params.xml index 6c80407baa76..881826780298 100644 --- a/reference/session/functions/session-get-cookie-params.xml +++ b/reference/session/functions/session-get-cookie-params.xml @@ -81,12 +81,6 @@ The "samesite" entry was added in the returned array. - - 5.2.0 - - The "httponly" entry was added in the returned array. - - diff --git a/reference/session/functions/session-regenerate-id.xml b/reference/session/functions/session-regenerate-id.xml index 4d8b2b2ab45c..0889e465cc56 100644 --- a/reference/session/functions/session-regenerate-id.xml +++ b/reference/session/functions/session-regenerate-id.xml @@ -67,37 +67,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 7.0.0 - - session_regenerate_id saves old session data - before closing. - - - - 5.1.0 - - Added the delete_old_session parameter. - - - - - - - - &reftitle.examples; diff --git a/reference/session/functions/session-set-cookie-params.xml b/reference/session/functions/session-set-cookie-params.xml index 2ac6c4dac76b..aef4cd2a2d6e 100644 --- a/reference/session/functions/session-set-cookie-params.xml +++ b/reference/session/functions/session-set-cookie-params.xml @@ -138,12 +138,6 @@ &return.success; Formerly the function returned void. - - 5.2.0 - - The httponly parameter was added. - - diff --git a/reference/session/functions/session-set-save-handler.xml b/reference/session/functions/session-set-save-handler.xml index 57b2a83050ec..2b5310b3d6c8 100644 --- a/reference/session/functions/session-set-save-handler.xml +++ b/reference/session/functions/session-set-save-handler.xml @@ -271,42 +271,6 @@ - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 7.0.0 - - Added the optional validate_sid and - update_timestamp parameters. - - - - 5.5.1 - - Added the optional create_sid parameter. - - - - 5.4.0 - - Added SessionHandlerInterface for implementing session handlers and - SessionHandler to expose internal PHP session handlers. - - - - - - - &reftitle.examples; diff --git a/reference/session/functions/session-start.xml b/reference/session/functions/session-start.xml index c4c008e9250f..7eafc2b29170 100644 --- a/reference/session/functions/session-start.xml +++ b/reference/session/functions/session-start.xml @@ -96,19 +96,6 @@ session. - - 7.0.0 - - The options parameter was added. - - - - 5.3.0 - - If a session fails to start, then &false; is returned. - Previously &true; was returned. - - diff --git a/reference/session_pgsql/book.xml b/reference/session_pgsql/book.xml deleted file mode 100644 index f33e013f285d..000000000000 --- a/reference/session_pgsql/book.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - PostgreSQL Session Save Handler - Session PgSQL - - - &reftitle.intro; - ¬e.no-windows.extension; - - This module provides an additional session save handler for the - session - module using PostgreSQL as a - storage system. A user-level session storage function may - also be used - session_set_save_handler, but this module is - written in C and therefore could be twice as fast, compared to - a session save handler written in PHP. - - - Session PgSQL is designed to scale any size of web sites and offers some - advanced features: - - session tables are created automatically - automatic session table vacuum - better garbage collection - multiple PostgreSQL servers support - automatic database server failover (switching) - - automatic database server load balancing if there are multiple - PostgreSQL servers. - - short circuit UPDATE - - - - - &reference.session-pgsql.setup; - &reference.session-pgsql.tables; - &reference.session-pgsql.constants; - &reference.session-pgsql.reference; - - - - - diff --git a/reference/session_pgsql/configure.xml b/reference/session_pgsql/configure.xml deleted file mode 100644 index 97a7cc42747c..000000000000 --- a/reference/session_pgsql/configure.xml +++ /dev/null @@ -1,30 +0,0 @@ - - -
    - &reftitle.install; - - &pecl.info.dead; - &url.pecl.vcs;session_pgsql. - -
    - - diff --git a/reference/session_pgsql/constants.xml b/reference/session_pgsql/constants.xml deleted file mode 100644 index 018ffb7def06..000000000000 --- a/reference/session_pgsql/constants.xml +++ /dev/null @@ -1,27 +0,0 @@ - - - - &reftitle.constants; - &no.constants; - - - - diff --git a/reference/session_pgsql/functions/session-pgsql-add-error.xml b/reference/session_pgsql/functions/session-pgsql-add-error.xml deleted file mode 100644 index 866935967b69..000000000000 --- a/reference/session_pgsql/functions/session-pgsql-add-error.xml +++ /dev/null @@ -1,80 +0,0 @@ - - - - - - session_pgsql_add_error - Increments error counts and sets last error message - - - &reftitle.description; - - boolsession_pgsql_add_error - interror_level - stringerror_message - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - error_level - - - - - - - - error_message - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - session_pgsql_get_error - - - - - - - diff --git a/reference/session_pgsql/functions/session-pgsql-get-error.xml b/reference/session_pgsql/functions/session-pgsql-get-error.xml deleted file mode 100644 index 43fe3ea7df41..000000000000 --- a/reference/session_pgsql/functions/session-pgsql-get-error.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - session_pgsql_get_error - Returns number of errors and last error message - - - &reftitle.description; - - arraysession_pgsql_get_error - boolwith_error_message&false; - - - Get the number of errors and optional the error messages. - - - - &reftitle.parameters; - - - - with_error_message - - - Set to &true; the literal error message for each error is also returned. - - - - - - - - &reftitle.returnvalues; - - The number of errors are returned as array. - - - - - - - - &reftitle.seealso; - - - session_pgsql_add_error - - - - - - - diff --git a/reference/session_pgsql/functions/session-pgsql-get-field.xml b/reference/session_pgsql/functions/session-pgsql-get-field.xml deleted file mode 100644 index c386d5350b78..000000000000 --- a/reference/session_pgsql/functions/session-pgsql-get-field.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - - session_pgsql_get_field - Get custom field value - - - &reftitle.description; - - stringsession_pgsql_get_field - - - - &warn.undocumented.func; - - - - - - - &reftitle.seealso; - - - session_pgsql_set_field - - - - - - - diff --git a/reference/session_pgsql/functions/session-pgsql-reset.xml b/reference/session_pgsql/functions/session-pgsql-reset.xml deleted file mode 100644 index faae2bf097da..000000000000 --- a/reference/session_pgsql/functions/session-pgsql-reset.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - - session_pgsql_reset - Reset connection to session database servers - - - &reftitle.description; - - boolsession_pgsql_reset - - - - Reset the connection to the session database servers. - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - - - - - - - diff --git a/reference/session_pgsql/functions/session-pgsql-set-field.xml b/reference/session_pgsql/functions/session-pgsql-set-field.xml deleted file mode 100644 index 6ed175b2b6da..000000000000 --- a/reference/session_pgsql/functions/session-pgsql-set-field.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - session_pgsql_set_field - Set custom field value - - - &reftitle.description; - - boolsession_pgsql_set_field - stringvalue - - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - value - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - - &reftitle.seealso; - - - session_pgsql_get_field - - - - - - - - - diff --git a/reference/session_pgsql/functions/session-pgsql-status.xml b/reference/session_pgsql/functions/session-pgsql-status.xml deleted file mode 100644 index d31003dc8074..000000000000 --- a/reference/session_pgsql/functions/session-pgsql-status.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - session_pgsql_status - Get current save handler status - - - - &reftitle.description; - - arraysession_pgsql_status - - - &warn.undocumented.func; - - - - - diff --git a/reference/session_pgsql/ini.xml b/reference/session_pgsql/ini.xml deleted file mode 100644 index 55e7f57a0e23..000000000000 --- a/reference/session_pgsql/ini.xml +++ /dev/null @@ -1,32 +0,0 @@ - - -
    - &reftitle.runtime; - &extension.runtime; - - PostgreSQL session save handler is still under development. Refer to the - README file in the source distribution for - configuration details. - -
    - - diff --git a/reference/session_pgsql/reference.xml b/reference/session_pgsql/reference.xml deleted file mode 100644 index bb8f81c0897e..000000000000 --- a/reference/session_pgsql/reference.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - Session PgSQL &Functions; - - Contact Information - - I have at the moment not very much time to further develop this - extension. I will implement more and more features in the near future. - - - If you have comments, bug fixes, enhancements or want to help developing - this, you can drop me a mail at - yohgaki@php.net. Any help is - very welcome. - - - - &reference.session-pgsql.entities.functions; - - - - diff --git a/reference/session_pgsql/setup.xml b/reference/session_pgsql/setup.xml deleted file mode 100644 index fbf86584f33c..000000000000 --- a/reference/session_pgsql/setup.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - &reftitle.setup; - -
    - &reftitle.required; - - You need at least PHP >= 4.3.0, and PostgreSQL >=7.2.0 as database - server. libpq that comes with PostgreSQL 7.2.0 or - later (and header files to build) and libmm - (and header files). - -
    - - &reference.session-pgsql.configure; - - &reference.session-pgsql.ini; - -
    - &reftitle.resources; - &no.resource; -
    - -     - - - diff --git a/reference/session_pgsql/tables.xml b/reference/session_pgsql/tables.xml deleted file mode 100644 index d7c6b2731d33..000000000000 --- a/reference/session_pgsql/tables.xml +++ /dev/null @@ -1,77 +0,0 @@ - - - - - Table definitions - - Session table definition - - - - - - - If you use HASH for INDEX, you'll - have a deadlock problem when the server load is - very high. Even if it's unlikely to have a deadlock - under normal operation, it can occur. Do not use - HASH for INDEX. - - - - You may change the session table as long as all fields are defined. - - - Application variables table definition - - - - - - - - - diff --git a/reference/session_pgsql/versions.xml b/reference/session_pgsql/versions.xml deleted file mode 100644 index d8456d012dec..000000000000 --- a/reference/session_pgsql/versions.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/simplexml/simplexmlelement/children.xml b/reference/simplexml/simplexmlelement/children.xml index 9999d2c0b598..cc7f2bccd6ca 100644 --- a/reference/simplexml/simplexmlelement/children.xml +++ b/reference/simplexml/simplexmlelement/children.xml @@ -55,30 +55,6 @@     - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.0 - - The optional parameter is_prefix was added. - - - - - - - - &reftitle.examples; diff --git a/reference/simplexml/simplexmlelement/getDocNamespaces.xml b/reference/simplexml/simplexmlelement/getDocNamespaces.xml index 64e381fc40dc..3e964eedf356 100644 --- a/reference/simplexml/simplexmlelement/getDocNamespaces.xml +++ b/reference/simplexml/simplexmlelement/getDocNamespaces.xml @@ -131,30 +131,6 @@ array(3) { - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - Added from_root parameter. - - - - - - - - &reftitle.seealso; diff --git a/reference/snmp/functions/snmp-set-oid-numeric-print.xml b/reference/snmp/functions/snmp-set-oid-numeric-print.xml index aca2321a4d70..6f17bf3d0afb 100644 --- a/reference/snmp/functions/snmp-set-oid-numeric-print.xml +++ b/reference/snmp/functions/snmp-set-oid-numeric-print.xml @@ -19,30 +19,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.0 - - This function is now an alias of snmp_set_oid_output_format. - - - - - - - - &reftitle.seealso; diff --git a/reference/snmp/functions/snmp-set-valueretrieval.xml b/reference/snmp/functions/snmp-set-valueretrieval.xml index bd4d0414fd36..f2cf72bf5001 100644 --- a/reference/snmp/functions/snmp-set-valueretrieval.xml +++ b/reference/snmp/functions/snmp-set-valueretrieval.xml @@ -110,42 +110,6 @@ - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - - Constants SNMP_VALUE_PLAIN or SNMP_VALUE_LIBRARY - may be combined with SNMP_VALUE_OBJECT - resulting different way of representing contents of value - array element in return value of GET-function. If no - SNMP_VALUE_{PLAIN,LIBRARY} constant is - accompanying SNMP_VALUE_OBJECT, - SNMP_VALUE_LIBRARY is used. - - - Prior to 5.4.0 SNMP_VALUE_OBJECT effecively meant - SNMP_VALUE_OBJECT|SNMP_VALUE_PLAIN. - - - - - - - - &reftitle.seealso; diff --git a/reference/soap/soapclient/dorequest.xml b/reference/soap/soapclient/dorequest.xml index f06693002d65..25601d3bb415 100644 --- a/reference/soap/soapclient/dorequest.xml +++ b/reference/soap/soapclient/dorequest.xml @@ -81,31 +81,6 @@ The XML SOAP response. - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.3 - - The one_way parameter was added. - - - - - - - - &reftitle.examples; diff --git a/reference/soap/soapclient/soapclient.xml b/reference/soap/soapclient/soapclient.xml index a44cb1cc1872..60337837e40a 100644 --- a/reference/soap/soapclient/soapclient.xml +++ b/reference/soap/soapclient/soapclient.xml @@ -175,36 +175,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.5.0 - - New ssl_method option. - - - - 5.4.0 - - New keep_alive option. - - - - - - - - &reftitle.examples; diff --git a/reference/soap/soapserver/soapserver.xml b/reference/soap/soapserver/soapserver.xml index 003890dfd3ec..23fbd9c458ad 100644 --- a/reference/soap/soapserver/soapserver.xml +++ b/reference/soap/soapserver/soapserver.xml @@ -111,30 +111,6 @@ $server = new SoapServer("books.wsdl", array('classmap' => array('book' => "MyBo - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.0 - - Added the typemap option. - - - - - - - - &reftitle.seealso; diff --git a/reference/sockets/functions/socket-create-pair.xml b/reference/sockets/functions/socket-create-pair.xml index b38174240ae4..e1508bf78cd6 100644 --- a/reference/sockets/functions/socket-create-pair.xml +++ b/reference/sockets/functions/socket-create-pair.xml @@ -83,30 +83,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function is now available on Windows platforms. - - - - - - - - &reftitle.examples; diff --git a/reference/spl/directoryiterator/construct.xml b/reference/spl/directoryiterator/construct.xml index 453ee8d1a4cd..e76e77f83a44 100644 --- a/reference/spl/directoryiterator/construct.xml +++ b/reference/spl/directoryiterator/construct.xml @@ -45,45 +45,6 @@ if the path is an empty string. - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - Throws UnexpectedValueException if the - path cannot be opened. - - - - 5.1.3 - - Throws RuntimeException if the - path is an empty string. - - - - 5.1.0 - - Throws RuntimeException on error. - Previously, threw Exception. - - - - - - - &reftitle.examples; diff --git a/reference/spl/functions/class-implements.xml b/reference/spl/functions/class-implements.xml index 87c25d2c3603..8189b119a409 100644 --- a/reference/spl/functions/class-implements.xml +++ b/reference/spl/functions/class-implements.xml @@ -53,31 +53,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.0 - - Added the option to pass the class parameter as - a string. Added the autoload parameter. - - - - - - - - &reftitle.examples; diff --git a/reference/spl/functions/class-parents.xml b/reference/spl/functions/class-parents.xml index 67736f58eac6..0da3b027ddfb 100644 --- a/reference/spl/functions/class-parents.xml +++ b/reference/spl/functions/class-parents.xml @@ -52,31 +52,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.0 - - Added the option to pass the class parameter as - a string. Added the autoload parameter. - - - - - - - - &reftitle.examples; diff --git a/reference/spl/functions/iterator-to-array.xml b/reference/spl/functions/iterator-to-array.xml index 5feeebca1a8d..fca7d72d1f30 100644 --- a/reference/spl/functions/iterator-to-array.xml +++ b/reference/spl/functions/iterator-to-array.xml @@ -66,38 +66,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.5.0 - - iterator_to_array gained support for key types - other than integer and string when the - use_keys parameter is enabled. - - - - 5.2.1 - - The use_keys parameter was added. - - - - - - - - &reftitle.examples; diff --git a/reference/spl/functions/spl-autoload-register.xml b/reference/spl/functions/spl-autoload-register.xml index 970a1f23201a..14a2bf903a92 100644 --- a/reference/spl/functions/spl-autoload-register.xml +++ b/reference/spl/functions/spl-autoload-register.xml @@ -78,36 +78,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - Namespaces support was introduced. - - - - 5.3.0 - - The prepend parameter was added. - - - - - - - - &reftitle.examples; diff --git a/reference/spl/splfileobject/flock.xml b/reference/spl/splfileobject/flock.xml index f3cd962771b9..667f829a1502 100644 --- a/reference/spl/splfileobject/flock.xml +++ b/reference/spl/splfileobject/flock.xml @@ -94,38 +94,6 @@ if ($file->flock(LOCK_EX)) { // do an exclusive lock - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.5.22, 5.6.6 - - Added support for the wouldblock parameter on - Windows. - - - - 5.3.2 - - The automatic unlocking when the file's resource handle is closed was - removed. Unlocking now always has to be done manually. - - - - - - - &reftitle.seealso; diff --git a/reference/spl/splfileobject/setcsvcontrol.xml b/reference/spl/splfileobject/setcsvcontrol.xml index 1d1401404650..46010a9c723e 100644 --- a/reference/spl/splfileobject/setcsvcontrol.xml +++ b/reference/spl/splfileobject/setcsvcontrol.xml @@ -79,12 +79,6 @@ string to disable the proprietary escape mechanism. - - 5.3.0 - - Added the escape parameter. - - diff --git a/reference/spl/splobjectstorage/attach.xml b/reference/spl/splobjectstorage/attach.xml index c8ae6053862b..7148306a3660 100644 --- a/reference/spl/splobjectstorage/attach.xml +++ b/reference/spl/splobjectstorage/attach.xml @@ -81,30 +81,6 @@ string(5) "hello" - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - Added the data parameter. - - - - - - - - &reftitle.seealso; diff --git a/reference/sqlite/functions/sqlite-factory.xml b/reference/sqlite/functions/sqlite-factory.xml deleted file mode 100644 index bd8daaef141e..000000000000 --- a/reference/sqlite/functions/sqlite-factory.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - sqlite_factory - Opens an SQLite database and returns an SQLiteDatabase object - - - - &reftitle.description; - - SQLiteDatabasesqlite_factory - stringfilename - intmode0666 - stringerror_message - - - sqlite_factory behaves similarly to - sqlite_open in that it opens an SQLite database or - attempts to create it if it does not exist. However, a - SQLiteDatabase object is - returned rather than a resource. Please see the - sqlite_open reference page for further usage and caveats. - - - - - &reftitle.parameters; - - - - filename - - - The filename of the SQLite database. - - - - - mode - - - The mode of the file. Intended to be used to open the database in - read-only mode. Presently, this parameter is ignored by the sqlite - library. The default value for mode is the octal value - 0666 and this is the recommended value. - - - - - error_message - - - Passed by reference and is set to hold a descriptive error message - explaining why the database could not be opened if there was an error. - - - - - - - - - &reftitle.returnvalues; - - Returns an SQLiteDatabase object on success, &null; on error. - - - - - &reftitle.examples; - - - <function>sqlite_factory</function> example - -query('SELECT user_id, username FROM users'); - -/* functionally equivalent to: */ - -$dbhandle = new SQLiteDatabase('sqlitedb'); -$dbhandle->query('SELECT user_id, username FROM users'); - -?>]]> - - - - - - - &reftitle.seealso; - - - sqlite_open - sqlite_popen - - - - - - diff --git a/reference/sqlite/functions/sqlite-fetch-column-types.xml b/reference/sqlite/functions/sqlite-fetch-column-types.xml deleted file mode 100644 index 78112e74e504..000000000000 --- a/reference/sqlite/functions/sqlite-fetch-column-types.xml +++ /dev/null @@ -1,169 +0,0 @@ - - - - - sqlite_fetch_column_types - SQLiteDatabase::fetchColumnTypes - - Return an array of column types from a particular table - - - - - &reftitle.description; - - arraysqlite_fetch_column_types - stringtable_name - resourcedbhandle - intresult_typeSQLITE_ASSOC - - &style.oop; (method): - - public arraySQLiteDatabase::fetchColumnTypes - stringtable_name - intresult_typeSQLITE_ASSOC - - - sqlite_fetch_column_types returns an array of column - data types from the specified table_name table. - - - - - &reftitle.parameters; - - - - table_name - - - The table name to query. - - - - - dbhandle - - - The SQLite Database resource; returned from sqlite_open - when used procedurally. This parameter is not required - when using the object-oriented method. - - - - - result_type - - - The optional result_type parameter accepts a - constant and determines how the returned array will be indexed. Using - SQLITE_ASSOC will return only associative indices - (named fields) while SQLITE_NUM will return only - numerical indices (ordinal field numbers). - SQLITE_ASSOC is the default for - this function. - - - - - - - - - &reftitle.returnvalues; - - Returns an array of column data types; &false; on error. - - &sqlite.case-fold; - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.0 - Added result_type - - - - - - - - - &reftitle.examples; - - - Procedural example - - $type) { - echo "Column: $column Type: $type\n"; -} -?> -]]> - - - - - - Object-oriented example - -query('CREATE TABLE foo (bar varchar(10), arf text)'); -$cols = $db->fetchColumnTypes('foo', SQLITE_ASSOC); - -foreach ($cols as $column => $type) { - echo "Column: $column Type: $type\n"; -} -?> -]]> - - &example.outputs; - - - - - - - - - diff --git a/reference/sqlite/functions/sqlite-fetch-object.xml b/reference/sqlite/functions/sqlite-fetch-object.xml deleted file mode 100644 index f023cb753dc3..000000000000 --- a/reference/sqlite/functions/sqlite-fetch-object.xml +++ /dev/null @@ -1,57 +0,0 @@ - - - - - sqlite_fetch_object - SQLiteResult::fetchObject - SQLiteUnbuffered::fetchObject - Fetches the next row from a result set as an object - - - - &reftitle.description; - - objectsqlite_fetch_object - resourceresult - stringclass_name - arrayctor_params - booldecode_binary&true; - - &style.oop; (method): - - objectSQLiteResult::fetchObject - stringclass_name - arrayctor_params - booldecode_binary&true; - - - objectSQLiteUnbuffered::fetchObject - stringclass_name - arrayctor_params - booldecode_binary&true; - - - &warn.undocumented.func; - - - - - diff --git a/reference/sqlite/functions/sqlite-has-prev.xml b/reference/sqlite/functions/sqlite-has-prev.xml deleted file mode 100644 index febddc4d77ce..000000000000 --- a/reference/sqlite/functions/sqlite-has-prev.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - sqlite_has_prev - SQLiteResult::hasPrev - Returns whether or not a previous row is available - - - - &reftitle.description; - - boolsqlite_has_prev - resourceresult - - &style.oop; (method): - - boolSQLiteResult::hasPrev - - - - Find whether there are more previous rows from the given result handle. - - - - - &reftitle.parameters; - - - - result - - - The SQLite result resource. This parameter is not required when using - the object-oriented method. - - &sqlite.no-unbuffered; - - - - - - - - &reftitle.returnvalues; - - Returns &true; if there are more previous rows available from the - result handle, or &false; otherwise. - - - - - &reftitle.seealso; - - - sqlite_prev - sqlite_has_more - sqlite_num_rows - - - - - - diff --git a/reference/sqlite/functions/sqlite-key.xml b/reference/sqlite/functions/sqlite-key.xml deleted file mode 100644 index f4cc17007006..000000000000 --- a/reference/sqlite/functions/sqlite-key.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - - - sqlite_key - SQLiteResult::key - Returns the current row index - - - - &reftitle.description; - &style.oop; (method): - - intSQLiteResult::key - - - - SQLiteResult::key returns the current row index of - the buffered result set result. - - - Unlike all other SQLite functions, this function does not have a procedural - version, and can only be called as a method on a - SQLiteResult object. - - - - - &reftitle.returnvalues; - - Returns the current row index of the buffered result set - result. - - - - - &reftitle.seealso; - - - sqlite_next - sqlite_current - sqlite_rewind - - - - - - diff --git a/reference/sqlite/functions/sqlite-prev.xml b/reference/sqlite/functions/sqlite-prev.xml deleted file mode 100644 index 97bf415727a5..000000000000 --- a/reference/sqlite/functions/sqlite-prev.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - sqlite_prev - SQLiteResult::prev - Seek to the previous row number of a result set - - - - &reftitle.description; - - boolsqlite_prev - resourceresult - - &style.oop; (method): - - boolSQLiteResult::prev - - - - sqlite_prev seeks back the - result handle to the previous row. - - - - - &reftitle.parameters; - - - - result - - - The SQLite result resource. This parameter is not required when using - the object-oriented method. - - &sqlite.no-unbuffered; - - - - - - - - &reftitle.returnvalues; - - Returns &true; on success, or &false; if there are no more previous rows. - - - - - &reftitle.seealso; - - - sqlite_has_prev - sqlite_rewind - sqlite_next - - - - - - diff --git a/reference/sqlite/functions/sqlite-valid.xml b/reference/sqlite/functions/sqlite-valid.xml deleted file mode 100644 index 786a7b8db299..000000000000 --- a/reference/sqlite/functions/sqlite-valid.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - sqlite_valid - SQLiteResult::valid - SQLiteUnbuffered::valid - Returns whether more rows are available - - - - &reftitle.description; - - boolsqlite_valid - resourceresult - - &style.oop; (method): - - boolSQLiteResult::valid - - - - boolSQLiteUnbuffered::valid - - - - Finds whether more rows are available from the given result handle. - - - - - &reftitle.parameters; - - - - result - - - The SQLite result resource. This parameter is not required when using - the object-oriented method. - - &sqlite.no-unbuffered; - - - - - - - - &reftitle.returnvalues; - - Returns &true; if there are more rows available from the - result handle, or &false; otherwise. - - - - - &reftitle.seealso; - - - sqlite_num_rows - sqlite_changes - - - - - - diff --git a/reference/sqlite/reference.xml b/reference/sqlite/reference.xml index 0c90835d93f3..6e6271319a2e 100644 --- a/reference/sqlite/reference.xml +++ b/reference/sqlite/reference.xml @@ -58,9 +58,6 @@ lastError - Returns the last error code of the most recently encountered error - - fetchColumnTypes - Return an array of column types from a particular table - @@ -76,9 +73,6 @@ fetch - Fetches the next row from the result set as an array - - fetchObject - Fetches the next row from the result set as an object - fetchSingle - Fetches the first column from the result set as a string @@ -97,24 +91,12 @@ current - Fetches the current row from the result set as an array - - key - Return the current row index - next - Seek to the next row number - - valid - Returns whether more rows are available - rewind - Seek to the first row number of the result set - - prev - Seek to the previous row number of the result set - - - hasPrev - Returns whether or not a previous row is available - numRows - Returns the number of rows in the result set @@ -136,9 +118,6 @@ fetch - Fetches the next row from the result set as an array - - fetchObject - Fetches the next row from the result set as an object - fetchSingle - Fetches the first column from the result set as a string @@ -160,9 +139,6 @@ next - Seek to the next row number - - valid - Returns whether more rows are available - diff --git a/reference/sqlite/versions.xml b/reference/sqlite/versions.xml index cd2f6dd48695..75397380b904 100644 --- a/reference/sqlite/versions.xml +++ b/reference/sqlite/versions.xml @@ -4,7 +4,6 @@ Do NOT translate this file --> - @@ -16,17 +15,12 @@ - - - - - @@ -36,7 +30,6 @@ - @@ -44,7 +37,6 @@ - - - - Statistics - - - - &reftitle.intro; - - This is the statistics extension. It contains few dozens of functions - useful for statistical computations. It is a wrapper around 2 scientific - libraries, namely DCDFLIB (Library of C routines for Cumulative - Distributions Functions, Inverses, and Other parameters) by B. Brown & - J. Lavato and RANDLIB by Barry Brown, James Lavato & Kathy Russell. - Includes CD and PD functions. - - - - - &reference.stats.setup; - &reference.stats.constants; - &reference.stats.reference; - - - - - diff --git a/reference/stats/constants.xml b/reference/stats/constants.xml deleted file mode 100644 index db0033b20f32..000000000000 --- a/reference/stats/constants.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - &reftitle.constants; - &no.constants; - - - - diff --git a/reference/stats/functions/stats-absolute-deviation.xml b/reference/stats/functions/stats-absolute-deviation.xml deleted file mode 100644 index e79c08d85996..000000000000 --- a/reference/stats/functions/stats-absolute-deviation.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - stats_absolute_deviation - Returns the absolute deviation of an array of values - - - &reftitle.description; - - floatstats_absolute_deviation - arraya - - - Returns the absolute deviation of the values in a. - - - - &reftitle.parameters; - - - - a - - - The input array - - - - - - - - - &reftitle.returnvalues; - - Returns the absolute deviation of the values in a, - or &false; if a is empty or is not an array. - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-cdf-beta.xml b/reference/stats/functions/stats-cdf-beta.xml deleted file mode 100644 index b20ecf6bff45..000000000000 --- a/reference/stats/functions/stats-cdf-beta.xml +++ /dev/null @@ -1,221 +0,0 @@ - - - - - stats_cdf_beta - Calculates any one parameter of the beta distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_beta - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the beta distribution. The kind of the return value and parameters (par1, - par2, and par3) are determined by - which. - - - The following table lists the return value and parameters by which. - CDF, x, alpha, and beta denotes cumulative distribution function, the value of the random - variable, and shape parameters of the beta distribution, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - alpha - beta - - - 2 - x - CDF - alpha - beta - - - 3 - alpha - x - CDF - beta - - - 4 - beta - x - CDF - alpha - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, alpha, or beta, determined by which. - - - - - - - - - - - - - - - -     - - diff --git a/reference/stats/functions/stats-cdf-binomial.xml b/reference/stats/functions/stats-cdf-binomial.xml deleted file mode 100644 index a9421844a696..000000000000 --- a/reference/stats/functions/stats-cdf-binomial.xml +++ /dev/null @@ -1,221 +0,0 @@ - - - - - stats_cdf_binomial - Calculates any one parameter of the binomial distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_binomial - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the binomial distribution. The kind of the return value and parameters - (par1, par2, and par3) - are determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, n, and p denotes cumulative distribution function, the number of successes, - the number of trials, and the success rate for each trial, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - n - p - - - 2 - x - CDF - n - p - - - 3 - n - x - CDF - p - - - 4 - p - x - CDF - n - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, n, or p, determined by which. - - - - - - - - - - - - - - - -     - - diff --git a/reference/stats/functions/stats-cdf-cauchy.xml b/reference/stats/functions/stats-cdf-cauchy.xml deleted file mode 100644 index 9245450d24df..000000000000 --- a/reference/stats/functions/stats-cdf-cauchy.xml +++ /dev/null @@ -1,221 +0,0 @@ - - - - - stats_cdf_cauchy - Calculates any one parameter of the Cauchy distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_cauchy - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the Cauchy distribution. The kind of the return value and parameters - (par1, par2, and par3) - are determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, x0, and gamma denotes cumulative distribution function, the value of the random - variable, the location and the scale parameter of the Cauchy distribution, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - x0 - gamma - - - 2 - x - CDF - x0 - gamma - - - 3 - x0 - x - CDF - gamma - - - 4 - gamma - x - CDF - x0 - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, x0, or gamma, determined by which. - - - - - - - - - - - - - - - -     - - diff --git a/reference/stats/functions/stats-cdf-chisquare.xml b/reference/stats/functions/stats-cdf-chisquare.xml deleted file mode 100644 index 7f3764a67063..000000000000 --- a/reference/stats/functions/stats-cdf-chisquare.xml +++ /dev/null @@ -1,201 +0,0 @@ - - - - - stats_cdf_chisquare - Calculates any one parameter of the chi-square distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_chisquare - floatpar1 - floatpar2 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the chi-square distribution. The kind of the return value and parameters - (par1 and par2) are determined by - which. - - - The following table lists the return value and parameters by which. - CDF, x, and k denotes cumulative distribution function, the value of the random variable, - and the degree of freedom of the chi-square distribution, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - - - - - 1 - CDF - x - k - - - 2 - x - CDF - k - - - 3 - k - x - CDF - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, or k, determined by which. - - - - - - - - - - - - - - - -     - - diff --git a/reference/stats/functions/stats-cdf-exponential.xml b/reference/stats/functions/stats-cdf-exponential.xml deleted file mode 100644 index b22f5fda6336..000000000000 --- a/reference/stats/functions/stats-cdf-exponential.xml +++ /dev/null @@ -1,201 +0,0 @@ - - - - - stats_cdf_exponential - Calculates any one parameter of the exponential distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_exponential - floatpar1 - floatpar2 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the exponential distribution. The kind of the return value and parameters - (par1 and par2) are determined by - which. - - - The following table lists the return value and parameters by which. - CDF, x, and lambda denotes cumulative distribution function, the value of the random - variable, and the rate parameter of the exponential distribution, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - - - - - 1 - CDF - x - lambda - - - 2 - x - CDF - lambda - - - 3 - lambda - x - CDF - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, or lambda, determined by which. - - - - - - - - - - - - - - - -     - - diff --git a/reference/stats/functions/stats-cdf-f.xml b/reference/stats/functions/stats-cdf-f.xml deleted file mode 100644 index 18e59736241c..000000000000 --- a/reference/stats/functions/stats-cdf-f.xml +++ /dev/null @@ -1,221 +0,0 @@ - - - - - stats_cdf_f - Calculates any one parameter of the F distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_f - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the F distribution. The kind of the return value and parameters - (par1, par2, and par3) - are determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, d1, and d2 denotes cumulative distribution function, the value of the random - variable, and the degree of freedoms of the F distribution, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - d1 - d2 - - - 2 - x - CDF - d1 - d2 - - - 3 - d1 - x - CDF - d2 - - - 4 - d2 - x - CDF - d1 - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, d1, or d2, determined by which. - - - - - - - - - - - - - - - -     - - diff --git a/reference/stats/functions/stats-cdf-gamma.xml b/reference/stats/functions/stats-cdf-gamma.xml deleted file mode 100644 index e58a70ec2759..000000000000 --- a/reference/stats/functions/stats-cdf-gamma.xml +++ /dev/null @@ -1,221 +0,0 @@ - - - - - stats_cdf_gamma - Calculates any one parameter of the gamma distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_gamma - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the gamma distribution. The kind of the return value and parameters - (par1, par2, and par3) - are determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, k, and theta denotes cumulative distribution function, the value of the random - variable, and the shape and the scale parameter of the gamma distribution, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - k - theta - - - 2 - x - CDF - k - theta - - - 3 - k - x - CDF - theta - - - 4 - theta - x - CDF - k - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, k, or theta, determined by which. - - - - - - - - - - - - - - - -     - - diff --git a/reference/stats/functions/stats-cdf-laplace.xml b/reference/stats/functions/stats-cdf-laplace.xml deleted file mode 100644 index 38ef88db64df..000000000000 --- a/reference/stats/functions/stats-cdf-laplace.xml +++ /dev/null @@ -1,221 +0,0 @@ - - - - - stats_cdf_laplace - Calculates any one parameter of the Laplace distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_laplace - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the Laplace distribution. The kind of the return value and parameters - (par1, par2, and par3) - are determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, mu, and b denotes cumulative distribution function, the value of the random - variable, and the location and the scale parameter of the Laplace distribution, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - mu - b - - - 2 - x - CDF - mu - b - - - 3 - mu - x - CDF - b - - - 4 - b - x - CDF - mu - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, mu, or b, determined by which. - - - - - - - - - - - - - - - -     - - diff --git a/reference/stats/functions/stats-cdf-logistic.xml b/reference/stats/functions/stats-cdf-logistic.xml deleted file mode 100644 index 6d3cb1bcb103..000000000000 --- a/reference/stats/functions/stats-cdf-logistic.xml +++ /dev/null @@ -1,221 +0,0 @@ - - - - - stats_cdf_logistic - Calculates any one parameter of the logistic distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_logistic - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the logistic distribution. The kind of the return value and parameters - (par1, par2, and par3) - are determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, mu, and s denotes cumulative distribution function, the value of the random - variable, and the location and the scale parameter of the logistic distribution, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - mu - s - - - 2 - x - CDF - mu - s - - - 3 - mu - x - CDF - s - - - 4 - s - x - CDF - mu - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, mu, or s, determined by which. - - - - - - - - - - - - - - - -     - - diff --git a/reference/stats/functions/stats-cdf-negative-binomial.xml b/reference/stats/functions/stats-cdf-negative-binomial.xml deleted file mode 100644 index eea959c7edd6..000000000000 --- a/reference/stats/functions/stats-cdf-negative-binomial.xml +++ /dev/null @@ -1,221 +0,0 @@ - - - - - stats_cdf_negative_binomial - Calculates any one parameter of the negative binomial distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_negative_binomial - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the negative binomial distribution. The kind of the return value and parameters - (par1, par2, and par3) - are determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, r, and p denotes cumulative distribution function, the number of failure, the number - of success, and the success rate for each trial, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - r - p - - - 2 - x - CDF - r - p - - - 3 - r - x - CDF - p - - - 4 - p - x - CDF - r - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, r, or p, determined by which. - - - - - - - - - - - - - - - -     - - diff --git a/reference/stats/functions/stats-cdf-noncentral-chisquare.xml b/reference/stats/functions/stats-cdf-noncentral-chisquare.xml deleted file mode 100644 index 700301849436..000000000000 --- a/reference/stats/functions/stats-cdf-noncentral-chisquare.xml +++ /dev/null @@ -1,222 +0,0 @@ - - - - - stats_cdf_noncentral_chisquare - Calculates any one parameter of the non-central chi-square distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_noncentral_chisquare - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the non-central chi-square distribution. The kind of the return value and parameters - (par1, par2, and par3) - are determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, k, and lambda denotes cumulative distribution function, the value of the random - variable, the degree of freedom and the non-centrality parameter of the distribution, - respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - k - lambda - - - 2 - x - CDF - k - lambda - - - 3 - k - x - CDF - lambda - - - 4 - lambda - x - CDF - k - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, k, or lambda, determined by which. - - - - - - - - - - - - - - - -     - - diff --git a/reference/stats/functions/stats-cdf-noncentral-f.xml b/reference/stats/functions/stats-cdf-noncentral-f.xml deleted file mode 100644 index de8e1651c1cb..000000000000 --- a/reference/stats/functions/stats-cdf-noncentral-f.xml +++ /dev/null @@ -1,244 +0,0 @@ - - - - - stats_cdf_noncentral_f - Calculates any one parameter of the non-central F distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_noncentral_f - floatpar1 - floatpar2 - floatpar3 - floatpar4 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the non-central F distribution. The kind of the return value and parameters - (par1, par2, par3, - and par4) are determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, nu1, nu2, and lambda denotes cumulative distribution function, the value of the - random variable, the degree of freedoms and the non-centrality parameter of the distribution, - respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - par4 - - - - - 1 - CDF - x - nu1 - nu2 - lambda - - - 2 - x - CDF - nu1 - nu2 - lambda - - - 3 - nu1 - x - CDF - nu2 - lambda - - - 4 - nu2 - x - CDF - nu1 - lambda - - - 5 - lambda - x - CDF - nu1 - nu2 - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - par4 - - - The fourth parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, nu1, nu2, or lambda, determined by which. - - - - - - - - - - - - - - - -     - - diff --git a/reference/stats/functions/stats-cdf-noncentral-t.xml b/reference/stats/functions/stats-cdf-noncentral-t.xml deleted file mode 100644 index 4e2bf39b3ce4..000000000000 --- a/reference/stats/functions/stats-cdf-noncentral-t.xml +++ /dev/null @@ -1,221 +0,0 @@ - - - - - - stats_cdf_noncentral_t - Calculates any one parameter of the non-central t-distribution give values for the others - - - - &reftitle.description; - - floatstats_cdf_noncentral_t - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the non-central t-distribution. The kind of the return value and parameters - (par1, par2, and par3) - are determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, nu, and mu denotes cumulative distribution function, the value of the random - variable, the degrees of freedom and the non-centrality parameter of the distribution, - respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - nu - mu - - - 2 - x - CDF - nu - mu - - - 3 - nu - x - CDF - mu - - - 4 - mu - x - CDF - nu - - - -
    -     -     - - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, nu, or mu, determined by which. - - - - - - - - - - - -     - - diff --git a/reference/stats/functions/stats-cdf-normal.xml b/reference/stats/functions/stats-cdf-normal.xml deleted file mode 100644 index 1a58ea588ec3..000000000000 --- a/reference/stats/functions/stats-cdf-normal.xml +++ /dev/null @@ -1,220 +0,0 @@ - - - - - - stats_cdf_normal - Calculates any one parameter of the normal distribution given values for the others - - - - &reftitle.description; - - floatstats_cdf_normal - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the normal distribution. The kind of the return value and parameters - (par1, par2, and par3) - are determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, mu, and sigma denotes cumulative distribution function, the value of the random - variable, the mean and the standard deviation of the normal distribution, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - mu - sigma - - - 2 - x - CDF - mu - sigma - - - 3 - mu - x - CDF - sigma - - - 4 - sigma - x - CDF - mu - - - -
    -     -     - - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, mu, or sigma, determined by which. - - - - - - - - - - - -     - - diff --git a/reference/stats/functions/stats-cdf-poisson.xml b/reference/stats/functions/stats-cdf-poisson.xml deleted file mode 100644 index 302b783298bc..000000000000 --- a/reference/stats/functions/stats-cdf-poisson.xml +++ /dev/null @@ -1,200 +0,0 @@ - - - - - stats_cdf_poisson - Calculates any one parameter of the Poisson distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_poisson - floatpar1 - floatpar2 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, of the Poisson distribution. - The kind of the return value and parameters (par1 and par2) are - determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, and lambda denotes cumulative distribution function, the value of the random variable, - and the parameter of the Poisson distribution, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - - - - - 1 - CDF - x - lambda - - - 2 - x - CDF - lambda - - - 3 - lambda - x - CDF - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, or lambda, determined by which. - - - - - - - - - - - - - - - -     - - diff --git a/reference/stats/functions/stats-cdf-t.xml b/reference/stats/functions/stats-cdf-t.xml deleted file mode 100644 index 17daaf3f70bd..000000000000 --- a/reference/stats/functions/stats-cdf-t.xml +++ /dev/null @@ -1,201 +0,0 @@ - - - - - stats_cdf_t - Calculates any one parameter of the t-distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_t - floatpar1 - floatpar2 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the t-distribution. The kind of the return value and parameters - (par1 and par2) are determined by - which. - - - The following table lists the return value and parameters by which. - CDF, x, and nu denotes cumulative distribution function, the value of the random - variable, and the degrees of freedom of the t-distribution, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - - - - - 1 - CDF - x - nu - - - 2 - x - CDF - nu - - - 3 - nu - x - CDF - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, or nu, determined by which. - - - - - - - - - - - - - - - -     - - diff --git a/reference/stats/functions/stats-cdf-uniform.xml b/reference/stats/functions/stats-cdf-uniform.xml deleted file mode 100644 index 93604c06d399..000000000000 --- a/reference/stats/functions/stats-cdf-uniform.xml +++ /dev/null @@ -1,221 +0,0 @@ - - - - - stats_cdf_uniform - Calculates any one parameter of the uniform distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_uniform - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the uniform distribution. The kind of the return value and parameters - (par1, par2, and par3) - are determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, a, and b denotes cumulative distribution function, the value of the random variable, - the lower bound and the higher bound of the uniform distribution, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - a - b - - - 2 - x - CDF - a - b - - - 3 - a - x - CDF - b - - - 4 - b - x - CDF - a - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, a, or b, determined by which. - - - - - - - - - - - - - - - -     - - diff --git a/reference/stats/functions/stats-cdf-weibull.xml b/reference/stats/functions/stats-cdf-weibull.xml deleted file mode 100644 index 0fc5ae789fce..000000000000 --- a/reference/stats/functions/stats-cdf-weibull.xml +++ /dev/null @@ -1,221 +0,0 @@ - - - - - stats_cdf_weibull - Calculates any one parameter of the Weibull distribution given values for the others - - - &reftitle.description; - - floatstats_cdf_weibull - floatpar1 - floatpar2 - floatpar3 - intwhich - - - Returns the cumulative distribution function, its inverse, or one of its parameters, - of the Weibull distribution. The kind of the return value and parameters - (par1, par2, and par3) - are determined by which. - - - The following table lists the return value and parameters by which. - CDF, x, k, and lambda denotes cumulative distribution function, the value of the random variable, - the shape and the scale parameter of the Weibull distribution, respectively. - - Return value and parameters - - - - which - Return value - par1 - par2 - par3 - - - - - 1 - CDF - x - k - lambda - - - 2 - x - CDF - k - lambda - - - 3 - k - x - CDF - lambda - - - 4 - lambda - x - CDF - k - - - -
    -     -     - - &reftitle.parameters; - - - - par1 - - - The first parameter - - - - - par2 - - - The second parameter - - - - - par3 - - - The third parameter - - - - - which - - - The flag to determine what to be calculated - - - - - - - - - &reftitle.returnvalues; - - Returns CDF, x, k, or lambda, determined by which. - - - - - - - - - - - - - - - -     - - diff --git a/reference/stats/functions/stats-covariance.xml b/reference/stats/functions/stats-covariance.xml deleted file mode 100644 index 303d71813b15..000000000000 --- a/reference/stats/functions/stats-covariance.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - stats_covariance - Computes the covariance of two data sets - - - &reftitle.description; - - floatstats_covariance - arraya - arrayb - - - Returns the covariance of a and b. - - - - &reftitle.parameters; - - - - a - - - The first array - - - - - b - - - The second array - - - - - - - - - &reftitle.returnvalues; - - Returns the covariance of a and b, - or &false; on failure. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-beta.xml b/reference/stats/functions/stats-dens-beta.xml deleted file mode 100644 index 8df89f19f994..000000000000 --- a/reference/stats/functions/stats-dens-beta.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - stats_dens_beta - Probability density function of the beta distribution - - - &reftitle.description; - - floatstats_dens_beta - floatx - floata - floatb - - - Returns the probability density at x, where the - random variable follows the beta distribution of which the shape parameters - are a and b. - - - - &reftitle.parameters; - - - - x - - - The value at which the probability density is calculated - - - - - a - - - The shape parameter of the distribution - - - - - b - - - The shape parameter of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability density at x or &false; for failure. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-cauchy.xml b/reference/stats/functions/stats-dens-cauchy.xml deleted file mode 100644 index 3048d0833ca8..000000000000 --- a/reference/stats/functions/stats-dens-cauchy.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - stats_dens_cauchy - Probability density function of the Cauchy distribution - - - &reftitle.description; - - floatstats_dens_cauchy - floatx - floatave - floatstdev - - - Returns the probability density at x, where the - random variable follows the Cauchy distribution whose location and scale are - ave and stdev, respectively. - - - - &reftitle.parameters; - - - - x - - - The value at which the probability density is calculated - - - - - ave - - - The location parameter of the distribution - - - - - stdev - - - The scale parameter of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability density at x or &false; for failure. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-chisquare.xml b/reference/stats/functions/stats-dens-chisquare.xml deleted file mode 100644 index 812fb4ad306c..000000000000 --- a/reference/stats/functions/stats-dens-chisquare.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - stats_dens_chisquare - Probability density function of the chi-square distribution - - - &reftitle.description; - - floatstats_dens_chisquare - floatx - floatdfr - - - Returns the probability density at x, where the - random variable follows the chi-square distribution of which the degree of - freedom is dfr. - - - - &reftitle.parameters; - - - - x - - - The value at which the probability density is calculated - - - - - dfr - - - The degree of freedom of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability density at x or &false; for failure. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-exponential.xml b/reference/stats/functions/stats-dens-exponential.xml deleted file mode 100644 index dffa0e5e1551..000000000000 --- a/reference/stats/functions/stats-dens-exponential.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - stats_dens_exponential - Probability density function of the exponential distribution - - - &reftitle.description; - - floatstats_dens_exponential - floatx - floatscale - - - Returns the probability density at x, where the - random variable follows the exponential distribution of which the scale is - scale. - - - - &reftitle.parameters; - - - - x - - - The value at which the probability density is calculated - - - - - scale - - - The scale of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability density at x or &false; for failure. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-f.xml b/reference/stats/functions/stats-dens-f.xml deleted file mode 100644 index b1eb37800701..000000000000 --- a/reference/stats/functions/stats-dens-f.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - stats_dens_f - Probability density function of the F distribution - - - &reftitle.description; - - floatstats_dens_f - floatx - floatdfr1 - floatdfr2 - - - Returns the probability density at x, where the - random variable follows the F distribution of which the degree of freedoms - are dfr1 and dfr2. - - - - &reftitle.parameters; - - - - x - - - The value at which the probability density is calculated - - - - - dfr1 - - - The degree of freedom of the distribution - - - - - dfr2 - - - The degree of freedom of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability density at x or &false; for failure. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-gamma.xml b/reference/stats/functions/stats-dens-gamma.xml deleted file mode 100644 index 7493ecf7712a..000000000000 --- a/reference/stats/functions/stats-dens-gamma.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - stats_dens_gamma - Probability density function of the gamma distribution - - - &reftitle.description; - - floatstats_dens_gamma - floatx - floatshape - floatscale - - - Returns the probability density at x, where the - random variable follows the gamma distribution of which the shape parameter - is shape and the scale parameter is scale. - - - - &reftitle.parameters; - - - - x - - - The value at which the probability density is calculated - - - - - shape - - - The shape parameter of the distribution - - - - - scale - - - The scale parameter of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability density at x or &false; for failure. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-laplace.xml b/reference/stats/functions/stats-dens-laplace.xml deleted file mode 100644 index e2443edb8456..000000000000 --- a/reference/stats/functions/stats-dens-laplace.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - stats_dens_laplace - Probability density function of the Laplace distribution - - - &reftitle.description; - - floatstats_dens_laplace - floatx - floatave - floatstdev - - - Returns the probability density at x, where the - random variable follows the Laplace distribution of which the location parameter - is ave and the scale parameter is stdev. - - - - &reftitle.parameters; - - - - x - - - The value at which the probability density is calculated - - - - - ave - - - The location parameter of the distribution - - - - - stdev - - - The shape parameter of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability density at x or &false; for failure. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-logistic.xml b/reference/stats/functions/stats-dens-logistic.xml deleted file mode 100644 index 1b0959644f5c..000000000000 --- a/reference/stats/functions/stats-dens-logistic.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - stats_dens_logistic - Probability density function of the logistic distribution - - - &reftitle.description; - - floatstats_dens_logistic - floatx - floatave - floatstdev - - - Returns the probability density at x, where the - random variable follows the logistic distribution of which the location parameter - is ave and the scale parameter is stdev. - - - - &reftitle.parameters; - - - - x - - - The value at which the probability density is calculated - - - - - ave - - - The location parameter of the distribution - - - - - stdev - - - The shape parameter of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability density at x or &false; for failure. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-normal.xml b/reference/stats/functions/stats-dens-normal.xml deleted file mode 100644 index 8053d8e3fa75..000000000000 --- a/reference/stats/functions/stats-dens-normal.xml +++ /dev/null @@ -1,163 +0,0 @@ - - - - - stats_dens_normal - Probability density function of the normal distribution - - - &reftitle.description; - - floatstats_dens_normal - floatx - floatave - floatstdev - - - Returns the probability density at x, where the - random variable follows the normal distribution of which the mean is - ave and the standard deviation is - stdev. - - - - &reftitle.parameters; - - - - x - - - The value at which the probability density is calculated - - - - - ave - - - The mean of the distribution - - - - - stdev - - - The standard deviation of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability density at x or &false; for failure. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-pmf-binomial.xml b/reference/stats/functions/stats-dens-pmf-binomial.xml deleted file mode 100644 index 3f6422c6da44..000000000000 --- a/reference/stats/functions/stats-dens-pmf-binomial.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - stats_dens_pmf_binomial - Probability mass function of the binomial distribution - - - &reftitle.description; - - floatstats_dens_pmf_binomial - floatx - floatn - floatpi - - - Returns the probability mass at x, where the random variable - follows the binomial distribution of which the number of trials is n - and the success rate is pi. - - - - &reftitle.parameters; - - - - x - - - The value at which the probability mass is calculated - - - - - n - - - The number of trials of the distribution - - - - - pi - - - The success rate of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability mass at x or &false; for failure. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-pmf-hypergeometric.xml b/reference/stats/functions/stats-dens-pmf-hypergeometric.xml deleted file mode 100644 index 26867dbac0ae..000000000000 --- a/reference/stats/functions/stats-dens-pmf-hypergeometric.xml +++ /dev/null @@ -1,172 +0,0 @@ - - - - - stats_dens_pmf_hypergeometric - Probability mass function of the hypergeometric distribution - - - &reftitle.description; - - floatstats_dens_pmf_hypergeometric - floatn1 - floatn2 - floatN1 - floatN2 - - - Returns the probability mass at n1, where the random variable - follows the hypergeometric distribution of which the number of failure is - n2, the number of success samples is N1, - and the number of failure samples is N2. - - - - &reftitle.parameters; - - - - n1 - - - The number of success, at which the probability mass is calculated - - - - - n2 - - - The number of failure of the distribution - - - - - N1 - - - The number of success samples of the distribution - - - - - N2 - - - The number of failure samples of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability mass at n1 or &false; for failure. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-pmf-negative-binomial.xml b/reference/stats/functions/stats-dens-pmf-negative-binomial.xml deleted file mode 100644 index 80e1c5c58119..000000000000 --- a/reference/stats/functions/stats-dens-pmf-negative-binomial.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - - stats_dens_pmf_negative_binomial - Probability mass function of the negative binomial distribution - - - - &reftitle.description; - - floatstats_dens_pmf_negative_binomial - floatx - floatn - floatpi - - - Returns the probability mass at x, where the - random variable follows the negative binomial distribution of which - the number of the success is n and the success - rate is pi. - - - - - &reftitle.parameters; - - - - x - - - The value at which the probability mass is calculated - - - - - n - - - The number of the success of the distribution - - - - - pi - - - The success rate of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability mass at x or &false; for failure. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-pmf-poisson.xml b/reference/stats/functions/stats-dens-pmf-poisson.xml deleted file mode 100644 index 633aee3c8ff0..000000000000 --- a/reference/stats/functions/stats-dens-pmf-poisson.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - stats_dens_pmf_poisson - Probability mass function of the Poisson distribution - - - &reftitle.description; - - floatstats_dens_pmf_poisson - floatx - floatlb - - - Returns the probability mass at x, where the random variable - follows the Poisson distribution whose parameter is lb. - - - - &reftitle.parameters; - - - - x - - - The value at which the probability mass is calculated - - - - - lb - - - The parameter of the Poisson distribution - - - - - - - - - &reftitle.returnvalues; - - The probability mass at x or &false; for failure. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-t.xml b/reference/stats/functions/stats-dens-t.xml deleted file mode 100644 index 1f5415b7e6f8..000000000000 --- a/reference/stats/functions/stats-dens-t.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - stats_dens_t - Probability density function of the t-distribution - - - &reftitle.description; - - floatstats_dens_t - floatx - floatdfr - - - Returns the probability density at x, where the - random variable follows the t-distribution of which the degree of - freedom is dfr. - - - - &reftitle.parameters; - - - - x - - - The value at which the probability density is calculated - - - - - dfr - - - The degree of freedom of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability density at x or &false; for failure. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-uniform.xml b/reference/stats/functions/stats-dens-uniform.xml deleted file mode 100644 index 27aabb0943cf..000000000000 --- a/reference/stats/functions/stats-dens-uniform.xml +++ /dev/null @@ -1,161 +0,0 @@ - - - - - - stats_dens_uniform - Probability density function of the uniform distribution - - - - &reftitle.description; - - floatstats_dens_uniform - floatx - floata - floatb - - - Returns the probability density at x, where the - random variable follows the uniform distribution of which the lower bound is - a and the upper bound is b. - - - - - &reftitle.parameters; - - - - x - - - The value at which the probability density is calculated - - - - - a - - - The lower bound of the distribution - - - - - b - - - The upper bound of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability density at x or &false; for failure. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-dens-weibull.xml b/reference/stats/functions/stats-dens-weibull.xml deleted file mode 100644 index d71b612d1b55..000000000000 --- a/reference/stats/functions/stats-dens-weibull.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - stats_dens_weibull - Probability density function of the Weibull distribution - - - &reftitle.description; - - floatstats_dens_weibull - floatx - floata - floatb - - - Returns the probability density at x, where the - random variable follows the Weibull distribution of which the shape parameter - is a and the scale parameter is b. - - - - &reftitle.parameters; - - - - x - - - The value at which the probability density is calculated - - - - - a - - - The shape parameter of the distribution - - - - - b - - - The scale parameter of the distribution - - - - - - - - - &reftitle.returnvalues; - - The probability density at x or &false; for failure. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-harmonic-mean.xml b/reference/stats/functions/stats-harmonic-mean.xml deleted file mode 100644 index 1327fbd1973f..000000000000 --- a/reference/stats/functions/stats-harmonic-mean.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - stats_harmonic_mean - Returns the harmonic mean of an array of values - - - &reftitle.description; - - numberstats_harmonic_mean - arraya - - - Returns the harmonic mean of the values in a. - - - - &reftitle.parameters; - - - - a - - - The input array - - - - - - - - - &reftitle.returnvalues; - - Returns the harmonic mean of the values in a, - or &false; if a is empty or is not an array. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-kurtosis.xml b/reference/stats/functions/stats-kurtosis.xml deleted file mode 100644 index 47b7d4265440..000000000000 --- a/reference/stats/functions/stats-kurtosis.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - stats_kurtosis - Computes the kurtosis of the data in the array - - - &reftitle.description; - - floatstats_kurtosis - arraya - - - Returns the kurtosis of the values in a. - - - - &reftitle.parameters; - - - - a - - - The input array - - - - - - - - - &reftitle.returnvalues; - - Returns the kurtosis of the values in a, - or &false; if a is empty or is not an array. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-beta.xml b/reference/stats/functions/stats-rand-gen-beta.xml deleted file mode 100644 index 5d5405b65319..000000000000 --- a/reference/stats/functions/stats-rand-gen-beta.xml +++ /dev/null @@ -1,154 +0,0 @@ - - - - - stats_rand_gen_beta - Generates a random deviate from the beta distribution - - - &reftitle.description; - - floatstats_rand_gen_beta - floata - floatb - - - Returns a random deviate from the beta distribution with parameters A and - B. The density of the beta is x^(a-1) * (1-x)^(b-1) / B(a,b) for 0 < x - <. Method R. C. H. Cheng. - - - - - &reftitle.parameters; - - - - a - - - The shape parameter of the beta distribution - - - - - b - - - The shape parameter of the beta distribution - - - - - - - - - &reftitle.returnvalues; - - A random deviate - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-chisquare.xml b/reference/stats/functions/stats-rand-gen-chisquare.xml deleted file mode 100644 index 372b57b7a548..000000000000 --- a/reference/stats/functions/stats-rand-gen-chisquare.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - stats_rand_gen_chisquare - Generates a random deviate from the chi-square distribution - - - &reftitle.description; - - floatstats_rand_gen_chisquare - floatdf - - - Returns a random deviate from the chi-square distribution where the degrees of - freedom is df. - - - - &reftitle.parameters; - - - - df - - - The degrees of freedom - - - - - - - - - &reftitle.returnvalues; - - A random deviate - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-exponential.xml b/reference/stats/functions/stats-rand-gen-exponential.xml deleted file mode 100644 index 88d58536cdae..000000000000 --- a/reference/stats/functions/stats-rand-gen-exponential.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - stats_rand_gen_exponential - Generates a random deviate from the exponential distribution - - - &reftitle.description; - - floatstats_rand_gen_exponential - floatav - - - Returns a random deviate from the exponential distribution of which the scale is - av. - - - - &reftitle.parameters; - - - - av - - - The scale parameter - - - - - - - - - &reftitle.returnvalues; - - A random deviate - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-f.xml b/reference/stats/functions/stats-rand-gen-f.xml deleted file mode 100644 index 0574db6aae45..000000000000 --- a/reference/stats/functions/stats-rand-gen-f.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - stats_rand_gen_f - Generates a random deviate from the F distribution - - - &reftitle.description; - - floatstats_rand_gen_f - floatdfn - floatdfd - - - Generates a random deviate from the F (variance ratio) distribution with - "dfn" degrees of freedom in the numerator and "dfd" degrees of freedom in - the denominator. Method : directly generates ratio of chisquare variates. - - - - &reftitle.parameters; - - - - dfn - - - The degrees of freedom in the numerator - - - - - dfd - - - The degrees of freedom in the denominator - - - - - - - - - &reftitle.returnvalues; - - A random deviate - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-funiform.xml b/reference/stats/functions/stats-rand-gen-funiform.xml deleted file mode 100644 index 087da301cd95..000000000000 --- a/reference/stats/functions/stats-rand-gen-funiform.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - stats_rand_gen_funiform - Generates uniform float between low (exclusive) and high (exclusive) - - - &reftitle.description; - - floatstats_rand_gen_funiform - floatlow - floathigh - - - Returns a random deviate from the uniform distribution from - low to high. - - - - &reftitle.parameters; - - - - low - - - The lower bound (inclusive) - - - - - high - - - The upper bound (exclusive) - - - - - - - - - &reftitle.returnvalues; - - A random deviate - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-gamma.xml b/reference/stats/functions/stats-rand-gen-gamma.xml deleted file mode 100644 index 85523b087dcb..000000000000 --- a/reference/stats/functions/stats-rand-gen-gamma.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - stats_rand_gen_gamma - Generates a random deviate from the gamma distribution - - - &reftitle.description; - - floatstats_rand_gen_gamma - floata - floatr - - - Generates a random deviate from the gamma distribution whose density is - (A**R)/Gamma(R) * X**(R-1) * Exp(-A*X). - - - - - &reftitle.parameters; - - - - a - - - location parameter of Gamma distribution (a - > 0). - - - - - r - - - shape parameter of Gamma distribution (r > - 0). - - - - - - - - &reftitle.returnvalues; - - A random deviate - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-ibinomial-negative.xml b/reference/stats/functions/stats-rand-gen-ibinomial-negative.xml deleted file mode 100644 index ac7edfee03ee..000000000000 --- a/reference/stats/functions/stats-rand-gen-ibinomial-negative.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - stats_rand_gen_ibinomial_negative - Generates a random deviate from the negative binomial distribution - - - &reftitle.description; - - intstats_rand_gen_ibinomial_negative - intn - floatp - - - Returns a random deviate from a negative binomial distribution where the number of success is - n and the success rate is p. - - - - &reftitle.parameters; - - - - n - - - The number of success - - - - - p - - - The success rate - - - - - - - - - &reftitle.returnvalues; - - A random deviate, which is the number of failure. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-ibinomial.xml b/reference/stats/functions/stats-rand-gen-ibinomial.xml deleted file mode 100644 index 348d4e933864..000000000000 --- a/reference/stats/functions/stats-rand-gen-ibinomial.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - stats_rand_gen_ibinomial - Generates a random deviate from the binomial distribution - - - &reftitle.description; - - intstats_rand_gen_ibinomial - intn - floatpp - - - Returns a random deviate from the binomial distribution whose number of trials is n - and whose probability of an event in each trial is pp. - - - - &reftitle.parameters; - - - - n - - - The number of trials - - - - - pp - - - The probability of an event in each trial - - - - - - - - - &reftitle.returnvalues; - - A random deviate - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-int.xml b/reference/stats/functions/stats-rand-gen-int.xml deleted file mode 100644 index 28aefa057408..000000000000 --- a/reference/stats/functions/stats-rand-gen-int.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - stats_rand_gen_int - Generates random integer between 1 and 2147483562 - - - &reftitle.description; - - intstats_rand_gen_int - - - - Returns a random integer between 1 and 2147483562 - - - - - - - &reftitle.returnvalues; - - A random integer - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-ipoisson.xml b/reference/stats/functions/stats-rand-gen-ipoisson.xml deleted file mode 100644 index 087ff4806fdd..000000000000 --- a/reference/stats/functions/stats-rand-gen-ipoisson.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - stats_rand_gen_ipoisson - Generates a single random deviate from a Poisson distribution - - - &reftitle.description; - - intstats_rand_gen_ipoisson - floatmu - - - Returns a random deviate from the Poisson distribution with parameter mu. - - - - &reftitle.parameters; - - - - mu - - - The parameter of the Poisson distribution - - - - - - - - - &reftitle.returnvalues; - - A random deviate - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-iuniform.xml b/reference/stats/functions/stats-rand-gen-iuniform.xml deleted file mode 100644 index b676c1196f11..000000000000 --- a/reference/stats/functions/stats-rand-gen-iuniform.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - stats_rand_gen_iuniform - Generates integer uniformly distributed between LOW (inclusive) and HIGH (inclusive) - - - &reftitle.description; - - intstats_rand_gen_iuniform - intlow - inthigh - - - Returns a random integer from the discrete uniform distribution between low (inclusive) - and high (inclusive). - - - - &reftitle.parameters; - - - - low - - - The lower bound - - - - - high - - - The upper bound - - - - - - - - - &reftitle.returnvalues; - - A random integer - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-noncentral-chisquare.xml b/reference/stats/functions/stats-rand-gen-noncentral-chisquare.xml deleted file mode 100644 index a9ef7c83da89..000000000000 --- a/reference/stats/functions/stats-rand-gen-noncentral-chisquare.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - - stats_rand_gen_noncentral_chisquare - Generates a random deviate from the non-central chi-square distribution - - - - &reftitle.description; - - floatstats_rand_gen_noncentral_chisquare - floatdf - floatxnonc - - - Returns a random deviate from the non-central chi-square distribution with degrees of freedom, - df, and non-centrality parameter, xnonc. - - - - - &reftitle.parameters; - - - - df - - - The degrees of freedom - - - - - xnonc - - - The non-centrality parameter - - - - - - - - - &reftitle.returnvalues; - - A random deviate - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-noncentral-f.xml b/reference/stats/functions/stats-rand-gen-noncentral-f.xml deleted file mode 100644 index de5e2cc63291..000000000000 --- a/reference/stats/functions/stats-rand-gen-noncentral-f.xml +++ /dev/null @@ -1,162 +0,0 @@ - - - - - stats_rand_gen_noncentral_f - Generates a random deviate from the noncentral F distribution - - - &reftitle.description; - - floatstats_rand_gen_noncentral_f - floatdfn - floatdfd - floatxnonc - - - Returns a random deviate from the non-central F distribution where the degrees of freedoms are - dfn (numerator) and dfd (denominator), and the non-centrality - parameter is xnonc. - - - - &reftitle.parameters; - - - - dfn - - - The degrees of freedom of the numerator - - - - - dfd - - - The degrees of freedom of the denominator - - - - - xnonc - - - The non-centrality parameter - - - - - - - - - &reftitle.returnvalues; - - A random deviate - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-noncentral-t.xml b/reference/stats/functions/stats-rand-gen-noncentral-t.xml deleted file mode 100644 index ede7d12f2b8d..000000000000 --- a/reference/stats/functions/stats-rand-gen-noncentral-t.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - stats_rand_gen_noncentral_t - Generates a single random deviate from a non-central t-distribution - - - &reftitle.description; - - floatstats_rand_gen_noncentral_t - floatdf - floatxnonc - - - Returns a random deviate from the non-central t-distribution with the degrees of freedom, - df, and the non-centrality parameter, xnonc. - - - - &reftitle.parameters; - - - - df - - - The degrees of freedom - - - - - xnonc - - - The non-centrality parameter - - - - - - - - - &reftitle.returnvalues; - - A random deviate - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-normal.xml b/reference/stats/functions/stats-rand-gen-normal.xml deleted file mode 100644 index 5853e8ec6cc8..000000000000 --- a/reference/stats/functions/stats-rand-gen-normal.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - stats_rand_gen_normal - Generates a single random deviate from a normal distribution - - - &reftitle.description; - - floatstats_rand_gen_normal - floatav - floatsd - - - Returns a random deviate from the normal distribution with mean, av, and standard deviation, - sd. - - - - &reftitle.parameters; - - - - av - - - The mean of the normal distribution - - - - - sd - - - The standard deviation of the normal distribution - - - - - - - - - &reftitle.returnvalues; - - A random deviate - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-gen-t.xml b/reference/stats/functions/stats-rand-gen-t.xml deleted file mode 100644 index 3294ece5f8a3..000000000000 --- a/reference/stats/functions/stats-rand-gen-t.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - stats_rand_gen_t - Generates a single random deviate from a t-distribution - - - &reftitle.description; - - floatstats_rand_gen_t - floatdf - - - Returns a random deviate from the t-distribution with the degrees of freedom, df. - - - - &reftitle.parameters; - - - - df - - - The degrees of freedom - - - - - - - - - &reftitle.returnvalues; - - A random deviate - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-get-seeds.xml b/reference/stats/functions/stats-rand-get-seeds.xml deleted file mode 100644 index 488129a5e9f5..000000000000 --- a/reference/stats/functions/stats-rand-get-seeds.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - stats_rand_get_seeds - Get the seed values of the random number generator - - - &reftitle.description; - - arraystats_rand_get_seeds - - - - Returns the current seed values of the random number generator - - - - - - &reftitle.returnvalues; - - Returns an array of two integers. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-phrase-to-seeds.xml b/reference/stats/functions/stats-rand-phrase-to-seeds.xml deleted file mode 100644 index f15b1abefdd6..000000000000 --- a/reference/stats/functions/stats-rand-phrase-to-seeds.xml +++ /dev/null @@ -1,142 +0,0 @@ - - - - - stats_rand_phrase_to_seeds - Generate two seeds for the RGN random number generator - - - &reftitle.description; - - arraystats_rand_phrase_to_seeds - stringphrase - - - Generate two seeds for the random number generator from a phrase. - - - - &reftitle.parameters; - - - - phrase - - - The input phrase - - - - - - - - - &reftitle.returnvalues; - - Returns an array of two integers. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-ranf.xml b/reference/stats/functions/stats-rand-ranf.xml deleted file mode 100644 index 13b4720ecdc7..000000000000 --- a/reference/stats/functions/stats-rand-ranf.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - stats_rand_ranf - Generates a random floating point number between 0 and 1 - - - &reftitle.description; - - floatstats_rand_ranf - - - - Returns a random floating point number from a uniform distribution between 0 (exclusive) and 1 (exclusive). - - - - - - - &reftitle.returnvalues; - - A random floating point number - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-rand-setall.xml b/reference/stats/functions/stats-rand-setall.xml deleted file mode 100644 index dcdf15030b3e..000000000000 --- a/reference/stats/functions/stats-rand-setall.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - stats_rand_setall - Set seed values to the random generator - - - &reftitle.description; - - voidstats_rand_setall - intiseed1 - intiseed2 - - - Set iseed1 and iseed2 as seed values to the random generator - used in statistic functions. - - - - &reftitle.parameters; - - - - iseed1 - - - The value which is used as the random seed - - - - - iseed2 - - - The value which is used as the random seed - - - - - - - - - &reftitle.returnvalues; - - No values are returned. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-skew.xml b/reference/stats/functions/stats-skew.xml deleted file mode 100644 index 2180f4b2ef8b..000000000000 --- a/reference/stats/functions/stats-skew.xml +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - stats_skew - Computes the skewness of the data in the array - - - &reftitle.description; - - floatstats_skew - arraya - - - Returns the skewness of the values in a. - - - - &reftitle.parameters; - - - - a - - - The input array - - - - - - - - - &reftitle.returnvalues; - - Returns the skewness of the values in a, - or &false; if a is empty or is not an array. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-standard-deviation.xml b/reference/stats/functions/stats-standard-deviation.xml deleted file mode 100644 index f58c68a05cdc..000000000000 --- a/reference/stats/functions/stats-standard-deviation.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - stats_standard_deviation - Returns the standard deviation - - - &reftitle.description; - - floatstats_standard_deviation - arraya - boolsample&false; - - - Returns the standard deviation of the values in a. - - - - &reftitle.parameters; - - - - a - - - The array of data to find the standard deviation for. Note that all - values of the array will be cast to float. - - - - - sample - - - Indicates if a represents a sample of the - population; defaults to &false;. - - - - - - - - - &reftitle.returnvalues; - - Returns the standard deviation on success; &false; on failure. - - - - - &reftitle.errors; - - Raises an E_WARNING when there are fewer than 2 - values in a. - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-stat-binomial-coef.xml b/reference/stats/functions/stats-stat-binomial-coef.xml deleted file mode 100644 index 94f5f7171e3e..000000000000 --- a/reference/stats/functions/stats-stat-binomial-coef.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - stats_stat_binomial_coef - Returns a binomial coefficient - - - &reftitle.description; - - floatstats_stat_binomial_coef - intx - intn - - - Returns the binomial coefficient of n choose x. - - - - &reftitle.parameters; - - - - x - - - The number of chooses from the set - - - - - n - - - The number of elements in the set - - - - - - - - - &reftitle.returnvalues; - - Returns the binomial coefficient - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-stat-correlation.xml b/reference/stats/functions/stats-stat-correlation.xml deleted file mode 100644 index 20bbf43c9fc9..000000000000 --- a/reference/stats/functions/stats-stat-correlation.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - stats_stat_correlation - Returns the Pearson correlation coefficient of two data sets - - - &reftitle.description; - - floatstats_stat_correlation - arrayarr1 - arrayarr2 - - - Returns the Pearson correlation coefficient between arr1 and arr2. - - - - &reftitle.parameters; - - - - arr1 - - - The first array - - - - - arr2 - - - The second array - - - - - - - - - &reftitle.returnvalues; - - Returns the Pearson correlation coefficient between arr1 and arr2, - or &false; on failure. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-stat-factorial.xml b/reference/stats/functions/stats-stat-factorial.xml deleted file mode 100644 index f3bb459a1863..000000000000 --- a/reference/stats/functions/stats-stat-factorial.xml +++ /dev/null @@ -1,139 +0,0 @@ - - - - - - stats_stat_factorial - Returns the factorial of an integer - - - - &reftitle.description; - - floatstats_stat_factorial - intn - - - Returns the factorial of an integer, n. - - - - - &reftitle.parameters; - - - n - - - An integer - - - - - - - - &reftitle.returnvalues; - - The factorial of n. - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-stat-independent-t.xml b/reference/stats/functions/stats-stat-independent-t.xml deleted file mode 100644 index 4ac049fff4a1..000000000000 --- a/reference/stats/functions/stats-stat-independent-t.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - - - stats_stat_independent_t - Returns the t-value from the independent two-sample t-test - - - &reftitle.description; - - floatstats_stat_independent_t - arrayarr1 - arrayarr2 - - - Returns the t-value of the independent two-sample t-test between - arr1 and arr2. - - &warn.undocumented.func; - - - - &reftitle.parameters; - - - - arr1 - - - The first set of values - - - - - arr2 - - - The second set of values - - - - - - - - - &reftitle.returnvalues; - - Returns the t-value, or &false; if failure. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-stat-innerproduct.xml b/reference/stats/functions/stats-stat-innerproduct.xml deleted file mode 100644 index cbfe91f099c8..000000000000 --- a/reference/stats/functions/stats-stat-innerproduct.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - stats_stat_innerproduct - Returns the inner product of two vectors - - - &reftitle.description; - - floatstats_stat_innerproduct - arrayarr1 - arrayarr2 - - - Returns the inner product of arr1 and arr2. - - - - &reftitle.parameters; - - - - arr1 - - - The first array - - - - - arr2 - - - The second array - - - - - - - - - &reftitle.returnvalues; - - Returns the inner product of arr1 and arr2, - or &false; on failure. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-stat-paired-t.xml b/reference/stats/functions/stats-stat-paired-t.xml deleted file mode 100644 index b4a0e028732d..000000000000 --- a/reference/stats/functions/stats-stat-paired-t.xml +++ /dev/null @@ -1,152 +0,0 @@ - - - - - stats_stat_paired_t - Returns the t-value of the dependent t-test for paired samples - - - &reftitle.description; - - floatstats_stat_paired_t - arrayarr1 - arrayarr2 - - - Returns the t-value of the dependent t-test for paired samples - arr1 and arr2. - - - - &reftitle.parameters; - - - - arr1 - - - The first samples - - - - - arr2 - - - The second samples - - - - - - - - - &reftitle.returnvalues; - - Returns the t-value, or &false; if failure. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-stat-percentile.xml b/reference/stats/functions/stats-stat-percentile.xml deleted file mode 100644 index 35901a186d39..000000000000 --- a/reference/stats/functions/stats-stat-percentile.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - stats_stat_percentile - Returns the percentile value - - - &reftitle.description; - - floatstats_stat_percentile - arrayarr - floatperc - - - Returns the perc-th percentile value of the array arr. - - - - &reftitle.parameters; - - - - arr - - - The input array - - - - - perc - - - The percentile - - - - - - - - - &reftitle.returnvalues; - - Returns the percentile values of the input array. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-stat-powersum.xml b/reference/stats/functions/stats-stat-powersum.xml deleted file mode 100644 index 29f1d83a5a34..000000000000 --- a/reference/stats/functions/stats-stat-powersum.xml +++ /dev/null @@ -1,151 +0,0 @@ - - - - - stats_stat_powersum - Returns the power sum of a vector - - - &reftitle.description; - - floatstats_stat_powersum - arrayarr - floatpower - - - Returns the sum of the power-th power of a vector represented as an array arr. - - - - &reftitle.parameters; - - - - arr - - - The input array - - - - - power - - - The power - - - - - - - - - &reftitle.returnvalues; - - Returns the power sum of the input array. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/functions/stats-variance.xml b/reference/stats/functions/stats-variance.xml deleted file mode 100644 index 8d28e43b1b30..000000000000 --- a/reference/stats/functions/stats-variance.xml +++ /dev/null @@ -1,153 +0,0 @@ - - - - - stats_variance - Returns the variance - - - &reftitle.description; - - floatstats_variance - arraya - boolsample&false; - - - Returns the variance of the values in a. - - - - &reftitle.parameters; - - - - a - - - The array of data to find the standard deviation for. Note that all - values of the array will be cast to float. - - - - - sample - - - Indicates if a represents a sample of the - population; defaults to &false;. - - - - - - - - - &reftitle.returnvalues; - - Returns the variance on success; &false; on failure. - - - - - - - - - - - - - - - - - - diff --git a/reference/stats/reference.xml b/reference/stats/reference.xml deleted file mode 100644 index 03288799321d..000000000000 --- a/reference/stats/reference.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - Statistic &Functions; - - &reference.stats.entities.functions; - - - - diff --git a/reference/stats/setup.xml b/reference/stats/setup.xml deleted file mode 100644 index f95bf8a3371a..000000000000 --- a/reference/stats/setup.xml +++ /dev/null @@ -1,68 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - No external libraries are needed. The extension comes bundled with the libraries used. - -
    - - - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;stats. - - - &pecl.windows.download; - -
    - - - -
    - &reftitle.runtime; - &no.config; -
    - - - -
    - &reftitle.resources; - &no.resource; -
    - - -     - - - diff --git a/reference/stats/versions.xml b/reference/stats/versions.xml deleted file mode 100644 index b5540ec717cd..000000000000 --- a/reference/stats/versions.xml +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/stream/functions/set-socket-blocking.xml b/reference/stream/functions/set-socket-blocking.xml deleted file mode 100644 index 02fde2a86284..000000000000 --- a/reference/stream/functions/set-socket-blocking.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - set_socket_blocking - &Alias; stream_set_blocking - - - - &warn.deprecated.alias-5-3-0.removed-7-0-0; - - - - &reftitle.description; - - &info.function.alias; - stream_set_blocking - - - - - diff --git a/reference/stream/functions/stream-context-create.xml b/reference/stream/functions/stream-context-create.xml index a758352bb5ab..9e97278b8342 100644 --- a/reference/stream/functions/stream-context-create.xml +++ b/reference/stream/functions/stream-context-create.xml @@ -56,30 +56,6 @@     - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - Added the optional params argument. - - - - - - - - &reftitle.examples; diff --git a/reference/stream/functions/stream-copy-to-stream.xml b/reference/stream/functions/stream-copy-to-stream.xml index c4e7540595b8..e1be45e04918 100644 --- a/reference/stream/functions/stream-copy-to-stream.xml +++ b/reference/stream/functions/stream-copy-to-stream.xml @@ -71,30 +71,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.0 - - Added the offset parameter - - - - - - - - &reftitle.examples; diff --git a/reference/stream/functions/stream-filter-append.xml b/reference/stream/functions/stream-filter-append.xml index d81975ac2a71..e0e3a2aa7ae8 100644 --- a/reference/stream/functions/stream-filter-append.xml +++ b/reference/stream/functions/stream-filter-append.xml @@ -88,31 +88,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.0 - - Prior to PHP 5.1.0, this function returns &true; on success - &return.falseforfailure;. - - - - - - - - &reftitle.examples; diff --git a/reference/stream/functions/stream-filter-prepend.xml b/reference/stream/functions/stream-filter-prepend.xml index 31606a96bdad..01253f6341d3 100644 --- a/reference/stream/functions/stream-filter-prepend.xml +++ b/reference/stream/functions/stream-filter-prepend.xml @@ -89,31 +89,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.0 - - Prior to PHP 5.1.0, this function returns &true; on success - &return.falseforfailure;. - - - - - - - - &reftitle.notes; diff --git a/reference/stream/functions/stream-get-contents.xml b/reference/stream/functions/stream-get-contents.xml index 5ec4598f37ec..45b1145d3254 100644 --- a/reference/stream/functions/stream-get-contents.xml +++ b/reference/stream/functions/stream-get-contents.xml @@ -63,30 +63,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.0 - - The offset was added. - - - - - - - - &reftitle.examples; diff --git a/reference/stream/functions/stream-socket-pair.xml b/reference/stream/functions/stream-socket-pair.xml index 2dd936a2395d..41a880d13cf6 100644 --- a/reference/stream/functions/stream-socket-pair.xml +++ b/reference/stream/functions/stream-socket-pair.xml @@ -79,30 +79,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - This function is now available on Windows platforms. - - - - - - - - &reftitle.examples; diff --git a/reference/stream/functions/stream-wrapper-register.xml b/reference/stream/functions/stream-wrapper-register.xml index 2605ae69c81f..8435d2b5327f 100644 --- a/reference/stream/functions/stream-wrapper-register.xml +++ b/reference/stream/functions/stream-wrapper-register.xml @@ -65,31 +65,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.4 - - Added the flags parameter. - - - - - - - - - &reftitle.examples; diff --git a/reference/stream/versions.xml b/reference/stream/versions.xml index a99e7a0c5dff..a96532e2c778 100644 --- a/reference/stream/versions.xml +++ b/reference/stream/versions.xml @@ -4,7 +4,6 @@ Do NOT translate this file --> - diff --git a/reference/strings/functions/addcslashes.xml b/reference/strings/functions/addcslashes.xml index 078d4fc97048..e28cc1971f04 100644 --- a/reference/strings/functions/addcslashes.xml +++ b/reference/strings/functions/addcslashes.xml @@ -96,30 +96,6 @@ echo addcslashes("zoo['.']", 'z..A'); - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.5 - - The escape sequences \v and \f were added. - - - - - - - - &reftitle.examples; diff --git a/reference/strings/functions/crypt.xml b/reference/strings/functions/crypt.xml index 0930cb917758..897e139b80db 100644 --- a/reference/strings/functions/crypt.xml +++ b/reference/strings/functions/crypt.xml @@ -169,77 +169,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.6.5 - - When the failure string "*0" is given as the - salt, "*1" will now be returned for consistency - with other crypt implementations. Prior to this version, PHP 5.6 would - incorrectly return a DES hash. - - - - 5.6.0 - - Raise E_NOTICE security warning if salt is omitted. - - - - 5.5.21 - - When the failure string "*0" is given as the - salt, "*1" will now be returned for consistency - with other crypt implementations. Prior to this version, PHP 5.5 (and - earlier branches) would incorrectly return a DES hash. - - - - 5.3.7 - - Added $2x$ and $2y$ Blowfish - modes to deal with potential high-bit attacks. - - - - 5.3.2 - - Added SHA-256 and SHA-512 crypt based on Ulrich Drepper's - implementation. - - - - 5.3.2 - - Fixed Blowfish behaviour on invalid rounds to return "failure" - string ("*0" or "*1"), instead of falling back to DES. - - - - 5.3.0 - - PHP now contains its own implementation for the MD5 crypt, Standard DES, - Extended DES and the Blowfish algorithms and will use that if the system - lacks of support for one or more of the algorithms. - - - - - - - - &reftitle.examples; diff --git a/reference/strings/functions/explode.xml b/reference/strings/functions/explode.xml index 2c44d3bdc221..1259b34a61f6 100644 --- a/reference/strings/functions/explode.xml +++ b/reference/strings/functions/explode.xml @@ -89,30 +89,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.0 - - Support for negative limits was added - - - - - - - - &reftitle.examples; diff --git a/reference/strings/functions/get-html-translation-table.xml b/reference/strings/functions/get-html-translation-table.xml index f4b195023646..2c38acea0889 100644 --- a/reference/strings/functions/get-html-translation-table.xml +++ b/reference/strings/functions/get-html-translation-table.xml @@ -119,44 +119,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - The default value for the encoding parameter was - changed to UTF-8. - - - - 5.4.0 - - The constants ENT_HTML401, ENT_XML1, - ENT_XHTML and ENT_HTML5 were added. - - - - 5.3.4 - - The encoding parameter was added. - - - - - - - - &reftitle.examples; diff --git a/reference/strings/functions/hex2bin.xml b/reference/strings/functions/hex2bin.xml index 21fc1c61c682..13b45344278f 100644 --- a/reference/strings/functions/hex2bin.xml +++ b/reference/strings/functions/hex2bin.xml @@ -53,37 +53,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.5.1 - - A warning is thrown if the input string is invalid hexadecimal string. - - - - 5.4.4 - - A warning is thrown if the input string is of odd length. In PHP 5.4.0 the string - was silently accepted, but the last byte was truncated. - - - - - - - - &reftitle.examples; diff --git a/reference/strings/functions/html-entity-decode.xml b/reference/strings/functions/html-entity-decode.xml index 05924265b409..037ca048b853 100644 --- a/reference/strings/functions/html-entity-decode.xml +++ b/reference/strings/functions/html-entity-decode.xml @@ -117,38 +117,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - &strings.changelog.encoding; - - 5.4.0 - - Default encoding changed from ISO-8859-1 to UTF-8. - - - - 5.4.0 - - The constants ENT_HTML401, ENT_XML1, - ENT_XHTML and ENT_HTML5 were added. - - - - - - - - &reftitle.examples; diff --git a/reference/strings/functions/htmlentities.xml b/reference/strings/functions/htmlentities.xml index 6cfb8bb85f7b..d9d2f565cb7d 100644 --- a/reference/strings/functions/htmlentities.xml +++ b/reference/strings/functions/htmlentities.xml @@ -155,52 +155,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - &strings.changelog.encoding; - - 5.4.0 - - The default value for the encoding parameter was - changed to UTF-8. - - - - 5.4.0 - - The constants ENT_SUBSTITUTE, ENT_DISALLOWED, - ENT_HTML401, ENT_XML1, - ENT_XHTML and ENT_HTML5 were added. - - - - 5.3.0 - - The constant ENT_IGNORE was added. - - - - 5.2.3 - - The double_encode parameter was added. - - - - - - - - &reftitle.examples; diff --git a/reference/strings/functions/htmlspecialchars-decode.xml b/reference/strings/functions/htmlspecialchars-decode.xml index ab0b445fccf9..bb4a269dc8b7 100644 --- a/reference/strings/functions/htmlspecialchars-decode.xml +++ b/reference/strings/functions/htmlspecialchars-decode.xml @@ -108,31 +108,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - The constants ENT_HTML401, ENT_XML1, - ENT_XHTML and ENT_HTML5 were added. - - - - - - - - &reftitle.examples; diff --git a/reference/strings/functions/htmlspecialchars.xml b/reference/strings/functions/htmlspecialchars.xml index af1292889324..4577ab919cd6 100644 --- a/reference/strings/functions/htmlspecialchars.xml +++ b/reference/strings/functions/htmlspecialchars.xml @@ -214,52 +214,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - &strings.changelog.encoding; - - 5.4.0 - - The default value for the encoding parameter was - changed to UTF-8. - - - - 5.4.0 - - The constants ENT_SUBSTITUTE, ENT_DISALLOWED, - ENT_HTML401, ENT_XML1, - ENT_XHTML and ENT_HTML5 were added. - - - - 5.3.0 - - The constant ENT_IGNORE was added. - - - - 5.2.3 - - The double_encode parameter was added. - - - - - - - - &reftitle.examples; diff --git a/reference/strings/functions/md5-file.xml b/reference/strings/functions/md5-file.xml index 56a1d1129a7a..b709ac6acd57 100644 --- a/reference/strings/functions/md5-file.xml +++ b/reference/strings/functions/md5-file.xml @@ -54,31 +54,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.0 - - Changed the function to use the streams API. It means that you can use - it with wrappers, like md5_file('http://example.com/..') - - - - - - - - &reftitle.examples; diff --git a/reference/strings/functions/nl2br.xml b/reference/strings/functions/nl2br.xml index 3f3de4a31c56..76d7b36ae4cf 100644 --- a/reference/strings/functions/nl2br.xml +++ b/reference/strings/functions/nl2br.xml @@ -111,31 +111,6 @@ string
         - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - Added the optional is_xhtml parameter. Before - this version '<br />' was always inserted. - - - - - - - - &reftitle.seealso; diff --git a/reference/strings/functions/number-format.xml b/reference/strings/functions/number-format.xml index 444ad6904dbc..b2a6841089df 100644 --- a/reference/strings/functions/number-format.xml +++ b/reference/strings/functions/number-format.xml @@ -110,15 +110,6 @@ for cases like where number would be -0.01. - - 5.4.0 - - This function now supports multiple bytes in - dec_point and - thousands_sep. Only the first byte of each - separator was used in older versions. - - diff --git a/reference/strings/functions/setlocale.xml b/reference/strings/functions/setlocale.xml index 5b1e83fe6fe5..3bbfd6f48d28 100644 --- a/reference/strings/functions/setlocale.xml +++ b/reference/strings/functions/setlocale.xml @@ -155,39 +155,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 7.0.0 - - Support for the category parameter passed as a string has - been removed. Only LC_* constants can be used as of this version. - - - - 5.3.0 - - This function now throws an E_DEPRECATED notice if a string is passed - to the category parameter instead of one of the - LC_* constants. - - - - - - - - &reftitle.examples; diff --git a/reference/strings/functions/sha1-file.xml b/reference/strings/functions/sha1-file.xml index e9b4e671050d..fbde48398124 100644 --- a/reference/strings/functions/sha1-file.xml +++ b/reference/strings/functions/sha1-file.xml @@ -75,30 +75,6 @@ foreach(glob('/home/Kalle/myproject/*.php') as $ent) - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.0 - - Changed the function to use the streams API. It means that you can use - it with wrappers, like sha1_file('http://example.com/..') - - - - - - - &reftitle.seealso; diff --git a/reference/strings/functions/str-word-count.xml b/reference/strings/functions/str-word-count.xml index 5d30a852af72..65b46646805d 100644 --- a/reference/strings/functions/str-word-count.xml +++ b/reference/strings/functions/str-word-count.xml @@ -92,30 +92,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.0 - - Added the charlist parameter - - - - - - - - &reftitle.examples; diff --git a/reference/strings/functions/strip-tags.xml b/reference/strings/functions/strip-tags.xml index c29152796ba1..7f66c7e94e98 100644 --- a/reference/strings/functions/strip-tags.xml +++ b/reference/strings/functions/strip-tags.xml @@ -96,14 +96,6 @@ strip_tags($input, '
    '); The allowable_tags now alternatively accepts an &array;. - - 5.3.4 - - strip_tags ignores self-closing XHTML - tags in - allowable_tags. - - diff --git a/reference/strings/functions/stripslashes.xml b/reference/strings/functions/stripslashes.xml index 053d3dc5bec1..7d2766140c72 100644 --- a/reference/strings/functions/stripslashes.xml +++ b/reference/strings/functions/stripslashes.xml @@ -15,13 +15,6 @@ Un-quotes a quoted string. - - - If magic_quotes_sybase is - on, no backslashes are stripped off but two apostrophes are replaced by - one instead. - - An example use of stripslashes is when the PHP directive magic_quotes_gpc diff --git a/reference/strings/functions/stristr.xml b/reference/strings/functions/stristr.xml index 9f8c8c4fe956..e567e552884e 100644 --- a/reference/strings/functions/stristr.xml +++ b/reference/strings/functions/stristr.xml @@ -64,30 +64,6 @@     - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - Added the optional parameter before_needle. - - - - - - - - &reftitle.examples; diff --git a/reference/strings/functions/strlen.xml b/reference/strings/functions/strlen.xml index 8884cae85404..0946e5ed519b 100644 --- a/reference/strings/functions/strlen.xml +++ b/reference/strings/functions/strlen.xml @@ -41,29 +41,6 @@ - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 5.3.0 - - Prior versions treated arrays as the string Array, thus returning - a string length of 5 and emitting an E_NOTICE level error. - - - - - - - &reftitle.examples; diff --git a/reference/strings/functions/strstr.xml b/reference/strings/functions/strstr.xml index b85422237c1b..a871e4ee2631 100644 --- a/reference/strings/functions/strstr.xml +++ b/reference/strings/functions/strstr.xml @@ -74,30 +74,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - Added the optional parameter before_needle. - - - - - - - - &reftitle.examples; diff --git a/reference/strings/functions/substr-compare.xml b/reference/strings/functions/substr-compare.xml index d0449592c55c..3eac0bf9c44b 100644 --- a/reference/strings/functions/substr-compare.xml +++ b/reference/strings/functions/substr-compare.xml @@ -109,18 +109,6 @@ offset may now be equal to the length of main_str. - - 5.5.11 - - length may now be 0. - - - - 5.1.0 - - Added the possibility to use a negative offset. - - diff --git a/reference/strings/functions/substr-count.xml b/reference/strings/functions/substr-count.xml index 4b3b0923deaf..f72eec566fd1 100644 --- a/reference/strings/functions/substr-count.xml +++ b/reference/strings/functions/substr-count.xml @@ -98,13 +98,6 @@ length may also be 0 now. - - 5.1.0 - - Added the offset and - the length parameters - - diff --git a/reference/strings/functions/substr.xml b/reference/strings/functions/substr.xml index 7e7b588d10af..b5403dd09f62 100644 --- a/reference/strings/functions/substr.xml +++ b/reference/strings/functions/substr.xml @@ -121,40 +121,6 @@ $rest = substr("abcdef", -3, -1); // returns "de" an empty string. - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 7.0.0 - - If string is equal to - start characters long, an empty string will be - returned. Prior to this version, &false; was returned in this case. - - - - 5.2.2 - 5.2.6 - - If the start parameter indicates the position of - a negative truncation or beyond, false is returned. Other versions get - the string from start. - - - - - - - &reftitle.examples; diff --git a/reference/strings/functions/ucwords.xml b/reference/strings/functions/ucwords.xml index af6e0e51a325..2ce6683c3739 100644 --- a/reference/strings/functions/ucwords.xml +++ b/reference/strings/functions/ucwords.xml @@ -57,30 +57,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.32, 5.5.16 - - Added the delimiters parameter. - - - - - - - - &reftitle.examples; diff --git a/reference/swish/Swish/construct.xml b/reference/swish/Swish/construct.xml deleted file mode 100644 index c72c3d3acec8..000000000000 --- a/reference/swish/Swish/construct.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - Swish::__construct - Construct a Swish object - - - &reftitle.description; - - voidSwish::__construct - stringindex_names - - &warn.experimental.func; - - - &reftitle.parameters; - - - - index_names - - - The list of index files separated by spaces. - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.errors; - - Throws SwishException on error. - - - - &reftitle.examples; - - - A <function>Swish::__construct</function> example - -getMessage(), "\n"; -} - -foreach ($swish->indexes as $index) { - var_dump($index["name"]); - var_dump($index["headers"]["Total Words"]); -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/swish/Swish/getMetaList.xml b/reference/swish/Swish/getMetaList.xml deleted file mode 100644 index fcb3454c419d..000000000000 --- a/reference/swish/Swish/getMetaList.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - Swish::getMetaList - Get the list of meta entries for the index - - - &reftitle.description; - - arraySwish::getMetaList - stringindex_name - - &warn.experimental.func; - - - &reftitle.parameters; - - - - index_name - - - The name of the index file. - - - - - - - - &reftitle.returnvalues; - - Returns an array of meta entries for the given index. - - - - &reftitle.examples; - - - Basic <function>Swish::getMetaList</function> example - -getMetaList("index.swish-e")); - -} catch (SwishException $e) { - echo $e->getMessage(), "\n"; -} - -?> -]]> - - &example.outputs.similar; - - - array(3) { - ["Name"]=> - string(12) "swishdefault" - ["Type"]=> - int(0) - ["ID"]=> - int(1) - } -} -]]> - - - - - - - - diff --git a/reference/swish/Swish/getPropertyList.xml b/reference/swish/Swish/getPropertyList.xml deleted file mode 100644 index 6e56cb8a464c..000000000000 --- a/reference/swish/Swish/getPropertyList.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - Swish::getPropertyList - Get the list of properties for the index - - - &reftitle.description; - - arraySwish::getPropertyList - stringindex_name - - &warn.experimental.func; - - - &reftitle.parameters; - - - - index_name - - - The name of the index file. - - - - - - - - &reftitle.returnvalues; - - Returns an array of properties for the given index. - - - - &reftitle.examples; - - - Basic <function>Swish::getPropertyList</function> example - -getPropertyList("index.swish-e"); - foreach ($properties as $prop) { - echo $prop["Name"],"\n"; - } - -} catch (SwishException $e) { - echo $e->getMessage(), "\n"; -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/swish/Swish/prepare.xml b/reference/swish/Swish/prepare.xml deleted file mode 100644 index 99d645222a26..000000000000 --- a/reference/swish/Swish/prepare.xml +++ /dev/null @@ -1,106 +0,0 @@ - - - - - Swish::prepare - Prepare a search query - - - &reftitle.description; - - objectSwish::prepare - stringquery - - &warn.experimental.func; - - Prepare and return a search object, which you can later use for unlimited - number of queries. - - - - &reftitle.parameters; - - - - query - - - Optional query string. The query can be also set using - SwishSearch::execute - method. - - - - - - - - &reftitle.returnvalues; - - Returns SwishSearch object. - - - - &reftitle.errors; - - Throws SwishException on error. - - - - &reftitle.examples; - - - Basic <function>Swish::prepare</function> example - -prepare("search query"); - $results = $search->execute(); - echo "Found: ", $results->hits, " hits\n"; - - $results = $search->execute("new search"); - - echo "Found: ", $results->hits, " hits\n"; -} catch (SwishException $e) { - echo $e->getMessage(), "\n"; -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - - diff --git a/reference/swish/Swish/query.xml b/reference/swish/Swish/query.xml deleted file mode 100644 index 0d24564e3a3a..000000000000 --- a/reference/swish/Swish/query.xml +++ /dev/null @@ -1,100 +0,0 @@ - - - - - Swish::query - Execute a query and return results object - - - &reftitle.description; - - objectSwish::query - stringquery - - &warn.experimental.func; - - A quick method to execute a search with default parameters. - - - - &reftitle.parameters; - - - - query - - - Query string. - - - - - - - - &reftitle.returnvalues; - - Returns SwishResults object. - - - - &reftitle.errors; - - Throws SwishException on error. - - - - &reftitle.examples; - - - Basic <function>Swish::query</function> example - -query("test query"); - - echo "Found: ", $results->hits, " hits\n"; - -} catch (SwishException $e) { - echo $e->getMessage(), "\n"; -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/swish/SwishResult/getMetaList.xml b/reference/swish/SwishResult/getMetaList.xml deleted file mode 100644 index 4149e1574449..000000000000 --- a/reference/swish/SwishResult/getMetaList.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - SwishResult::getMetaList - Get a list of meta entries - - - &reftitle.description; - - arraySwishResult::getMetaList - - - &warn.experimental.func; - - - &reftitle.returnvalues; - - Returns the same array as swish::getmetalist, - but uses the index file from the result handle. - - - - - - diff --git a/reference/swish/SwishResult/stem.xml b/reference/swish/SwishResult/stem.xml deleted file mode 100644 index 5b2a725ebf7d..000000000000 --- a/reference/swish/SwishResult/stem.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - SwishResult::stem - Stems the given word - - - &reftitle.description; - - arraySwishResult::stem - stringword - - &warn.experimental.func; - - Stems the word based on the fuzzy mode used during indexing. - Each result object is linked with its index, so the results are based on this index. - - - - &reftitle.parameters; - - - - word - - - The word to stem. - - - - - - - - &reftitle.returnvalues; - - Returns array containing the stemmed word variants (usually just one). - - - - &reftitle.errors; - - Throws SwishException on error. - - - - &reftitle.examples; - - - Basic <function>SwishResult::stem</function> example - -query("testing OR others"); - - if ($result = $results->nextResult()) { - var_dump($result->stem("testing")); //the results fully depend on the stemmer used in the index - var_dump($result->stem("others")); - } - -} catch (SwishException $e) { - echo "Error: ", $e->getMessage(), "\n"; -} - -?> -]]> - - &example.outputs.similar; - - - string(4) "test" -} -array(1) { - [0]=> - string(5) "other" -} -]]> - - - - - - - - diff --git a/reference/swish/SwishResults/getParsedWords.xml b/reference/swish/SwishResults/getParsedWords.xml deleted file mode 100644 index 75df0aaf536b..000000000000 --- a/reference/swish/SwishResults/getParsedWords.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - SwishResults::getParsedWords - Get an array of parsed words - - - &reftitle.description; - - arraySwishResults::getParsedWords - stringindex_name - - &warn.experimental.func; - - - &reftitle.parameters; - - - - indexi_name - - - The name of the index used to initialize Swish - object. - - - - - - - - &reftitle.returnvalues; - - An array of parsed words with stopwords removed. The list of parsed words - may be useful for highlighting search terms in the results. - - - - &reftitle.examples; - - - Basic <function>SwishResults::getParsedWords</function> example - -query("'some characters' and numbers"); - - var_dump($results->getParsedWords("index.swish-e")); - var_dump($results->indexes[0]['parsed_words']); //same result in a different way - -} catch (SwishException $e) { - echo "Error: ", $e->getMessage(), "\n"; -} - -?> -]]> - - &example.outputs.similar; - - - string(4) "some" - [1]=> - string(10) "characters" - [2]=> - string(3) "and" - [3]=> - string(7) "numbers" -} -array(4) { - [0]=> - string(4) "some" - [1]=> - string(10) "characters" - [2]=> - string(3) "and" - [3]=> - string(7) "numbers" -} -]]> - - - - - - - - diff --git a/reference/swish/SwishResults/getRemovedStopwords.xml b/reference/swish/SwishResults/getRemovedStopwords.xml deleted file mode 100644 index 933046e64157..000000000000 --- a/reference/swish/SwishResults/getRemovedStopwords.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - SwishResults::getRemovedStopwords - Get an array of stopwords removed from the query - - - &reftitle.description; - - arraySwishResults::getRemovedStopwords - stringindex_name - - &warn.experimental.func; - - - &reftitle.parameters; - - - - index_name - - - The name of the index used to initialize Swish - object. - - - - - - - - &reftitle.returnvalues; - - Returns array of stopwords removed from the query. - - - - - - diff --git a/reference/swish/SwishResults/nextResult.xml b/reference/swish/SwishResults/nextResult.xml deleted file mode 100644 index 4def463ae4fe..000000000000 --- a/reference/swish/SwishResults/nextResult.xml +++ /dev/null @@ -1,75 +0,0 @@ - - - - - SwishResults::nextResult - Get the next search result - - - &reftitle.description; - - objectSwishResults::nextResult - - - &warn.experimental.func; - - - &reftitle.returnvalues; - - Returns the next SwishResult object in the result - set or &false; if there are no more results available. - - - - - &reftitle.examples; - - - Basic <function>SwishResults::nextResult</function> example - -prepare(); - - $results = $search->execute("lost"); - while($result = $results->nextResult()) { - /* do something with the result object */ - } - -} catch (SwishException $e) { - echo $e->getMessage(), "\n"; -} - -?> -]]> - - - - - - - - diff --git a/reference/swish/SwishResults/seekResult.xml b/reference/swish/SwishResults/seekResult.xml deleted file mode 100644 index 228d996e2e36..000000000000 --- a/reference/swish/SwishResults/seekResult.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - SwishResults::seekResult - Set current seek pointer to the given position - - - &reftitle.description; - - intSwishResults::seekResult - intposition - - &warn.experimental.func; - - - &reftitle.parameters; - - - - position - - - Zero-based position number. Cannot be less than zero. - - - - - - - - &reftitle.returnvalues; - - Returns new position value on success. - - - - &reftitle.errors; - - Throws SwishException on error. - - - - &reftitle.examples; - - - Basic <function>SwishResults::seekResult</function> example - -prepare(); - - $results = $search->execute("lost"); - - var_dump($results->seekResult(0)); //this will succeed - var_dump($results->seekResult(100)); //this will fail - -} catch (SwishException $e) { - echo "Error: ", $e->getMessage(), "\n"; -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/swish/SwishSearch/execute.xml b/reference/swish/SwishSearch/execute.xml deleted file mode 100644 index 739ed38fa1a2..000000000000 --- a/reference/swish/SwishSearch/execute.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - SwishSearch::execute - Execute the search and get the results - - - &reftitle.description; - - objectSwishSearch::execute - stringquery - - &warn.experimental.func; - - Searches the index file(s) based on the parameters set in the search - object. - - - - &reftitle.parameters; - - - - query - - - The query string is an optional parameter, it can be also set using - Swish::prepare - method. The query string is preserved between executions, so you can - set it once, but execute the search multiple times. - - - - - - - - &reftitle.returnvalues; - - Returns SwishResults object. - - - - &reftitle.errors; - - Throws SwishException on error. - - - - &reftitle.examples; - - - Basic <function>SwishSearch::execute</function> example - -prepare(); - - $results = $search->execute("query"); - echo "First query found: ", $results->hits, " hits\n"; - - $results = $search->execute("new OR query"); - echo "Second query found: ", $results->hits, " hits\n"; - -} catch (SwishException $e) { - echo $e->getMessage(), "\n"; -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/swish/SwishSearch/resetLimit.xml b/reference/swish/SwishSearch/resetLimit.xml deleted file mode 100644 index ad44ea315a3b..000000000000 --- a/reference/swish/SwishSearch/resetLimit.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - SwishSearch::resetLimit - Reset the search limits - - - &reftitle.description; - - voidSwishSearch::resetLimit - - - &warn.experimental.func; - - Reset the search limits previous set by - . - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.examples; - - - Basic <function>SwishSearch::resetLimit</function> example - -prepare(); - - $results = $search->execute("time"); - echo "First query found: ", $results->hits, " hits\n"; - - $search->setLimit("swishdocsize", "3000", "6000"); //limit by document size, from 3000 to 6000 bytes - $results = $search->execute("time"); - echo "Second query found: ", $results->hits, " hits\n"; - - $search->resetLimit(); - $results = $search->execute("time"); - echo "Third query found: ", $results->hits, " hits\n"; - -} catch (SwishException $e) { - echo $e->getMessage(), "\n"; -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/swish/SwishSearch/setLimit.xml b/reference/swish/SwishSearch/setLimit.xml deleted file mode 100644 index 63c1b61a9519..000000000000 --- a/reference/swish/SwishSearch/setLimit.xml +++ /dev/null @@ -1,137 +0,0 @@ - - - - - SwishSearch::setLimit - Set the search limits - - - &reftitle.description; - - voidSwishSearch::setLimit - stringproperty - stringlow - stringhigh - - &warn.experimental.func; - - - &reftitle.parameters; - - - - property - - - Search result property name. - - - - - low - - - The lowest value of the property. - - - - - high - - - The highest value of the property. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.errors; - - Throws SwishException on error. - - - - &reftitle.examples; - - - Basic <function>SwishSearch::setLimit</function> example - -prepare(); - - $results = $search->execute("time"); - echo "First query found: ", $results->hits, " hits\n"; - - $i = 0; - while($result = $results->nextResult()) { - echo "Hit #", ++$i, " - ", $result->swishdocsize, " bytes\n"; - } - - $search->setLimit("swishdocsize", "3000", "6000"); //limit by document size, from 3000 to 6000 bytes - $results = $search->execute("time"); - echo "Second query found: ", $results->hits, " hits\n"; - - $i = 0; - while($result = $results->nextResult()) { - echo "Hit #", ++$i, " - ", $result->swishdocsize, " bytes\n"; - } - -} catch (SwishException $e) { - echo $e->getMessage(), "\n"; -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/swish/SwishSearch/setPhraseDelimiter.xml b/reference/swish/SwishSearch/setPhraseDelimiter.xml deleted file mode 100644 index 23d6e1670036..000000000000 --- a/reference/swish/SwishSearch/setPhraseDelimiter.xml +++ /dev/null @@ -1,111 +0,0 @@ - - - - - SwishSearch::setPhraseDelimiter - Set the phrase delimiter - - - &reftitle.description; - - voidSwishSearch::setPhraseDelimiter - stringdelimiter - - &warn.experimental.func; - - - &reftitle.parameters; - - - - delimiter - - - Phrase delimiter character. The default delimiter is double-quotes. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.examples; - - - Basic <function>SwishSearch::setPhraseDelimiter</function> example - -prepare(); - - $results = $search->execute('"every time"'); //looking for "every time" - echo "First query found: ", $results->hits, " hits\n"; - - $search->setPhraseDelimiter("'"); - $results = $search->execute("'every time'"); //the same query, but using different delimiter - echo "Second query found: ", $results->hits, " hits\n"; - - $search->setPhraseDelimiter('"'); - $results = $search->execute("'every time'"); //looking for "every" and "time" - echo "Third query found: ", $results->hits, " hits\n"; - - //let's look at parsed words - var_dump($results->getParsedWords("index.swish-e")); - -} catch (SwishException $e) { - echo $e->getMessage(), "\n"; -} - -?> -]]> - - &example.outputs.similar; - - - string(5) "every" - [1]=> - string(4) "time" -} -]]> - - - - - - - - diff --git a/reference/swish/SwishSearch/setSort.xml b/reference/swish/SwishSearch/setSort.xml deleted file mode 100644 index d8f54b1b29ae..000000000000 --- a/reference/swish/SwishSearch/setSort.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - SwishSearch::setSort - Set the sort order - - - &reftitle.description; - - voidSwishSearch::setSort - stringsort - - &warn.experimental.func; - - - &reftitle.parameters; - - - - sort - - - Sort order of the results is a string containing name of a result - property combined with sort direction ("asc" or "desc"). - Examples: "swishrank desc", "swishdocpath asc", "swishtitle asc", - "swishdocsize desc", "swishlastmodified desc" etc. - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.examples; - - - Basic <function>SwishSearch::setSort</function> example - -prepare(); - - $results = $search->execute("time"); - echo "First query found: ", $results->hits, " hits\n"; - - $i = 0; - while($result = $results->nextResult()) { - echo "Hit #", ++$i, " - ", $result->swishdocsize, " bytes\n"; - } - - $search->setSort("swishdocsize desc"); //sort by document size - $results = $search->execute("time"); - echo "Second query found: ", $results->hits, " hits\n"; - - $i = 0; - while($result = $results->nextResult()) { - echo "Hit #", ++$i, " - ", $result->swishdocsize, " bytes\n"; - } - -} catch (SwishException $e) { - echo $e->getMessage(), "\n"; -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/swish/SwishSearch/setStructure.xml b/reference/swish/SwishSearch/setStructure.xml deleted file mode 100644 index eae893b4a664..000000000000 --- a/reference/swish/SwishSearch/setStructure.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - SwishSearch::setStructure - Set the structure flag in the search object - - - &reftitle.description; - - voidSwishSearch::setStructure - intstructure - - &warn.experimental.func; - - - &reftitle.parameters; - - - - structure - - - The structure flag a bitmask is used to limit search to certain parts of HTML - documents (like title, meta, body etc.). Its possible values are listed below. - To combine several values use bitwise OR operator, see example below. - - - - - - - - - - Swish::IN_FILE - - - - - Swish::IN_TITLE - - - - - Swish::IN_HEAD - - - - - Swish::IN_BODY - - - - - Swish::IN_COMMENTS - - - - - Swish::IN_HEADER - - - - - Swish::IN_EMPHASIZED - - - - - Swish::IN_META - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - &reftitle.examples; - - - Basic <function>SwishSearch::setStructure</function> example - -prepare(); - - $results = $search->execute("time"); - echo "First query found: ", $results->hits, " hits\n"; - - $search->setStructure(Swish::IN_TITLE|Swish::IN_HEAD); //search in title and head - $results = $search->execute("time"); - echo "Second query found: ", $results->hits, " hits\n"; - - $search->setStructure(Swish::IN_ALL); //search in whole document, the default value - $results = $search->execute("time"); - echo "Third query found: ", $results->hits, " hits\n"; - -} catch (SwishException $e) { - echo $e->getMessage(), "\n"; -} - -?> -]]> - - &example.outputs.similar; - - - - - - - - - - diff --git a/reference/swish/book.xml b/reference/swish/book.xml deleted file mode 100644 index 069e979c02c9..000000000000 --- a/reference/swish/book.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - Swish Indexing - Swish - - - - &reftitle.intro; - - The swish extension provides the bindings for Swish-e API. - Swish-e stands for "Simple Web Indexing System for Humans - Enhanced" and - is an open source system for indexing and search. - Swish-e itself is licensed under GPL license, but uses a clause that - allows applications to link against the library if every copy of the - combined work is accompanied by the URL to Swish-e source code. Here it - is: http://swish-e.org. - - - &warn.experimental; - - - - &reference.swish.setup; - &reference.swish.constants; - &reference.swish.examples; - - &reference.swish.reference; - - - - - diff --git a/reference/swish/classes.xml b/reference/swish/classes.xml deleted file mode 100644 index 8c627209c5e1..000000000000 --- a/reference/swish/classes.xml +++ /dev/null @@ -1,222 +0,0 @@ - - -
    - &reftitle.classes; -
    - &reftitle.classes; -
    - <classname>Swish</classname> - - -
    - &reftitle.properties; - - - - indexes - the array of indexes used and their properties. Certain - list of properties depends on Swish-e version. - - - -
    -
    - &reftitle.methods; - - - - - constructs new - Swish object. - Throws SwishException on error. - - - - - - prepares and returns - SwishSearch object. - Throws SwishException on error. - - - - - - executes the query and - returns SwishResults object. - Throws SwishException on error. - - - - - returns an array - of meta entries for the given index file. - - - - returns an array - of properties for the given index file. - - -
    -
    -
    - <classname>SwishSearch</classname> - - -
    - &reftitle.methods; - - - - - sets the - structure flag in the search object. This flag is used to limit search - to certain parts of HTML documents. - - - - - - sets - the phrase delimiter character. The default delimiter is double-quotes. - - - - - - sets the sort - order of the results. - - - - - - sets the limits - for the search. - Throws SwishException on error. - - - - - - resets the - limits. - - - - - - executes the - query and returns SwishResults object. - Throws SwishException on error. - - - -
    -
    -
    - <classname>SwishResults</classname> - - -
    - &reftitle.properties; - - - - hits - the number of results in this - SwishResults object. - - - - - indexes - the array of indexes used in the search. - - - -
    -
    - &reftitle.methods; - - - - - returns - next SwishResult object or &false; if no - more results are available. - - - - - - sets the - current seek position in the SwishResults - object. - Throws SwishException on error. - - - - - - - returns an array of words in the query with stopwords removed. - - - - - - - returns an array of removed stopwords. - - - -
    -
    -
    - <classname>SwishResult</classname> - - -
    - &reftitle.properties; - - - Properties list depends on Swish-e version, see examples. - - -
    -
    - &reftitle.methods; - - - - - returns - an array of meta entries for the index used in this result. - - - - - - stems the word - and returns result as an array of strings. - Throws SwishException on error. - - - -
    -
    -
    - <classname>SwishException</classname> - - SwishException extends the built in - Exception class and possesses the same set of - properties and methods. See for more details. - -
    -
    -
    - - - diff --git a/reference/swish/constants.xml b/reference/swish/constants.xml deleted file mode 100644 index 2ea8e42b3c6b..000000000000 --- a/reference/swish/constants.xml +++ /dev/null @@ -1,240 +0,0 @@ - - - - &reftitle.constants; - &extension.constants; - - - - Swish::META_TYPE_UNDEF - (integer) - - - - - - - - - Swish::META_TYPE_STRING - (integer) - - - - - - - - - Swish::META_TYPE_ULONG - (integer) - - - - - - - - - Swish::META_TYPE_DATE - (integer) - - - - - - - - - Swish::IN_FILE_BIT - (integer) - - - - - - - - - Swish::IN_TITLE_BIT - (integer) - - - - - - - - - Swish::IN_HEAD_BIT - (integer) - - - - - - - - - Swish::IN_BODY_BIT - (integer) - - - - - - - - - Swish::IN_COMMENTS_BIT - (integer) - - - - - - - - - Swish::IN_HEADER_BIT - (integer) - - - - - - - - - Swish::IN_EMPHASIZED_BIT - (integer) - - - - - - - - - Swish::IN_META_BIT - (integer) - - - - - - - - - Swish::IN_FILE - (integer) - - - - - - - - - Swish::IN_TITLE - (integer) - - - - - - - - - Swish::IN_HEAD - (integer) - - - - - - - - - Swish::IN_BODY - (integer) - - - - - - - - - Swish::IN_COMMENTS - (integer) - - - - - - - - - Swish::IN_HEADER - (integer) - - - - - - - - - Swish::IN_EMPHASIZED - (integer) - - - - - - - - - Swish::IN_META - (integer) - - - - - - - - - Swish::IN_ALL - (integer) - - - - - - - - - - - diff --git a/reference/swish/examples.xml b/reference/swish/examples.xml deleted file mode 100644 index 22d6f98a903e..000000000000 --- a/reference/swish/examples.xml +++ /dev/null @@ -1,81 +0,0 @@ - - - - - &reftitle.examples; -
    - Basic usage - - - Basic search query - -query("test OR text"); - - echo "Found ", $results->hits, " results\n"; - while ($result = $results->nextResult()) { - var_dump($result); - break; //break after the first result - } - -} catch (SwishException $e) { - echo "Error: ", $e->getMessage(), "\n"; -} - -?> -]]> - - - - &example.outputs.similar; - - - int(1) - ["swishrank"]=> - int(1000) - ["swishfilenum"]=> - int(10) - ["swishdbfile"]=> - string(13) "index.swish-e" - ["swishdocpath"]=> - string(23) "README.SUBMITTING_PATCH" - ["swishtitle"]=> - NULL - ["swishdocsize"]=> - int(4557) - ["swishlastmodified"]=> - int(1072136752) -} -]]> - -
    -     - - diff --git a/reference/swish/reference.xml b/reference/swish/reference.xml deleted file mode 100644 index 346df919d636..000000000000 --- a/reference/swish/reference.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - Swish &Functions; - - &reference.swish.entities.Swish; - &reference.swish.entities.SwishResult; - &reference.swish.entities.SwishResults; - &reference.swish.entities.SwishSearch; - - - diff --git a/reference/swish/setup.xml b/reference/swish/setup.xml deleted file mode 100644 index 7a3792b2927d..000000000000 --- a/reference/swish/setup.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - PECL/swish requires PHP 5.1.3 or newer. - -
    - - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;swish. - -
    - - - -
    - &reftitle.runtime; - &no.config; -
    - - - -
    - &reftitle.resources; - &no.resource; -
    - - -     - - - diff --git a/reference/swish/versions.xml b/reference/swish/versions.xml deleted file mode 100644 index 2a2cf7f74189..000000000000 --- a/reference/swish/versions.xml +++ /dev/null @@ -1,53 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/sybase/book.xml b/reference/sybase/book.xml deleted file mode 100644 index 2929a087a79d..000000000000 --- a/reference/sybase/book.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - Sybase - - - - &reftitle.intro; - - As of PHP 7.0.0, the sybase_ct extension has been removed. - - - - - - &reference.sybase.setup; - &reference.sybase.constants; - &reference.sybase.reference; - - - - - diff --git a/reference/sybase/configure.xml b/reference/sybase/configure.xml deleted file mode 100644 index 6c8b49fc2611..000000000000 --- a/reference/sybase/configure.xml +++ /dev/null @@ -1,45 +0,0 @@ - - -
    - &reftitle.install; - - To enable Sybase-DB support configure PHP - . DIR is the - Sybase home directory, defaults to /home/sybase. - To enable Sybase-CT support configure PHP - . DIR is the - Sybase home directory, defaults to /home/sybase. - - - - As of PHP 5.3.0, the Sybase extension has been superseded by the - sybase_ct extension and is no longer maintained. To continue using - sybase you must use the sybase_ct extension. - - - As of PHP 7.0.0, the sybase_ct extension has been removed. - - -
    - - - diff --git a/reference/sybase/constants.xml b/reference/sybase/constants.xml deleted file mode 100644 index f3e71f170540..000000000000 --- a/reference/sybase/constants.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - &reftitle.constants; - &no.constants; - - - - diff --git a/reference/sybase/functions/sybase-affected-rows.xml b/reference/sybase/functions/sybase-affected-rows.xml deleted file mode 100644 index 8cd3bb5ebcb0..000000000000 --- a/reference/sybase/functions/sybase-affected-rows.xml +++ /dev/null @@ -1,113 +0,0 @@ - - - - - sybase_affected_rows - Gets number of affected rows in last query - - - - &warn.removed.function-7-0-0; - - - - - &reftitle.description; - - intsybase_affected_rows - resourcelink_identifier - - - sybase_affected_rows returns the number of - rows affected by the last INSERT, UPDATE or DELETE query on the - server associated with the specified link identifier. - - - This command is not effective for SELECT statements, only on - statements which modify records. To retrieve the number of rows - returned from a SELECT, use sybase_num_rows. - - - - - &reftitle.parameters; - - - - link_identifier - - - If the link identifier isn't specified, the last opened link is assumed. - - - - - - - - - &reftitle.returnvalues; - - Returns the number of affected rows, as an integer. - - - - - &reftitle.examples; - - - Delete-Query - - -]]> - - &example.outputs; - - - - - - - - - &reftitle.seealso; - - - sybase_num_rows - - - - - - - diff --git a/reference/sybase/functions/sybase-close.xml b/reference/sybase/functions/sybase-close.xml deleted file mode 100644 index bea7e90c41c1..000000000000 --- a/reference/sybase/functions/sybase-close.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - sybase_close - Closes a Sybase connection - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - boolsybase_close - resourcelink_identifier - - - sybase_close closes the link to a Sybase - database that's associated with the specified link - link_identifier. - - - Note that this isn't usually necessary, as non-persistent - open links are automatically closed at the end of the script's - execution. - - - sybase_close will not close persistent links - generated by sybase_pconnect. - - - - - &reftitle.parameters; - - - - link_identifier - - - If the link identifier isn't specified, the last opened link is - assumed. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - sybase_connect - sybase_pconnect - - - - - - - diff --git a/reference/sybase/functions/sybase-connect.xml b/reference/sybase/functions/sybase-connect.xml deleted file mode 100644 index f2b824028f78..000000000000 --- a/reference/sybase/functions/sybase-connect.xml +++ /dev/null @@ -1,184 +0,0 @@ - - - - - sybase_connect - Opens a Sybase server connection - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - resourcesybase_connect - stringservername - stringusername - stringpassword - stringcharset - stringappname - boolnew&false; - - - sybase_connect establishes a connection to a - Sybase server. - - - In case a second call is made to - sybase_connect with the same arguments, no - new link will be established, but instead, the link identifier of - the already opened link will be returned. - - - The link to the server will be closed as soon as the - execution of the script ends, unless it's closed earlier by - explicitly calling sybase_close. - - - - - &reftitle.parameters; - - - - servername - - - The servername argument has to be a valid servername that is defined - in the 'interfaces' file. - - - - - username - - - Sybase user name - - - - - password - - - Password associated with username. - - - - - charset - - - Specifies the charset for the connection - - - - - appname - - - Specifies an appname for the Sybase connection. - This allow you to make separate connections in the same script to the - same database. This may come handy when you have started a transaction - in your current connection, and you need to be able to do a separate - query which cannot be performed inside this transaction. - - - - - new - - - Whether to open a new connection or use the existing one. - - - - - - - - - &reftitle.returnvalues; - - Returns a positive Sybase link identifier on success, or &false; on - failure. - - - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - The new parameter was added. - - - - - - - - - - &reftitle.examples; - - - <function>sybase_connect</function> example - - -]]> - - - - - - - &reftitle.seealso; - - - sybase_pconnect - sybase_close - - - - - - - diff --git a/reference/sybase/functions/sybase-data-seek.xml b/reference/sybase/functions/sybase-data-seek.xml deleted file mode 100644 index 155455f18870..000000000000 --- a/reference/sybase/functions/sybase-data-seek.xml +++ /dev/null @@ -1,87 +0,0 @@ - - - - - sybase_data_seek - Moves internal row pointer - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - boolsybase_data_seek - resourceresult_identifier - introw_number - - - sybase_data_seek moves the internal row - pointer of the Sybase result associated with the specified result - identifier to pointer to the specified row number. The next call - to sybase_fetch_row would return that row. - - - - - &reftitle.parameters; - - - - result_identifier - - - - - - - row_number - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - sybase_fetch_row - - - - - - - diff --git a/reference/sybase/functions/sybase-deadlock-retry-count.xml b/reference/sybase/functions/sybase-deadlock-retry-count.xml deleted file mode 100644 index a6f500d828d0..000000000000 --- a/reference/sybase/functions/sybase-deadlock-retry-count.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - sybase_deadlock_retry_count - Sets the deadlock retry count - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - voidsybase_deadlock_retry_count - intretry_count - - - Using sybase_deadlock_retry_count, the number of retries - can be defined in cases of deadlocks. By default, every deadlock is retried - an infinite number of times or until the process is killed by Sybase, the - executing script is killed (for instance, by set_time_limit) - or the query succeeds. - - - - - &reftitle.parameters; - - - - retry_count - - - - Values for retry_count - - - - -1 - Retry forever (default) - - - 0 - Do not retry - - - n - Retry n times - - - -
    -     -     -     -     -     -     - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.notes; - &sybase.ct.only; - - -     - - diff --git a/reference/sybase/functions/sybase-fetch-array.xml b/reference/sybase/functions/sybase-fetch-array.xml deleted file mode 100644 index e06fda4c16c2..000000000000 --- a/reference/sybase/functions/sybase-fetch-array.xml +++ /dev/null @@ -1,133 +0,0 @@ - - - - - sybase_fetch_array - Fetch row as array - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - arraysybase_fetch_array - resourceresult - - - sybase_fetch_array is an extended version of - sybase_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. - - - An important thing to note is that using - sybase_fetch_array is NOT significantly - slower than using sybase_fetch_row, while it - provides a significant added value. - - - - - &reftitle.parameters; - - - - result - - - - - - - - - - - &reftitle.returnvalues; - - Returns an array that corresponds to the fetched row, or &false; if there - are no more rows. - - - - 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. - - - - - - &reftitle.examples; - - - Identical fieldnames - - -]]> - - - The above example would produce the following output (assuming the two tables only - have each one column called "person_id"): - - - - int(1) - ["person_id"]=> - int(1) - [1]=> - int(1) - ["person_id1"]=> - int(1) -} -]]> - - - - - - - &reftitle.seealso; - - - sybase_fetch_row - sybase_fetch_assoc - sybase_fetch_object - - - - - - - diff --git a/reference/sybase/functions/sybase-fetch-assoc.xml b/reference/sybase/functions/sybase-fetch-assoc.xml deleted file mode 100644 index fa5c680e73df..000000000000 --- a/reference/sybase/functions/sybase-fetch-assoc.xml +++ /dev/null @@ -1,94 +0,0 @@ - - - - - sybase_fetch_assoc - Fetch a result row as an associative array - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - arraysybase_fetch_assoc - resourceresult - - - sybase_fetch_assoc is a version of - sybase_fetch_row that uses column names - instead of integers for indices in the result array. Columns from - different tables with the same names are returned as - name, name1, name2, ..., nameN. - - - An important thing to note is that using - sybase_fetch_assoc is NOT significantly - slower than using sybase_fetch_row, while it - provides a significant added value. - - - - - &reftitle.parameters; - - - - result - - - - - - - - - - - &reftitle.returnvalues; - - Returns an array that corresponds to the fetched row, or &false; if there - are no more rows. - - - - - &reftitle.notes; - &sybase.ct.only; - - - - &reftitle.seealso; - - - sybase_fetch_row - sybase_fetch_array - sybase_fetch_object - - - - - - - diff --git a/reference/sybase/functions/sybase-fetch-field.xml b/reference/sybase/functions/sybase-fetch-field.xml deleted file mode 100644 index 7b1dcd52646c..000000000000 --- a/reference/sybase/functions/sybase-fetch-field.xml +++ /dev/null @@ -1,118 +0,0 @@ - - - - - sybase_fetch_field - Get field information from a result - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - objectsybase_fetch_field - resourceresult - intfield_offset-1 - - - sybase_fetch_field can be used in order to - obtain information about fields in a certain query result. - - - - - &reftitle.parameters; - - - - result - - - - - - - field_offset - - - If the field offset isn't specified, the next field that wasn't yet - retrieved by sybase_fetch_field is retrieved. - - - - - - - - - &reftitle.returnvalues; - - Returns an object containing field information. - - - The properties of the object are: - - - - - name - column name. if the column is a result of a function, this - property is set to computed#N, where #N is a serial number. - - - - - column_source - the table from which the column was taken - - - - - max_length - maximum length of the column - - - - - numeric - 1 if the column is numeric - - - - - type - datatype of the column - - - - - - - &reftitle.seealso; - - - sybase_field_seek - - - - - - - diff --git a/reference/sybase/functions/sybase-fetch-object.xml b/reference/sybase/functions/sybase-fetch-object.xml deleted file mode 100644 index adf8c6517e8e..000000000000 --- a/reference/sybase/functions/sybase-fetch-object.xml +++ /dev/null @@ -1,120 +0,0 @@ - - - - - sybase_fetch_object - Fetch a row as an object - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - objectsybase_fetch_object - resourceresult - mixedobject - - - sybase_fetch_object is similar to - sybase_fetch_assoc, with one difference - an object - is returned, instead of an array. - - - Speed-wise, the function is identical to - sybase_fetch_array, and almost as quick as - sybase_fetch_row (the difference is insignificant). - - - - - &reftitle.parameters; - - - - result - - - - - - - object - - - Use the second object to specify the type of object - you want to return. If this parameter is omitted, the object will be of - type stdClass. - - - - - - - - - &reftitle.returnvalues; - - Returns an object with properties that correspond to the fetched row, or - &false; if there are no more rows. - - - - - &reftitle.examples; - - - <function>sybase_fetch_object</function> return as Foo - - -]]> - - - - - - - &reftitle.seealso; - - - sybase_fetch_array - sybase_fetch_row - - - - - - - diff --git a/reference/sybase/functions/sybase-fetch-row.xml b/reference/sybase/functions/sybase-fetch-row.xml deleted file mode 100644 index 7d2255df495f..000000000000 --- a/reference/sybase/functions/sybase-fetch-row.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - - sybase_fetch_row - Get a result row as an enumerated array - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - arraysybase_fetch_row - resourceresult - - - sybase_fetch_row fetches one row of data - from the result associated with the specified result identifier. - - - Subsequent call to sybase_fetch_row would - return the next row in the result set, or &false; if there are no - more rows. - - - - - &reftitle.parameters; - - - - result - - - - - - - - - - - &reftitle.returnvalues; - - Returns an array that corresponds to the fetched row, or &false; if there - are no more rows. Each result column is stored in an array offset, - starting at offset 0. - - - Data types - - - - 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 - - - -
    -     - - - &reftitle.seealso; - - - sybase_fetch_array - sybase_fetch_assoc - sybase_fetch_object - sybase_data_seek - sybase_result - - - - -     - - diff --git a/reference/sybase/functions/sybase-field-seek.xml b/reference/sybase/functions/sybase-field-seek.xml deleted file mode 100644 index a79b01db4bfb..000000000000 --- a/reference/sybase/functions/sybase-field-seek.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - sybase_field_seek - Sets field offset - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - boolsybase_field_seek - resourceresult - intfield_offset - - - Seeks to the specified field offset. If the next call to - sybase_fetch_field won't include a field - offset, this field would be returned. - - - - - &reftitle.parameters; - - - - result - - - - - - - field_offset - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - sybase_fetch_field - - - - - - - diff --git a/reference/sybase/functions/sybase-free-result.xml b/reference/sybase/functions/sybase-free-result.xml deleted file mode 100644 index 64cb2a72f000..000000000000 --- a/reference/sybase/functions/sybase-free-result.xml +++ /dev/null @@ -1,72 +0,0 @@ - - - - - sybase_free_result - Frees result memory - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - boolsybase_free_result - resourceresult - - - sybase_free_result only needs to be called - if you are worried about using too much memory while your script - is running. All result memory will automatically be freed when - the script ends. You may call sybase_free_result - with the result identifier as an argument and the associated - result memory will be freed. - - - - - &reftitle.parameters; - - - - result - - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - - diff --git a/reference/sybase/functions/sybase-get-last-message.xml b/reference/sybase/functions/sybase-get-last-message.xml deleted file mode 100644 index a33dba9e4f59..000000000000 --- a/reference/sybase/functions/sybase-get-last-message.xml +++ /dev/null @@ -1,62 +0,0 @@ - - - - - sybase_get_last_message - Returns the last message from the server - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - stringsybase_get_last_message - - - - sybase_get_last_message returns the last - message reported by the server. - - - - - &reftitle.returnvalues; - - Returns the message as a string. - - - - - &reftitle.seealso; - - - sybase_min_message_severity - - - - - - - diff --git a/reference/sybase/functions/sybase-min-client-severity.xml b/reference/sybase/functions/sybase-min-client-severity.xml deleted file mode 100644 index ed272f864eb1..000000000000 --- a/reference/sybase/functions/sybase-min-client-severity.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - sybase_min_client_severity - Sets minimum client severity - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - voidsybase_min_client_severity - intseverity - - - sybase_min_client_severity sets the minimum - client severity level. - - - - - &reftitle.parameters; - - - - severity - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.notes; - &sybase.ct.only; - - - - &reftitle.seealso; - - - sybase_min_server_severity - - - - - - - diff --git a/reference/sybase/functions/sybase-min-error-severity.xml b/reference/sybase/functions/sybase-min-error-severity.xml deleted file mode 100644 index 9e7cdaedff6d..000000000000 --- a/reference/sybase/functions/sybase-min-error-severity.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - sybase_min_error_severity - Sets minimum error severity - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - voidsybase_min_error_severity - intseverity - - - sybase_min_error_severity sets the minimum - error severity level. - - - - - &reftitle.parameters; - - - - severity - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.notes; - &sybase.ct.only; - - - - &reftitle.seealso; - - - sybase_min_message_severity - - - - - - - diff --git a/reference/sybase/functions/sybase-min-message-severity.xml b/reference/sybase/functions/sybase-min-message-severity.xml deleted file mode 100644 index 0848e571e45b..000000000000 --- a/reference/sybase/functions/sybase-min-message-severity.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - sybase_min_message_severity - Sets minimum message severity - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - voidsybase_min_message_severity - intseverity - - - sybase_min_message_severity sets the minimum - message severity level. - - - - - &reftitle.parameters; - - - - severity - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.notes; - &sybase.db.only; - - - - &reftitle.seealso; - - - sybase_min_error_severity - - - - - - - diff --git a/reference/sybase/functions/sybase-min-server-severity.xml b/reference/sybase/functions/sybase-min-server-severity.xml deleted file mode 100644 index e4c60fbee4c4..000000000000 --- a/reference/sybase/functions/sybase-min-server-severity.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - sybase_min_server_severity - Sets minimum server severity - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - voidsybase_min_server_severity - intseverity - - - sybase_min_server_severity sets the minimum - server severity level. - - - - - &reftitle.parameters; - - - - severity - - - - - - - - - - - &reftitle.returnvalues; - - &return.void; - - - - - &reftitle.notes; - &sybase.ct.only; - - - - &reftitle.seealso; - - - sybase_min_client_severity - - - - - - - diff --git a/reference/sybase/functions/sybase-num-fields.xml b/reference/sybase/functions/sybase-num-fields.xml deleted file mode 100644 index f9d44853ab7d..000000000000 --- a/reference/sybase/functions/sybase-num-fields.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - sybase_num_fields - Gets the number of fields in a result set - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - intsybase_num_fields - resourceresult - - - sybase_num_fields returns the number of fields in a - result set. - - - - - &reftitle.parameters; - - - - result - - - - - - - - - - - &reftitle.returnvalues; - - Returns the number of fields as an integer. - - - - - &reftitle.seealso; - - - sybase_query - sybase_fetch_field - sybase_num_rows - - - - - - - diff --git a/reference/sybase/functions/sybase-num-rows.xml b/reference/sybase/functions/sybase-num-rows.xml deleted file mode 100644 index cbb1c2d01019..000000000000 --- a/reference/sybase/functions/sybase-num-rows.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - sybase_num_rows - Get number of rows in a result set - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - intsybase_num_rows - resourceresult - - - sybase_num_rows returns the number of rows in a - result set. - - - - - &reftitle.parameters; - - - - result - - - - - - - - - - - &reftitle.returnvalues; - - Returns the number of rows as an integer. - - - - - &reftitle.seealso; - - - sybase_num_fields - sybase_query - sybase_fetch_row - - - - - - - diff --git a/reference/sybase/functions/sybase-pconnect.xml b/reference/sybase/functions/sybase-pconnect.xml deleted file mode 100644 index a3af371f0cd3..000000000000 --- a/reference/sybase/functions/sybase-pconnect.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - sybase_pconnect - Open persistent Sybase connection - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - resourcesybase_pconnect - stringservername - stringusername - stringpassword - stringcharset - stringappname - - - sybase_pconnect acts very much like - sybase_connect with two major differences. - - - First, when connecting, the function would first try to find a - (persistent) link that's already open with the same host, - username and password. If one is found, an identifier for it - will be returned instead of opening a new connection. - - - Second, the connection to the SQL server will not be closed when - the execution of the script ends. Instead, the link will remain - open for future use (sybase_close will not - close links established by sybase_pconnect). - - - This type of links is therefore called 'persistent'. - - - - - &reftitle.parameters; - - - - servername - - - The servername argument has to be a valid servername that is defined - in the 'interfaces' file. - - - - - username - - - Sybase user name - - - - - password - - - Password associated with username. - - - - - charset - - - Specifies the charset for the connection - - - - - appname - - - Specifies an appname for the Sybase connection. - This allow you to make separate connections in the same script to the - same database. This may come handy when you have started a transaction - in your current connection, and you need to be able to do a separate - query which cannot be performed inside this transaction. - - - - - - - - - &reftitle.returnvalues; - - Returns a positive Sybase persistent link identifier on success, or - &false; on error. - - - - - &reftitle.seealso; - - - sybase_connect - - - - - - - diff --git a/reference/sybase/functions/sybase-query.xml b/reference/sybase/functions/sybase-query.xml deleted file mode 100644 index af27654a44ef..000000000000 --- a/reference/sybase/functions/sybase-query.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - sybase_query - Sends a Sybase query - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - mixedsybase_query - stringquery - resourcelink_identifier - - - sybase_query sends a query to the currently - active database on the server that's associated with the specified - link identifier. - - - - - &reftitle.parameters; - - - - query - - - - - - - link_identifier - - - If the 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 sybase_connect was called, and use it. - - - - - - - - - &reftitle.returnvalues; - - Returns a positive Sybase result identifier on success, &false; on error, - or &true; if the query was successful but didn't return any columns. - - - - - &reftitle.seealso; - - - sybase_select_db - sybase_connect - - - - - - - diff --git a/reference/sybase/functions/sybase-result.xml b/reference/sybase/functions/sybase-result.xml deleted file mode 100644 index f3b8c9815ef3..000000000000 --- a/reference/sybase/functions/sybase-result.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - sybase_result - Get result data - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - stringsybase_result - resourceresult - introw - mixedfield - - - Returns the contents of the cell at the row and offset in - the specified Sybase result set. - - - When working on large result sets, you should consider using one - of the functions that fetch an entire row (specified below). As - these functions return the contents of multiple cells in one - function call, they're MUCH quicker than sybase_result(). Also, - note that specifying a numeric offset for the field argument is - much quicker than specifying a fieldname or tablename.fieldname - argument. - - - Recommended high-performance alternatives: - sybase_fetch_row, - sybase_fetch_array and - sybase_fetch_object. - - - - - &reftitle.parameters; - - - - result - - - - - - - row - - - - - - - field - - - The field argument can be the field's offset, or the field's name, or - the field's table dot field's name (tablename.fieldname). If the - column name has been aliased ('select foo as bar from...'), use the - alias instead of the column name. - - - - - - - - - &reftitle.returnvalues; - - sybase_result returns the contents of one cell from a - Sybase result set. - - - - - - diff --git a/reference/sybase/functions/sybase-select-db.xml b/reference/sybase/functions/sybase-select-db.xml deleted file mode 100644 index e2a0bcb4b136..000000000000 --- a/reference/sybase/functions/sybase-select-db.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - sybase_select_db - Selects a Sybase database - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - boolsybase_select_db - stringdatabase_name - resourcelink_identifier - - - sybase_select_db sets the current active - database on the server that's associated with the specified link - identifier. - - - Every subsequent call to sybase_query will be - made on the active database. - - - - - &reftitle.parameters; - - - - database_name - - - - - - - link_identifier - - - If no link identifier is specified, the last opened link is assumed. - If no link is open, the function will try to establish a link as if - sybase_connect was called, and use it. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.seealso; - - - sybase_connect - sybase_pconnect - sybase_query - - - - - - - diff --git a/reference/sybase/functions/sybase-set-message-handler.xml b/reference/sybase/functions/sybase-set-message-handler.xml deleted file mode 100644 index a147fd35866b..000000000000 --- a/reference/sybase/functions/sybase-set-message-handler.xml +++ /dev/null @@ -1,148 +0,0 @@ - - - - - sybase_set_message_handler - Sets the handler called when a server message is raised - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - boolsybase_set_message_handler - callablehandler - resourcelink_identifier - - - sybase_set_message_handler sets a user function to - handle messages generated by the server. You may specify the name of a - global function, or use an array to specify an object reference and a - method name. - - - - - &reftitle.parameters; - - - - handler - - - The handler expects five arguments in the following order: message - number, severity, state, line number and description. The first four - are integers. The last is a string. If the function returns &false;, - PHP generates an ordinary error message. - - - - - link_identifier - - - If the link identifier isn't specified, the last opened link is assumed. - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>sybase_set_message_handler</function> callback function - - -]]> - - - - <function>sybase_set_message_handler</function> callback to a class - - -]]> - - - - <function>sybase_set_message_handler</function> unhandled messages - - -]]> - - - - - - - &reftitle.notes; - &sybase.ct.only; - - - - - diff --git a/reference/sybase/functions/sybase-unbuffered-query.xml b/reference/sybase/functions/sybase-unbuffered-query.xml deleted file mode 100644 index 07d93e654afa..000000000000 --- a/reference/sybase/functions/sybase-unbuffered-query.xml +++ /dev/null @@ -1,159 +0,0 @@ - - - - - sybase_unbuffered_query - Send a Sybase query and do not block - - - - &warn.removed.function-7-0-0; - - - - &reftitle.description; - - resourcesybase_unbuffered_query - stringquery - resourcelink_identifier - boolstore_result - - - sybase_unbuffered_query sends a query to the - currently active database on the server that's associated with the specified - link identifier. If the 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 sybase_connect was - called, and use it. - - - Unlike sybase_query, - sybase_unbuffered_query reads only the first - row of the result set. sybase_fetch_array and similar - function read more rows as needed. sybase_data_seek - reads up to the target row. The behavior may produce better performance - for large result sets. - - - sybase_num_rows will only return the correct number - of rows if all result sets have been read. To Sybase, the number of rows - is not known and is therefore computed by the client implementation. - - - - If you don't read all of the resultsets prior to executing the next query, - PHP will raise a warning and cancel all of the pending results. To get rid of - this, use sybase_free_result which will cancel pending - results of an unbuffered query. - - - - - - &reftitle.parameters; - - - - query - - - - - - - link_identifier - - - - - - - store_result - - - The optional store_result can be &false; to - indicate the resultsets shouldn't be fetched into memory, thus - minimizing memory usage which is particularly interesting with very - large resultsets. - - - - - - - - - &reftitle.returnvalues; - - Returns a positive Sybase result identifier on success, or &false; on - error. - - - - - &reftitle.examples; - - - <function>sybase_unbuffered_query</function> example - -'; - if ($i++ > 40000) { - break; - } -} - -sybase_free_result($q); -sybase_close($dbh); - -?> -]]> - - - - - - - &reftitle.notes; - &sybase.ct.only; - - - - &reftitle.seealso; - - - sybase_query - - - - - - - diff --git a/reference/sybase/ini.xml b/reference/sybase/ini.xml deleted file mode 100644 index c444a861bdb4..000000000000 --- a/reference/sybase/ini.xml +++ /dev/null @@ -1,273 +0,0 @@ - - -
    - &reftitle.runtime; - &extension.runtime; - - - Sybase configuration options - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - sybase.allow_persistent - "1" - PHP_INI_ALL - PHP_INI_ALL in PHP <= 4.0.2. PHP_INI_SYSTEM in PHP <= 4.0.3. - - - sybase.max_persistent - "-1" - PHP_INI_ALL - PHP_INI_ALL in PHP <= 4.0.2. PHP_INI_SYSTEM in PHP <= 4.0.3. - - - sybase.max_links - "-1" - PHP_INI_ALL - PHP_INI_ALL in PHP <= 4.0.2. PHP_INI_SYSTEM in PHP <= 4.0.3. - - - sybase.interface_file - "/usr/sybase/interfaces" - PHP_INI_SYSTEM - - - - sybase.min_error_severity - "10" - PHP_INI_ALL - - - - sybase.min_message_severity - "10" - PHP_INI_ALL - - - - sybase.compatability_mode - "0" - PHP_INI_ALL - - - - magic_quotes_sybase - "0" - PHP_INI_ALL - Deprecated in PHP 5.3.0. Removed in PHP 5.4.0. - - - -
    -     - - &ini.descriptions.title; - - - - - - - sybase.allow_persistent - boolean - - - - Whether to allow persistent Sybase connections. - - - - - - - sybase.max_persistent - integer - - - - The maximum number of persistent Sybase connections per - process. -1 means no limit. - - - - - - - sybase.max_links - integer - - - - The maximum number of Sybase connections per process, - including persistent connections. -1 means no limit. - - - - - - - sybase.min_error_severity - integer - - - - Minimum error severity to display. - - - - - - - sybase.min_message_severity - integer - - - - Minimum message severity to display. - - - - - - - magic_quotes_sybase - boolean - - - - If magic_quotes_sybase is on, a - single-quote is escaped with a single-quote instead of a - backslash if magic_quotes_gpc - or magic_quotes_runtime - are enabled. - This setting is also respected by addslashes and - stripslashes. - - - - Note that when magic_quotes_sybase - is ON it completely overrides magic_quotes_gpc - . In this case even when - magic_quotes_gpc is enabled - neither double quotes, backslashes or NUL's - will be escaped. - - - &warn.deprecated.feature-5-3-0.removed-5-4-0; - - - - - - - - - Sybase-CT configuration options - - - - &Name; - &Default; - &Changeable; - &Changelog; - - - - - sybct.deadlock_retry_count - "0" - PHP_INI_ALL - Available since PHP 4.3.0. - - - -
    -     - - &ini.descriptions.title; - - - - - - - sybct.login_timeout - integer - - - - The maximum time in seconds to wait for a connection attempt - to succeed before returning failure. Note that if - max_execution_time has been exceeded when a connection attempt - times out, your script will be terminated before it can take - action on failure. The default is one minute. - - - - - - - sybct.timeout - integer - - - - The maximum time in seconds to wait for a select_db or query - operation to succeed before returning failure. Note that if - max_execution_time has been exceeded when an operation times - out, your script will be terminated before it can take action - on failure. The default is no limit. - - - - - - - sybct.deadlock_retry_count - int - - - - Allows you to define how often deadlocks are to be retried. The default - is 0, value -1 means "forever". - - - - - - - - &ini.php.constants; - - -
    - - - diff --git a/reference/sybase/reference.xml b/reference/sybase/reference.xml deleted file mode 100644 index 56243963b533..000000000000 --- a/reference/sybase/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - Sybase &Functions; - - &reference.sybase.entities.functions; - - - - diff --git a/reference/sybase/setup.xml b/reference/sybase/setup.xml deleted file mode 100644 index f03d62c94b62..000000000000 --- a/reference/sybase/setup.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - &no.requirement; -
    - - - - &reference.sybase.configure; - - - - &reference.sybase.ini; - - - -
    - &reftitle.resources; - &no.resource; -
    - - -     - - - diff --git a/reference/sybase/versions.xml b/reference/sybase/versions.xml deleted file mode 100644 index 0e4a1a301d8e..000000000000 --- a/reference/sybase/versions.xml +++ /dev/null @@ -1,52 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/reference/tokenizer/functions/token-get-all.xml b/reference/tokenizer/functions/token-get-all.xml index e2ec9671049a..e2dc9e6f97c4 100644 --- a/reference/tokenizer/functions/token-get-all.xml +++ b/reference/tokenizer/functions/token-get-all.xml @@ -63,36 +63,6 @@ content of the original token in element 1 and the line number in element 2.     - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 7.0.0 - - Added the optional flags parameter along with - the TOKEN_PARSE flag. - - - - 5.2.2 - - Line numbers are returned in element 2 - - - - - - - &reftitle.examples; diff --git a/reference/uodbc/functions/odbc-execute.xml b/reference/uodbc/functions/odbc-execute.xml index 29d9a7649f35..e4807aa35b93 100644 --- a/reference/uodbc/functions/odbc-execute.xml +++ b/reference/uodbc/functions/odbc-execute.xml @@ -91,8 +91,7 @@ $success = odbc_execute($stmt, array($a, $b, $c)); If you need to call a stored procedure using INOUT or OUT parameters, the recommended workaround is to use a native extension for your database - (for example, mssql for MS SQL Server, - or oci8 for Oracle). + (for example, oci8 for Oracle). diff --git a/reference/uodbc/functions/odbc-prepare.xml b/reference/uodbc/functions/odbc-prepare.xml index 75fa471c73c3..f082c661c79f 100644 --- a/reference/uodbc/functions/odbc-prepare.xml +++ b/reference/uodbc/functions/odbc-prepare.xml @@ -80,8 +80,7 @@ $success = odbc_execute($stmt, array($a, $b, $c)); If you need to call a stored procedure using INOUT or OUT parameters, the recommended workaround is to use a native extension for your database - (for example, mssql for MS SQL Server, - or oci8 for Oracle). + (for example, oci8 for Oracle). diff --git a/reference/url/functions/base64-decode.xml b/reference/url/functions/base64-decode.xml index 1d875825a245..3f879bbf95dc 100644 --- a/reference/url/functions/base64-decode.xml +++ b/reference/url/functions/base64-decode.xml @@ -53,28 +53,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.0 - strict added - - - - - - - &reftitle.examples; diff --git a/reference/url/functions/get-headers.xml b/reference/url/functions/get-headers.xml index 2fbbd01cf92a..fbbf223af7f9 100644 --- a/reference/url/functions/get-headers.xml +++ b/reference/url/functions/get-headers.xml @@ -81,14 +81,6 @@ The context parameter was added. - - 5.1.3 - - This function now uses the default stream context, which can be - set/changed with the stream_context_set_default - function. - - diff --git a/reference/url/functions/http-build-query.xml b/reference/url/functions/http-build-query.xml index 1ab6e3b3da67..90d990e69bb9 100644 --- a/reference/url/functions/http-build-query.xml +++ b/reference/url/functions/http-build-query.xml @@ -98,42 +98,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - The enc_type parameter was added. - - - - 5.1.3 - - Square brackets are escaped. - - - - 5.1.2 - - The arg_separator parameter was added. - - - - - - - - &reftitle.examples; diff --git a/reference/url/functions/parse-url.xml b/reference/url/functions/parse-url.xml index 9378d40aacf0..f1505ffb6137 100644 --- a/reference/url/functions/parse-url.xml +++ b/reference/url/functions/parse-url.xml @@ -122,42 +122,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.7 - - Fixed host recognition when scheme - is omitted and a leading component separator is present. - - - - 5.3.3 - - Removed the E_WARNING that was emitted when URL - parsing failed. - - - - 5.1.2 - Added the component parameter. - - - - - - - &reftitle.examples; diff --git a/reference/url/functions/rawurlencode.xml b/reference/url/functions/rawurlencode.xml index 04fbdaf5c86d..45df903d3763 100644 --- a/reference/url/functions/rawurlencode.xml +++ b/reference/url/functions/rawurlencode.xml @@ -52,37 +52,6 @@ - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.4 - - Tilde characters are no longer encoded when - rawurlencode is used with EBCDIC strings. - - - - 5.3.0 - - Now conforms to RFC 3986. - - - - - - - &reftitle.examples; diff --git a/reference/var/functions/empty.xml b/reference/var/functions/empty.xml index a104c81a8a16..13d4c46d53a2 100644 --- a/reference/var/functions/empty.xml +++ b/reference/var/functions/empty.xml @@ -62,40 +62,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.5.0 - - - empty now supports expressions, rather than only - variables. - - - - - 5.4.0 - - - Checking non-numeric offsets of strings returns &true;. - - - - - - - - &reftitle.examples; diff --git a/reference/var/functions/get-resource-type.xml b/reference/var/functions/get-resource-type.xml index 2b18ee8cd110..3cb72c47eb81 100644 --- a/reference/var/functions/get-resource-type.xml +++ b/reference/var/functions/get-resource-type.xml @@ -50,29 +50,6 @@ - - &reftitle.changelog; - - - - - &Version; - &Description; - - - - - 5.3.0 - - If handle is not a resource this - functions returns &null;. Formerly, &false; has been returned. - - - - - - - &reftitle.examples; diff --git a/reference/var/functions/import-request-variables.xml b/reference/var/functions/import-request-variables.xml deleted file mode 100644 index 4691f3ed5861..000000000000 --- a/reference/var/functions/import-request-variables.xml +++ /dev/null @@ -1,138 +0,0 @@ - - - - - import_request_variables - Import GET/POST/Cookie variables into the global scope - - - - &reftitle.description; - - boolimport_request_variables - stringtypes - stringprefix - - - Imports GET/POST/Cookie variables into the global scope. It is useful if - you disabled register_globals, - but would like to see some variables in the global scope. - - - If you're interested in importing other variables into the global scope, - such as $_SERVER, consider using extract. - - &warn.deprecated.function-5-3-0.removed-5-4-0; - - - - &reftitle.parameters; - - - - types - - - Using the types parameter, you can specify - which request variables to import. You can use 'G', 'P' and 'C' - characters respectively for GET, POST and Cookie. These characters are - not case sensitive, so you can also use any combination of 'g', 'p' - and 'c'. POST includes the POST uploaded file information. - - - - Note that the order of the letters matters, as when using - "GP", the - POST variables will overwrite GET variables with the same name. Any - other letters than GPC are discarded. - - - - - - prefix - - - Variable name prefix, prepended before all variable's name imported - into the global scope. So if you have a GET value named - "userid", and provide a prefix - "pref_", then you'll get a global variable named - $pref_userid. - - - - Although the prefix parameter is optional, you - will get an E_NOTICE level - error if you specify no prefix, or specify an empty string as a - prefix. This is a possible security hazard. Notice level errors are - not displayed using the default error reporting level. - - - - - - - - - - &reftitle.returnvalues; - - &return.success; - - - - - &reftitle.examples; - - - <function>import_request_variables</function> example - - -]]> - - - - - - - &reftitle.seealso; - - - $_REQUEST - register_globals - Predefined Variables - extract - - - - - - - diff --git a/reference/var/functions/intval.xml b/reference/var/functions/intval.xml index eb0a0c78d70b..5573fc45c448 100644 --- a/reference/var/functions/intval.xml +++ b/reference/var/functions/intval.xml @@ -139,32 +139,6 @@ echo intval(true); // 1 - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.0 - - Throws E_NOTICE and - returns 1, when an object is passed to - var. - - - - - - - - &reftitle.seealso; diff --git a/reference/var/functions/isset.xml b/reference/var/functions/isset.xml index f3b24654aae4..38a802d87c55 100644 --- a/reference/var/functions/isset.xml +++ b/reference/var/functions/isset.xml @@ -67,32 +67,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.4.0 - - - Checking non-numeric offsets of strings now returns &false;. - - - - - - - - - &reftitle.examples; diff --git a/reference/var/functions/var-export.xml b/reference/var/functions/var-export.xml index 1272c976b20d..c0078587759c 100644 --- a/reference/var/functions/var-export.xml +++ b/reference/var/functions/var-export.xml @@ -83,13 +83,6 @@ PHP. - - 5.1.0 - - Made it possible to export classes and arrays containing classes using - the __set_state() magic method. - - diff --git a/reference/var/versions.xml b/reference/var/versions.xml index 5c4968f4e9dd..f51b85df0689 100644 --- a/reference/var/versions.xml +++ b/reference/var/versions.xml @@ -13,7 +13,6 @@ - diff --git a/reference/vpopmail/book.xml b/reference/vpopmail/book.xml deleted file mode 100644 index 4fa9664d4ef0..000000000000 --- a/reference/vpopmail/book.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - - vpopmail - - - - &reftitle.intro; - &warn.experimental; - - - - &reference.vpopmail.setup; - &reference.vpopmail.constants; - &reference.vpopmail.reference; - - - - - diff --git a/reference/vpopmail/configure.xml b/reference/vpopmail/configure.xml deleted file mode 100644 index c08871705600..000000000000 --- a/reference/vpopmail/configure.xml +++ /dev/null @@ -1,36 +0,0 @@ - - -
    - &reftitle.install; - - &pecl.moved; - - - &pecl.info; - &url.pecl.package;vpopmail. - - - &pecl.windows.download; - -
    - - diff --git a/reference/vpopmail/constants.xml b/reference/vpopmail/constants.xml deleted file mode 100644 index 796a1b70b039..000000000000 --- a/reference/vpopmail/constants.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - &reftitle.constants; - &no.constants; - - - - diff --git a/reference/vpopmail/functions/vpopmail-add-alias-domain-ex.xml b/reference/vpopmail/functions/vpopmail-add-alias-domain-ex.xml deleted file mode 100644 index 41dd85c5877b..000000000000 --- a/reference/vpopmail/functions/vpopmail-add-alias-domain-ex.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - vpopmail_add_alias_domain_ex - Add alias to an existing virtual domain - - - &reftitle.description; - - boolvpopmail_add_alias_domain_ex - stringolddomain - stringnewdomain - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/vpopmail/functions/vpopmail-add-alias-domain.xml b/reference/vpopmail/functions/vpopmail-add-alias-domain.xml deleted file mode 100644 index 457289171540..000000000000 --- a/reference/vpopmail/functions/vpopmail-add-alias-domain.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - vpopmail_add_alias_domain - Add an alias for a virtual domain - - - &reftitle.description; - - boolvpopmail_add_alias_domain - stringdomain - stringaliasdomain - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/vpopmail/functions/vpopmail-add-domain-ex.xml b/reference/vpopmail/functions/vpopmail-add-domain-ex.xml deleted file mode 100644 index 723aa6cc5cc5..000000000000 --- a/reference/vpopmail/functions/vpopmail-add-domain-ex.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - vpopmail_add_domain_ex - Add a new virtual domain - - - &reftitle.description; - - boolvpopmail_add_domain_ex - stringdomain - stringpasswd - stringquota - stringbounce - boolapop - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/vpopmail/functions/vpopmail-add-domain.xml b/reference/vpopmail/functions/vpopmail-add-domain.xml deleted file mode 100644 index 3fa2945ea0ff..000000000000 --- a/reference/vpopmail/functions/vpopmail-add-domain.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - vpopmail_add_domain - Add a new virtual domain - - - &reftitle.description; - - boolvpopmail_add_domain - stringdomain - stringdir - intuid - intgid - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/vpopmail/functions/vpopmail-add-user.xml b/reference/vpopmail/functions/vpopmail-add-user.xml deleted file mode 100644 index c948deadc508..000000000000 --- a/reference/vpopmail/functions/vpopmail-add-user.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - vpopmail_add_user - Add a new user to the specified virtual domain - - - &reftitle.description; - - boolvpopmail_add_user - stringuser - stringdomain - stringpassword - stringgecos - boolapop - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/vpopmail/functions/vpopmail-alias-add.xml b/reference/vpopmail/functions/vpopmail-alias-add.xml deleted file mode 100644 index 385434693e5f..000000000000 --- a/reference/vpopmail/functions/vpopmail-alias-add.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - vpopmail_alias_add - Insert a virtual alias - - - &reftitle.description; - - boolvpopmail_alias_add - stringuser - stringdomain - stringalias - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/vpopmail/functions/vpopmail-alias-del-domain.xml b/reference/vpopmail/functions/vpopmail-alias-del-domain.xml deleted file mode 100644 index 97078290fcc8..000000000000 --- a/reference/vpopmail/functions/vpopmail-alias-del-domain.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - vpopmail_alias_del_domain - Deletes all virtual aliases of a domain - - - &reftitle.description; - - boolvpopmail_alias_del_domain - stringdomain - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/vpopmail/functions/vpopmail-alias-del.xml b/reference/vpopmail/functions/vpopmail-alias-del.xml deleted file mode 100644 index cce232486f90..000000000000 --- a/reference/vpopmail/functions/vpopmail-alias-del.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - vpopmail_alias_del - Deletes all virtual aliases of a user - - - &reftitle.description; - - boolvpopmail_alias_del - stringuser - stringdomain - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/vpopmail/functions/vpopmail-alias-get-all.xml b/reference/vpopmail/functions/vpopmail-alias-get-all.xml deleted file mode 100644 index d323d767d9ee..000000000000 --- a/reference/vpopmail/functions/vpopmail-alias-get-all.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - vpopmail_alias_get_all - Get all lines of an alias for a domain - - - &reftitle.description; - - arrayvpopmail_alias_get_all - stringdomain - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/vpopmail/functions/vpopmail-alias-get.xml b/reference/vpopmail/functions/vpopmail-alias-get.xml deleted file mode 100644 index 5b372cfb0312..000000000000 --- a/reference/vpopmail/functions/vpopmail-alias-get.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - vpopmail_alias_get - Get all lines of an alias for a domain - - - &reftitle.description; - - arrayvpopmail_alias_get - stringalias - stringdomain - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/vpopmail/functions/vpopmail-auth-user.xml b/reference/vpopmail/functions/vpopmail-auth-user.xml deleted file mode 100644 index 46f8670c49c7..000000000000 --- a/reference/vpopmail/functions/vpopmail-auth-user.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - vpopmail_auth_user - Attempt to validate a username/domain/password - - - &reftitle.description; - - boolvpopmail_auth_user - stringuser - stringdomain - stringpassword - stringapop - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/vpopmail/functions/vpopmail-del-domain-ex.xml b/reference/vpopmail/functions/vpopmail-del-domain-ex.xml deleted file mode 100644 index 88c3a1816d90..000000000000 --- a/reference/vpopmail/functions/vpopmail-del-domain-ex.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - vpopmail_del_domain_ex - Delete a virtual domain - - - &reftitle.description; - - boolvpopmail_del_domain_ex - stringdomain - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/vpopmail/functions/vpopmail-del-domain.xml b/reference/vpopmail/functions/vpopmail-del-domain.xml deleted file mode 100644 index f234dba5372b..000000000000 --- a/reference/vpopmail/functions/vpopmail-del-domain.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - vpopmail_del_domain - Delete a virtual domain - - - &reftitle.description; - - boolvpopmail_del_domain - stringdomain - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/vpopmail/functions/vpopmail-del-user.xml b/reference/vpopmail/functions/vpopmail-del-user.xml deleted file mode 100644 index 9265a40b4d30..000000000000 --- a/reference/vpopmail/functions/vpopmail-del-user.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - vpopmail_del_user - Delete a user from a virtual domain - - - &reftitle.description; - - boolvpopmail_del_user - stringuser - stringdomain - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/vpopmail/functions/vpopmail-error.xml b/reference/vpopmail/functions/vpopmail-error.xml deleted file mode 100644 index 2a2b9ca9a756..000000000000 --- a/reference/vpopmail/functions/vpopmail-error.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - vpopmail_error - Get text message for last vpopmail error - - - &reftitle.description; - - stringvpopmail_error - - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/vpopmail/functions/vpopmail-passwd.xml b/reference/vpopmail/functions/vpopmail-passwd.xml deleted file mode 100644 index 8577d99a79b6..000000000000 --- a/reference/vpopmail/functions/vpopmail-passwd.xml +++ /dev/null @@ -1,41 +0,0 @@ - - - - - vpopmail_passwd - Change a virtual user's password - - - &reftitle.description; - - boolvpopmail_passwd - stringuser - stringdomain - stringpassword - boolapop - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/vpopmail/functions/vpopmail-set-user-quota.xml b/reference/vpopmail/functions/vpopmail-set-user-quota.xml deleted file mode 100644 index fb970a665040..000000000000 --- a/reference/vpopmail/functions/vpopmail-set-user-quota.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - vpopmail_set_user_quota - Sets a virtual user's quota - - - &reftitle.description; - - boolvpopmail_set_user_quota - stringuser - stringdomain - stringquota - - &warn.experimental.func; - &warn.undocumented.func; - - - - diff --git a/reference/vpopmail/reference.xml b/reference/vpopmail/reference.xml deleted file mode 100644 index 25583801cdac..000000000000 --- a/reference/vpopmail/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - vpopmail &Functions; - - &reference.vpopmail.entities.functions; - - - - diff --git a/reference/vpopmail/setup.xml b/reference/vpopmail/setup.xml deleted file mode 100644 index bb651fe93721..000000000000 --- a/reference/vpopmail/setup.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - &no.requirement; -
    - - - - &reference.vpopmail.configure; - - - -
    - &reftitle.runtime; - &no.config; -
    - - - -
    - &reftitle.resources; - &no.resource; -
    - - -     - - - diff --git a/reference/vpopmail/versions.xml b/reference/vpopmail/versions.xml deleted file mode 100644 index 1c153246fc3e..000000000000 --- a/reference/vpopmail/versions.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/reference/win32ps/book.xml b/reference/win32ps/book.xml deleted file mode 100644 index 4148c6dc9db1..000000000000 --- a/reference/win32ps/book.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - win32ps - - - - &reftitle.intro; - - The win32ps extension is a Windows specific extension that allows PHP - retrieve statistics about process and memory utilization. - - - - - &reference.win32ps.setup; - &reference.win32ps.constants; - &reference.win32ps.examples; - &reference.win32ps.reference; - - - - - diff --git a/reference/win32ps/constants.xml b/reference/win32ps/constants.xml deleted file mode 100644 index 42c49c53f567..000000000000 --- a/reference/win32ps/constants.xml +++ /dev/null @@ -1,29 +0,0 @@ - - - - - &reftitle.constants; - &no.constants; - - - - diff --git a/reference/win32ps/examples.xml b/reference/win32ps/examples.xml deleted file mode 100644 index 041dac3f57eb..000000000000 --- a/reference/win32ps/examples.xml +++ /dev/null @@ -1,95 +0,0 @@ - - - - - &reftitle.examples; -
    - Win32ps examples - - - Statistics about the current PHP process - - 936 - [exe] => D:\Daten\Source\php-5.1\Debug_TS\php.exe - [mem] => Array - ( - [page_fault_count] => 2062 - [peak_working_set_size] => 8396800 - [working_set_size] => 8396800 - [quota_peak_paged_pool_usage] => 32080 - [quota_paged_pool_usage] => 31876 - [quota_peak_non_paged_pool_usage] => 4240 - [quota_non_paged_pool_usage] => 3888 - [pagefile_usage] => 5865472 - [peak_pagefile_usage] => 5865472 - ) - - [tms] => Array - ( - [created] => 0.093 - [kernel] => 0.015 - [user] => 0.062 - ) - - ) -*/ -?> -]]> - - - - - - Statistics about global memory utilization - - 37 - [unit] => 1024 - [total_phys] => 1048096 - [avail_phys] => 649960 - [total_pagefile] => 2521368 - [avail_pagefile] => 2237940 - [total_virtual] => 2097024 - [avail_virtual] => 2057848 - ) -*/ -?> -]]> - - - -
    -     - - - diff --git a/reference/win32ps/functions/win32-ps-list-procs.xml b/reference/win32ps/functions/win32-ps-list-procs.xml deleted file mode 100644 index 4c27d185efca..000000000000 --- a/reference/win32ps/functions/win32-ps-list-procs.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - - win32_ps_list_procs - List running processes - - - &reftitle.description; - - arraywin32_ps_list_procs - - - - Retrieves statistics about all running processes. - - - - &reftitle.returnvalues; - - Returns &false; on failure, or an array consisting of process statistics like - win32_ps_stat_proc returns for all running processes on success. - - - - &reftitle.seealso; - - - win32_ps_stat_proc - - - - - - diff --git a/reference/win32ps/functions/win32-ps-stat-mem.xml b/reference/win32ps/functions/win32-ps-stat-mem.xml deleted file mode 100644 index 81f85c1e5190..000000000000 --- a/reference/win32ps/functions/win32-ps-stat-mem.xml +++ /dev/null @@ -1,114 +0,0 @@ - - - - - win32_ps_stat_mem - Stat memory utilization - - - &reftitle.description; - - arraywin32_ps_stat_mem - - - - Retrieves statistics about the global memory utilization. - - - - &reftitle.returnvalues; - - Returns &false; on failure, or an array consisting of the - following information on success: - - - - - load - - - The current memory load in percent of physical memory. - - - - - unit - - - This is always 1024, and indicates that the following values are the count of 1024 bytes. - - - - - total_phys - - - The amount of total physical memory. - - - - - avail_phys - - - The amount of still available physical memory. - - - - - total_pagefile - - - The amount of total pageable memory (physical memory + paging file). - - - - - avail_pagefile - - - The amount of still available pageable memory (physical memory + paging file). - - - - - total_virtual - - - The amount of total virtual memory for a process. - - - - - avail_virtual - - - The amount of still available virtual memory for a process. - - - - - - - - - diff --git a/reference/win32ps/functions/win32-ps-stat-proc.xml b/reference/win32ps/functions/win32-ps-stat-proc.xml deleted file mode 100644 index 557e7081311d..000000000000 --- a/reference/win32ps/functions/win32-ps-stat-proc.xml +++ /dev/null @@ -1,115 +0,0 @@ - - - - - win32_ps_stat_proc - Stat process - - - &reftitle.description; - - arraywin32_ps_stat_proc - intpid0 - - - Retrieves statistics about the process with the process id pid. - - - - &reftitle.parameters; - - - - pid - - - The process id of the process to stat. If omitted, the id of the current process. - - - - - - - - &reftitle.returnvalues; - - Returns &false; on failure, or an array consisting of the - following information on success: - - - - - pid - - - The process id. - - - - - exe - - - The 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. - - - - - - - - &reftitle.seealso; - - - win32_ps_list_procs - - - - - - diff --git a/reference/win32ps/reference.xml b/reference/win32ps/reference.xml deleted file mode 100644 index ed8af72894f7..000000000000 --- a/reference/win32ps/reference.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - win32ps &Functions; - - &reference.win32ps.entities.functions; - - - - diff --git a/reference/win32ps/setup.xml b/reference/win32ps/setup.xml deleted file mode 100644 index f74cdf1e5444..000000000000 --- a/reference/win32ps/setup.xml +++ /dev/null @@ -1,63 +0,0 @@ - - - - - &reftitle.setup; - - -
    - &reftitle.required; - - Windows NT, Windows 2000, Windows XP or Windows Server 2003. - Any version of Windows derived from Windows NT should be compatible. - -
    - - - -
    - &reftitle.install; - - &pecl.info; - &url.pecl.package;win32ps. - -
    - - - -
    - &reftitle.runtime; - &no.config; -
    - - - -
    - &reftitle.resources; - &no.resource; -
    - - -     - - - diff --git a/reference/win32ps/versions.xml b/reference/win32ps/versions.xml deleted file mode 100644 index c4f4755191a3..000000000000 --- a/reference/win32ps/versions.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - - - - - \ No newline at end of file diff --git a/reference/xmlreader/xmlreader/expand.xml b/reference/xmlreader/xmlreader/expand.xml index 6980a2401251..8e9abd3d42a7 100644 --- a/reference/xmlreader/xmlreader/expand.xml +++ b/reference/xmlreader/xmlreader/expand.xml @@ -38,31 +38,7 @@ The resulting DOMNode or &false; on error.     - - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.3.0 - - The parameter basenode was added. - - - - - - - - + - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.1.3 - - Return &null; if no attribute found. - Previously, returned an empty string. - - - - - - - - &reftitle.seealso; diff --git a/reference/xmlreader/xmlreader/open.xml b/reference/xmlreader/xmlreader/open.xml index 7ec6616789a3..28173460f6d1 100644 --- a/reference/xmlreader/xmlreader/open.xml +++ b/reference/xmlreader/xmlreader/open.xml @@ -67,31 +67,6 @@ &dom.allowstatic; - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.0 - - encoding and options - were added. - - - - - - - - &reftitle.seealso; diff --git a/reference/xmlreader/xmlreader/xml.xml b/reference/xmlreader/xmlreader/xml.xml index 58108e92b52f..54ca3436287d 100644 --- a/reference/xmlreader/xmlreader/xml.xml +++ b/reference/xmlreader/xmlreader/xml.xml @@ -67,31 +67,6 @@ &dom.allowstatic; - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.0 - - encoding and options - were added. - - - - - - - - &reftitle.seealso; diff --git a/reference/xmlwriter/functions/xmlwriter-write-element-ns.xml b/reference/xmlwriter/functions/xmlwriter-write-element-ns.xml index 70397c4e89c3..440b94c87ba0 100644 --- a/reference/xmlwriter/functions/xmlwriter-write-element-ns.xml +++ b/reference/xmlwriter/functions/xmlwriter-write-element-ns.xml @@ -78,30 +78,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.3 - - The content parameter became optional. - - - - - - - - &reftitle.seealso; diff --git a/reference/xmlwriter/functions/xmlwriter-write-element.xml b/reference/xmlwriter/functions/xmlwriter-write-element.xml index 441fc583b84d..69c1a68075da 100644 --- a/reference/xmlwriter/functions/xmlwriter-write-element.xml +++ b/reference/xmlwriter/functions/xmlwriter-write-element.xml @@ -58,30 +58,6 @@ - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.3 - - The content parameter became optional. - - - - - - - - &reftitle.seealso; diff --git a/reference/xsl/xsltprocessor/importstylesheet.xml b/reference/xsl/xsltprocessor/importstylesheet.xml index c2435914c997..b2cafafe71c9 100644 --- a/reference/xsl/xsltprocessor/importstylesheet.xml +++ b/reference/xsl/xsltprocessor/importstylesheet.xml @@ -39,30 +39,6 @@ &return.success; - - &reftitle.changelog; - - - - - - &Version; - &Description; - - - - - 5.2.8 - - Accepts SimpleXMLElement again which was broken - since PHP 5.2.6. - - - - - - - If enabled, a single-quote is escaped with a single-quote instead of a