Skip to content

Commit

Permalink
#37 Ajout de nouvelles règles php-cs-fixer.
Browse files Browse the repository at this point in the history
  • Loading branch information
noelma committed Jan 21, 2019
1 parent 4c345b0 commit 6ebfb49
Show file tree
Hide file tree
Showing 88 changed files with 705 additions and 731 deletions.
132 changes: 100 additions & 32 deletions .php_cs.dist
Original file line number Diff line number Diff line change
@@ -1,38 +1,106 @@
<?php

/* friendsofphp/php-cs-fixer: 1.13.* */
$finder = PhpCsFixer\Finder::create()
->in(__DIR__);

return PhpCsFixer\Config::create()
->setRules([
'@PSR2' => true,
/* Force la déclaration des tableaux sous leur forme courte. */
'array_syntax'=> ['syntax' => 'short'],
/* Ajoute un saut de ligne avant chaque return en fin de fonction. */
'blank_line_before_statement'=>true,
/* Combine les isset() && successives. */
'combine_consecutive_issets' => true,
/* Combine les unset() successives. */
'combine_consecutive_unsets'=>true,
/* Remplace les commentaires simples # par //. */
'hash_to_slash_comment'=>true,
/* Retire les parenthèses des include/require. */
'include'=>true,
/* Ne pas avoir de code à l'ouverture d'une balise php */
'linebreak_after_opening_tag'=>true,
/* Supprime les commentaires vides. */
'no_empty_comment'=>true,
/* Supprime les blocks PHPDoc vides. */
'no_empty_phpdoc'=>true,
/* Supprimez les instructions de point virgule inutiles. */
'no_empty_statement'=>true,
/* Supprime les lignes vides supplémentaire. */
'no_extra_blank_lines'=>true,
/* La ligne de déclaration de l'espace de noms ne doit pas contenir d'espaces de début. */
'no_leading_namespace_whitespace'=>true,
/* Remplace les <?= par des <?php echo. */
'no_short_echo_tag'=>true,
/* Ordonne les éléments des class. */
'ordered_class_elements'=>true
])
->setFinder($finder);
->setRules([
'@PSR2' => true,
/* Force la déclaration des tableaux sous leur forme courte. */
'array_syntax' => [ 'syntax' => 'short' ],
/* Ajoute un saut de ligne avant chaque return en fin de fonction. */
'blank_line_before_statement' => true,
/* Ajoute un espace entre le cast et la variable. */
'cast_spaces' => true,
/* Les éléments de classe, de trait et d’interface doivent être séparés par une ligne vierge. */
'class_attributes_separation' => true,
/* Combine les isset() && successives. */
'combine_consecutive_issets' => true,
/* Combine les unset() successives. */
'combine_consecutive_unsets' => true,
/* Ajoute un espace avant et après les points de concaténation. */
'concat_space' => [ 'spacing' => 'one' ],
/* Remplace les commentaires simples # par //. */
'fully_qualified_strict_types' => true,
'hash_to_slash_comment' => true,
/* Retire les parenthèses des include/require. */
'include' => true,
/* Ne pas avoir de code à l'ouverture d'une balise php */
'linebreak_after_opening_tag' => true,
/* Supprime les commentaires vides. */
'lowercase_cast' => true,
/* Les mots-clés PHP DOIVENT être en minuscules. */
'lowercase_keywords' => true,
/* Les références statiques de classe self, static et parent DOIVENT être en minuscule. */
'lowercase_static_reference' => true,
/* Les constantes magiques doivent être utilisées avec la bonne case. */
'magic_constant_casing' => true,
/* Les définitions de méthodes magiques et les appels doivent utiliser la case appropriée. */
'magic_method_casing' => true,
/* Supprime les commentaires vides. */
'no_empty_comment' => true,
/* Supprime les blocks PHPDoc vides. */
'no_empty_phpdoc' => true,
/* Supprimez les instructions de point virgule inutiles. */
'no_empty_statement' => true,
/* Supprime les lignes vides supplémentaire. */
'no_extra_blank_lines' => true,
/* Supprimer les barres obliques au début de use. */
'no_leading_import_slash' => true,
/* La ligne de déclaration de l'espace de noms ne doit pas contenir d'espaces de début. */
'no_leading_namespace_whitespace' => true,
/* Remplace l'utilisation du print par echo. */
'no_mixed_echo_print' => true,
/* Supprime les espaces d'une seule ligne avant la fermeture du point-virgule. */
'no_singleline_whitespace_before_semicolons' => true,
/* Supprimes les espaces autour des accolades des tableaux. */
'no_spaces_around_offset' => [ 'outside' ],
/* Remplace les éléments elseif superflus par if. */
'no_superfluous_elseif' => true,
/* Supprime les accolades superflus. */
'no_unneeded_curly_braces' => true,
/* Supprime les parenthèses superflus. */
'no_unneeded_control_parentheses' => true,
/* Une class final ne doit pas avoir de méthodes finales. */
'no_unneeded_final_method' => true,
/* Supprimez les virgules de fin dans les listes. */
'no_trailing_comma_in_list_call' => true,
/* Supprimez les virgules de fin dans les array. */
'no_trailing_comma_in_singleline_array' => true,
/* Remplace les <?= par des <?php echo. */
'no_short_echo_tag' => true,
/* Les annotations PHPUnit doivent être un FQCN, y compris un espace de noms racine. */
'php_unit_fqcn_annotation' => true,
/* Appliquez la camelCase aux méthodes de test PHPUnit, après la configuration. */
'php_unit_method_casing' => true,
/* Aligne tus les éléments des balises phpdoc. */
'phpdoc_align' => true,
/* Indente les Docblocks au niveau du sujet documenté. */
'phpdoc_indent' => true,
/* Supprime les annotations @access de PHPDoc. */
'phpdoc_no_access' => true,
/* Ordonne les annotations PHPDoc. */
'phpdoc_order' => true,
/* Les docblocks ne doivent être utilisés que sur des éléments structurels. */
'phpdoc_to_comment' => true,
/* Supprime les lignes vides au début et fin de la PHPDoc. */
'phpdoc_trim' => true,
/* Les variables locales, dynamiques et directement référencées ne doivent pas être affectées ni directement renvoyées par une fonction ou une méthode. */
'return_assignment' => true,
/* Les versions courtes des cast seront utilisées. */
'short_scalar_cast' => true,
/* Convertis les guillemets doubles en guillemets simples pour des chaînes simples. */
'single_quote' => [ 'strings_containing_single_quote_chars' => true ],
/* Correction des espaces après un point-virgule. */
'space_after_semicolon' => true,
/* Corrige les opérateurs d’incrémentation et de décrémentation si possible. */
'standardize_increment' => true,
/* Ordonne les éléments des class. */
'ordered_class_elements' => true,
/* Ordonne les imports (use). */
'ordered_imports' => true,
/* Les opérateurs unaires doivent être placés à côté de leurs opérandes. */
'unary_operator_spaces' => true,
])
->setFinder($finder);
1 change: 1 addition & 0 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
"php-coveralls/php-coveralls": "^1.0 || ^2.0"
},
"suggest": {
"friendsofphp/php-cs-fixer": "Pour normaliser le code PHP.",
"phpdocumentor/phpdocumentor": "Pour générer une documentation en ligne de commande.",
"phpmetrics/phpmetrics": "Pour générer un rapport de l'état du code au format HTML.",
"psr/http-factory": "Pour une meilleur abstraction entre les différents projets utilisant http-message"
Expand Down
8 changes: 4 additions & 4 deletions src/App.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@

use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Soosyze\Router;
use Soosyze\Container;
use Soosyze\Components\Http\Response;
use Soosyze\Components\Http\ServerRequest;
use Soosyze\Components\Http\Stream;
use Soosyze\Components\Util\Util;
use Soosyze\Container;
use Soosyze\Router;

/**
* Coeur de l'application, il est le ciment qui unis les modules et les services.
Expand Down Expand Up @@ -146,7 +146,7 @@ public function getSettings()
* Revoie la valeur d'un paramètre du framework ou le paramètre par défaut.
*
* @param string $key
* @param mixed $default
* @param mixed $default
*
* @return mixed
*/
Expand Down Expand Up @@ -264,7 +264,7 @@ public function set($key, $srv)
* @codeCoverageIgnore Fonction testé directement avec l'objet Container.
*
* @param string $name Nom du hook à déclencher.
* @param array $args Arguments de la fonction de rappelle.
* @param array $args Arguments de la fonction de rappelle.
*
* @return mixed Résultat final des exécutions des hooks.
*/
Expand Down
5 changes: 3 additions & 2 deletions src/Autoload.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
class Autoload
{
const DS = DIRECTORY_SEPARATOR;

/**
* Tableau avec comme clés un namespace et en valeur la racine de son arborescence.
*
Expand Down Expand Up @@ -133,7 +134,7 @@ public function autoload($class)
}
}

/**
/*
* Recherche une correspondance entre le namespace fournit en librairie
* et la classe instanciée.
*/
Expand All @@ -145,7 +146,7 @@ public function autoload($class)
}
}

/**
/*
* Si le namespace n'est pas précisé en librairie, on parcoure les répertoires
* pour chercher une correspondance avec l'arborescence.
*/
Expand Down
32 changes: 15 additions & 17 deletions src/Components/Email/Email.php
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ class Email
* Ajoute un destinataire.
*
* @param string $email Email du destinataire.
* @param string $name Nom du destinataire.
* @param string $name Nom du destinataire.
*
* @return $this
*/
Expand All @@ -65,7 +65,7 @@ public function to($email, $name = '')
* Ajoute un ou plusieurs déstinataires en copie du email.
*
* @param string $email Email en copie.
* @param string $name Nom du destinataire.
* @param string $name Nom du destinataire.
*
* @return $this
*/
Expand All @@ -79,8 +79,8 @@ public function addCc($email, $name = '')
/**
* Ajoute un ou plusieurs destinataires en copie cachée du email.
*
* @param type $email Email en copie cachée.
* @param string $name Nom du destinataire.
* @param type $email Email en copie cachée.
* @param string $name Nom du destinataire.
*
* @return $this
*/
Expand All @@ -95,7 +95,7 @@ public function addBcc($email, $name = '')
* Ajoute une adresse de provenance.
*
* @param string $email Email de provenance.
* @param string $name Nom du destinataire.
* @param string $name Nom du destinataire.
*
* @return $this
*/
Expand All @@ -110,7 +110,7 @@ public function from($email, $name = '')
* Ajoute une adresse de retour.
*
* @param string $email Email de retour.
* @param string $name Nom du destinataire.
* @param string $name Nom du destinataire.
*
* @return $this
*/
Expand All @@ -130,7 +130,7 @@ public function replayTo($email, $name = '')
*/
public function subject($subj)
{
$this->subject = mb_convert_encoding($subj, "ASCII");
$this->subject = mb_convert_encoding($subj, 'ASCII');

return $this;
}
Expand All @@ -144,7 +144,7 @@ public function subject($subj)
*/
public function message($msg)
{
$this->message = mb_convert_encoding($msg, "ASCII");
$this->message = mb_convert_encoding($msg, 'ASCII');

return $this;
}
Expand Down Expand Up @@ -195,7 +195,7 @@ public function getHeaders()
* @param $name Nom du champ d'en-tête insensible à la casse.
*
* @return string Si l'en-tête est trouvé alors il est renvoyé
* toutes les valeurs de l'en-tête concaténés par une virgule, sinon une chaine vide.
* toutes les valeurs de l'en-tête concaténés par une virgule, sinon une chaine vide.
*/
public function getHeaderLine($name)
{
Expand All @@ -210,7 +210,7 @@ public function getHeaderLine($name)
* @param $name Nom du champ d'en-tête insensible à la casse.
*
* @return string[] Si l'en-tête est trouvé alors il est renvoyé
* toutes ses valeurs, sinon un tableau vide.
* toutes ses valeurs, sinon un tableau vide.
*/
public function getHeader($name)
{
Expand Down Expand Up @@ -252,7 +252,7 @@ public function parseHeaders()
* Formalise les données d'un email est de son destinataire.
*
* @param string $email Email (from, bcc, cc, replayTo...).
* @param string $name Nom du destinataire.
* @param string $name Nom du destinataire.
*
* @return string
*/
Expand All @@ -266,7 +266,7 @@ protected function parseMail($email, $name = '')
/**
* Renvoyer une instance avec la valeur fournie en remplaçant l'en-tête spécifié.
*
* @param string $name Nom du champ d'en-tête insensible à la casse.
* @param string $name Nom du champ d'en-tête insensible à la casse.
* @param string|string[] $value Valeur(s) de l'en-tête.
*
* @return $this
Expand All @@ -283,7 +283,7 @@ protected function withHeader($name, $value)
/**
* Renvoyer une instance avec la valeur fournie en ajoutant l'en-tête spécifié.
*
* @param string $name Nom du champ d'en-tête insensible à la casse.
* @param string $name Nom du champ d'en-tête insensible à la casse.
* @param string|string[] $value Valeur(s) de l'en-tête.
*
* @return $this
Expand All @@ -306,9 +306,8 @@ protected function withAddedHeader($name, $value)
*
* @param string $strEmail Email à filtrer.
*
* @return $this
*
* @throws \InvalidArgumentException Le paramètre n'est pas une adresse email valide.
* @return $this
*/
private function filtreEmail($strEmail)
{
Expand All @@ -326,9 +325,8 @@ private function filtreEmail($strEmail)
*
* @param string $name Nom d'un destinataire.
*
* @return string Chaine nettoyée.
*
* @throws \InvalidArgumentException Le paramètre n'est pas un nom de destinataire valide.
* @return string Chaine nettoyée.
*/
private function filtreName($name)
{
Expand Down
Loading

0 comments on commit 6ebfb49

Please sign in to comment.