Coding Guidelines

• Coding Guidelines
  • Coding Standard
    • PSR-2
  • Entities and Collections
    • Entity
      • Entity Naming convention
    • Collection
      • Collection Naming convention
  • Middleware

Coding Standard

DotKernel 3 follows the rules described in the PHP-FIG PSR-2 document.

PSR-2

Entities and Collections

Entity

The entity is the representation of an object.

The following are entities

• a post
• a document
• a user relation

Entity Naming convention

Classes that represent entities are following the following structure:

• Must start with the entity name
• Must end with the word Entity
• Must contain no other words unless they define a relation

Examples of named entities

• PostEntity - represents a blog post
• DocumentEntity - represents a document
• DocuentUserEntity - represents a document with a user relation

Note: our recommendation is to name the class attributes (object properties) the same as the column names in persistent storage (database)

Collection

The collection is the representation of a list of objects. Programatically speaking: a collection is an iterable set of entities.

The following are collections

• a list of posts
• a list of documents
• a list of users in relation to the document

Collection Naming convention

Classes that represent entities are following the following structure:

• Must start with the entity name,
• Must end with the word Collection

Examples of named collections

• PostCollection - represents a blog post list
• DocumentCollection - represents a document list
• DocumentUserCollection - represents a list of users

Middleware

Middleware simply calls the code

The “Resources” or the “Middleware” should contain only base operation. For instance, queries like SELECT- FROM (...) won’t be written directly in the middleware Code like $db->select()->from() will also be avoided when writing the middleware.

In PSR-7 applications Interfaces will be highly used. These interfaces only contain the basic / common behaviour.

• POST
• GET
• PUT
• PATCH
• DELETE

Your services/modules will have interfaces to make them compatible with any PSR-7 Middleware application-stack.