From c672ec208a81a60850823b9e46318485c30bec6f Mon Sep 17 00:00:00 2001 From: Jakub Vrana Date: Wed, 15 May 2013 21:23:52 +0000 Subject: [PATCH] Add PHP 5.5 cURL functions git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@330233 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/curl/functions/curl-escape.xml | 68 +++++++++++++++ reference/curl/functions/curl-file-create.xml | 84 +++++++++++++++++++ reference/curl/functions/curl-pause.xml | 68 +++++++++++++++ reference/curl/functions/curl-reset.xml | 59 +++++++++++++ reference/curl/functions/curl-share-close.xml | 66 +++++++++++++++ reference/curl/functions/curl-share-init.xml | 57 +++++++++++++ .../curl/functions/curl-share-setopt.xml | 84 +++++++++++++++++++ reference/curl/functions/curl-strerror.xml | 66 +++++++++++++++ reference/curl/functions/curl-unescape.xml | 68 +++++++++++++++ 9 files changed, 620 insertions(+) create mode 100644 reference/curl/functions/curl-escape.xml create mode 100644 reference/curl/functions/curl-file-create.xml create mode 100644 reference/curl/functions/curl-pause.xml create mode 100644 reference/curl/functions/curl-reset.xml create mode 100644 reference/curl/functions/curl-share-close.xml create mode 100644 reference/curl/functions/curl-share-init.xml create mode 100644 reference/curl/functions/curl-share-setopt.xml create mode 100644 reference/curl/functions/curl-strerror.xml create mode 100644 reference/curl/functions/curl-unescape.xml diff --git a/reference/curl/functions/curl-escape.xml b/reference/curl/functions/curl-escape.xml new file mode 100644 index 0000000000..6caad995a1 --- /dev/null +++ b/reference/curl/functions/curl-escape.xml @@ -0,0 +1,68 @@ + + + + + + curl_escape + URL encodes the given string + + + + &reftitle.description; + + stringcurl_escape + resourcech + stringstr + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + &curl.ch.description; + + str + + + + + + + + + + + &reftitle.returnvalues; + + Return escaped string&return.falseforfailure;. + + + + + + diff --git a/reference/curl/functions/curl-file-create.xml b/reference/curl/functions/curl-file-create.xml new file mode 100644 index 0000000000..981aaba0af --- /dev/null +++ b/reference/curl/functions/curl-file-create.xml @@ -0,0 +1,84 @@ + + + + + + curl_file_create + Create the CURLFile object + + + + &reftitle.description; + + CURLFilecurl_file_create + stringfilename + stringmimetype + stringpostname + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + filename + + + + + + + + mimetype + + + + + + + + postname + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + + diff --git a/reference/curl/functions/curl-pause.xml b/reference/curl/functions/curl-pause.xml new file mode 100644 index 0000000000..6284d89b71 --- /dev/null +++ b/reference/curl/functions/curl-pause.xml @@ -0,0 +1,68 @@ + + + + + + curl_pause + Pause and unpause a connection + + + + &reftitle.description; + + intcurl_pause + resourcech + intbitmask + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + &curl.ch.description; + + bitmask + + + One of CURLPAUSE_* constants. + + + + + + + + &reftitle.returnvalues; + + Returns an error code (CURLE_OK for no error). + + + + + + diff --git a/reference/curl/functions/curl-reset.xml b/reference/curl/functions/curl-reset.xml new file mode 100644 index 0000000000..b5c1459f93 --- /dev/null +++ b/reference/curl/functions/curl-reset.xml @@ -0,0 +1,59 @@ + + + + + + curl_reset + Reset all options of a libcurl session handle + + + + &reftitle.description; + + voidcurl_reset + resourcech + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + &curl.ch.description; + + + + + &reftitle.returnvalues; + + &return.void; + + + + + + diff --git a/reference/curl/functions/curl-share-close.xml b/reference/curl/functions/curl-share-close.xml new file mode 100644 index 0000000000..60d5b55e2c --- /dev/null +++ b/reference/curl/functions/curl-share-close.xml @@ -0,0 +1,66 @@ + + + + + + curl_share_close + Close a set of cURL handles + + + + &reftitle.description; + + voidcurl_share_close + resourcesh + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + sh + + + + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + + + diff --git a/reference/curl/functions/curl-share-init.xml b/reference/curl/functions/curl-share-init.xml new file mode 100644 index 0000000000..5dd3fbb6d1 --- /dev/null +++ b/reference/curl/functions/curl-share-init.xml @@ -0,0 +1,57 @@ + + + + + + curl_share_init + Initialize a share curl handle + + + + &reftitle.description; + + resourcecurl_share_init + + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + Returns resource of type "cURL Share Handle". + + + + + + diff --git a/reference/curl/functions/curl-share-setopt.xml b/reference/curl/functions/curl-share-setopt.xml new file mode 100644 index 0000000000..da61d3b391 --- /dev/null +++ b/reference/curl/functions/curl-share-setopt.xml @@ -0,0 +1,84 @@ + + + + + + curl_share_setopt + Set an option for a cURL transfer + + + + &reftitle.description; + + boolcurl_share_setopt + resourcesh + intoption + stringvalue + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + sh + + + + + + + + option + + + + + + + + value + + + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + + diff --git a/reference/curl/functions/curl-strerror.xml b/reference/curl/functions/curl-strerror.xml new file mode 100644 index 0000000000..122e0c2ba6 --- /dev/null +++ b/reference/curl/functions/curl-strerror.xml @@ -0,0 +1,66 @@ + + + + + + curl_strerror + Return string describing error code + + + + &reftitle.description; + + stringcurl_strerror + interrornum + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + + errornum + + + One of CURLE_* constants. + + + + + + + + &reftitle.returnvalues; + + Returns error description or &null; for invalid error code. + + + + + + diff --git a/reference/curl/functions/curl-unescape.xml b/reference/curl/functions/curl-unescape.xml new file mode 100644 index 0000000000..09dfd2b673 --- /dev/null +++ b/reference/curl/functions/curl-unescape.xml @@ -0,0 +1,68 @@ + + + + + + curl_unescape + URL decodes the given string + + + + &reftitle.description; + + stringcurl_unescape + resourcech + stringstr + + + + + + &warn.undocumented.func; + + + + + &reftitle.parameters; + + &curl.ch.description; + + str + + + + + + + + + + + &reftitle.returnvalues; + + Return unescaped string&return.falseforfailure;. + + + + + +