Format code with PSR

[EarthlingDavey]

As @wilson1000-MoJ suggested in this review. https://github.com/ministryofjustice/justice-gov-uk/pull/77#discussion_r1512622834

It's important to use a standard for code readability, and minimise that chance of merge conflicts.

Let's revisit.

[EarthlingDavey]

@EmilyHazlehurst has raised an important point about using PHPDoc comments to describe functions. https://github.com/ministryofjustice/justice-gov-uk/pull/91#discussion_r1524881714

e.g.

/**
* Prevent all single posts, of any post type, from using the document(s) slug.
*
* @param bool $bad_slug Whether the slug is bad or not
* @param string $slug The document slug
* @return bool The sum of the two numbers.
*/

https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/

+1 from me. Let's have a team discussion.

[EarthlingDavey]

Adding to this, we could potentially:

• php format on save.
• pre commit hook to run phpcs and/or unit tests etc.
• CI build for generating browsable docs. WP use phpDocumentor, I've had a trial and it looks really nice!

[EarthlingDavey]

Further research PSR-4.

Implementation would mean adding autoloader section of composer.json. This will require build-fpm-composer has access to php source code in the Dockerfile.

Resources:

• https://gitlab.com/rawkode/php-examples/-/blob/main/docker-and-kubernetes/pingcrm/composer.json?ref_type=heads#L42
• https://www.youtube.com/live/z_LWJPLhD6g?t=4475
• https://getcomposer.org/doc/04-schema.md#autoload
• https://www.php-fig.org/psr/psr-4/
• https://dlxplugins.com/tutorials/creating-a-psr-4-autoloading-wordpress-plugin/
• https://medium.com/write-better-wordpress-code/psr-4-autoloading-in-plugins-and-themes-720f459f4df4
• https://www.mrkwp.com/guide/convert-shortcode-to-block-wordpress/using-composer-and-psr-4/