class ShareaholicCurlMultiShareCount in Share Buttons, Related Posts, Content Analytics - Shareaholic 8

A class that implements ShareaholicShareCounts This class will get the share counts by calling the social services via curl_multi

@package shareaholic

Hierarchy

• class \ShareaholicShareCount
  • class \ShareaholicCurlMultiShareCount

File

lib/social-share-counts/curl_multi_share_count.php, line 19

class ShareaholicCurlMultiShareCount extends ShareaholicShareCount {

  /**
   * This function should get all the counts for the
   * supported services
   *
   * It should return an associative array with the services as
   * the keys and the counts as the value.
   *
   * Example:
   * array('facebook' => 12, 'pinterest' => 0, 'twitter' => 14, ...);
   *
   * @return Array an associative array of service => counts
   */
  public function get_counts() {
    $services_length = count($this->services);
    $config = self::get_services_config();
    $response = array();
    $response['status'] = 200;

    // array of curl handles
    $curl_handles = array();

    // multi handle
    $multi_handle = curl_multi_init();
    for ($i = 0; $i < $services_length; $i++) {
      $service = $this->services[$i];
      if (!isset($config[$service])) {
        continue;
      }
      if (isset($config[$service]['prepare'])) {
        $this
          ->{$config[$service]['prepare']}($this->url, $config);
      }

      // Create the curl handle
      $curl_handles[$service] = curl_init();

      // set the curl options to make the request
      $this
        ->curl_setopts($curl_handles[$service], $config, $service);

      // add the handle to curl_multi_handle
      curl_multi_add_handle($multi_handle, $curl_handles[$service]);
    }

    // Run curl_multi only if there are some actual curl handles
    if (count($curl_handles) > 0) {

      // While we're still active, execute curl
      $running = NULL;
      do {
        $mrc = curl_multi_exec($multi_handle, $running);
      } while ($mrc == CURLM_CALL_MULTI_PERFORM);
      while ($running && $mrc == CURLM_OK) {

        // Wait for activity on any curl-connection
        if (curl_multi_select($multi_handle) == -1) {
          usleep(1);
        }

        // Continue to exec until curl is ready to
        // give us more data
        do {
          $mrc = curl_multi_exec($multi_handle, $running);
        } while ($mrc == CURLM_CALL_MULTI_PERFORM);
      }

      // handle the responses
      foreach ($curl_handles as $service => $handle) {
        if (curl_errno($handle)) {
          $response['status'] = 500;
        }
        $result = array(
          'body' => curl_multi_getcontent($handle),
          'response' => array(
            'code' => curl_getinfo($handle, CURLINFO_HTTP_CODE),
          ),
        );
        $callback = $config[$service]['callback'];
        $counts = $this
          ->{$callback}($result);
        if (is_numeric($counts)) {
          $response['data'][$service] = $counts;
        }
        $this->raw_response[$service] = $result;
        curl_multi_remove_handle($multi_handle, $handle);
        curl_close($handle);
      }
      curl_multi_close($multi_handle);
    }
    return $response;
  }
  private function curl_setopts($curl_handle, $config, $service) {

    // set the url to make the curl request
    curl_setopt($curl_handle, CURLOPT_URL, str_replace('%s', $this->url, $config[$service]['url']));
    $timeout = isset($this->options['timeout']) ? $this->options['timeout'] : 6;

    // other necessary settings:
    // CURLOPT_HEADER means include header in output, which we do not want
    // CURLOPT_RETURNTRANSER means return output as string or not
    curl_setopt_array($curl_handle, array(
      CURLOPT_HEADER => 0,
      CURLOPT_RETURNTRANSFER => 1,
      CURLOPT_TIMEOUT => $timeout,
      CURLOPT_SSL_VERIFYPEER => false,
      CURLOPT_SSL_VERIFYHOST => false,
    ));

    // set the http method: default is GET
    if ($config[$service]['method'] === 'POST') {
      curl_setopt($curl_handle, CURLOPT_POST, 1);
    }

    // set the body and headers
    $headers = isset($config[$service]['headers']) ? $config[$service]['headers'] : array();
    $body = isset($config[$service]['body']) ? $config[$service]['body'] : NULL;
    if (isset($body)) {
      if (isset($headers['Content-Type']) && $headers['Content-Type'] === 'application/json') {
        $data_string = json_encode($body);
        curl_setopt($curl_handle, CURLOPT_HTTPHEADER, array(
          'Content-Type: application/json',
          'Content-Length: ' . strlen($data_string),
        ));
        curl_setopt($curl_handle, CURLOPT_POSTFIELDS, $data_string);
      }
    }

    // set the useragent
    $useragent = isset($config[$service]['User-Agent']) ? $config[$service]['User-Agent'] : 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10.8; rv:24.0) Gecko/20100101 Firefox/24.0';
    curl_setopt($curl_handle, CURLOPT_USERAGENT, $useragent);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ShareaholicCurlMultiShareCount::curl_setopts	private	function
ShareaholicCurlMultiShareCount::get_counts	public	function	This function should get all the counts for the supported services Overrides ShareaholicShareCount::get_counts
ShareaholicShareCount::$options	protected	property
ShareaholicShareCount::$raw_response	public	property
ShareaholicShareCount::$services	protected	property
ShareaholicShareCount::$url	protected	property
ShareaholicShareCount::buffer_count_callback	public	function	Callback function for buffer count API Gets the buffer share counts from response
ShareaholicShareCount::facebook_count_callback	public	function	Callback function for facebook count API Gets the facebook counts from response
ShareaholicShareCount::fancy_count_callback	public	function	Callback function for Fancy count API Gets the Fancy counts from response
ShareaholicShareCount::get_client_ip	public	function	Get the client's ip address
ShareaholicShareCount::get_services_config	public static	function
ShareaholicShareCount::has_http_error	public	function	Check if calling the service returned any type of error
ShareaholicShareCount::is_url_encoded	public	function	Check if the url is encoded
ShareaholicShareCount::odnoklassniki_count_callback	public	function	Callback function for odnoklassniki count API Gets the odnoklassniki counts from response
ShareaholicShareCount::pinterest_count_callback	public	function	Callback function for pinterest count API Gets the pinterest counts from response
ShareaholicShareCount::reddit_count_callback	public	function	Callback function for reddit count API Gets the reddit counts from response
ShareaholicShareCount::tumblr_count_callback	public	function	Callback function for Tumblr count API Gets the Tumblr counts from response
ShareaholicShareCount::vk_count_callback	public	function	Callback function for vk count API Gets the vk counts from response
ShareaholicShareCount::yummly_count_callback	public	function	Callback function for Yummly count API Gets the Yummly counts from response
ShareaholicShareCount::__construct	public	function