CoreLibs/development
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

phpan/phpstan checks and fixes

Browse Source
This commit is contained in:
Clemens Schwaighofer
2022-01-13 16:11:19 +09:00
parent 13c0fcd869
commit 1bd45d8a8a
9 changed files with 97 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

0
4dev/checking/phan.sh Normal file → Executable file
View File

0
4dev/checking/phpstan.sh Normal file → Executable file
View File

71
4dev/tests/CoreLibsDebugLoggingTest.php
View File

@@ -13,12 +13,81 @@ use PHPUnit\Framework\TestCase;
*/ */
final class CoreLibsDebugLoggingTest extends TestCase final class CoreLibsDebugLoggingTest extends TestCase
{ {
public $log;
public function optionsProvider(): array
{
return [
'log folder set' => [
[
'log_folder' => '/tmp'
],
[
'log_folder' => '/tmp/'
],
[]
],
'nothing set' => [
null,
[
'log_folder' => getcwd() . DIRECTORY_SEPARATOR
],
[]
],
'no options set, constant set' => [
null,
[
'log_folder' => '/tmp/'
],
[
'constant' => [
'BASE' => '/tmp',
'LOG' => '/'
]
]
],
];
}
// init tests // init tests
// - __construct call with options // - __construct call with options
/**
* Undocumented function
*
* @dataProvider optionsProvider
* @testdox init test [$_dataName]
*
* @param array|null $options
* @param array $expected
* @param array $override
* @return void
*/
public function testClassInit(?array $options, array $expected, array $override): void
{
if (!empty($override['constant'])) {
foreach ($override['constant'] as $var => $value) {
define($var, $value);
}
}
if ($options === null) {
$this->log = new \CoreLibs\Debug\Logging();
} else {
$this->log = new \CoreLibs\Debug\Logging($options);
}
// check that settings match
// print "LOG: " . $this->log->getSetting('log_folder') . "\n";
$this->assertEquals(
$expected['log_folder'],
$this->log->getSetting('log_folder')
);
}
// setting tests // setting tests
// - basicSetLogId // - basicSetLogId
// - getLogLevelAll // - getLogId
// - setLogLevelAll // - setLogLevelAll
// - getLogLevelAll
// - debugFor // - debugFor
// - setLogLevel // - setLogLevel
// - getLogLevel // - getLogLevel

13
README.md
View File

@@ -30,16 +30,21 @@ The old non namepsace format layout.
This is fully deprecated and will no longer be maintaned. This is fully deprecated and will no longer be maintaned.
last tested PHP 5.6 and PHP 7.0 last tested PHP 5.6 and PHP 7.0
### namespace ### development
The new namespace branch. This is the development area for the master branch Any current development is done here
## Static checks ## Static checks
With phpstan With phpstan (`4dev/checking/phpstan.sh`)
`phpstan` `phpstan`
With phan With phan (`4dev/checking/phan.sh`)
`phan --progress-bar -C --analyze-twice` `phan --progress-bar -C --analyze-twice`
pslam is setup but not configured pslam is setup but not configured
## Unit tests
With phpunit (`4dev/checking/phpunit.sh`)
`phpunit -c $phpunit.xml 4dev/tests/`

5
www/admin/class_test.json.php
View File

@@ -29,12 +29,11 @@ if (!defined('SET_SESSION_NAME')) {
$LOG_FILE_ID = 'classTest-json'; $LOG_FILE_ID = 'classTest-json';
ob_end_flush(); ob_end_flush();
use CoreLibs\Check\Json; use CoreLibs\Convert\Json;
// use CoreLibs\Check\Jason;
use CoreLibs\Debug\Support as DgS; use CoreLibs\Debug\Support as DgS;
$basic = new CoreLibs\Basic(); $basic = new CoreLibs\Basic();
$json_class = 'CoreLibs\Check\Json'; $json_class = 'CoreLibs\Convert\Json';
// define a list of from to color sets for conversion test // define a list of from to color sets for conversion test

24
www/lib/CoreLibs/Basic.php
View File

@@ -1238,10 +1238,10 @@ class Basic
* @param int $green green 0-255 * @param int $green green 0-255
* @param int $blue blue 0-255 * @param int $blue blue 0-255
* @param bool $hex_prefix default true, prefix with "#" * @param bool $hex_prefix default true, prefix with "#"
* @return string rgb in hex values with leading # if set * @return string|bool rgb in hex values with leading # if set
* @deprecated use \CoreLibs\Convert\Colors::rgb2hex() instead * @deprecated use \CoreLibs\Convert\Colors::rgb2hex() instead
*/ */
public static function rgb2hex(int $red, int $green, int $blue, bool $hex_prefix = true): string public static function rgb2hex(int $red, int $green, int $blue, bool $hex_prefix = true)
{ {
trigger_error('Method ' . __METHOD__ . ' is deprecated, use \CoreLibs\Convert\Colors::rgb2hex()', E_USER_DEPRECATED); trigger_error('Method ' . __METHOD__ . ' is deprecated, use \CoreLibs\Convert\Colors::rgb2hex()', E_USER_DEPRECATED);
return \CoreLibs\Convert\Colors::rgb2hex($red, $green, $blue, $hex_prefix); return \CoreLibs\Convert\Colors::rgb2hex($red, $green, $blue, $hex_prefix);
@@ -1252,10 +1252,10 @@ class Basic
* @param int $red red 0-255 * @param int $red red 0-255
* @param int $green green 0-255 * @param int $green green 0-255
* @param int $blue blue 0-255 * @param int $blue blue 0-255
* @return string hex rgb string * @return string|bool hex rgb string
* @deprecated use rgb2hex instead * @deprecated use rgb2hex instead
*/ */
public static function rgb2html(int $red, int $green, int $blue): string public static function rgb2html(int $red, int $green, int $blue)
{ {
trigger_error('Method ' . __METHOD__ . ' is deprecated, use \CoreLibs\Convert\Colors::rgb2hex()', E_USER_DEPRECATED); trigger_error('Method ' . __METHOD__ . ' is deprecated, use \CoreLibs\Convert\Colors::rgb2hex()', E_USER_DEPRECATED);
// check that each color is between 0 and 255 // check that each color is between 0 and 255
@@ -1269,10 +1269,10 @@ class Basic
* @param int $red red 0-255 * @param int $red red 0-255
* @param int $green green 0-255 * @param int $green green 0-255
* @param int $blue blue 0-255 * @param int $blue blue 0-255
* @return array<mixed> Hue, Sat, Brightness/Value * @return array<mixed>|bool Hue, Sat, Brightness/Value
* @deprecated use \CoreLibs\Convert\Colors::rgb2hsb() instead * @deprecated use \CoreLibs\Convert\Colors::rgb2hsb() instead
*/ */
public static function rgb2hsb(int $red, int $green, int $blue): array public static function rgb2hsb(int $red, int $green, int $blue)
{ {
trigger_error('Method ' . __METHOD__ . ' is deprecated, use \CoreLibs\Convert\Colors::rgb2hsb()', E_USER_DEPRECATED); trigger_error('Method ' . __METHOD__ . ' is deprecated, use \CoreLibs\Convert\Colors::rgb2hsb()', E_USER_DEPRECATED);
return \CoreLibs\Convert\Colors::rgb2hsb($red, $green, $blue); return \CoreLibs\Convert\Colors::rgb2hsb($red, $green, $blue);
@@ -1283,10 +1283,10 @@ class Basic
* @param int $H hue 0-360 * @param int $H hue 0-360
* @param float $S saturation 0-1 (float) * @param float $S saturation 0-1 (float)
* @param float $V brightness/value 0-1 (float) * @param float $V brightness/value 0-1 (float)
* @return array<mixed> 0 red/1 green/2 blue array * @return array<mixed>|bool 0 red/1 green/2 blue array
* @deprecated use \CoreLibs\Convert\Colors::hsb2rgb() instead * @deprecated use \CoreLibs\Convert\Colors::hsb2rgb() instead
*/ */
public static function hsb2rgb(int $H, float $S, float $V): array public static function hsb2rgb(int $H, float $S, float $V)
{ {
trigger_error('Method ' . __METHOD__ . ' is deprecated, use \CoreLibs\Convert\Colors::hsb2rgb()', E_USER_DEPRECATED); trigger_error('Method ' . __METHOD__ . ' is deprecated, use \CoreLibs\Convert\Colors::hsb2rgb()', E_USER_DEPRECATED);
return \CoreLibs\Convert\Colors::hsb2rgb($H, (int)round($S * 100), (int)round($V * 100)); return \CoreLibs\Convert\Colors::hsb2rgb($H, (int)round($S * 100), (int)round($V * 100));
@@ -1299,10 +1299,10 @@ class Basic
* @param int $r red 0-255 * @param int $r red 0-255
* @param int $g green 0-255 * @param int $g green 0-255
* @param int $b blue 0-255 * @param int $b blue 0-255
* @return array<mixed> hue/sat/luminance * @return array<mixed>|bool hue/sat/luminance
* @deprecated use \CoreLibs\Convert\Colors::rgb2hsl() instead * @deprecated use \CoreLibs\Convert\Colors::rgb2hsl() instead
*/ */
public static function rgb2hsl(int $r, int $g, int $b): array public static function rgb2hsl(int $r, int $g, int $b)
{ {
trigger_error('Method ' . __METHOD__ . ' is deprecated, use \CoreLibs\Convert\Colors::rgb2hsl()', E_USER_DEPRECATED); trigger_error('Method ' . __METHOD__ . ' is deprecated, use \CoreLibs\Convert\Colors::rgb2hsl()', E_USER_DEPRECATED);
return \CoreLibs\Convert\Colors::rgb2hsb($r, $g, $b); return \CoreLibs\Convert\Colors::rgb2hsb($r, $g, $b);
@@ -1313,10 +1313,10 @@ class Basic
* @param int $h hue: 0-360 (degrees) * @param int $h hue: 0-360 (degrees)
* @param float $s saturation: 0-1 * @param float $s saturation: 0-1
* @param float $l luminance: 0-1 * @param float $l luminance: 0-1
* @return array<mixed> red/blue/green 0-255 each * @return array<mixed>|bool red/blue/green 0-255 each
* @deprecated use \CoreLibs\Convert\Colors::hsl2rgb() instead * @deprecated use \CoreLibs\Convert\Colors::hsl2rgb() instead
*/ */
public static function hsl2rgb(int $h, float $s, float $l): array public static function hsl2rgb(int $h, float $s, float $l)
{ {
trigger_error('Method ' . __METHOD__ . ' is deprecated, use \CoreLibs\Convert\Colors::hsl2rgb()', E_USER_DEPRECATED); trigger_error('Method ' . __METHOD__ . ' is deprecated, use \CoreLibs\Convert\Colors::hsl2rgb()', E_USER_DEPRECATED);
return \CoreLibs\Convert\Colors::hsl2rgb($h, $s * 100, $l * 100); return \CoreLibs\Convert\Colors::hsl2rgb($h, $s * 100, $l * 100);

1
www/lib/CoreLibs/Combined/ArrayHandler.php
View File

@@ -330,6 +330,7 @@ class ArrayHandler
/** /**
* will loop through an array recursivly and write the array keys back * will loop through an array recursivly and write the array keys back
* @param array<mixed> $array multidemnsional array to flatten * @param array<mixed> $array multidemnsional array to flatten
* @param array<mixed> $return recoursive pass on array of keys
* @return array<mixed> flattened keys array * @return array<mixed> flattened keys array
*/ */
public static function flattenArrayKey(array $array, array $return = []): array public static function flattenArrayKey(array $array, array $return = []): array

2
www/lib/CoreLibs/Create/Uids.php
View File

@@ -60,7 +60,7 @@ class Uids
// fallback to this hash type // fallback to this hash type
$hash = self::FALLBACK_HASH; $hash = self::FALLBACK_HASH;
if ( if (
defined('DEFAULT_HASH') && !empty(DEFAULT_HASH) && defined('DEFAULT_HASH') &&
in_array(DEFAULT_HASH, hash_algos()) in_array(DEFAULT_HASH, hash_algos())
) { ) {
$hash = DEFAULT_HASH; $hash = DEFAULT_HASH;

4
www/lib/CoreLibs/Debug/FileWriter.php
View File

@@ -13,6 +13,7 @@ class FileWriter
{ {
/** @var string */ /** @var string */
private static $debug_filename = 'debug_file.log'; // where to write output private static $debug_filename = 'debug_file.log'; // where to write output
/** @var string */
private static $debug_folder; private static $debug_folder;
/** /**
@@ -71,8 +72,7 @@ class FileWriter
// if empty try to set base log folder // if empty try to set base log folder
if ( if (
empty(self::$debug_folder) && empty(self::$debug_folder) &&
defined('BASE') && !empty(BASE) && defined('BASE') && defined('LOG')
defined('LOG') && !empty(LOG)
) { ) {
self::$debug_folder = BASE . LOG; self::$debug_folder = BASE . LOG;
} }