Differences

This shows you the differences between two versions of the page.

--- development:coding_standards [2016/05/24 13:59] – crhallberg
+++ development:coding_standards [2023/03/17 10:43] (current) – demiankatz
@@ Line 3: / Line 3: @@
 ===== PHP =====
-VuFind uses the [[http://pear.php.net/manual/en/standards.php|PEAR Coding Standards]] for its PHP code. Several additional recommendations are enforced using the php-cs-fixer tool. For help with standards compliance, see the [[development:recommended_tools#style|recommended tools page]].
+VuFind® currently uses the [[https://www.php-fig.org/psr/psr-12/|PSR-12 standard]] for its PHP code; versions 8.x and earlier were developed using the similar but now outdated [[http://pear.php.net/manual/en/standards.php|PEAR Coding Standards]]. Several additional recommendations are enforced using the php-cs-fixer tool. For help with standards compliance, see the [[development:recommended_tools#style|recommended tools page]].
 ===== Javascript =====
-ESLint style enforcement in progress. Will use ESLint recommended with a few extra rules. Join in the conversation on [[https://github.com/vufind-org/vufind/pull/700|this pull request]].
+ESLint style enforcement is in effect. It uses ESLint recommended rules with a few extra rules. For more information, see [[https://github.com/vufind-org/vufind/pull/700|this pull request]].
 ===== Templates =====
-Style guide forth-coming.
+Templates are a difficult mix of conditional PHP, HTML, and inline JS. Here's a few guidelines to help write clearer templates.
+  * 2 Space Indents
+  * Long php tags - ''<?php''
+  * Use short echo tags - ''<?=$var ?>''
+  * Use if blocks instead of brackets and indent inside - ''<?php if(): ?><?php endif; ?>''
+  * Use Slots to simply buffering and conditional content, especially across templates
+  * If a loop is producing multiple buttons, links, etc. per item, consider making a subtemplate and using ''<?=$this->render() ?>''
+  * Don't call Model methods from Views, perform this logic in the Controllers
+Many of these items and more are enforced and automatically corrected with [[https://github.com/FriendsOfPHP/PHP-CS-Fixer|PHP-CS-fixer]].
 ===== CSS =====
@@ Line 36: / Line 45: @@
 ---- struct data ----
+properties.Page Owner :
 ----