https://github.com/npbtrac/wp-plugin-enpii-base
Enpii Base plugin to WordPress development, this requires ACF plugin to work
https://github.com/npbtrac/wp-plugin-enpii-base
composer-package wordpress wordpress-plugin
Last synced: 10 months ago
JSON representation
Enpii Base plugin to WordPress development, this requires ACF plugin to work
- Host: GitHub
- URL: https://github.com/npbtrac/wp-plugin-enpii-base
- Owner: npbtrac
- License: mit
- Created: 2018-07-23T04:36:47.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-11-12T23:25:56.000Z (over 1 year ago)
- Last Synced: 2024-11-14T18:55:10.595Z (over 1 year ago)
- Topics: composer-package, wordpress, wordpress-plugin
- Language: PHP
- Homepage:
- Size: 37.9 MB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
## Installation
- Commands to set up the development environment
```shell script
cp .env.example .env
docker pull composer
docker run --rm --interactive --tty --volume $PWD:/app composer composer install
docker-compose up -d
```
- Run the WP CLI command to prepare the necessary things
```
docker-compose exec wordpress wp enpii-base prepare_wp_app
```
## Explaination
- `dev-docker` is the folder for docker related stuffs
- `dev-docker/wordpress` would be the document root for the webserver default host (it's `/var/www/html` in the container)
- In the container `wordpress`
- `devuser` is the user to own the files and folder
- `nobody` is ths user of the webserver (for uploading files or create files using the web requests)
## Working with the containers
- To SSH to the wordpress containers
```
docker-compose exec --user=devuser wordpress sh
```
The local website will work with http://127.0.0.1:10108/ (or the port you put in env file)
## Development
- Remember to enable git case sensitive for files
```
git config core.ignorecase false
```
- Add `XDEBUG_MODE=off` before `composer` to turn off XDebug to speedup the composer
### Base concepts
- This plugin will create a laravel application `wp_app()` (a DI container https://code.tutsplus.com/tutorials/digging-in-to-laravels-ioc-container--cms-22167) contains everything we need.
- Each plugin or theme will act as a Service Provider https://laravel.com/docs/7.x/providers
- We are trying to implement Domain Driven Development (DDD) and Command Query Responsibility Segregation (CQRS)
- Code sample here https://github.com/mguinea/laravel-ddd-example
- More on DDD https://content-garden.com/domain-driven-design-ddd-principles-with-laravel
- More on CQRS https://tsh.io/blog/cqrs-event-sourcing-php/, https://github.com/artisansdk/cqrs
- Each handler is a class (1 class only for 1 handler). An action may contain many hanlders.
### Working with composer
- We should use `~1.0.3` when require a package (only update if bugfixing released)
- We use `mozart` (https://packagist.org/packages/coenjacobs/mozart) package to put the dependencies to a separate folder for the plugin to avoid the conflicts
- We should use `mozart` globally
- After running `composer update`, you need to run `mozart compose` (this should be run manually). If issues found related to some composer issues e.g. wrong included files, wrong path (due to the moving of files) ... you need to run `composer update` (or `composer dump-autoload`) one more time after fixing `composer.json` file.
- In case we want to upgrade laravel framework (it's a crazy thing), you need to add `"laravel/framework": "7.30.6"` to the dependencies then remove that line and `composer.lock` after running mozart then run `composer update` again.
#### Process to perform the composer and mozart:
- Remove the `autoload -> files` part in composer.json
- `XDEBUG_MODE=off composer install` or `XDEBUG_MODE=off composer update`
- `composer dump-autoload`
- `mozart compose`
- Undo the removing `autoload -> files`
- `composer dump-autoload`
Or you can do the alternative way
- `XDEBUG_MODE=off composer install --no-autoloader` or `XDEBUG_MODE=off composer update --no-autoloader`
- `mozart compose`
- `composer dump-autoload`
#### After using `mozart`, remember to manually repair the namespace in:
- `LogManager`, use namespace `as Monolog`
- `ParseLogConfiguration` (same as above)
- `Symfony\Component\Routing\Route`, find the keyword `compiler_class` and update that option value to the one with the namespace
- Replace all `app()` -> `wp_app()`, `collect()` -> `wp_app_collect()`
### Naming Convention
- Spaces, indentation are defined in `.editorconfig`
- We follow WordPress conventions https://developer.wordpress.org/coding-standards/wordpress-coding-standards/php/#naming-conventions
- Variables, functions, methods should be named in **snake_eye** rules e.g. `$current_date`, `get_latest_posts` (not `$currentDate` or `getLatestPosts`)
- Classes, Traits, Interfaces, enum names should be named with capitalized words separated by underscores e.g. `Top_Gun`, `A_Simple_Payment_Gateway` (not `TopGun` or `ASimplePaymentGateway`)
- Running **phpcs** to find coding standard issues
- With docker (we need to use php 7.4 to avoid errors)
```shell script
# Run the docker pull once if you haven't run that before
docker pull npbtrac/php:7.4-x86
# For arm
# docker pull npbtrac/php:7.4-arm
docker run --rm --interactive --tty -v $PWD:/var/www/html npbtrac/php:7.4-arm ./vendor/bin/phpcs
```
- Or if you have your executable php 7.4 on your machine (we need to use php 7.4 to avoid errors)
```shell script
/path/to/your/php7.4/executable/file ./vendor/bin/phpcs
```
- Running **phpcbf** to fix code style issues
- With docker (we need to use php 7.4 to avoid errors)
```shell script
# Run the docker pull once if you haven't run that before
docker pull serversideup/php:8.0-cli
docker run --rm --interactive --tty -v $PWD:/var/www/html serversideup/php:8.0-cli ./vendor/bin/phpcbf
```
- Or if you have your executable php 7.4 on your machine (we need to use php 7.4 to avoid errors)
```shell script
/path/to/your/php8.0/executable/file ./vendor/bin/phpcbf
```
### Testing
- To run unit test
```
composer codecept unit
```
### Install plugins and themes via the WP Admin Dashbboard
- We need to ensure needed folders are there (only run once)
```shell script
docker compose exec --user=devuser wordpress mkdir -p /var/www/html/wp-content/uploads >/dev/null 2>&1
docker compose exec --user=devuser wordpress mkdir -p /var/www/html/wp-content/upgrade >/dev/null 2>&1
docker compose exec --user=devuser wordpress mkdir -p /var/www/html/wp-content/cache >/dev/null 2>&1
docker compose exec --user=devuser wordpress chmod -R 777 /var/www/html/wp-content/cache /var/www/html/wp-content/uploads /var/www/html/wp-content/upgrade
```
- To install plugins and themes via the Admin Dashboard, you need to follow these steps:
1. Add this part to `wp-config.php` (after `That's all ... ` line)
```
define( 'FS_METHOD', 'direct' );
define( 'FS_CHMOD_DIR', (0755 & ~ umask()) );
define( 'FS_CHMOD_FILE', (0644 & ~ umask()) );
```
2. Allow the file writting folders first
For plugins:
```shell script
docker compose exec --user=devuser wordpress chmod g+w /var/www/html/wp-content/plugins/
```
For themes:
```shell script
docker compose exec --user=devuser wordpress chmod g+w /var/www/html/wp-content/themes/
```
3. Start to perform plugins, themes installation
4. Revoke the write permission
```shell script
docker compose exec --user=devuser wordpress chmod g-w /var/www/html/wp-content/plugins/
docker compose exec --user=devuser wordpress chmod g-w /var/www/html/wp-content/themes/
```
5. Remove the previous part added to `wp-config.php` (item 1)
## License
The Enpii Base plugin is open-sourced software licensed under the [MIT license](LICENSE.md).