Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable more PHP-CS-Fixer rules for PHPDoc #864

Merged
merged 5 commits into from
Feb 6, 2020
Merged

Enable more PHP-CS-Fixer rules for PHPDoc #864

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
81fea07
Use phpdoc_order rule
ob-stripe Feb 6, 2020
dd26cf0
Use phpdoc_to_comment rule
ob-stripe Feb 6, 2020
dea2461
Use align_multiline_comment rule
ob-stripe Feb 6, 2020
aca32fc
Use no_blank_lines_after_phpdoc rule
ob-stripe Feb 6, 2020
b20f3b7
Use no_empty_phpdoc rule
ob-stripe Feb 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .php_cs.dist
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,29 @@ return PhpCsFixer\Config::create()
'@PHP56Migration:risky' => true,
'@PHPUnit57Migration:risky' => true,
'@PSR2' => true,
'align_multiline_comment' => true,
'array_syntax' => ['syntax' => 'short'],
'blank_line_after_opening_tag' => true,
'class_attributes_separation' => [
'elements' => ['method'],
],
'linebreak_after_opening_tag' => true,
'native_function_invocation' => true,
'no_blank_lines_after_phpdoc' => true,
'no_empty_phpdoc' => true,
'phpdoc_add_missing_param_annotation' => true,
'phpdoc_indent' => true,
'phpdoc_inline_tag' => true,
'phpdoc_no_access' => true,
'phpdoc_no_alias_tag' => true,
'phpdoc_no_empty_return' => true,
'phpdoc_no_useless_inheritdoc' => true,
'phpdoc_order' => true,
'phpdoc_return_self_reference' => true,
'phpdoc_scalar' => true,
'phpdoc_separation' => true,
'phpdoc_single_line_var_spacing' => true,
'phpdoc_to_comment' => true,
'phpdoc_trim' => true,
'phpdoc_trim_consecutive_blank_line_separation' => true,
'phpdoc_types' => true,
Expand Down
16 changes: 8 additions & 8 deletions lib/ApiRequestor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,9 @@ private static function _encodeObjects($d)
* @param array|null $params
* @param array|null $headers
*
* @return array tuple containing (ApiReponse, API key)
*
* @throws Exception\ApiErrorException
*
* @return array tuple containing (ApiReponse, API key)
*/
public function request($method, $url, $params = null, $headers = null)
{
Expand Down Expand Up @@ -295,10 +295,10 @@ private static function _defaultHeaders($apiKey, $clientInfo = null)
* @param array $params
* @param array $headers
*
* @return array
*
* @throws Exception\AuthenticationException
* @throws Exception\ApiConnectionException
*
* @return array
*/
private function _requestRaw($method, $url, $params, $headers)
{
Expand Down Expand Up @@ -384,9 +384,9 @@ private function _requestRaw($method, $url, $params, $headers)
/**
* @param resource $resource
*
* @return \CURLFile|string
*
* @throws Exception\InvalidArgumentException
*
* @return \CURLFile|string
*/
private function _processResourceParam($resource)
{
Expand All @@ -412,10 +412,10 @@ private function _processResourceParam($resource)
* @param int $rcode
* @param array $rheaders
*
* @return array
*
* @throws Exception\UnexpectedValueException
* @throws Exception\ApiErrorException
*
* @return array
*/
private function _interpretResponse($rbody, $rcode, $rheaders)
{
Expand Down
4 changes: 2 additions & 2 deletions lib/ApiResource.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ public function __set($k, $v)
}

/**
* @return ApiResource The refreshed resource.
*
* @throws Exception\ApiErrorException
*
* @return ApiResource The refreshed resource.
*/
public function refresh()
{
Expand Down
4 changes: 2 additions & 2 deletions lib/Webhook.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ abstract class Webhook
* @param int $tolerance maximum difference allowed between the header's
* timestamp and the current time
*
* @return Event the Event instance
*
* @throws Exception\UnexpectedValueException if the payload is not valid JSON,
* @throws Exception\SignatureVerificationException if the verification fails.
*
* @return Event the Event instance
*/
public static function constructEvent($payload, $sigHeader, $secret, $tolerance = self::DEFAULT_TOLERANCE)
{
Expand Down