liamhao / FeiYuCRM

src/FeiYu.php

<?php

Missing file doc comment

namespace FeiYuCRM;

/**
 * FeiYuCRM system class
 * @author haosijia <haosijia@zhufaner.com>

There must be exactly one blank line before the tags in a doc comment

 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class FeiYu
{
  // Server address

Line indented incorrectly; expected at least 4 spaces, found 2

  public $host = '';

Line indented incorrectly; expected at least 4 spaces, found 2

  // Data fetch route

Line indented incorrectly; expected at least 4 spaces, found 2

  public $pull_route = '';

Line indented incorrectly; expected at least 4 spaces, found 2

  // Upload data route

Line indented incorrectly; expected at least 4 spaces, found 2

  public $push_route = '';

Line indented incorrectly; expected at least 4 spaces, found 2

  // Encryption key

Line indented incorrectly; expected at least 4 spaces, found 2

  public $signature_key = '';

Line indented incorrectly; expected at least 4 spaces, found 2

  // Token

Line indented incorrectly; expected at least 4 spaces, found 2

  public $token = '';

Line indented incorrectly; expected at least 4 spaces, found 2

  // Timestamp

Line indented incorrectly; expected at least 4 spaces, found 2

  protected $timestamp = '';

Line indented incorrectly; expected at least 4 spaces, found 2

  // Signature

Line indented incorrectly; expected at least 4 spaces, found 2

  protected $signature = '';

Line indented incorrectly; expected at least 4 spaces, found 2

  // Start time

Line indented incorrectly; expected at least 4 spaces, found 2

  protected $start_time = '';

Line indented incorrectly; expected at least 4 spaces, found 2

  // End time

Line indented incorrectly; expected at least 4 spaces, found 2

  protected $end_time = '';

Line indented incorrectly; expected at least 4 spaces, found 2

  // Page size

Line indented incorrectly; expected at least 4 spaces, found 2

  protected $page_size = '';

Line indented incorrectly; expected at least 4 spaces, found 2

  // Run route

Line indented incorrectly; expected at least 4 spaces, found 2

  protected $fetch_route = '';

Line indented incorrectly; expected at least 4 spaces, found 2

  // Data from host

Line indented incorrectly; expected at least 4 spaces, found 2

  protected $res_data = '';

Line indented incorrectly; expected at least 4 spaces, found 2

  // Push data source

Line indented incorrectly; expected at least 4 spaces, found 2

  protected $push_data = '';

Line indented incorrectly; expected at least 4 spaces, found 2

  public function __construct($options)

Line indented incorrectly; expected 4 spaces, found 2

Missing doc comment for function __construct()

  {

Line indented incorrectly; expected at least 4 spaces, found 2

    $this->host = isset($options['host'])?$options['host']:$this->host;

Line indented incorrectly; expected at least 8 spaces, found 4

    $this->pull_route = isset($options['pull_route'])?$options['pull_route']:$this->pull_route;

Line indented incorrectly; expected at least 8 spaces, found 4

    $this->push_route = isset($options['push_route'])?$options['push_route']:$this->push_route;

Line indented incorrectly; expected at least 8 spaces, found 4

    $this->signature_key = isset($options['signature_key'])?$options['signature_key']:$this->signature_key;

Line indented incorrectly; expected at least 8 spaces, found 4

    $this->token = isset($options['token'])?$options['token']:$this->token;

Line indented incorrectly; expected at least 8 spaces, found 4

    $this->timestamp = time();

Line indented incorrectly; expected at least 8 spaces, found 4

  }

Line indented incorrectly; expected 4 spaces, found 2

  /**

Line indented incorrectly; expected at least 4 spaces, found 2

   * pull data

Doc comment short description must start with a capital letter

   * @param string $start_time ['Y-m-d']

There must be exactly one blank line before the tags in a doc comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

   * @param string $end_time ['Y-m-d']

Expected 3 spaces after parameter name; 1 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

   * @param int $page_size

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

   * @return $this

Tag @return cannot be grouped with parameter tags in a doc comment

   */
  public function pullData($start_time, $end_time, $page_size)

Line indented incorrectly; expected 4 spaces, found 2

  {

Line indented incorrectly; expected at least 4 spaces, found 2

    $this->start_time = strtotime($start_time);

Line indented incorrectly; expected at least 8 spaces, found 4

    $this->end_time = strtotime($end_time);

Line indented incorrectly; expected at least 8 spaces, found 4

    $this->page_size = $page_size;

Line indented incorrectly; expected at least 8 spaces, found 4

    $this->fetch_route = $this->pull_route;

Line indented incorrectly; expected at least 8 spaces, found 4

    return $this;

Line indented incorrectly; expected at least 8 spaces, found 4

  }

Line indented incorrectly; expected 4 spaces, found 2

  /**

Line indented incorrectly; expected at least 4 spaces, found 2

   * push data

Doc comment short description must start with a capital letter

   * @param array $data

There must be exactly one blank line before the tags in a doc comment

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

   * @return bool

Tag @return cannot be grouped with parameter tags in a doc comment

   */
  public function pushData($data)

Line indented incorrectly; expected 4 spaces, found 2

  {

Line indented incorrectly; expected at least 4 spaces, found 2

    if(!isset($data['clue_convert_state']) || !isset($data['clue_id'])){

Line indented incorrectly; expected 8 spaces, found 4

Expected "if (...) {\n"; found "if(...){\n"

There must be a single space between the closing parenthesis and the opening brace of a multi-line IF statement; found 0 spaces

      throw new FeiYuException("Upload data is missing the necessary parameters", 1);

Line indented incorrectly; expected at least 12 spaces, found 6

    }

Line indented incorrectly; expected 8 spaces, found 4

    if(!is_numeric($data['clue_convert_state'])){

Line indented incorrectly; expected 8 spaces, found 4

Expected "if (...) {\n"; found "if(...){\n"

There must be a single space between the closing parenthesis and the opening brace of a multi-line IF statement; found 0 spaces

      throw new FeiYuException("'clue_convert_state' must be a numeric type", 1);

Line indented incorrectly; expected at least 12 spaces, found 6

    }

Line indented incorrectly; expected 8 spaces, found 4

    $data['clue_convert_state'] = (int)$data['clue_convert_state'];

Line indented incorrectly; expected at least 8 spaces, found 4

    $this->push_data = json_encode([

Line indented incorrectly; expected at least 8 spaces, found 4

The opening parenthesis of a multi-line function call should be the last content on the line.

      'source' => 0,

This line of the multi-line function call does not seem to be indented correctly. Expected 8 spaces, but found 6.

Line indented incorrectly; expected at least 8 spaces, found 6

      'data' => [

This line of the multi-line function call does not seem to be indented correctly. Expected 8 spaces, but found 6.

Line indented incorrectly; expected at least 8 spaces, found 6

        'clue_id' => $data['clue_id'],
        'clue_convert_state' => $data['clue_convert_state'],
      ],

This line of the multi-line function call does not seem to be indented correctly. Expected 8 spaces, but found 6.

Line indented incorrectly; expected at least 8 spaces, found 6

    ]);

Line indented incorrectly; expected at least 8 spaces, found 4

For multi-line function calls, the closing parenthesis should be on a new line.

    $this->fetch_route = $this->push_route;

Line indented incorrectly; expected at least 8 spaces, found 4

    $this->fetchCurl();

Line indented incorrectly; expected at least 8 spaces, found 4

    return !$this->getResData()['status'];

Line indented incorrectly; expected at least 8 spaces, found 4

  }

Line indented incorrectly; expected 4 spaces, found 2

  /**

Line indented incorrectly; expected at least 4 spaces, found 2

   * get result data from curl

Doc comment short description must start with a capital letter

   * @return string

There must be exactly one blank line before the tags in a doc comment

   */
  public function getResData()

Line indented incorrectly; expected 4 spaces, found 2

  {

Line indented incorrectly; expected at least 4 spaces, found 2

    return $this->res_data;

Line indented incorrectly; expected at least 8 spaces, found 4

  }

Line indented incorrectly; expected 4 spaces, found 2

  /**

Line indented incorrectly; expected at least 4 spaces, found 2

Parameter $callback should have a doc-comment as per coding-style.

   * get all page data and run callback function in every page

Doc comment short description must start with a capital letter

   * @return string

There must be exactly one blank line before the tags in a doc comment

   */
  public function run($callback)

Line indented incorrectly; expected 4 spaces, found 2

  {

Line indented incorrectly; expected at least 4 spaces, found 2

    $page = 1;

Line indented incorrectly; expected at least 8 spaces, found 4

    do {

Line indented incorrectly; expected 8 spaces, found 4

      $this->fetchCurl($page);

Line indented incorrectly; expected at least 12 spaces, found 6

      if (call_user_func($callback, $this->res_data['data']) === false) {

Line indented incorrectly; expected 12 spaces, found 6

        return false;

Line indented incorrectly; expected at least 16 spaces, found 8

      }

Line indented incorrectly; expected 12 spaces, found 6

      $page++;

Line indented incorrectly; expected at least 12 spaces, found 6

    } while (($page-1)*($this->page_size) < $this->res_data['count']);

Line indented incorrectly; expected 8 spaces, found 4

    return true;

Line indented incorrectly; expected at least 8 spaces, found 4

  }

Line indented incorrectly; expected 4 spaces, found 2

  /**

Line indented incorrectly; expected at least 4 spaces, found 2

   * encrypt url and start_time and end_time to signature

Doc comment short description must start with a capital letter

   * @return $this

There must be exactly one blank line before the tags in a doc comment

   */
  protected function encryptData()

Line indented incorrectly; expected 4 spaces, found 2

  {

Line indented incorrectly; expected at least 4 spaces, found 2

    // 拼接中的空格很重要

Line indented incorrectly; expected at least 8 spaces, found 4

    if($this->fetch_route == $this->pull_route){

Line indented incorrectly; expected 8 spaces, found 4

Expected "if (...) {\n"; found "if(...){\n"

There must be a single space between the closing parenthesis and the opening brace of a multi-line IF statement; found 0 spaces

      $data = $this->fetch_route.'?start_time='.$this->start_time.'&end_time='.$this->end_time.' '.$this->timestamp;

Line indented incorrectly; expected at least 12 spaces, found 6

    } else {

Line indented incorrectly; expected 8 spaces, found 4

      $data = $this->fetch_route.' '.$this->timestamp;

Line indented incorrectly; expected at least 12 spaces, found 6

    }

Line indented incorrectly; expected 8 spaces, found 4

    $this->signature = base64_encode(hash_hmac('sha256', $data, $this->signature_key));

It seems like $this->signature_key can also be of type mixed; however, parameter $key of hash_hmac() does only seem to accept string, maybe add an additional type check?

Line indented incorrectly; expected at least 8 spaces, found 4

    return $this;

Line indented incorrectly; expected at least 8 spaces, found 4

  }

Line indented incorrectly; expected 4 spaces, found 2

  /**

Line indented incorrectly; expected at least 4 spaces, found 2

   * fetch data by curl

Doc comment short description must start with a capital letter

   * @param string $page

There must be exactly one blank line before the tags in a doc comment

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

   * @return $this

Tag @return cannot be grouped with parameter tags in a doc comment

   */
  protected function fetchCurl($page = 1)

Line indented incorrectly; expected 4 spaces, found 2

  {

Line indented incorrectly; expected at least 4 spaces, found 2

    $this->encryptData();

Line indented incorrectly; expected at least 8 spaces, found 4

    $ch = curl_init();

Line indented incorrectly; expected at least 8 spaces, found 4

    if(!$ch){

$ch is of type false|resource, thus it always evaluated to false.

Line indented incorrectly; expected 8 spaces, found 4

Expected "if (...) {\n"; found "if(...){\n"

There must be a single space between the closing parenthesis and the opening brace of a multi-line IF statement; found 0 spaces

      throw new FeiYuException('cURL init failed', 1);

Line indented incorrectly; expected at least 12 spaces, found 6

    }

Line indented incorrectly; expected 8 spaces, found 4

    curl_setopt($ch, CURLOPT_URL, $this->host.$this->fetch_route.'?page='.$page.'&page_size='.$this->page_size.'&start_time='.$this->start_time.'&end_time='.$this->end_time);

Line indented incorrectly; expected at least 8 spaces, found 4

    curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

Line indented incorrectly; expected at least 8 spaces, found 4

    curl_setopt($ch, CURLOPT_TIMEOUT, 5);

Line indented incorrectly; expected at least 8 spaces, found 4

    curl_setopt($ch, CURLOPT_HTTPHEADER, [

Line indented incorrectly; expected at least 8 spaces, found 4

The opening parenthesis of a multi-line function call should be the last content on the line.

        'Content-Type: application/json;charset=UTF-8',
        'Signature: ' . $this->signature,
        'Timestamp: ' . $this->timestamp,
        'Access-Token: ' . $this->token,
    ]);

Line indented incorrectly; expected at least 8 spaces, found 4

For multi-line function calls, the closing parenthesis should be on a new line.

    if($this->fetch_route == $this->push_route){

Line indented incorrectly; expected 8 spaces, found 4

Expected "if (...) {\n"; found "if(...){\n"

There must be a single space between the closing parenthesis and the opening brace of a multi-line IF statement; found 0 spaces

      curl_setopt($ch, CURLOPT_POST, true);

Line indented incorrectly; expected at least 12 spaces, found 6

      curl_setopt($ch, CURLOPT_POSTFIELDS, $this->push_data);

Line indented incorrectly; expected at least 12 spaces, found 6

    }

Line indented incorrectly; expected 8 spaces, found 4

    $output = curl_exec($ch);

Line indented incorrectly; expected at least 8 spaces, found 4

    $error = curl_error($ch);

Line indented incorrectly; expected at least 8 spaces, found 4

    curl_close($ch);

Line indented incorrectly; expected at least 8 spaces, found 4

    if($error != ''){

Line indented incorrectly; expected 8 spaces, found 4

Expected "if (...) {\n"; found "if(...){\n"

There must be a single space between the closing parenthesis and the opening brace of a multi-line IF statement; found 0 spaces

      throw new FeiYuException($error, 1);

Line indented incorrectly; expected at least 12 spaces, found 6

    }

Line indented incorrectly; expected 8 spaces, found 4

    $this->res_data = json_decode($output, true);

Line indented incorrectly; expected at least 8 spaces, found 4

    if($this->res_data['status'] != 'success'){

Line indented incorrectly; expected 8 spaces, found 4

Expected "if (...) {\n"; found "if(...){\n"

There must be a single space between the closing parenthesis and the opening brace of a multi-line IF statement; found 0 spaces

      if(is_array($this->res_data['msg'])){

Line indented incorrectly; expected 12 spaces, found 6

Expected "if (...) {\n"; found "if(...){\n"

There must be a single space between the closing parenthesis and the opening brace of a multi-line IF statement; found 0 spaces

        throw new FeiYuException(json_encode($this->res_data['msg']), 1);

Line indented incorrectly; expected at least 16 spaces, found 8

      }

Line indented incorrectly; expected 12 spaces, found 6

      throw new FeiYuException($this->res_data['msg'], 1);

Line indented incorrectly; expected at least 12 spaces, found 6

    }

Line indented incorrectly; expected 8 spaces, found 4

    return $this;

Line indented incorrectly; expected at least 8 spaces, found 4

  }

Line indented incorrectly; expected 4 spaces, found 2

}

class FeiYuException extends \Exception

Missing doc comment for class FeiYuException

{
  
}