PHPDoctor

? Phpdoc tor

Vérifiez les fichiers ou répertoires PHP pour les types manquants.

Si vous utilisez déjà PHPSTAN pour vos vérifications de type, mais que parfois quelqu'un de l'équipe commette toujours du code non tapé, PHPDoctor est pour vous.

Installer via "Phar" ( recommandé )

https://github.com/voku/phpdoctor/releases

Installer via "Composer Besoin"

composer require-dev voku/phpdoctor

Démarrage rapide

 Usage:
  analyse [options] [--] <path...>

Arguments:
  path                                                                                   The path to analyse

Options:
      --autoload-file[=AUTOLOAD-FILE]                                                    The path to your autoloader. [default: ""]
      --access[=ACCESS]                                                                  Check for "public|protected|private" methods. [default: "public|protected|private"]
      --skip-ambiguous-types-as-error[=SKIP-AMBIGUOUS-TYPES-AS-ERROR]                    Skip check for ambiguous types. (false or true) [default: "false"]
      --skip-deprecated-functions[=SKIP-DEPRECATED-FUNCTIONS]                            Skip check for deprecated functions / methods. (false or true) [default: "false"]
      --skip-functions-with-leading-underscore[=SKIP-FUNCTIONS-WITH-LEADING-UNDERSCORE]  Skip check for functions / methods with leading underscore. (false or true) [default: "false"]
      --skip-parse-errors[=SKIP-PARSE-ERRORS]                                            Skip parse errors in the output. (false or true) [default: "true"]
      --path-exclude-regex[=PATH-EXCLUDE-REGEX]                                          Skip some paths via regex e.g. "#/vendor/|/other/.*/path/#i" [default: "#/vendor/|/tests/#i"]

Démo

Analyser une chaîne:

 $ code = '
<?php declare(strict_types = 1);   
     
class HelloWorld
{
    /**
     * @param mixed $date
     */ 
    public function sayHello($date): void
    {
        echo ' Hello, ' . $date->format( ' j. n. Y ' );
    }
} ' ;

$ phpdocErrors = PhpCodeChecker:: checkFromString ( $ code );

// [8]: missing parameter type for HelloWorld->sayHello() | parameter:date']

Ignorer les erreurs

Vous pouvez utiliser <phpdoctor-ignore-this-line/> dans @param ou @return phpdocs pour ignorer les erreurs directement dans votre code.

 /**
 * @param mixed $lall <p>this is mixed but it is ok, because ...</p> <phpdoctor-ignore-this-line/>
 *
 * @return array <phpdoctor-ignore-this-line/>
 */
function foo_ignore ( $ lall ) {
    return $ lall ;
}

Construire le fichier phar

Préparer: https://github.com/phar-io/phive

phive install humbug/box
php tools/box compile --debug

Soutien

Pour le soutien et les dons, veuillez visiter GitHub | Problèmes | PayPal | Patreon.

Pour les mises à jour de statut et les annonces de publication, veuillez visiter les versions | Twitter | Patreon.

Pour un soutien professionnel, veuillez me contacter.

Merci

• Merci à GitHub (Microsoft) pour l'hébergement du code et une bonne infrastructure, y compris les problèmes de gestion des problèmes, etc.
• Merci à Intellij car ils fabriquent les meilleurs IDE pour PHP et ils m'ont donné une licence open source pour PHPStorm!
• Merci à Travis CI d'être l'outil d'intégration continue le plus impressionnant et le plus simple!
• Merci à Styleci pour la vérification du style de code simple mais puissant.
• Merci à PhpStan && PSALM pour les très grands outils d'analyse statique et pour découvrir des bogues dans le code!