PHPDoc enhanced

hiqdev · Dec 8, 2016 · 3e43056 · 3e43056
1 parent 27ca6fe
commit 3e43056
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 8 deletions.
diff --git a/src/ActiveQuery.php b/src/ActiveQuery.php
@@ -132,6 +132,10 @@ public function prepare()
  return $this;
  }
 
+ /**
+ * @param $with
+ * @return static
+ */
  public function joinWith($with)
  {
  $this->joinWith[] = (array) $with;

diff --git a/src/Connection.php b/src/Connection.php
@@ -160,7 +160,7 @@ public function getQueryBuilder()
  * @param string $url URL
  * @param array $query query options
  * @param string $body request body
- * @param bool  $raw  if response body contains JSON and should be decoded
+ * @param bool $raw Do not try to decode data, event when response is decodeable (JSON). Defaults to `false`
  * @throws HiArtException
  * @throws \yii\base\InvalidConfigException
  * @return mixed response
@@ -174,22 +174,22 @@ public function get($url, $query = [], $body = null, $raw = false)
  * Performs HEAD HTTP request.
  * @param string $url URL
  * @param array $query query options
- * @param string $body request body
+ * @param bool $raw Do not try to decode data, event when response is decodeable (JSON). Defaults to `false`
  * @throws HiArtException
  * @throws \yii\base\InvalidConfigException
  * @return mixed response
  */
  public function head($url, $query = [], $body = null)
  {
- return $this->makeRequest('HEAD', $url, $query, $body, $raw);
+ return $this->makeRequest('HEAD', $url, $query, $body);
  }
 
  /**
  * Performs POST HTTP request.
  * @param string $url URL
  * @param array $query query options
  * @param string $body request body
- * @param bool  $raw  if response body contains JSON and should be decoded
+ * @param bool $raw Do not try to decode data, event when response is decodeable (JSON). Defaults to `false`
  * @throws HiArtException
  * @throws \yii\base\InvalidConfigException
  * @return mixed response
@@ -204,7 +204,7 @@ public function post($url, $query = [], $body = null, $raw = false)
  * @param string $url URL
  * @param array $query query options
  * @param string $body request body
- * @param bool  $raw  if response body contains JSON and should be decoded
+ * @param bool $raw Do not try to decode data, event when response is decodeable (JSON). Defaults to `false`
  * @throws HiArtException
  * @throws \yii\base\InvalidConfigException
  * @return mixed response
@@ -219,7 +219,7 @@ public function put($url, $query = [], $body = null, $raw = false)
  * @param string $url URL
  * @param array $query query options
  * @param string $body request body
- * @param bool  $raw  if response body contains JSON and should be decoded
+ * @param bool $raw Do not try to decode data, event when response is decodeable (JSON). Defaults to `false`
  * @throws HiArtException
  * @throws \yii\base\InvalidConfigException
  * @return mixed response
@@ -245,7 +245,7 @@ public function perform($url, $body = [])
  * @param string $url URL
  * @param array $query query options, (GET parameters)
  * @param string $body request body, (POST parameters)
- * @param bool  $raw  if response body contains JSON and should be decoded
+ * @param bool $raw Do not try to decode data, event when response is decodeable (JSON). Defaults to `false`
  * @throws HiArtException
  * @throws \yii\base\InvalidConfigException
  * @return mixed response
@@ -281,7 +281,7 @@ private function prepareUrl($path, array $query = [])
  * @param string $method POST, GET, etc
  * @param string $url the URL for request, not including proto and site
  * @param array|string $body the request body. When array - will be sent as POST params, otherwise - as RAW body.
- * @param bool $raw Whether to decode data, when response is decodeable (JSON).
+ * @param bool $raw Do not try to decode data, event when response is decodeable (JSON). Defaults to `false`
  * @return array|string
  */
  protected function handleRequest($method, $url, $body = null, $raw = false)