Оглавление:
Это демонстрационный проект, демонстрирующий мои навыки объектно-ориентированного программирования с использованием PHP, написания унитарных тестов PHPUnit и использования таких инструментов, как Composer (менеджер зависимостей для PHP), Git (распределенная система контроля версий) и Unix-оболочка. Также отражает мои знания современных платформ разработки, таких как GitHub (онлайн-центр репозиториев исходного кода), Codecov (для анализа покрытия кода) и CircleCI (непрерывная интеграция и непрерывная доставка).
Этот проект ни в коем случае не был написан для использования в производстве, но может использоваться по вашему желанию под вашу полную ответственность. Вы также можете его разветвить и использовать в качестве основы для своего собственного проекта, если он окажется для вас полезным.
OoWordpressNonces — это пакет Composer для WordPress, предназначенный для работы с Nonce WordPress с использованием подхода объектно-ориентированного программирования .
Он не заменяет исходную систему WordPress Nonce, этот пакет представляет собой всего лишь оболочку исходных функций WordPress Nonce , использующую ООП- подход.
Код прост, понятен и полностью документирован. В исходном коде каждый метод класса имеет ссылку на исходную функцию WordPress, которую он обертывает. Для получения более подробной информации вы можете просмотреть официальную документацию WordPress для Nonce.
Вы можете установить OoWordpressNonces , добавив эту спецификацию репозитория пакетов в файл composer.json
вашего проекта:
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/josepcrespo/oo-wordpress-nonces"
}
],
"require": {
"josepcrespo/oo-wordpress-nonces": "master"
}
}
а затем запустите php composer.phar update
.
В этом разделе вы можете получить инструкции по настройке этого проекта на локальном компьютере для целей разработки и тестирования.
Клонируйте проект с помощью Git:
git clone https://github.com/josepcrespo/oo-wordpress-nonces.git
или загрузите ZIP-файл со всеми файлами проекта: https://github.com/josepcrespo/oo-wordpress-nonces/archive/master.zip.
Прежде чем начать установку Composer:
- PHP, установленный в вашей системе, является обязательным требованием. Если ваша среда разработки работает на macOS, я рекомендую установить ее с помощью Homebrew.
- Перед началом использования Homebrew настоятельно рекомендуется установить и обновить Xcode. Вы можете установить/обновить Xcode, используя магазин приложений macOS.
- Если вы используете macOS , вам также необходимо установить инструменты командной строки Xcode. Чтобы установить/обновить инструменты командной строки Xcode , напишите эту команду с помощью Terminal.app (после установки или обновления Xcode ):
xcode-select --install
Чтобы быстро установить Composer в текущий каталог, посетите официальную страницу загрузки Composer для получения обновленных инструкций.
Чтобы установить определенные зависимости для вашего проекта, просто запустите команду установки Composer в корневой каталог проекта, используя Terminal.app (если вы используете macOS ) или предпочитаемую вами оболочку :
php composer.phar install
Для получения более подробной информации вы можете ознакомиться с официальными рекомендациями Composer по установке зависимостей.
Если вы использовали опцию --filename
при установке Composer
- Возможно, вы установили Composer с помощью опции установщика
--filename
, например, так:php composer-setup.php --filename=composer
В этом случае вам следует запуститьcomposer install
, чтобы установить зависимости.
Юнитарные тесты этого пакета были выполнены с использованием PHPUnit.
cp phpunit.xml.dist phpunit.xml
vendor/bin/phpunit
После запуска тестов вы можете просмотреть результаты покрытия тестами, открыв файл index.html
, созданный в папкеtests tests/code-coverage-reports/html-format/
.
Если PHPUnit выдает сообщение об ошибке, в котором говорится, что он не может найти какой-либо класс, используемый в тестах.
- Используйте следующую команду Composer , а затем повторно запустите тесты.
php composer.phar dump-autoload
Вам необходимо включить PHP-расширение Xdebug.
- Функциональность покрытия кода PHPUnit настроена для этого проекта по умолчанию. Он использует компонент PHP_CodeCoverage , который, в свою очередь, использует функциональность покрытия кода, предоставляемую расширением Xdebug для PHP.
- Если вы не хотите видеть покрытие кода или не можете правильно включить расширение Xdebug, вы можете удалить полную запись
, присутствующую в файле конфигурации phpunit.xml.