PhpDeprecationDetector

PhpDeprecationDetector

PHPDeprecationDetector - Analizador del código PHP para buscar los usos de la funcionalidad en desorden en las versiones de intérpretes más recientes: detector de deprecaciones.

PhpDeprecationDetector detecta:

• Uso de funciones desapercibidas, variables, constantes e ini-directivos .
• Uso de la funcionalidad de las funciones desactivadas.
• Uso de nombres o trucos prohibidos (por ejemplo, identificadores reservados en versiones más nuevas).

Literalmente le ayuda a encontrar un código que puede fallar después de la migración a la nueva versión de PHP.

1. Instalación
2. Uso

• Escáner de consola
• Formato de informe JSON

Instalación

Archivo phar

1. Simplemente descargue un PHAR de la página de lanzamientos y haga ejecutable

chmod +x phpdd-x.x.x.phar

2. a. Instalación local : úsela desde la carpeta actual:

    . /phpdd-x.x.x.phar -h

   b. Instalación global : muévalo a una de las carpetas enumeradas en su $PATH y ejecute desde cualquier carpeta:

   sudo mv phpdd-x.x.x.phar /usr/local/bin/phpdd
   phpdd -h

Compositor

Otra forma de instalar PHPDD es a través del compositor.

1. Instalar compositor:

curl -sS https://getcomposer.org/installer | php

2. Instale PHPDD en Global Composer Dir:

./composer.phar global require wapmorgan/php-deprecation-detector dev-master

3. Ejecutar desde cualquier carpeta:

phpdd -h

Uso

Escáner de consola

Para escanear sus archivos o carpeta, inicie phpdd y pase los nombres de archivo o directorio.

 Description:
  Analyzes PHP code and searches issues with deprecated functionality in newer interpreter versions.

Usage:
  scan [options] [--] <files>...

Arguments:
  files                                    Which files you want to analyze (separate multiple names with a space)?

Options:
  -t, --target[=TARGET]                    Sets target PHP interpreter version. [default: "8.0"]
  -a, --after[=AFTER]                      Sets initial PHP interpreter version for checks. [default: "5.3"]
  -e, --exclude[=EXCLUDE]                  Sets excluded file or directory names for scanning. If need to pass few names, join it with comma.
  -s, --max-size[=MAX-SIZE]                Sets max size of php file. If file is larger, it will be skipped. [default: "1mb"]
      --file-extensions[=FILE-EXTENSIONS]  Sets file extensions to be parsed. [default: "php, php5, phtml"]
      --skip-checks[=SKIP-CHECKS]          Skip all checks containing any of the given values. Pass a comma-separated list for multiple values.
      --output[=OUTPUT]                    The output type required. Options: stdout, json, junit. Defaults to stdout.
      --output-file[=OUTPUT-FILE]          File path to store results where output is not stdout.
  -h, --help                               Display help for the given command. When no command is given display help for the scan command
  -q, --quiet                              Do not output any message
  -V, --version                            Display this application version
      --ansi                               Force ANSI output
      --no-ansi                            Disable ANSI output
  -n, --no-interaction                     Do not ask any interactive question
  -v|vv|vvv, --verbose                     Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

• Al proporcionar opción adicional --target , puede especificar la versión de PHP para realizar menos comprobaciones. Versiones objetivo disponibles: 5.3, 5.4, 5.5, 5.6, 7.0, 7.1, 7.2, 7.3, 7.4, 8.0. Una versión más grande incluye reglas para verificar de todos los anteriores.
• Al proporcionar: opción --exclude , puede excluir carpetas o archivos específicos de analizar. Por ejemplo, --exclude vendor evitará verificar las bibliotecas de terceros.
• Al proporcionar la opción --skip-checks puede excluir cheques específicos de Analyze.
• Si sus archivos tienen una extensión inusual, puede especificar todos los EXT mediante opción de --file-extensions . Por defecto, utiliza php , phtml y php5 .
• Si necesita generar el resultado de análisis legible por máquina, use la opción --output-file para especificar la ruta para almacenar el archivo de salida como se especifica en --output (JSON o JUnit).

Ejemplo de uso

 > ./bin/phpdd tests/
Max file size set to: 1.000 MiB
Folder /media/wapmorgan/Локальный диск/Документы/PhpDeprecationDetector/tests
- PHP 5.3 (3) - your version is greater or equal
+------------+---------+---------------------------------------------------------------------+
| File:Line  | Type    | Issue                                                               |
+------------+---------+---------------------------------------------------------------------+
| /5.3.php:2 | removed | Function dl() is removed.                                           |
| /5.3.php:3 | removed | Ini define_syslog_variables is removed.                             |
| /5.3.php:5 | changed | Function usage piet() (@call_with_passing_by_reference) is changed. |
|            |         | Call with passing by reference is deprecated. Problem is "&$hoho"   |
+------------+---------+---------------------------------------------------------------------+

- PHP 5.4 (2) - your version is greater or equal
+------------+---------+-----------------------------------------------+
| File:Line  | Type    | Issue                                         |
+------------+---------+-----------------------------------------------+
| /5.4.php:2 | removed | Function mcrypt_generic_end() is removed.     |
|            |         | Consider replace with mcrypt_generic_deinit() |
| /5.4.php:3 | removed | Function magic_quotes_runtime() is removed.   |
+------------+---------+-----------------------------------------------+
...
...
...

Formato de informe JSON

Además, puede almacenar el resultado del resultado en formato JSON para una verificación automática. Pase --output-file=FILENAME para escribir el resultado en el archivo de nombre de archivo o no se establece en la salida a stdout .

Formato de informe Junit

Además, puede almacenar analizar el resultado en formato JUnit para una verificación automática. Pase --output-file=FILENAME para escribir el resultado en el archivo de nombre de archivo o no se establece en la salida a stdout .

Formato de JSON - Diccionario con artículos:

• Infomessage [] info_messages - Lista de mensajes de información sobre el proceso de análisis.
• Problema [] Problemas : lista de problemas encontrados en su código.
• Reemplazar Hugestion [] reemplazar_suggestions : lista de sugerencias de reemplazo basadas en su código.
• Nota [] Notas : lista de notas sobre el comportamiento de las nuevas funciones.

Elemento Descripción:

• Estructura de infoMessage :
  • Tipo de cadena - Tipo de mensaje - Cualquiera de (Información | Advertencia)
  • Mensaje de cadena - Texto del mensaje
• Estructura de emisión :
  • Versión de cadena: versión de intérprete que tiene un problema actual ( como 7.2 )
  • Archivo de cadena: ruta relativa al archivo en el que se encontró el problema ( como SRC/Problemclass.php )
  • Ruta de cadena: ruta absoluta al archivo en el que se encuentra el problema ( como /var/www/html/project/src/problemclass.php )
  • INT LINE - Línea en el archivo en el que se encontró el tema
  • columna int - columna en línea en la que se encontró el problema
  • Categoría de cadena - Categoría de emisión - Cualquiera de (cambiado | eliminado | violación)
  • Tipo de cadena - Tipo de problema concreto ( como "constante" o "identificador" )
  • Camplante de cadena: objeto de problema concreto que puede causar problemas ( como magic_quotes_runtime o preg_replace() (@preg_replace_e_modifier) )
• Reemplaza la estructura de sugestión:
  • Tipo de cadena - Tipo de objeto de reemplazo ( como Variable o INI )
  • Problema de cadena - Objeto de reemplazo ( como MCRYPT_GENERIC_END () o cada () )
  • Reemplazo de cadenas: sugerencia para reemplazar con ( como MCRYPT_GENERIC_DEINIT () o foreach () ))
• Nota Estructura:
  • Tipo de cadena - Tipo de nota ( como function_usage o depreced_feature )
  • Problema de cadena - Objeto nota ( como preg_replace() (@preg_replace_e_modifier) ​​o parse_str() (@parse_str_without_argument) ))
  • Nota de cadena: nota el texto ( como Usage of "e" modifier in preg_replace is deprecated: "asdasdsd~ie" o Call to parse_str() without second argument is deprecated )

Construir

docker run --rm --interactive --tty --volume $PWD :/app composer:2.2.4 sh
# and inside a container:
docker-php-ext-install bcmath
composer require macfja/phar-builder
echo phar.readonly=0 >> /usr/local/etc/php/php-cli.ini
composer run-script build