"Fossies" - the Fresh Open Source Software Archive

Member "docs/phpcrawl/PHPCrawlerUtils.html" (20 Jan 2013, 32778 Bytes) of package /linux/www/SitemapCreator.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) HTML source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    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 Class PHPCrawlerUtils</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="class-name">Class PHPCrawlerUtils</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-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
   20                         
   21                     </div>
   22     <div class="info-box-body">
   23                 <!-- ========== Info from phpDoc block ========= -->
   24 <p class="short-description">Static util-methods used by phpcrawl.</p>
   25         <p class="notes">
   26             Located in <a class="field" href="_libs---PHPCrawler---PHPCrawlerUtils.class.php.html">/libs/PHPCrawler/PHPCrawlerUtils.class.php</a> (line <span class="field">8</span>)
   27         </p>
   28         
   29                 
   30         <pre></pre>
   31     
   32             </div>
   33 </div>
   34 
   35 
   36 
   37 
   38     <a name="sec-method-summary"></a>
   39     <div class="info-box">
   40         <div class="info-box-title">Method Summary</span></div>
   41         <div class="nav-bar">
   42             <a href="#sec-description">Description</a> |
   43                                                 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
   44         </div>
   45         <div class="info-box-body">         
   46             <div class="method-summary">
   47                                                 <div class="method-definition">
   48                     static                      <span class="method-result">string</span>
   49                                         <a href="#buildURLFromLink" title="details" class="method-name">buildURLFromLink</a>
   50                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$link</span>, <span class="var-type"><a href="../phpcrawl/PHPCrawlerUrlPartsDescriptor.html">PHPCrawlerUrlPartsDescriptor</a></span>&nbsp;<span class="var-name">$BaseUrlParts</span>)
   51                                     </div>
   52                                                                 <div class="method-definition">
   53                     static                      <span class="method-result">string</span>
   54                                         <a href="#buildURLFromParts" title="details" class="method-name">buildURLFromParts</a>
   55                                             (<span class="var-type">array</span>&nbsp;<span class="var-name">$url_parts</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$normalize</span> = <span class="var-default">false</span>])
   56                                     </div>
   57                                                                 <div class="method-definition">
   58                     static                      <span class="method-result">bool</span>
   59                                         <a href="#checkRegexPattern" title="details" class="method-name">checkRegexPattern</a>
   60                                             (<span class="var-type"></span>&nbsp;<span class="var-name">$pattern</span>)
   61                                     </div>
   62                                                                 <div class="method-definition">
   63                     static                      <span class="method-result">bool</span>
   64                                         <a href="#checkStringAgainstRegexArray" title="details" class="method-name">checkStringAgainstRegexArray</a>
   65                                             (<span class="var-type"></span>&nbsp;<span class="var-name">&$string</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$regex_array</span>, <span class="var-type">&string</span>&nbsp;<span class="var-name">$string</span>)
   66                                     </div>
   67                                                                 <div class="method-definition">
   68                     static                      <span class="method-result">mixed</span>
   69                                         <a href="#deserializeFromFile" title="details" class="method-name">deserializeFromFile</a>
   70                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>)
   71                                     </div>
   72                                                                 <div class="method-definition">
   73                     static                      <span class="method-result">string</span>
   74                                         <a href="#getBaseUrlFromMetaTag" title="details" class="method-name">getBaseUrlFromMetaTag</a>
   75                                             (<span class="var-type"></span>&nbsp;<span class="var-name">&$html_source</span>)
   76                                     </div>
   77                                                                 <div class="method-definition">
   78                     static                      <span class="method-result">array</span>
   79                                         <a href="#getCookiesFromHeader" title="details" class="method-name">getCookiesFromHeader</a>
   80                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$header</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$source_url</span>)
   81                                     </div>
   82                                                                 <div class="method-definition">
   83                     static                      <span class="method-result">string</span>
   84                                         <a href="#getHeaderValue" title="details" class="method-name">getHeaderValue</a>
   85                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$header</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$directive</span>)
   86                                     </div>
   87                                                                 <div class="method-definition">
   88                     static                      <span class="method-result">int</span>
   89                                         <a href="#getHTTPStatusCode" title="details" class="method-name">getHTTPStatusCode</a>
   90                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$header</span>)
   91                                     </div>
   92                                                                 <div class="method-definition">
   93                     static                      <span class="method-result">array</span>
   94                                         <a href="#getMetaTagAttributes" title="details" class="method-name">getMetaTagAttributes</a>
   95                                             (<span class="var-type">&string</span>&nbsp;<span class="var-name">&$html_source</span>)
   96                                     </div>
   97                                                                 <div class="method-definition">
   98                     static                      <span class="method-result">string</span>
   99                                         <a href="#getRedirectURLFromHeader" title="details" class="method-name">getRedirectURLFromHeader</a>
  100                                             (<span class="var-type"></span>&nbsp;<span class="var-name">&$header</span>)
  101                                     </div>
  102                                                                 <div class="method-definition">
  103                     static                      <span class="method-result">string</span>
  104                                         <a href="#getRootUrl" title="details" class="method-name">getRootUrl</a>
  105                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
  106                                     </div>
  107                                                                 <div class="method-definition">
  108                     static                      <span class="method-result">string</span>
  109                                         <a href="#getSystemTempDir" title="details" class="method-name">getSystemTempDir</a>
  110                                         ()
  111                                     </div>
  112                                                                 <div class="method-definition">
  113                     static                      <span class="method-result">bool</span>
  114                                         <a href="#isUTF8String" title="details" class="method-name">isUTF8String</a>
  115                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$string</span>)
  116                                     </div>
  117                                                                 <div class="method-definition">
  118                     static                      <span class="method-result">bool</span>
  119                                         <a href="#isValidUrlString" title="details" class="method-name">isValidUrlString</a>
  120                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$string</span>)
  121                                     </div>
  122                                                                 <div class="method-definition">
  123                     static                      <span class="method-result">string</span>
  124                                         <a href="#normalizeURL" title="details" class="method-name">normalizeURL</a>
  125                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
  126                                     </div>
  127                                                                 <div class="method-definition">
  128                     static                      <span class="method-result">void</span>
  129                                         <a href="#rmDir" title="details" class="method-name">rmDir</a>
  130                                             (<span class="var-type"></span>&nbsp;<span class="var-name">$dir</span>)
  131                                     </div>
  132                                                                 <div class="method-definition">
  133                     static                      <span class="method-result">void</span>
  134                                         <a href="#serializeToFile" title="details" class="method-name">serializeToFile</a>
  135                                             (<span class="var-type"></span>&nbsp;<span class="var-name">$target_file</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
  136                                     </div>
  137                                                                 <div class="method-definition">
  138                     static                      <span class="method-result">void</span>
  139                                         <a href="#sort2dArray" title="details" class="method-name">sort2dArray</a>
  140                                             (<span class="var-type"></span>&nbsp;<span class="var-name">&$array</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$sort_args</span>)
  141                                     </div>
  142                                                                 <div class="method-definition">
  143                     static                      <span class="method-result">array</span>
  144                                         <a href="#splitURL" title="details" class="method-name">splitURL</a>
  145                                             (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
  146                                     </div>
  147                                 
  148                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 </div>
  149         </div>
  150     </div>      
  151 
  152     
  153     <a name="sec-methods"></a>
  154     <div class="info-box">
  155         <div class="info-box-title">Methods</div>
  156         <div class="nav-bar">
  157             <a href="#sec-description">Description</a> |
  158                                                                 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  159                         
  160         </div>
  161         <div class="info-box-body">
  162             <A NAME='method_detail'></A>
  163 <a name="methodbuildURLFromLink" id="buildURLFromLink"><!-- --></a>
  164 <div class="oddrow">
  165     
  166     <div class="method-header">
  167         <span class="method-title">static method buildURLFromLink</span> (line <span class="line-number">228</span>)
  168     </div> 
  169     
  170     <!-- ========== Info from phpDoc block ========= -->
  171 <p class="short-description">Reconstructs a full qualified and normalized URL from a given link relating to the URL the link was found in.</p>
  172     <ul class="tags">
  173                 <li><span class="field">return:</span> The rebuild, full qualified and normilazed URL the link is leading to (i.e. &quot;http://www.foo.com/page.htm&quot;)                 Or NULL if the link couldn't be rebuild correctly.</li>
  174                 <li><span class="field">access:</span> public</li>
  175             </ul>
  176     
  177     <div class="method-signature">
  178         static
  179         <span class="method-result">string</span>
  180         <span class="method-name">
  181             buildURLFromLink
  182         </span>
  183                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$link</span>, <span class="var-type"><a href="../phpcrawl/PHPCrawlerUrlPartsDescriptor.html">PHPCrawlerUrlPartsDescriptor</a></span>&nbsp;<span class="var-name">$BaseUrlParts</span>)
  184             </div>
  185     
  186             <ul class="parameters">
  187                     <li>
  188                 <span class="var-type">string</span>
  189                 <span class="var-name">$link</span><span class="var-description">: The link (i.e. &quot;../page.htm&quot;)</span>           </li>
  190                     <li>
  191                 <span class="var-type"><a href="../phpcrawl/PHPCrawlerUrlPartsDescriptor.html">PHPCrawlerUrlPartsDescriptor</a></span>
  192                 <span class="var-name">$BaseUrlParts</span><span class="var-description">: The parts of the URL the link was found in (i.e. &quot;http://www.foo.com/folder/index.html&quot;)</span>            </li>
  193                 </ul>
  194         
  195             
  196     </div>
  197 <a name="methodbuildURLFromParts" id="buildURLFromParts"><!-- --></a>
  198 <div class="evenrow">
  199     
  200     <div class="method-header">
  201         <span class="method-title">static method buildURLFromParts</span> (line <span class="line-number">123</span>)
  202     </div> 
  203     
  204     <!-- ========== Info from phpDoc block ========= -->
  205 <p class="short-description">Builds an URL from it's single parts.</p>
  206     <ul class="tags">
  207                 <li><span class="field">return:</span> The URL</li>
  208                 <li><span class="field">access:</span> public</li>
  209             </ul>
  210     
  211     <div class="method-signature">
  212         static
  213         <span class="method-result">string</span>
  214         <span class="method-name">
  215             buildURLFromParts
  216         </span>
  217                     (<span class="var-type">array</span>&nbsp;<span class="var-name">$url_parts</span>, [<span class="var-type">bool</span>&nbsp;<span class="var-name">$normalize</span> = <span class="var-default">false</span>])
  218             </div>
  219     
  220             <ul class="parameters">
  221                     <li>
  222                 <span class="var-type">array</span>
  223                 <span class="var-name">$url_parts</span><span class="var-description">: <p>Array conatining the URL-parts.                          The keys should be:</p><p>&quot;protocol&quot; (z.B. &quot;http://&quot;) OPTIONAL                          &quot;host&quot;     (z.B. &quot;www.bla.de&quot;)                          &quot;path&quot;     (z.B. &quot;/test/palimm/&quot;) OPTIONAL                          &quot;file&quot;     (z.B. &quot;index.htm&quot;) OPTIONAL                          &quot;port&quot;     (z.B. 80) OPTIONAL                          &quot;auth_username&quot; OPTIONAL                          &quot;auth_password&quot; OPTIONAL</p></span>          </li>
  224                     <li>
  225                 <span class="var-type">bool</span>
  226                 <span class="var-name">$normalize</span><span class="var-description">: If TRUE, the URL will be returned normalized.                           (I.e. http://www.foo.com/path/ insetad of http://www.foo.com:80/path/)</span>           </li>
  227                 </ul>
  228         
  229             
  230     </div>
  231 <a name="methodcheckRegexPattern" id="checkRegexPattern"><!-- --></a>
  232 <div class="oddrow">
  233     
  234     <div class="method-header">
  235         <span class="method-title">static method checkRegexPattern</span> (line <span class="line-number">194</span>)
  236     </div> 
  237     
  238     <!-- ========== Info from phpDoc block ========= -->
  239 <p class="short-description">Checks whether a given RegEx-pattern is valid or not.</p>
  240     <ul class="tags">
  241                 <li><span class="field">access:</span> public</li>
  242             </ul>
  243     
  244     <div class="method-signature">
  245         static
  246         <span class="method-result">bool</span>
  247         <span class="method-name">
  248             checkRegexPattern
  249         </span>
  250                     (<span class="var-type"></span>&nbsp;<span class="var-name">$pattern</span>)
  251             </div>
  252     
  253             <ul class="parameters">
  254                     <li>
  255                 <span class="var-type"></span>
  256                 <span class="var-name">$pattern</span>          </li>
  257                 </ul>
  258         
  259             
  260     </div>
  261 <a name="methodcheckStringAgainstRegexArray" id="checkStringAgainstRegexArray"><!-- --></a>
  262 <div class="evenrow">
  263     
  264     <div class="method-header">
  265         <span class="method-title">static method checkStringAgainstRegexArray</span> (line <span class="line-number">388</span>)
  266     </div> 
  267     
  268     <!-- ========== Info from phpDoc block ========= -->
  269 <p class="short-description">Checks whether a given string matches with one of the given regular-expressions.</p>
  270     <ul class="tags">
  271                 <li><span class="field">return:</span> TRUE if one of the regexes matches the string, otherwise FALSE.</li>
  272                 <li><span class="field">access:</span> public</li>
  273             </ul>
  274     
  275     <div class="method-signature">
  276         static
  277         <span class="method-result">bool</span>
  278         <span class="method-name">
  279             checkStringAgainstRegexArray
  280         </span>
  281                     (<span class="var-type"></span>&nbsp;<span class="var-name">&$string</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$regex_array</span>, <span class="var-type">&string</span>&nbsp;<span class="var-name">$string</span>)
  282             </div>
  283     
  284             <ul class="parameters">
  285                     <li>
  286                 <span class="var-type">&string</span>
  287                 <span class="var-name">$string</span><span class="var-description">: The string</span>          </li>
  288                     <li>
  289                 <span class="var-type">array</span>
  290                 <span class="var-name">$regex_array</span><span class="var-description">: Numerich array containing the regular-expressions to check against.</span>            </li>
  291                     <li>
  292                 <span class="var-type"></span>
  293                 <span class="var-name">&$string</span>          </li>
  294                 </ul>
  295         
  296             
  297     </div>
  298 <a name="methoddeserializeFromFile" id="deserializeFromFile"><!-- --></a>
  299 <div class="oddrow">
  300     
  301     <div class="method-header">
  302         <span class="method-title">static method deserializeFromFile</span> (line <span class="line-number">506</span>)
  303     </div> 
  304     
  305     <!-- ========== Info from phpDoc block ========= -->
  306 <p class="short-description">Returns deserialized data that is stored in a file.</p>
  307     <ul class="tags">
  308                 <li><span class="field">return:</span> The data or NULL if the file doesn't exist</li>
  309                 <li><span class="field">access:</span> public</li>
  310             </ul>
  311     
  312     <div class="method-signature">
  313         static
  314         <span class="method-result">mixed</span>
  315         <span class="method-name">
  316             deserializeFromFile
  317         </span>
  318                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>)
  319             </div>
  320     
  321             <ul class="parameters">
  322                     <li>
  323                 <span class="var-type">string</span>
  324                 <span class="var-name">$file</span><span class="var-description">: The file containing the serialized data</span>           </li>
  325                 </ul>
  326         
  327             
  328     </div>
  329 <a name="methodgetBaseUrlFromMetaTag" id="getBaseUrlFromMetaTag"><!-- --></a>
  330 <div class="evenrow">
  331     
  332     <div class="method-header">
  333         <span class="method-title">static method getBaseUrlFromMetaTag</span> (line <span class="line-number">350</span>)
  334     </div> 
  335     
  336     <!-- ========== Info from phpDoc block ========= -->
  337 <p class="short-description">Returns the base-URL specified in a meta-tag in the given HTML-source</p>
  338     <ul class="tags">
  339                 <li><span class="field">return:</span> The base-URL or NULL if not found.</li>
  340                 <li><span class="field">access:</span> public</li>
  341             </ul>
  342     
  343     <div class="method-signature">
  344         static
  345         <span class="method-result">string</span>
  346         <span class="method-name">
  347             getBaseUrlFromMetaTag
  348         </span>
  349                     (<span class="var-type"></span>&nbsp;<span class="var-name">&$html_source</span>)
  350             </div>
  351     
  352             <ul class="parameters">
  353                     <li>
  354                 <span class="var-type"></span>
  355                 <span class="var-name">&$html_source</span>         </li>
  356                 </ul>
  357         
  358             
  359     </div>
  360 <a name="methodgetCookiesFromHeader" id="getCookiesFromHeader"><!-- --></a>
  361 <div class="oddrow">
  362     
  363     <div class="method-header">
  364         <span class="method-title">static method getCookiesFromHeader</span> (line <span class="line-number">435</span>)
  365     </div> 
  366     
  367     <!-- ========== Info from phpDoc block ========= -->
  368 <p class="short-description">Returns all cookies from the give response-header.</p>
  369     <ul class="tags">
  370                 <li><span class="field">return:</span> Numeric array containing all cookies as PHPCrawlerCookieDescriptor-objects.</li>
  371                 <li><span class="field">access:</span> public</li>
  372             </ul>
  373     
  374     <div class="method-signature">
  375         static
  376         <span class="method-result">array</span>
  377         <span class="method-name">
  378             getCookiesFromHeader
  379         </span>
  380                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$header</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$source_url</span>)
  381             </div>
  382     
  383             <ul class="parameters">
  384                     <li>
  385                 <span class="var-type">string</span>
  386                 <span class="var-name">$header</span><span class="var-description">: The response-header</span>         </li>
  387                     <li>
  388                 <span class="var-type">string</span>
  389                 <span class="var-name">$source_url</span><span class="var-description">: URL the cookie was send from.</span>           </li>
  390                 </ul>
  391         
  392             
  393     </div>
  394 <a name="methodgetHeaderValue" id="getHeaderValue"><!-- --></a>
  395 <div class="evenrow">
  396     
  397     <div class="method-header">
  398         <span class="method-title">static method getHeaderValue</span> (line <span class="line-number">416</span>)
  399     </div> 
  400     
  401     <!-- ========== Info from phpDoc block ========= -->
  402 <p class="short-description">Gets the value of an header-directive from the given HTTP-header.</p>
  403 <p class="description"><p>Example:  <div class="src-code"><ol><li><div class="src-line"><span class="src-id"><a href="../phpcrawl/PHPCrawlerUtils.html">PHPCrawlerUtils</a></span><span class="src-sym">::</span><a href="../phpcrawl/PHPCrawlerUtils.html#methodgetHeaderValue">getHeaderValue</a><span class="src-sym">(</span><span class="src-var">$header</span><span class="src-sym">,&nbsp;</span><span class="src-str">&quot;content-type&quot;</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
  404 </ol></div></p></p>
  405     <ul class="tags">
  406                 <li><span class="field">return:</span> The value of the given directive found in the header.                 Or NULL if not found.</li>
  407                 <li><span class="field">access:</span> public</li>
  408             </ul>
  409     
  410     <div class="method-signature">
  411         static
  412         <span class="method-result">string</span>
  413         <span class="method-name">
  414             getHeaderValue
  415         </span>
  416                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$header</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$directive</span>)
  417             </div>
  418     
  419             <ul class="parameters">
  420                     <li>
  421                 <span class="var-type">string</span>
  422                 <span class="var-name">$header</span><span class="var-description">: The HTTP-header</span>         </li>
  423                     <li>
  424                 <span class="var-type">string</span>
  425                 <span class="var-name">$directive</span><span class="var-description">: The header-directive</span>         </li>
  426                 </ul>
  427         
  428             
  429     </div>
  430 <a name="methodgetHTTPStatusCode" id="getHTTPStatusCode"><!-- --></a>
  431 <div class="oddrow">
  432     
  433     <div class="method-header">
  434         <span class="method-title">static method getHTTPStatusCode</span> (line <span class="line-number">207</span>)
  435     </div> 
  436     
  437     <!-- ========== Info from phpDoc block ========= -->
  438 <p class="short-description">Gets the HTTP-statuscode from a given response-header.</p>
  439     <ul class="tags">
  440                 <li><span class="field">return:</span> The status-code or NULL if no status-code was found.</li>
  441                 <li><span class="field">access:</span> public</li>
  442             </ul>
  443     
  444     <div class="method-signature">
  445         static
  446         <span class="method-result">int</span>
  447         <span class="method-name">
  448             getHTTPStatusCode
  449         </span>
  450                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$header</span>)
  451             </div>
  452     
  453             <ul class="parameters">
  454                     <li>
  455                 <span class="var-type">string</span>
  456                 <span class="var-name">$header</span><span class="var-description">: The response-header</span>         </li>
  457                 </ul>
  458         
  459             
  460     </div>
  461 <a name="methodgetMetaTagAttributes" id="getMetaTagAttributes"><!-- --></a>
  462 <div class="evenrow">
  463     
  464     <div class="method-header">
  465         <span class="method-title">static method getMetaTagAttributes</span> (line <span class="line-number">586</span>)
  466     </div> 
  467     
  468     <!-- ========== Info from phpDoc block ========= -->
  469 <p class="short-description">Gets all meta-tag atteributes from the given HTML-source.</p>
  470     <ul class="tags">
  471                 <li><span class="field">return:</span> Assoziative array conatining all found meta-attributes.                The keys are the meta-names, the values the content of the attributes.                (like $tags[&quot;robots&quot;] = &quot;nofollow&quot;)</li>
  472                 <li><span class="field">access:</span> public</li>
  473             </ul>
  474     
  475     <div class="method-signature">
  476         static
  477         <span class="method-result">array</span>
  478         <span class="method-name">
  479             getMetaTagAttributes
  480         </span>
  481                     (<span class="var-type">&string</span>&nbsp;<span class="var-name">&$html_source</span>)
  482             </div>
  483     
  484             <ul class="parameters">
  485                     <li>
  486                 <span class="var-type">&string</span>
  487                 <span class="var-name">&$html_source</span>         </li>
  488                 </ul>
  489         
  490             
  491     </div>
  492 <a name="methodgetRedirectURLFromHeader" id="getRedirectURLFromHeader"><!-- --></a>
  493 <div class="oddrow">
  494     
  495     <div class="method-header">
  496         <span class="method-title">static method getRedirectURLFromHeader</span> (line <span class="line-number">367</span>)
  497     </div> 
  498     
  499     <!-- ========== Info from phpDoc block ========= -->
  500 <p class="short-description">Returns the redirect-URL from the given HTML-header</p>
  501     <ul class="tags">
  502                 <li><span class="field">return:</span> The redirect-URL or NULL if not found.</li>
  503                 <li><span class="field">access:</span> public</li>
  504             </ul>
  505     
  506     <div class="method-signature">
  507         static
  508         <span class="method-result">string</span>
  509         <span class="method-name">
  510             getRedirectURLFromHeader
  511         </span>
  512                     (<span class="var-type"></span>&nbsp;<span class="var-name">&$header</span>)
  513             </div>
  514     
  515             <ul class="parameters">
  516                     <li>
  517                 <span class="var-type"></span>
  518                 <span class="var-name">&$header</span>          </li>
  519                 </ul>
  520         
  521             
  522     </div>
  523 <a name="methodgetRootUrl" id="getRootUrl"><!-- --></a>
  524 <div class="evenrow">
  525     
  526     <div class="method-header">
  527         <span class="method-title">static method getRootUrl</span> (line <span class="line-number">458</span>)
  528     </div> 
  529     
  530     <!-- ========== Info from phpDoc block ========= -->
  531 <p class="short-description">Returns the normalized root-URL of the given URL</p>
  532     <ul class="tags">
  533                 <li><span class="field">return:</span> The root-URL, e.g. &quot;http://www.foo.com&quot;</li>
  534                 <li><span class="field">access:</span> public</li>
  535             </ul>
  536     
  537     <div class="method-signature">
  538         static
  539         <span class="method-result">string</span>
  540         <span class="method-name">
  541             getRootUrl
  542         </span>
  543                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
  544             </div>
  545     
  546             <ul class="parameters">
  547                     <li>
  548                 <span class="var-type">string</span>
  549                 <span class="var-name">$url</span><span class="var-description">: The URL, e.g. &quot;www.foo.con/something/index.html&quot;</span>         </li>
  550                 </ul>
  551         
  552             
  553     </div>
  554 <a name="methodgetSystemTempDir" id="getSystemTempDir"><!-- --></a>
  555 <div class="oddrow">
  556     
  557     <div class="method-header">
  558         <span class="method-title">static method getSystemTempDir</span> (line <span class="line-number">568</span>)
  559     </div> 
  560     
  561     <!-- ========== Info from phpDoc block ========= -->
  562 <p class="short-description">Determinates the systems temporary-directory.</p>
  563     <ul class="tags">
  564                 <li><span class="field">access:</span> public</li>
  565             </ul>
  566     
  567     <div class="method-signature">
  568         static
  569         <span class="method-result">string</span>
  570         <span class="method-name">
  571             getSystemTempDir
  572         </span>
  573                 ()
  574             </div>
  575     
  576         
  577             
  578     </div>
  579 <a name="methodisUTF8String" id="isUTF8String"><!-- --></a>
  580 <div class="evenrow">
  581     
  582     <div class="method-header">
  583         <span class="method-title">static method isUTF8String</span> (line <span class="line-number">614</span>)
  584     </div> 
  585     
  586     <!-- ========== Info from phpDoc block ========= -->
  587 <p class="short-description">Checks wether the given string is an UTF8-encoded string.</p>
  588 <p class="description"><p>Taken from http://www.php.net/manual/de/function.mb-detect-encoding.php  (comment from &quot;prgss at bk dot ru&quot;)</p></p>
  589     <ul class="tags">
  590                 <li><span class="field">return:</span> TRUE if the string is UTF-8 encoded.</li>
  591                 <li><span class="field">access:</span> public</li>
  592             </ul>
  593     
  594     <div class="method-signature">
  595         static
  596         <span class="method-result">bool</span>
  597         <span class="method-name">
  598             isUTF8String
  599         </span>
  600                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$string</span>)
  601             </div>
  602     
  603             <ul class="parameters">
  604                     <li>
  605                 <span class="var-type">string</span>
  606                 <span class="var-name">$string</span><span class="var-description">: The string</span>          </li>
  607                 </ul>
  608         
  609             
  610     </div>
  611 <a name="methodisValidUrlString" id="isValidUrlString"><!-- --></a>
  612 <div class="oddrow">
  613     
  614     <div class="method-header">
  615         <span class="method-title">static method isValidUrlString</span> (line <span class="line-number">630</span>)
  616     </div> 
  617     
  618     <!-- ========== Info from phpDoc block ========= -->
  619 <p class="short-description">Checks whether the given string is a valid, urlencoded URL (by RFC)</p>
  620     <ul class="tags">
  621                 <li><span class="field">return:</span> TRUE if the string is a valid url-string.</li>
  622                 <li><span class="field">access:</span> public</li>
  623             </ul>
  624     
  625     <div class="method-signature">
  626         static
  627         <span class="method-result">bool</span>
  628         <span class="method-name">
  629             isValidUrlString
  630         </span>
  631                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$string</span>)
  632             </div>
  633     
  634             <ul class="parameters">
  635                     <li>
  636                 <span class="var-type">string</span>
  637                 <span class="var-name">$string</span><span class="var-description">: The string</span>          </li>
  638                 </ul>
  639         
  640             
  641     </div>
  642 <a name="methodnormalizeURL" id="normalizeURL"><!-- --></a>
  643 <div class="evenrow">
  644     
  645     <div class="method-header">
  646         <span class="method-title">static method normalizeURL</span> (line <span class="line-number">179</span>)
  647     </div> 
  648     
  649     <!-- ========== Info from phpDoc block ========= -->
  650 <p class="short-description">Normalizes an URL</p>
  651 <p class="description"><p>I.e. converts http://www.foo.com:80/path/ to http://www.foo.com/path/</p></p>
  652     <ul class="tags">
  653                 <li><span class="field">return:</span> OR NULL on failure</li>
  654                 <li><span class="field">access:</span> public</li>
  655             </ul>
  656     
  657     <div class="method-signature">
  658         static
  659         <span class="method-result">string</span>
  660         <span class="method-name">
  661             normalizeURL
  662         </span>
  663                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
  664             </div>
  665     
  666             <ul class="parameters">
  667                     <li>
  668                 <span class="var-type">string</span>
  669                 <span class="var-name">$url</span>          </li>
  670                 </ul>
  671         
  672             
  673     </div>
  674 <a name="methodrmDir" id="rmDir"><!-- --></a>
  675 <div class="oddrow">
  676     
  677     <div class="method-header">
  678         <span class="method-title">static method rmDir</span> (line <span class="line-number">469</span>)
  679     </div> 
  680     
  681     <!-- ========== Info from phpDoc block ========= -->
  682 <p class="short-description">Deletes a directory recursivly</p>
  683     <ul class="tags">
  684                 <li><span class="field">access:</span> public</li>
  685             </ul>
  686     
  687     <div class="method-signature">
  688         static
  689         <span class="method-result">void</span>
  690         <span class="method-name">
  691             rmDir
  692         </span>
  693                     (<span class="var-type"></span>&nbsp;<span class="var-name">$dir</span>)
  694             </div>
  695     
  696             <ul class="parameters">
  697                     <li>
  698                 <span class="var-type"></span>
  699                 <span class="var-name">$dir</span>          </li>
  700                 </ul>
  701         
  702             
  703     </div>
  704 <a name="methodserializeToFile" id="serializeToFile"><!-- --></a>
  705 <div class="evenrow">
  706     
  707     <div class="method-header">
  708         <span class="method-title">static method serializeToFile</span> (line <span class="line-number">493</span>)
  709     </div> 
  710     
  711     <!-- ========== Info from phpDoc block ========= -->
  712 <p class="short-description">Serializes data (objects, arrayse etc.) and writes it to the given file.</p>
  713     <ul class="tags">
  714                 <li><span class="field">access:</span> public</li>
  715             </ul>
  716     
  717     <div class="method-signature">
  718         static
  719         <span class="method-result">void</span>
  720         <span class="method-name">
  721             serializeToFile
  722         </span>
  723                     (<span class="var-type"></span>&nbsp;<span class="var-name">$target_file</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$data</span>)
  724             </div>
  725     
  726             <ul class="parameters">
  727                     <li>
  728                 <span class="var-type"></span>
  729                 <span class="var-name">$target_file</span>          </li>
  730                     <li>
  731                 <span class="var-type"></span>
  732                 <span class="var-name">$data</span>         </li>
  733                 </ul>
  734         
  735             
  736     </div>
  737 <a name="methodsort2dArray" id="sort2dArray"><!-- --></a>
  738 <div class="oddrow">
  739     
  740     <div class="method-header">
  741         <span class="method-title">static method sort2dArray</span> (line <span class="line-number">519</span>)
  742     </div> 
  743     
  744     <!-- ========== Info from phpDoc block ========= -->
  745 <p class="short-description">Sorts a twodimensiolnal array.</p>
  746     <ul class="tags">
  747                 <li><span class="field">access:</span> public</li>
  748             </ul>
  749     
  750     <div class="method-signature">
  751         static
  752         <span class="method-result">void</span>
  753         <span class="method-name">
  754             sort2dArray
  755         </span>
  756                     (<span class="var-type"></span>&nbsp;<span class="var-name">&$array</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$sort_args</span>)
  757             </div>
  758     
  759             <ul class="parameters">
  760                     <li>
  761                 <span class="var-type"></span>
  762                 <span class="var-name">&$array</span>           </li>
  763                     <li>
  764                 <span class="var-type"></span>
  765                 <span class="var-name">$sort_args</span>            </li>
  766                 </ul>
  767         
  768             
  769     </div>
  770 <a name="methodsplitURL" id="splitURL"><!-- --></a>
  771 <div class="evenrow">
  772     
  773     <div class="method-header">
  774         <span class="method-title">static method splitURL</span> (line <span class="line-number">27</span>)
  775     </div> 
  776     
  777     <!-- ========== Info from phpDoc block ========= -->
  778 <p class="short-description">Splits an URL into its parts</p>
  779     <ul class="tags">
  780                 <li><span class="field">return:</span> <p>An array containig the parts of the URL</p><p>The keys are:</p><p>&quot;protocol&quot; (z.B. &quot;http://&quot;)                      &quot;host&quot;     (z.B. &quot;www.bla.de&quot;)                      &quot;path&quot;     (z.B. &quot;/test/palimm/&quot;)                      &quot;file&quot;     (z.B. &quot;index.htm&quot;)                      &quot;domain&quot;   (z.B. &quot;foo.com&quot;)                      &quot;port&quot;     (z.B. 80)                      &quot;auth_username&quot;                      &quot;auth_password&quot;</p></li>
  781                 <li><span class="field">access:</span> public</li>
  782             </ul>
  783     
  784     <div class="method-signature">
  785         static
  786         <span class="method-result">array</span>
  787         <span class="method-name">
  788             splitURL
  789         </span>
  790                     (<span class="var-type">string</span>&nbsp;<span class="var-name">$url</span>)
  791             </div>
  792     
  793             <ul class="parameters">
  794                     <li>
  795                 <span class="var-type">string</span>
  796                 <span class="var-name">$url</span><span class="var-description">: The URL</span>            </li>
  797                 </ul>
  798         
  799             
  800     </div>
  801 
  802                         
  803         </div>
  804     </div>
  805 
  806 
  807     <p class="notes" id="credit">
  808         Documentation generated on Sun, 20 Jan 2013 21:18:50 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
  809     </p>
  810     </div></body>
  811 </html>