CO_Chameleon_Utils Class Reference

Collaboration diagram for CO_Chameleon_Utils:

Static Public Member Functions
static	call_curl ( $in_uri, $in_post=false, &$http_status=NULL, &$content_failure_note=NULL)
	This is a function that returns the results of an HTTP call to a URI. It is a lot more secure than file_get_contents, but does the same thing. More...

Detailed Description

Definition at line 31 of file co_chameleon_utils.class.php.

Member Function Documentation

call_curl()

static CO_Chameleon_Utils::call_curl (   $in_uri,   $in_post = false, &  $http_status = NULL, &  $content_failure_note = NULL  )

static

This is a function that returns the results of an HTTP call to a URI. It is a lot more secure than file_get_contents, but does the same thing.

Returns

a string, containing the response. Null if the call fails to get any data.

Parameters

$in_uri	A string. The URI to call.
$in_post	If true, the transaction is a POST, not a GET. Default is false.
$http_status	Optional reference to a string. Returns the HTTP call status.
$content_failure_note	If there's a content failure, instead of throwing an exception, we will put it in here (if provided).

Definition at line 40 of file co_chameleon_utils.class.php.

                                  {
        $ret = null;
    
        // If the curl extension isn't loaded, we're screwed.
        if (extension_loaded('curl')) {
            // This gets the session as a cookie.
            if (isset($_COOKIE['PHPSESSID']) && $_COOKIE['PHPSESSID']) {
                $strCookie = 'PHPSESSID='.$_COOKIE['PHPSESSID'].'; path=/';
 
                session_write_close();
            }
 
            // Create a new cURL resource.
            $resource = curl_init();
        
            if (isset($strCookie)) {
                curl_setopt($resource, CURLOPT_COOKIE, $strCookie);
            }
        
            // If we will be POSTing this transaction, we split up the URI.
            if ($in_post) {
                $spli = explode("?", $in_uri, 2);
            
                if (is_array($spli) && count($spli)) {
                    $in_uri = $spli[0];
                    $in_params = $spli[1];
                    // Convert query string into an array using parse_str(). parse_str() will decode values along the way.
                    parse_str($in_params, $temp);
                
                    // Now rebuild the query string using http_build_query(). It will re-encode values along the way.
                    // It will also take original query string params that have no value and appends a "=" to them
                    // thus giving them and empty value.
                    $in_params = http_build_query($temp);
            
                    curl_setopt($resource, CURLOPT_POST, true);
                    curl_setopt($resource, CURLOPT_POSTFIELDS, $in_params);
                }
            }
        
            // Set url to call.
            curl_setopt($resource, CURLOPT_URL, $in_uri);
        
            // Make curl_exec() function (see below) return requested content as a string (unless call fails).
            curl_setopt($resource, CURLOPT_RETURNTRANSFER, true);
        
            // By default, cURL prepends response headers to string returned from call to curl_exec().
            // You can control this with the below setting.
            // Setting it to false will remove headers from beginning of string.
            // If you WANT the headers, see the Yahoo documentation on how to parse with them from the string.
            curl_setopt($resource, CURLOPT_HEADER, false);
        
            // Set maximum times to allow redirection (use only if needed as per above setting. 3 is sort of arbitrary here).
            curl_setopt($resource, CURLOPT_MAXREDIRS, 3);
        
            // Set connection timeout in seconds (very good idea).
            curl_setopt($resource, CURLOPT_CONNECTTIMEOUT, 10);
        
            // Direct cURL to send request header to server allowing compressed content to be returned and decompressed automatically (use only if needed).
            curl_setopt($resource, CURLOPT_ENCODING, 'gzip,deflate');
            
            // Pretend we're a browser, so that anti-cURL settings don't pooch us.
            curl_setopt($resource, CURLOPT_USERAGENT, "cURL Mozilla/5.0 (Windows NT 5.1; rv:21.0) Gecko/20130401 Firefox/21.0 CHAMELEON/BADGER"); 
 
            // Trust meeeee...
            curl_setopt($resource, CURLOPT_SSL_VERIFYPEER, false);
    
            // Execute cURL call and return results in $content variable.
            $content = curl_exec($resource);
        
            // Check if curl_exec() call failed (returns false on failure) and handle failure.
            if (false === $content) {
                // Cram as much info into the content note as possible.
                $content_failure_note = "curl failure calling $in_uri, ".curl_error($resource).", ".curl_errno ($resource);
            } else {
                // Do what you want with returned content (e.g. HTML, XML, etc) here or AFTER curl_close() call below as it is stored in the $content variable.
        
                // You MIGHT want to get the HTTP status code returned by server (e.g. 200, 400, 500).
                // If that is the case then this is how to do it.
                $http_status = curl_getinfo($resource, CURLINFO_HTTP_CODE);
            }
        
            // Close cURL and free resource.
            curl_close ($resource);
        
            // Maybe echo $contents of $content variable here.
            if (false !== $content) {
                $ret = $content;
            }
        }
    
        return $ret;
    }

Referenced by CO_places_Basalt_Plugin\_lookup_address(), CO_Place\geocode_long_lat(), and CO_Place\lookup_address().

Here is the caller graph for this function: