Skip to content

Commit

Permalink
type-hints / static analysis (primary focus on HttpMessage)
Browse files Browse the repository at this point in the history 
Javascript fixes
Update phpDoc types list
  • Loading branch information
@bkdotcom
bkdotcom committed Jan 25, 2024
1 parent deba1b1 commit 90dd623
Show file tree
Hide file tree
Showing 77 changed files with 1,807 additions and 1,359 deletions.
15 changes: 9 additions & 6 deletions src/Backtrace/Backtrace.php
View file
Expand Up @@ -4,7 +4,7 @@
* @package Backtrace
* @author Brad Kent <bkfake-github@yahoo.com>
* @license http://opensource.org/licenses/MIT MIT
* @copyright 2020-2023 Brad Kent
* @copyright 2020-2024 Brad Kent
* @version v2.2
* @link http://www.github.com/bkdotcom/Backtrace
*/
Expand All @@ -16,7 +16,9 @@
use bdk\Backtrace\SkipInternal;
use bdk\Backtrace\Xdebug;
use Exception;
use InvalidArgumentException;
use ParseError;
use Throwable;

/**
* Utility for getting backtrace
Expand All @@ -31,6 +33,7 @@ class Backtrace
const INCL_ARGS = 1;
const INCL_OBJECT = 2;

/** @var array */
protected static $callerInfoDefault = array(
'args' => array(),
'class' => null, // where the method is defined
Expand Down Expand Up @@ -67,7 +70,7 @@ public static function addInternalClass($classes, $level = 0)
* @param int $limit limit the number of stack frames returned.
* @param \Exception|\Throwable $exception (optional) Exception from which to get backtrace
*
* @return array
* @return array[]
*/
public static function get($options = 0, $limit = 0, $exception = null)
{
Expand All @@ -76,7 +79,7 @@ public static function get($options = 0, $limit = 0, $exception = null)
$trace = $exception
? self::getExceptionTrace($exception)
: (\array_reverse(Xdebug::getFunctionStack() ?: array())
?: \debug_backtrace($debugBacktraceOpts, $limit ? $limit + 2 : 0));
?: \debug_backtrace($debugBacktraceOpts, $limit > 0 ? $limit + 2 : 0));
$trace = Normalizer::normalize($trace);
$trace = SkipInternal::removeInternalFrames($trace);
// keep the calling file & line, but toss the called function (what initiated trace)
Expand Down Expand Up @@ -138,7 +141,7 @@ public static function getCallerInfo($offset = 0, $options = 0)
* @param array $backtrace backtrace frames
* @param int $length number of lines to include
*
* @return array backtrace
* @return array[] backtrace
*/
public static function addContext(array $backtrace, $length = 19)
{
Expand Down Expand Up @@ -166,7 +169,7 @@ public static function getFileLines($file, $start = null, $length = null)
*
* @param array $backtrace backtrace
*
* @return array
* @return array[]
*/
private static function callerInfoBuild(array $backtrace)
{
Expand Down Expand Up @@ -270,7 +273,7 @@ private static function parseFunction($function)
/**
* Convert our additive options to PHP's options
*
* @param int $options bitmask options
* @param int|null $options bitmask options
*
* @return int
*/
Expand Down
14 changes: 7 additions & 7 deletions src/Backtrace/Context.php
View file
Expand Up @@ -4,7 +4,7 @@
* @package Backtrace
* @author Brad Kent <bkfake-github@yahoo.com>
* @license http://opensource.org/licenses/MIT MIT
* @copyright 2020-2023 Brad Kent
* @copyright 2020-2024 Brad Kent
* @version v2.2
* @link http://www.github.com/bkdotcom/Backtrace
*/
Expand Down Expand Up @@ -55,9 +55,9 @@ public static function add(array $backtrace, $length = 19)
*
* Returns array of lineNumber => line
*
* @param string $file filepath
* @param int $start line to start on (1 = first line)
* @param int $length number of lines to return
* @param string $file filepath
* @param int|null $start line to start on (1 = first line)
* @param int|null $length number of lines to return
*
* @return array|false false if file doesn't exist
*/
Expand Down Expand Up @@ -116,9 +116,9 @@ private static function findEvalCode(array $backtrace, $index)
*
* Essentially array_slice but one-based vs zero-based
*
* @param array $lines lines of code
* @param int $start line to start on (1 = first line)
* @param int $length number of lines to return
* @param array $lines lines of code
* @param int|null $start line to start on (1 = first line)
* @param int|null $length number of lines to return
*
* @return array
*/
Expand Down
4 changes: 3 additions & 1 deletion src/Backtrace/Normalizer.php
View file
Expand Up @@ -4,7 +4,7 @@
* @package Backtrace
* @author Brad Kent <bkfake-github@yahoo.com>
* @license http://opensource.org/licenses/MIT MIT
* @copyright 2020-2023 Brad Kent
* @copyright 2020-2024 Brad Kent
* @version v2.2
* @link http://www.github.com/bkdotcom/Backtrace
*/
Expand All @@ -16,8 +16,10 @@
*/
class Normalizer
{
/** @var array */
private static $backtraceTemp = array();

/** @var array */
private static $frameDefault = array(
'args' => array(),
'evalLine' => null,
Expand Down
7 changes: 5 additions & 2 deletions src/Backtrace/SkipInternal.php
View file
Expand Up @@ -4,7 +4,7 @@
* @package Backtrace
* @author Brad Kent <bkfake-github@yahoo.com>
* @license http://opensource.org/licenses/MIT MIT
* @copyright 2020-2023 Brad Kent
* @copyright 2020-2024 Brad Kent
* @version v2.2
* @link http://www.github.com/bkdotcom/Backtrace
*/
Expand Down Expand Up @@ -54,7 +54,10 @@ class SkipInternal
public static function addInternalClass($classes, $level = 0)
{
if (\is_int($level) === false) {
throw new InvalidArgumentException(\sprintf('level must be an integer'));
throw new InvalidArgumentException(\sprintf(
'level must be an integer. %s provided.',
\gettype($level)
));
}
if (\is_array($classes) === false) {
$classes = array($classes => $level);
Expand Down
6 changes: 3 additions & 3 deletions src/Backtrace/Xdebug.php
View file
Expand Up @@ -4,7 +4,7 @@
* @package Backtrace
* @author Brad Kent <bkfake-github@yahoo.com>
* @license http://opensource.org/licenses/MIT MIT
* @copyright 2020-2023 Brad Kent
* @copyright 2020-2024 Brad Kent
* @version v2.2
* @link http://www.github.com/bkdotcom/Backtrace
*/
Expand All @@ -26,7 +26,7 @@ class Xdebug
*
* @param int $maxDepth set xdebug.var_display_max_depth ini/config
*
* @return array|false
* @return array[]|false
*
* @see https://bugs.xdebug.org/view.php?id=695
* @see https://bugs.xdebug.org/view.php?id=1529
Expand All @@ -39,7 +39,7 @@ public static function getFunctionStack($maxDepth = 3)
}
$vdmdKey = 'xdebug.var_display_max_depth';
$vdmdBak = \ini_get($vdmdKey);
\ini_set($vdmdKey, $maxDepth);
\ini_set($vdmdKey, (string) $maxDepth);
$stack = \xdebug_get_function_stack();
\ini_set($vdmdKey, $vdmdBak);
// phpcs:ignore SlevomatCodingStandard.Namespaces.FullyQualifiedGlobalFunctions.NonFullyQualified
Expand Down
25 changes: 15 additions & 10 deletions src/Container/Container.php
View file
Expand Up @@ -6,7 +6,7 @@
* @package PHPDebugConsole
* @author Brad Kent <bkfake-github@yahoo.com>
* @license http://opensource.org/licenses/MIT MIT
* @copyright 2014-2022 Brad Kent
* @copyright 2014-2024 Brad Kent
* @version v3.0
*/

Expand All @@ -31,6 +31,7 @@
*/
class Container implements \ArrayAccess
{
/** @var array */
private $cfg = array(
'allowOverride' => false, // whether can update alreay built service
'onInvoke' => null, // callable
Expand All @@ -43,8 +44,10 @@ class Container implements \ArrayAccess
*/
private $factories;

/** @var array<string, bool> */
private $invoked = array(); // keep track of invoked service closures

/** @var array<string, bool> */
private $keys = array();

/**
Expand All @@ -55,8 +58,10 @@ class Container implements \ArrayAccess
*/
private $protected;

/** @var array<string, mixed> */
private $raw = array();

/** @var array<string, mixed> */
private $values = array();

/**
Expand Down Expand Up @@ -207,26 +212,26 @@ public function offsetGet($name)
* ArrayAccess
* Sets a parameter or an object.
*
* @param string $name The unique identifier for the parameter or object
* @param mixed $value The value of the parameter or a closure to define an object
* @param string $offset The unique identifier for the parameter or object
* @param mixed $value The value of the parameter or a closure to define an object
*
* @throws \RuntimeException Prevent override of a already built service
* @return void
*/
#[\ReturnTypeWillChange]
public function offsetSet($name, $value)
public function offsetSet($offset, $value)
{
if (isset($this->invoked[$name]) && $this->cfg['allowOverride'] === false) {
if (isset($this->invoked[$offset]) && $this->cfg['allowOverride'] === false) {
throw new \RuntimeException(
\sprintf('Cannot update "%s" after it has been instantiated.', $name)
\sprintf('Cannot update "%s" after it has been instantiated.', $offset)
);
}

$this->keys[$name] = true;
$this->values[$name] = $value;
$this->keys[$offset] = true;
$this->values[$offset] = $value;
unset(
$this->invoked[$name],
$this->raw[$name]
$this->invoked[$offset],
$this->raw[$offset]
);
}

Expand Down
3 changes: 3 additions & 0 deletions src/CurlHttpMessage/Client.php
View file
Expand Up @@ -2,11 +2,14 @@

namespace bdk\CurlHttpMessage;

use bdk\CurlHttpMessage\Exception\NetworkException;
use bdk\CurlHttpMessage\Factory;
use bdk\CurlHttpMessage\HandlerStack;
use bdk\Promise\PromiseInterface;
use InvalidArgumentException;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\UriInterface;

/**
* Lightweight PSR-7 (HttpMessage) based cURL client
Expand Down
1 change: 1 addition & 0 deletions src/CurlHttpMessage/ClientAsync.php
View file
Expand Up @@ -4,6 +4,7 @@

use bdk\Promise;
use bdk\Promise\EachPromise;
use bdk\Promise\PromiseInterface;
use InvalidArgumentException;
use Psr\Http\Message\RequestInterface;

Expand Down
6 changes: 3 additions & 3 deletions src/CurlHttpMessage/CurlReqRes.php
View file
Expand Up @@ -15,7 +15,7 @@
*/
class CurlReqRes
{
/** @var resource|CurlHandle */
/** @var resource|\CurlHandle */
private $curlHandle;

/** @var bool */
Expand Down Expand Up @@ -127,7 +127,7 @@ public function finish()
*
* @param bool $create (false) whether handle should be created
*
* @return resource|CurlHandle|null
* @return resource|\CurlHandle|null
*/
public function getCurlHandle($create = false)
{
Expand All @@ -143,7 +143,7 @@ public function getCurlHandle($create = false)
*
* If setting, also sets curl options
*
* @param resource|CurlHandle|null $curlHandle curlHandle
* @param resource|\CurlHandle|null $curlHandle curlHandle
*
* @return self
*/
Expand Down
3 changes: 2 additions & 1 deletion src/Debug/AbstractComponent.php
View file
Expand Up @@ -6,7 +6,7 @@
* @package PHPDebugConsole
* @author Brad Kent <bkfake-github@yahoo.com>
* @license http://opensource.org/licenses/MIT MIT
* @copyright 2014-2022 Brad Kent
* @copyright 2014-2024 Brad Kent
* @version v3.0
*/

Expand All @@ -20,5 +20,6 @@
*/
abstract class AbstractComponent extends BaseAbstractComponent implements ConfigurableInterface
{
/** @var callable */
protected $setCfgMergeCallable = 'array_merge';
}
15 changes: 12 additions & 3 deletions src/Debug/AbstractDebug.php
View file
Expand Up @@ -23,23 +23,32 @@

/**
* Handle underlying Debug bootstraping and config
*
* @psalm-consistent-constructor
*/
class AbstractDebug
{
/** @var \bdk\Debug\Config */
protected $config;

/** @var \bdk\Container */
/** @var Container */
protected $container;
/** @var Container */
protected $serviceContainer;

/** @var \bdk\Debug */
/** @var Debug|null */
protected static $instance;

/** @var array<string, array> */
protected static $methodDefaultArgs = array();

/** @var Debug|null */
protected $parentInstance;

/** @var Debug */
protected $rootInstance;

/** @var array<int, string> */
protected $readOnly = array(
'parentInstance',
'rootInstance',
Expand All @@ -50,7 +59,7 @@ class AbstractDebug
*
* @param array $cfg config
*/
public function __construct($cfg)
public function __construct($cfg = array())
{
if (!isset(self::$instance)) {
// self::getInstance() will always return initial/first instance
Expand Down
6 changes: 3 additions & 3 deletions src/Debug/Collector/MySqli.php
View file
Expand Up @@ -6,7 +6,7 @@
* @package PHPDebugConsole
* @author Brad Kent <bkfake-github@yahoo.com>
* @license http://opensource.org/licenses/MIT MIT
* @copyright 2014-2022 Brad Kent
* @copyright 2014-2024 Brad Kent
* @version v3.0
*/

Expand Down Expand Up @@ -173,9 +173,9 @@ public function prepare($query)
* {@inheritDoc}
*/
#[\ReturnTypeWillChange]
public function query($query, $resultmode = MYSQLI_STORE_RESULT)
public function query($query, $resultMode = MYSQLI_STORE_RESULT)
{
return $this->profileCall('query', $query, array($query, $resultmode));
return $this->profileCall('query', $query, array($query, $resultMode));
}

/**
Expand Down
4 changes: 2 additions & 2 deletions src/Debug/LogEntry.php
View file
Expand Up @@ -6,7 +6,7 @@
* @package PHPDebugConsole
* @author Brad Kent <bkfake-github@yahoo.com>
* @license http://opensource.org/licenses/MIT MIT
* @copyright 2014-2022 Brad Kent
* @copyright 2014-2024 Brad Kent
* @version v3.0
*/

Expand All @@ -24,7 +24,7 @@ class LogEntry extends Event implements JsonSerializable
/**
* Regular expression for determining if argument contains "substitutions"
*
* @var string
* @var non-empty-string
*/
public $subRegex = '/%
(?:
Expand Down

0 comments on commit 90dd623

Please sign in to comment.