Beyond SOLID principles & patterns

Here you'll find OctoberCMS best practices which tend to be overlooked in real life October projects.

Follow OctoberCMS naming conventions

OctoberCMS does not follow traditional Laravel naming conventions for a number of reasons. As such, you should utilize the naming conventions accepted by the OctoberCMS community:

Follow naming conventions accepted by the OctoberCMS community:

What	How	Good	Bad
Controller	plural	Articles	ArticlesController
Model	singular	User	Users
hasOne or belongsTo relationship	singular	articleComment	articleComments, article_comment
All other relationships	plural	articleComments	articleComment, article_comments
Table name	author_plugin_ prefix, plural	acme_blog_article_comments	article_comment, articleComments
Pivot table	author_plugin_ prefix, semantically correct	acme_blog_user_articles	article_users, articles_users
Boolean columns	is_prefix	is_active	active
Migration	version folder heirarchy	1.0.1/create_articles_table	2017_01_01_000000_articles
Method	camelCase	getAll	get_all
Controller method (regular)	match partial name	index	saveArticle
Controller method (AJAX handler, specific method)	method prefix, camelCase	index_onDoSomething	indexOnDoSomething
Controller method (AJAX global handler)	on prefix, TitleCase	onAjaxRequest
Controller YAML	snake_case	config_form.yaml	configfields.yaml,fieldsconfig.yaml
Model YAML	columns/fields prefix, snake_case	columns_simple.yaml	simplecolumns.yaml, columnsposts.yaml
Controller partials	_prefix, snake_case, .htm extension	_users.htm	users.htm
Class references	qualified namespace	\Backend\Behaviors\FormController::class	'Backend.Behaviors.FormController'
Vendor naming	TitleCase	AcmeCo.SuperPlugin	acme.blog, rainLab.user

Also Follow Laravel naming conventions & PSR standards when possible.

Foundation Library

OctoberCMS is built on Laravel.

Learning OctoberCMS

The best place to learn about OctoberCMS is by reading the documentation or following some tutorials.

Contact

• Visit my site
• Check out my other repos
• Follow me on Twitter
• Find me on Slack

Coding standards

Please follow the following guides and code standards:

• Developer guidelines
• PSR 4 Coding Standards
• PSR 2 Coding Style Guide
• PSR 1 Coding Standards