The OG thread. Get printable PDF versions here.
39
Functional code can both clean things up and make them impossible to understand. Refactor common loops into functional calls, but don't write stupidly complex reduce()s just to avoid writing a loop. There's a use case for both.
38
Above I said that moving business logic to action/service classes is good. But context matters
Here's code design advice from a popular "Laravel best practices" repo. There's absolutely no reason to put a 3-line check into a class. That's just overengineered
37
Don't turn all arrays into collections just because Laravel offers them, but DO turn arrays into collections when you can make use of collection syntax to clean up your code.
36
Many people will disagree with this, because they do it. But it makes no sense.
There's no point in using docblocks when they don't give any extra information. If the typehint is enough, don't add a docblock.
That's just noise.
35
If you validate some resource's attributes on multiple places, you definitely want to centralize these validation rules, so that you don't change them in one place but forget about the other places.
34
You can make your Blade templates more expressive by creating custom directives. For example, rather than checking if the user has the admin role, you could use @admin.
33
ALWAYS use strict comparison (=== and !==). If needed, cast things go the correct type before comparing. Better than weird == results
Also consider enabling strict types in your code. This will prevent passing variables of wrong data types to functions
32
Sometimes you may want to execute DB queries in blade. There are some ok use cases for this, such as in layout files.
But if it's a view returned by a controller, pass the data in the view data instead.
31
This is largely a matter of personal preference, but calling a global function instead of having to import a class and statically call a method feels nicer to me.
Bonus points for session('key') syntax.
30
PHP has many great operators that can replace ugly if checks. Memorize them.
29
Install extensions, write annotations, use typehints. Your IDE will help you with getting your code working correctly, which lets you spend more energy on writing code that's also readable.
28
If you have a complex route action, consider moving it to a separate controller.
For OrderController::create, you'd create CreateOrderController.
Another solution is to move that logic to an action class β do what works best in your case.
27
Instead of writing controller actions like PostController@index, use the callable array syntax [PostController::class, 'index'].
You will be able to navigate to the class by clicking PostController.
26
You can store things like "results per page" in config files. Don't add them to the app config file though. Create your own. In my e-commerce project, I use config/shop.php.
25
If you want to retrieve some data from a model, create an accessor.
Keep methods for things that change the model in some way.
24
Rather than writing complex where() clauses, create query scopes with expressive names.
This will make your e.g. controllers have to know less about the database structure and your code will be cleaner.
23
Sometimes you may have multiple classes with the same name. Rather than importing them with an alias, import the namespaces.
22
Similar to single-use traits.
This tactic is great when you have a very long template and you want to make it more manageable.
There's nothing wrong with @including headers and footers in layouts, or things like complex forms in page views.
21
Adding methods to classes where they belong is cleaner than creating action classes for everything, but it can make the classes grow big
Consider using traits. They're meant primarily for code reuse, but there's nothing wrong with single-use traits
20
Rather than thinking "what can this object do", think about "what can be done with this object". Exceptions apply, such as with action classes, but this is a good rule of thumb.
19
Creating custom collections can be a great way to achieve more expressive syntax. Consider this example with order totals.
18
Don't think that long variable/method names are wrong. They're not. They're expressive.
Better to call a longer method than a short one and check the docblock to understand what it does
Same with variables. Don't use nonsense 3-letters abbreviations
17
You can also create objects with fluent APIs. Gradually add data by with separate calls, and only require the absolute minimum in the constructor.
Each method will return $this, so you can stop at any call.
16
Rather than passing a huge amount of arguments in a specific order, consider creating an object with properties to store this data.
Bonus points if you can find that some behavior can be moved into to this object.
15
This ties the previous tweet with the other tips here. OOP exists to make your code more readable, use it. Don't just write 400 line long procedural code in controller actions.
Here's code from my first Laravel project π¬
14
Know the difference between static/instance methods & variables and private/protected/public visibility. Also learn how Laravel uses magic methods.
You don't need this as a beginner, but as your code grows, it's crucial.
13
If you repeat some code a lot, consider if extracting it to a helper function would make the code cleaner.
12
Sometimes people put helpers into a class.
Beware, it can get messy. This is a class with only static methods used as helper functions. It's usually better to put these methods into classes with related logic or just keep them as global functions.
11
If some method is too long or complex, and it's hard to understand what exactly is happening, split the logic into multiple methods.
10
They're a great place to hide complex validation logic.
But beware of exactly that β hiding things. When your validation logic is simple, there's nothing wrong with doing it in the controller. Moving it to a form request makes it less explicit
9
Consider offloading some logic from controllers to events. For example, when creating models.
The benefit is that creating these models will work the same everywhere (controllers, jobs, ...) and the controller has one less worry about the details of the DB schema
8
Your controllers should be simple. They should say things like "create invoice for order". They shouldn't be concerned with the details of how your database is structured.
Leave that to the model.
7
Let's expand on the previous example. Sometimes, creating a class for a single action can clean things up.
Models should encapsulate the business logic related to them, but they shouldn't be too big.
6
5
The opposite of the previous tip. Sometimes the value comes from a complex call and as such, creating a variable improves readability & removes the need for a comment.
Remember that context matters & your end goal is readability
4
Opening an array with [ and indenting the values tends to work well. Same with long function parameter values.
Other good places to split lines are chained calls and closures.
3
The code will be cleaner & more readable and you will see understandable exceptions if something goes wrong. No half-passing edge cases.
2
Too much nesting & else statements tend to make code harder to read.
1
Using some "macro" philosophy for structuring your code, like hexagonal architecture or DDD won't save you.
A clean codebase is the result of constant good decisions at the micro level.
We're writing a book, you can get it for free here. We're writing a book! Join the early access to get it for free.