Merge pull request #5 from josantonius/pre-release/v2.0.2

pre-release/v2.0.2

Author: josantonius

.github/lang/es-ES/README.md

@@ -18,9 +18,8 @@ Para manejar excepciones puedes utilizar la biblioteca
 
 ---
 
-- [Instalación](#instalación)
 - [Requisitos](#requisitos)
-- [Cómo empezar](#cómo-empezar)
+- [Instalación](#instalación)
 - [Clases disponibles](#clases-disponibles)
   - [Clase ErrorHandler](#clase-errorhandler)
   - [Clase ErrorHandled](#clase-errorhandled)
@@ -67,79 +66,71 @@ git clone https://github.com/josantonius/php-error-handler.git
 
 ### Clase ErrorException
 
-```php
-/**
- * Esta clase es una extensión de ErrorException.
- * 
- * @see https://www.php.net/manual/en/class.errorexception.php
- */
-use Josantonius\ErrorHandler\ErrorException;
-```
+`Josantonius\ErrorHandler\ErrorException` Extends
+[ErrorException](https://www.php.net/manual/en/class.errorexception.php)
 
 Obtener el archivo donde se produjo el error:
 
 ```php
-$errorHandled->getFile(): string
+public function getFile(): string;
 ```
 
 Obtener el nivel del error:
 
 ```php
-$errorHandled->getLevel(): int
+public function getLevel(): int;
 ```
 
 Obtener el la línea donde se produjo el error:
 
 ```php
-$errorHandled->getLine(): int
+public function getLine(): int;
 ```
 
 Obtener el mensaje del error:
 
 ```php
-$errorHandled->getMessage(): string
+public function getMessage(): string;
 ```
 
 Obtener el nombre del error:
 
 ```php
-$errorHandled->getName(): string
+public function getName(): string;
 ```
 
 ### Clase ErrorHandled
 
-```php
-use Josantonius\ErrorHandler\ErrorHandled;
-```
+`Josantonius\ErrorHandler\ErrorHandled`
 
 Obtener el archivo donde se produjo el error:
 
 ```php
-$errorHandled->getFile(): string
+public function getFile(): string;
 ```
 
 Obtener el nivel del error:
 
 ```php
-$errorHandled->getLevel(): int
+public function getLevel(): int;
 ```
 
 Obtener el la línea donde se produjo el error:
 
 ```php
-$errorHandled->getLine(): int
+public function getLine(): int;
 ```
 
 Obtener el mensaje del error:
 
 ```php
-$errorHandled->getMessage(): string
+public function getMessage(): string;
 ```
 
 Obtener el nombre del error:
 
 ```php
-$errorHandled->getName(): string
+public function getName(): string;
 ```
 
 ### Clase ErrorHandler
@@ -156,7 +147,7 @@ Convertir errores en excepciones:
  * 
  * @see https://www.php.net/manual/en/errorfunc.constants.php para ver los niveles disponibles.
  */
-$errorHandler->convertToExceptions(int ...$errorLevel): ErrorHandler
+public function convertToExceptions(int ...$errorLevel): ErrorHandler;
 ```
 
 Convertir errores en excepciones excepto algunos:
@@ -171,7 +162,7 @@ Convertir errores en excepciones excepto algunos:
  * 
  * @see https://www.php.net/manual/en/errorfunc.constants.php para ver los niveles disponibles.
  */
-$errorHandler->convertToExceptionsExcept(int ...$errorLevel): ErrorHandler
+public function convertToExceptionsExcept(int ...$errorLevel): ErrorHandler;
 ```
 
 Registrar función para manejar errores:
@@ -182,7 +173,7 @@ Registrar función para manejar errores:
  * 
  * @see https://www.php.net/manual/en/functions.first_class_callable_syntax.php
  */
-$errorHandler->register(callable $callback): ErrorHandler
+public function register(callable $callback): ErrorHandler;
 ```
 
 Utilizar los informes de errores para determinar qué errores se gestionan:
@@ -195,7 +186,7 @@ Utilizar los informes de errores para determinar qué errores se gestionan:
  *
  * @see https://www.php.net/manual/en/function.error-reporting.php
  */
-$errorHandler->useErrorReportingLevel(): ErrorHandler
+public function useErrorReportingLevel(): ErrorHandler;
 ```
 
 ## Excepciones utilizadas

CHANGELOG.md

@@ -1,5 +1,16 @@
 # CHANGELOG
 
+## [v2.0.2](https://github.com/josantonius/php-error/releases/tag/v2.0.2) (2022-XX-XX)
+
+* The notation type in the test function names has been changed from camel to snake case for readability.
+
+* Functions were added to document the methods and avoid confusion.
+
+* Disabled the ´CamelCaseMethodName´ rule in ´phpmd.xml´ to avoid warnings about function names in tests.
+
+* The alignment of the asterisks in the comments has been fixed.
+
+
 ## [v2.0.1](https://github.com/josantonius/php-error/releases/tag/v2.0.1) (2022-08-11)
 
 * Documentation was improved.

README.md

@@ -30,7 +30,7 @@ To handle exceptions you can use the
 - [TODO](#todo)
 - [Changelog](#changelog)
 - [Contribution](#contribution)
-- [Sponsor](#Sponsor)
+- [Sponsor](#sponsor)
 - [License](#license)
 
 ---
@@ -66,92 +66,76 @@ git clone https://github.com/josantonius/php-error-handler.git
 
 ### ErrorException Class
 
-```php
-/**
- * This class extends from ErrorException.
- * 
- * @see https://www.php.net/manual/en/class.errorexception.php
- */
-use Josantonius\ErrorHandler\ErrorException;
-```
+`Josantonius\ErrorHandler\ErrorException` Extends
+[ErrorException](https://www.php.net/manual/en/class.errorexception.php)
 
 Gets error file:
 
 ```php
-$errorHandler->getFile(): string
+public function getFile(): string;
 ```
 
 Gets error level:
 
 ```php
-$errorHandler->getLevel(): int
+public function getLevel(): int;
 ```
 
 Gets error file line:
 
 ```php
-$errorHandler->getLine(): int
+public function getLine(): int;
 ```
 
 Gets error message:
 
 ```php
-$errorHandler->getMessage(): string
+public function getMessage(): string;
 ```
 
 Gets error name:
 
 ```php
-$errorHandler->getName(): string
+public function getName(): string;
 ```
 
 ### ErrorHandled Class
 
-```php
-use Josantonius\ErrorHandler\ErrorHandled;
-```
+`Josantonius\ErrorHandler\ErrorHandled`
 
 Gets error file:
 
 ```php
-$errorHandled->getFile(): string
+public function getFile(): string;
 ```
 
 Gets error level:
 
 ```php
-$errorHandled->getLevel(): int
+public function getLevel(): int;
 ```
 
 Gets error file line:
 
 ```php
-$errorHandled->getLine(): int
+public function getLine(): int;
 ```
 
 Gets error message:
 
 ```php
-$errorHandled->getMessage(): string
+public function getMessage(): string;
 ```
 
 Gets error name:
 
 ```php
-$errorHandled->getName(): string
+public function getName(): string;
 ```
 
 ### ErrorHandler Class
 
-```php
-use Josantonius\ErrorHandler\ErrorHandler;
-```
-
-Create object:
-
-```php
-$errorHandler = new ErrorHandler();
-```
+`Josantonius\ErrorHandler\ErrorHandler`
 
 Convert errors to exceptions:
 
@@ -165,7 +149,7 @@ Convert errors to exceptions:
  * 
  * @see https://www.php.net/manual/en/errorfunc.constants.php to view available error levels.
  */
-$errorHandler->convertToExceptions(int ...$errorLevel): ErrorHandler
+public function convertToExceptions(int ...$errorLevel): ErrorHandler;
 ```
 
 Convert errors to exceptions except for some of them:
@@ -180,7 +164,7 @@ Convert errors to exceptions except for some of them:
  * 
  * @see https://www.php.net/manual/en/errorfunc.constants.php to view available error levels.
  */
-$errorHandler->convertToExceptionsExcept(int ...$errorLevel): ErrorHandler
+public function convertToExceptionsExcept(int ...$errorLevel): ErrorHandler;
 ```
 
 Register error handler function:
@@ -191,7 +175,7 @@ Register error handler function:
  * 
  * @see https://www.php.net/manual/en/functions.first_class_callable_syntax.php
  */
-$errorHandler->register(callable $callback): ErrorHandler
+public function register(callable $callback): ErrorHandler;
 ```
 
 Use error reporting to determine which errors are handled:
@@ -204,7 +188,7 @@ Use error reporting to determine which errors are handled:
  *
  * @see https://www.php.net/manual/en/function.error-reporting.php
  */
-$errorHandler->useErrorReportingLevel(): ErrorHandler
+public function useErrorReportingLevel(): ErrorHandler;
 ```
 
 ## Exceptions Used

phpmd.xml

@@ -32,7 +32,7 @@
     <rule ref="rulesets/controversial.xml/Superglobals" />
     <rule ref="rulesets/controversial.xml/CamelCaseClassName" />
     <rule ref="rulesets/controversial.xml/CamelCasePropertyName" />
-    <rule ref="rulesets/controversial.xml/CamelCaseMethodName" />
+    <!--<rule ref="rulesets/controversial.xml/CamelCaseMethodName"/>-->
     <rule ref="rulesets/controversial.xml/CamelCaseParameterName" />
     <rule ref="rulesets/controversial.xml/CamelCaseVariableName" />
 

src/ErrorException.php

@@ -1,13 +1,13 @@
 <?php
 
 /*
-* This file is part of https://github.com/josantonius/php-error-handler repository.
-*
-* (c) Josantonius <[email protected]>
-*
-* For the full copyright and license information, please view the LICENSE
-* file that was distributed with this source code.
-*/
+ * This file is part of https://github.com/josantonius/php-error-handler repository.
+ *
+ * (c) Josantonius <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 
 namespace Josantonius\ErrorHandler;
 

src/ErrorHandled.php

@@ -3,13 +3,13 @@
 declare(strict_types=1);
 
 /*
-* This file is part of https://github.com/josantonius/php-error-handler repository.
-*
-* (c) Josantonius <[email protected]>
-*
-* For the full copyright and license information, please view the LICENSE
-* file that was distributed with this source code.
-*/
+ * This file is part of https://github.com/josantonius/php-error-handler repository.
+ *
+ * (c) Josantonius <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 
 namespace Josantonius\ErrorHandler;
 

src/ErrorHandler.php

@@ -3,13 +3,13 @@
 declare(strict_types=1);
 
 /*
-* This file is part of https://github.com/josantonius/php-error-handler repository.
-*
-* (c) Josantonius <[email protected]>
-*
-* For the full copyright and license information, please view the LICENSE
-* file that was distributed with this source code.
-*/
+ * This file is part of https://github.com/josantonius/php-error-handler repository.
+ *
+ * (c) Josantonius <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
 
 namespace Josantonius\ErrorHandler;