| [ PHPXref.com ] | [ Generated: Sun Jul 20 21:13:28 2008 ] | [ Yahoolib 0.1 ] |
| [ Index ] [ Variables ] [ Functions ] [ Classes ] [ Constants ] [ Statistics ] | ||
[Summary view] [Print] [Text view]
1 <?xml version="1.0" encoding="iso-8859-1"?> 2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 3 <html xmlns="http://www.w3.org/1999/xhtml"> 4 <head> 5 <!-- template designed by Marco Von Ballmoos --> 6 <title>Docs for page yahootools.inc.php</title> 7 <link rel="stylesheet" href="../media/stylesheet.css" /> 8 <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> 9 </head> 10 <body> 11 <div class="page-body"> 12 <h2 class="file-name">/yahootools.inc.php</h2> 13 14 <a name="sec-description"></a> 15 <div class="info-box"> 16 <div class="info-box-title">Description</div> 17 <div class="nav-bar"> 18 <span class="disabled">Description</span> | 19 <a href="#sec-variables">Variables</a> 20 | <a href="#sec-functions">Functions</a> 21 </div> 22 <div class="info-box-body"> 23 <!-- ========== Info from phpDoc block ========= --> 24 <p class="short-description">yahootools.inc.php -- Helpful functions for running Yahoo! REST requests</p> 25 <ul class="tags"> 26 <li><span class="field">link:</span> <a href="http://sourceforge.net/projects/yahoolib">http://sourceforge.net/projects/yahoolib</a></li> 27 <li><span class="field">version:</span> 0.1 June 3rd, 2005</li> 28 <li><span class="field">author:</span> Jason Levitt. XML parsing function based on code by Torsten Koster</li> 29 </ul> 30 31 </div> 32 </div> 33 34 35 36 37 <a name="sec-variables"></a> 38 <div class="info-box"> 39 <div class="info-box-title">Variables</div> 40 <div class="nav-bar"> 41 <a href="#sec-description">Description</a> | 42 <span class="disabled">Variables</span> 43 | <a href="#sec-functions">Functions</a> 44 </div> 45 <div class="info-box-body"> 46 <a name="global$xml_list_elements" id="global$xml_list_elements"><!-- --></a> 47 <div class="evenrow"> 48 49 <div> 50 <span class="var-title"> 51 <span class="var-type">array</span> 52 <span class="var-name">$xml_list_elements</span> 53 (line <span class="line-number">29</span>) 54 </span> 55 </div> 56 57 <!-- ========== Info from phpDoc block ========= --> 58 <p class="short-description">Global variables</p> 59 <p class="description"><p>$xml_list_elements contains any V1 XML elements that are array structures $parser_error, $getdata_error, and $postdata_error contain explanations of error conditions for the XmlParser(), GetData(), and PostData() functions</p></p> 60 61 62 </div> 63 </div> 64 </div> 65 66 <a name="sec-functions"></a> 67 <div class="info-box"> 68 <div class="info-box-title">Functions</div> 69 <div class="nav-bar"> 70 <a href="#sec-description">Description</a> | 71 <a href="#sec-variables">Variables</a> 72 | <span class="disabled">Functions</span> 73 </div> 74 <div class="info-box-body"> 75 <a name="functioncomposeArray" id="functioncomposeArray"><!-- --></a> 76 <div class="oddrow"> 77 78 <div> 79 <span class="method-title">composeArray</span> (line <span class="line-number">120</span>) 80 </div> 81 82 <!-- ========== Info from phpDoc block ========= --> 83 <p class="short-description">A private helper function for XmlParser(). Parses repeated XML values into arrays.</p> 84 85 <div class="method-signature"> 86 <span class="method-result">array</span> 87 <span class="method-name"> 88 &composeArray 89 </span> 90 (<span class="var-type">array</span> <span class="var-name">$array</span>, <span class="var-type">array</span> <span class="var-name">$elements</span>, <span class="var-type">string</span> <span class="var-name">$value</span>) 91 </div> 92 93 <ul class="parameters"> 94 <li> 95 <span class="var-type">array</span> 96 <span class="var-name">$array</span> </li> 97 <li> 98 <span class="var-type">array</span> 99 <span class="var-name">$elements</span> </li> 100 <li> 101 <span class="var-type">string</span> 102 <span class="var-name">$value</span> </li> 103 </ul> 104 105 106 </div> 107 <a name="functionGetData" id="functionGetData"><!-- --></a> 108 <div class="evenrow"> 109 110 <div> 111 <span class="method-title">GetData</span> (line <span class="line-number">170</span>) 112 </div> 113 114 <!-- ========== Info from phpDoc block ========= --> 115 <p class="short-description">GetData -- Fetch a URL using an HTTP 1.0 GET operation</p> 116 <p class="description"><p>GetData returns a string that is the result of doing an HTTP 1.0 GET request on the URL. If an error occurs, false is returned and the global $getdata_error is set to describe the error.</p></p> 117 <ul class="tags"> 118 <li><span class="field">return:</span> Either false on error or result of fetching the URL</li> 119 </ul> 120 121 <div class="method-signature"> 122 <span class="method-result">boolean|string</span> 123 <span class="method-name"> 124 GetData 125 </span> 126 (<span class="var-type">string</span> <span class="var-name">$url</span>, <span class="var-type">integer</span> <span class="var-name">$timeout</span>) 127 </div> 128 129 <ul class="parameters"> 130 <li> 131 <span class="var-type">string</span> 132 <span class="var-name">$url</span><span class="var-description">: A valid HTTP URL</span> </li> 133 <li> 134 <span class="var-type">integer</span> 135 <span class="var-name">$timeout</span><span class="var-description">: Number of seconds to block waiting for a response</span> </li> 136 </ul> 137 138 139 </div> 140 <a name="functionPostData" id="functionPostData"><!-- --></a> 141 <div class="oddrow"> 142 143 <div> 144 <span class="method-title">PostData</span> (line <span class="line-number">287</span>) 145 </div> 146 147 <!-- ========== Info from phpDoc block ========= --> 148 <p class="short-description">PostData -- Fetch a URL using an HTTP 1.0 POST operation</p> 149 <p class="description"><p>PostData returns a string that is the result of doing an HTTP 1.0 POST request on the URL. If an error occurs, false is returned and the global $postdata_error is set to describe the error.</p></p> 150 <ul class="tags"> 151 <li><span class="field">return:</span> False or the result of posting the elements of the URL</li> 152 </ul> 153 154 <div class="method-signature"> 155 <span class="method-result">boolean|string</span> 156 <span class="method-name"> 157 PostData 158 </span> 159 (<span class="var-type">string</span> <span class="var-name">$url</span>, <span class="var-type">integer</span> <span class="var-name">$timeout</span>) 160 </div> 161 162 <ul class="parameters"> 163 <li> 164 <span class="var-type">string</span> 165 <span class="var-name">$url</span><span class="var-description">: A valid HTTP URL</span> </li> 166 <li> 167 <span class="var-type">integer</span> 168 <span class="var-name">$timeout</span><span class="var-description">: Number of seconds to block waiting for a response</span> </li> 169 </ul> 170 171 172 </div> 173 <a name="functionXmlParser" id="functionXmlParser"><!-- --></a> 174 <div class="evenrow"> 175 176 <div> 177 <span class="method-title">XmlParser</span> (line <span class="line-number">44</span>) 178 </div> 179 180 <!-- ========== Info from phpDoc block ========= --> 181 <p class="short-description">XmlParser -- parse XML into an associative array</p> 182 <p class="description"><p>Takes a string of XML as input and returns an associative array. If an error occurs, false is returned and the global $parser_error describes the error in detail.</p></p> 183 <ul class="tags"> 184 <li><span class="field">return:</span> Returns false on error or associative array on success</li> 185 </ul> 186 187 <div class="method-signature"> 188 <span class="method-result">boolean|array</span> 189 <span class="method-name"> 190 XmlParser 191 </span> 192 (<span class="var-type">string</span> <span class="var-name">$string</span>) 193 </div> 194 195 <ul class="parameters"> 196 <li> 197 <span class="var-type">string</span> 198 <span class="var-name">$string</span><span class="var-description">: A string of XML</span> </li> 199 </ul> 200 201 202 </div> 203 </div> 204 </div> 205 206 <p class="notes" id="credit"> 207 Documentation generated on Fri, 3 Jun 2005 13:32:22 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a> 208 </p> 209 </div></body> 210 </html>
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| [ Powered by PHPXref - Served by Debian GNU/Linux ] |