Table des matières:
Il s'agit d'un projet de démonstration visant à fournir un exemple de mes compétences en programmation orientée objet utilisant PHP, en écrivant des tests unitaires PHPUnit et en profitant d'outils tels que Composer (un gestionnaire de dépendances pour PHP), Git (un système de contrôle de version distribué) et, le Coquille Unix. Cela reflète également ma connaissance des plates-formes de développement modernes telles que GitHub (un hub de référentiels de codes sources en ligne), Codecov (pour des informations sur la couverture du code) et CircleCI (intégration continue et livraison continue).
Ce projet n'a en aucun cas été écrit dans l'optique d'être utilisé en production, mais peut être utilisé à votre guise sous votre entière responsabilité. Vous pouvez également le créer et l'utiliser comme base pour votre propre projet si vous le trouvez utile.
OoWordpressNonces est un package Composer pour WordPress permettant de gérer les Nonces WordPress en utilisant une approche de programmation orientée objet .
Il ne remplace pas le système WordPress Nonces d'origine, ce package n'est qu'un wrapper, utilisant une approche POO , des fonctions WordPress Nonces d'origine.
Le code est simple, explicite et entièrement documenté. Sur la source du code, chaque méthode de classe a un lien vers la fonction WordPress d'origine qu'elle enveloppe. Pour plus de détails, vous pouvez consulter la documentation officielle WordPress pour Nonces
Vous pouvez installer OoWordpressNonces en ajoutant cette spécification de référentiel de packages au fichier composer.json
de votre projet :
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/josepcrespo/oo-wordpress-nonces"
}
],
"require": {
"josepcrespo/oo-wordpress-nonces": "master"
}
}
puis exécutez php composer.phar update
.
Dans cette section, vous pouvez obtenir les instructions pour configurer ce projet sur votre ordinateur local à des fins de développement et de test.
Clonez le projet à l'aide de Git :
git clone https://github.com/josepcrespo/oo-wordpress-nonces.git
ou téléchargez un fichier ZIP avec tous les fichiers du projet : https://github.com/josepcrespo/oo-wordpress-nonces/archive/master.zip
Avant de commencer à installer Composer :
- PHP installé sur votre système est une condition obligatoire. Si votre environnement de développement fonctionne sur macOS, je vous recommande de l'installer en utilisant Homebrew
- Avant de commencer à utiliser Homebrew, il est fortement recommandé d'installer et de mettre à jour Xcode. Vous pouvez installer/mettre à jour Xcode à l'aide du macOS App Store.
- Si vous utilisez macOS , vous devez également installer les outils de ligne de commande Xcode. Pour installer/mettre à jour les outils de ligne de commande Xcode , écrivez cette commande à l'aide de Terminal.app (après avoir installé ou mis à jour Xcode ) :
xcode-select --install
Pour installer rapidement Composer dans le répertoire actuel, veuillez vous référer à la page de téléchargement officielle de Composer pour obtenir des instructions mises à jour.
Pour installer les dépendances définies pour votre projet, exécutez simplement la commande Composer install dans le répertoire racine du projet à l'aide de Terminal.app (si vous utilisez macOS ) ou avec votre Shell préféré :
php composer.phar install
Vous souhaiterez peut-être consulter les directives officielles de Composer pour l'installation des dépendances pour plus de détails.
Si vous avez utilisé l'option --filename
lors de l'installation de Composer
- Peut-être avez-vous installé votre Composer en utilisant l'option d'installation
--filename
, par exemple de cette manière :php composer-setup.php --filename=composer
Dans ce cas, vous devez exécutercomposer install
afin d'installer les dépendances.
Les tests unitaires de ce package ont été réalisés à l'aide de PHPUnit.
cp phpunit.xml.dist phpunit.xml
vendor/bin/phpunit
Après avoir exécuté les tests, vous pouvez afficher les résultats de couverture des tests en ouvrant le fichier index.html
créé dans le dossier tests/code-coverage-reports/html-format/
.
Si PHPUnit renvoie un message d'erreur indiquant qu'il ne peut pas trouver une classe utilisée dans les tests.
- Utilisez la commande Composer suivante, puis réexécutez les tests.
php composer.phar dump-autoload
Vous devez activer l’extension PHP Xdebug.
- La fonctionnalité de couverture de code de PHPUnit est configurée par défaut pour ce projet. Il utilise le composant PHP_CodeCoverage , qui exploite à son tour la fonctionnalité de couverture de code fournie par l'extension Xdebug pour PHP.
- Si vous ne souhaitez pas voir la couverture du code ou si vous ne pouvez pas activer correctement l'extension Xdebug, vous pouvez supprimer l'entrée
complète présente dans le fichier de configuration phpunit.xml.