PHPStan level 6

Author: phpfui

README.md

@@ -1,4 +1,4 @@
-# PHPFUI\MySQLSlowLog\Parser [![Tests](https://github.com/phpfui/MySQLSlowQueryParser/actions/workflows/tests.yml/badge.svg)](https://github.com/phpfui/MySQLSlowQueryParser/actions?query=workflow%3Atests) [![Latest Packagist release](https://img.shields.io/packagist/v/phpfui/mysql-slow-log-parser.svg)](https://packagist.org/packages/phpfui/mysql-slow-log-parser)
+# PHPFUI\MySQLSlowLog\Parser [![Tests](https://github.com/phpfui/MySQLSlowQueryParser/actions/workflows/tests.yml/badge.svg)](https://github.com/phpfui/MySQLSlowQueryParser/actions?query=workflow%3Atests) [![Latest Packagist release](https://img.shields.io/packagist/v/phpfui/mysql-slow-log-parser.svg)](https://packagist.org/packages/phpfui/mysql-slow-log-parser) ![](https://img.shields.io/badge/PHPStan-level%206-brightgreen.svg?style=flat)
 
 PHP Parser for MySQL Slow Query Logs featuring sortable results
 

phpstan.neon.dist

@@ -0,0 +1,18 @@
+parameters:
+level: 6
+errorFormat: raw
+editorUrl: '%%file%% %%line%% %%column%%: %%error%%'
+paths:
+- src
+- tests
+ignoreErrors:
+-
+message: '#Access to an undefined property PHPFUI\\MySQLSlowQuery\\Entry::#'
+paths:
+- tests/*
+-
+message: '#Access to an undefined property PHPFUI\\MySQLSlowQuery\\Session::#'
+paths:
+- tests/*
+
+

src/PHPFUI/MySQLSlowQuery/BaseObject.php

@@ -4,12 +4,16 @@
 
 abstract class BaseObject
 {
+/** @var array<string, mixed> $fields */
 protected array $fields = [];
 
-abstract public function __construct(array $paramters = []);
+/** @param array<string, string> $parameters $parameters */
+abstract public function __construct(array $parameters = []);
 
 /**
  * Allows for $object->field syntax
+ *
+ * @return string | array<int, mixed>
  */
 public function __get(string $field)
 {
@@ -24,6 +28,8 @@ public function __get(string $field)
 /**
  * Allows for $object->field = $x syntax
  *
+ * @param mixed $value value to set
+ *
  * @return mixed returns $value so you can string together assignments
  */
 public function __set(string $field, $value)
@@ -38,6 +44,7 @@ public function __set(string $field, $value)
 return $value;
 }
 
+/** @return array<string, mixed> */
 public function asArray() : array
 {
 return $this->fields;

src/PHPFUI/MySQLSlowQuery/Entry.php

@@ -4,6 +4,7 @@
 
 class Entry extends \PHPFUI\MySQLSlowQuery\BaseObject
 {
+// @phpstan-ignore-next-line
 public function __construct(array $parameters = [])
 {
 $this->fields = [

src/PHPFUI/MySQLSlowQuery/Parser.php

@@ -8,16 +8,20 @@ class Parser
 
 private const TIME = '# Time: ';
 
+/** @var array<int, \PHPFUI\MySQLSlowQuery\Entry> */
 private array $entries = [];
 
+/** @var array<int, string> */
 private array $extraLines = [];
 
 private string $fileName = '';
 
+// @phpstan-ignore-next-line
 private $handle;
 
 private bool $inSession = true;
 
+/** @var array<int, \PHPFUI\MySQLSlowQuery\Session> */
 private array $sessions = [];
 
 private string $sortColumn = 'Query_time';
@@ -39,6 +43,8 @@ public function __construct(string $fileName)
  *
  * @throws Exception\EmptyLog
  * @throws Exception\LogLine
+ * @return array<int, \PHPFUI\MySQLSlowQuery\Entry>
+ *
  */
 public function getEntries(int $session = -1) : array
 {
@@ -53,6 +59,7 @@ public function getEntries(int $session = -1) : array
 
 foreach ($this->entries as $entry)
 {
+// @phpstan-ignore-next-line
 if ($entry->Session == $session)
 {
 $entries[] = $entry;
@@ -66,10 +73,10 @@ public function getEntries(int $session = -1) : array
 }
 
 /**
- * Return \PHPFUI\MySQLSlowQuery\Session sessions from file
- *
  * @throws Exception\EmptyLog
  * @throws Exception\LogLine
+ * @return array<int, \PHPFUI\MySQLSlowQuery\Session> sessions from file
+ *
  */
 public function getSessions() : array
 {
@@ -114,7 +121,7 @@ protected function entrySort(\PHPFUI\MySQLSlowQuery\Entry $lhs, \PHPFUI\MySQLSlo
 return $lhs->{$column} <=> $rhs->{$column};
 }
 
-private function getNextLine()
+private function getNextLine() : string
 {
 if ($this->extraLines)
 {
@@ -163,6 +170,7 @@ private function parse() : void
 
 $query = [];
 
+// @phpstan-ignore-next-line
 while (\strlen($line = $this->getNextLine()) > 0 && '#' !== $line[0])
 {
 if (0 === \stripos($line, self::PORT))// found a session
@@ -186,7 +194,9 @@ private function parse() : void
 {
 $this->pushLine($line);
 }
+// @phpstan-ignore-next-line
 $entry->Query = $query;
+// @phpstan-ignore-next-line
 $entry->Session = \count($this->sessions) - 1;
 $this->entries[] = $entry;
 }

src/PHPFUI/MySQLSlowQuery/Session.php

@@ -4,6 +4,7 @@
 
 class Session extends \PHPFUI\MySQLSlowQuery\BaseObject
 {
+/** @param array<int, string> $sessionData */
 public function __construct(array $sessionData = [])
 {
 $this->fields = [
@@ -12,10 +13,12 @@ public function __construct(array $sessionData = [])
 'Transport' => '',
 ];
 
+// @phpstan-ignore-next-line
 $this->Server = \trim(\str_replace('. started with:', '', $sessionData[0] ?? 'unknown'));
 
 if (\strpos($sessionData[1] ?? '', ', '))
 {
+// @phpstan-ignore-next-line
 [$this->Port, $this->Transport] = \explode(', ', \trim($sessionData[1]));
 }
 }

tests/UnitTest.php

@@ -35,13 +35,15 @@ public function testInvalidGet() : void
 {
 $this->expectException(\PHPFUI\MySQLSlowQuery\Exception\Get::class);
 $entry = new \PHPFUI\MySQLSlowQuery\Entry();
+// @phpstan-ignore-next-line
 $entry->fred;
 }
 
 public function testInvalidSet() : void
 {
 $this->expectException(\PHPFUI\MySQLSlowQuery\Exception\Set::class);
 $entry = new \PHPFUI\MySQLSlowQuery\Entry();
+// @phpstan-ignore-next-line
 $entry->fred = 'Ethyl';
 }