PSR-12 is a coding style guideline defined by the PHP-FIG (PHP Framework Interoperability Group). It builds on PSR-1 (Basic Coding Standard) and PSR-2 (Coding Style Guide), extending them to include modern practices and requirements.
PSR-12 aims to establish a consistent and readable code style for PHP projects, facilitating collaboration between developers and maintaining a uniform codebase.
namespace declaration.use statements should follow the namespace declaration.namespace App\Controller;
use App\Service\MyService;
use Psr\Log\LoggerInterface;{ for a class or method must be placed on the next line.public, protected, private) is mandatory for all methods and properties.class MyClass
{
private string $property;
public function myMethod(): void
{
// code
}
}public function myFunction(
int $param1,
string $param2
): string {
return 'example';
}{ must be on the same line as the control structure.if ($condition) {
// code
} elseif ($otherCondition) {
// code
} else {
// code
}[]) for arrays.$array = [
'first' => 'value1',
'second' => 'value2',
];?.public function getValue(?int $id): ?string
{
return $id !== null ? (string) $id : null;
}<?php tag and must not include a closing ?> tag.PSR-12 extends PSR-2 by:
PSR-12 is the standard for modern and consistent PHP code. It improves code quality and simplifies collaboration, especially in team environments. Tools like PHP_CodeSniffer or PHP-CS-Fixer can help ensure adherence to PSR-12 effortlessly.
PSR-3 is a PHP-FIG (PHP Framework Interoperability Group) recommendation that establishes a standardized interface for logging libraries in PHP applications. This interface defines methods and rules that allow developers to work with logs consistently across different frameworks and libraries, making it easier to replace or change logging libraries within a project without changing the codebase that calls the logger.
Standardized Logger Interface: PSR-3 defines a Psr\Log\LoggerInterface with a set of methods corresponding to different log levels, such as emergency(), alert(), critical(), error(), warning(), notice(), info(), and debug().
Log Levels: The standard specifies eight log levels (emergency, alert, critical, error, warning, notice, info, and debug), which follow an escalating level of severity. These are based on the widely used RFC 5424 Syslog protocol, ensuring compatibility with many logging systems.
Message Interpolation: PSR-3 includes a basic formatting mechanism known as message interpolation, where placeholders (like {placeholder}) within log messages are replaced with actual values. For instance:$logger->error("User {username} not found", ['username' => 'johndoe']);
This allows for consistent, readable logs without requiring complex string manipulation.
Flexible Implementation: Any logging library that implements LoggerInterface can be used in PSR-3 compatible code, such as Monolog, which is widely used in the PHP ecosystem.
Error Handling: PSR-3 also allows the log() method to be used to log at any severity level dynamically, by passing the severity level as a parameter.
Here’s a basic example of how a PSR-3 compliant logger might be used:
use Psr\Log\LoggerInterface;
class UserService
{
private $logger;
public function __construct(LoggerInterface $logger)
{
$this->logger = $logger;
}
public function findUser($username)
{
$this->logger->info("Searching for user {username}", ['username' => $username]);
// ...
}
}
For more details, you can check the official PHP-FIG documentation for PSR-3.
PSR-1 is a PHP Standards Recommendation created by the PHP-FIG (Framework Interop Group) that defines basic coding standards for PHP code style and structure to ensure interoperability between different PHP projects and frameworks. Its main purpose is to establish a consistent baseline for PHP code, making it easier to understand and collaborate on projects across the PHP ecosystem. PSR-1, also known as the Basic Coding Standard, includes several key guidelines:
File Formatting:
<?php or <?= tags.Namespace and Class Names:
StudlyCaps (PascalCase).Constants, Properties, and Method Naming:
CONST_VALUE).camelCase.Autoloading:
include or require statements.PSR-1 is considered a foundational standard, and it works in tandem with PSR-2 and PSR-12, which define more detailed code formatting guidelines. Together, these standards help improve code readability and consistency across PHP projects.
PHP Mess Detector (PHPMD) is a static analysis tool for PHP that helps detect potential problems in your code. It identifies a wide range of code issues, including:
PHPMD is configurable, allowing you to define custom rules or use predefined rule sets like "unused code" or "naming conventions." It works similarly to PHP_CodeSniffer, but while CodeSniffer focuses more on style and formatting issues, PHPMD is more focused on the logic and structure of the code.
In summary, PHPMD helps ensure code quality and maintainability by pointing out potential "messes" that might otherwise go unnoticed.
An Entity is a central concept in software development, particularly in Domain-Driven Design (DDD). It refers to an object or data record that has a unique identity and whose state can change over time. The identity of an entity remains constant, regardless of how its attributes change.
Unique Identity: Every entity has a unique identifier (e.g., an ID) that distinguishes it from other entities. This identity is the primary distinguishing feature and remains the same throughout the entity’s lifecycle.
Mutable State: Unlike a value object, an entity’s state can change. For example, a customer’s properties (like name or address) may change, but the customer remains the same through its unique identity.
Business Logic: Entities often encapsulate business logic that relates to their behavior and state within the domain.
Consider a Customer entity in an e-commerce system. This entity could have the following attributes:
If the customer’s name or address changes, the entity is still the same customer because of its unique ID. This is the key difference from a Value Object, which does not have a persistent identity.
Entities are often represented as database tables, where the unique identity is stored as a primary key. In an object-oriented programming model, entities are typically represented by a class or object that manages the entity's logic and state.
Exakat is a static analysis tool for PHP designed to improve code quality and ensure best practices in PHP projects. Like Psalm, it focuses on analyzing PHP code, but it offers unique features and analyses to help developers identify issues and make their applications more efficient and secure.
Here are some of Exakat’s main features:
Exakat can be used as a standalone tool or integrated into a Continuous Integration (CI) pipeline to ensure code is continuously checked for quality and security. It's a versatile tool for PHP developers who want to maintain high standards for their code.
A Null Pointer Exception (NPE) is a runtime error that occurs when a program tries to access a reference that doesn’t hold a valid value, meaning it's set to "null". In programming languages like Java, C#, or C++, "null" indicates that the reference doesn't point to an actual object.
Here are common scenarios where a Null Pointer Exception can occur:
1. Calling a method on a null reference object:
String s = null;
s.length(); // This will throw a Null Pointer Exception2. Accessing a field of a null object:
Person p = null;
p.name = "John"; // NPE because p is set to null3. Accessing an array element that is null:
String[] arr = new String[5];
arr[0].length(); // arr[0] is null, causing an NPE4. Manually assigning null to an object:
Object obj = null;
obj.toString(); // NPE because obj is null
To avoid a Null Pointer Exception, developers should ensure that a reference is not null before accessing it. Modern programming languages also provide mechanisms like Optionals (e.g., in Java) or Nullable types (e.g., in C#) to handle such cases more safely.
Event-driven Programming is a programming paradigm where the flow of the program is determined by events. These events can be external, such as user inputs or sensor outputs, or internal, such as changes in the state of a program. The primary goal of event-driven programming is to develop applications that can dynamically respond to various actions or events without explicitly dictating the control flow through the code.
In event-driven programming, there are several core concepts that help understand how it works:
Events: An event is any significant occurrence or change in the system that requires a response from the program. Examples include mouse clicks, keyboard inputs, network requests, timer expirations, or system state changes.
Event Handlers: An event handler is a function or method that responds to a specific event. When an event occurs, the corresponding event handler is invoked to execute the necessary action.
Event Loop: The event loop is a central component in event-driven systems that continuously waits for events to occur and then calls the appropriate event handlers.
Callbacks: Callbacks are functions that are executed in response to an event. They are often passed as arguments to other functions, which then execute the callback function when an event occurs.
Asynchronicity: Asynchronous programming is often a key feature of event-driven applications. It allows the system to respond to events while other processes continue to run in the background, leading to better responsiveness.
Event-driven programming is widely used across various areas of software development, from desktop applications to web applications and mobile apps. Here are some examples:
In GUI development, programs are designed to respond to user inputs like mouse clicks, keyboard inputs, or window movements. These events are generated by the user interface and need to be handled by the program.
Example in JavaScript (Web Application):
<!-- HTML Button -->
<button id="myButton">Click Me!</button>
<script>
// JavaScript Event Handler
document.getElementById("myButton").addEventListener("click", function() {
alert("Button was clicked!");
});
</script>In this example, a button is defined on an HTML page. An event listener is added in JavaScript to respond to the click event. When the button is clicked, the corresponding function is executed, displaying an alert message.
In network programming, an application responds to incoming network events such as HTTP requests or WebSocket messages.
Example in Python (with Flask):
from flask import Flask
app = Flask(__name__)
# Event Handler for HTTP GET Request
@app.route('/')
def hello():
return "Hello, World!"
if __name__ == '__main__':
app.run()Here, the web server responds to an incoming HTTP GET request at the root URL (/) and returns the message "Hello, World!".
In real-time applications, commonly found in games or real-time data processing systems, the program must continuously respond to user actions or sensor events.
Example in JavaScript (with Node.js):
const http = require('http');
// Create an HTTP server
const server = http.createServer((req, res) => {
if (req.url === '/') {
res.write('Hello, World!');
res.end();
}
});
// Event Listener for incoming requests
server.listen(3000, () => {
console.log('Server listening on port 3000');
});In this Node.js example, a simple HTTP server is created that responds to incoming requests. The server waits for requests and responds accordingly when a request is made to the root URL (/).
Responsiveness: Programs can dynamically react to user inputs or system events, leading to a better user experience.
Modularity: Event-driven programs are often modular, allowing event handlers to be developed and tested independently.
Asynchronicity: Asynchronous event handling enables programs to respond efficiently to events without blocking operations.
Scalability: Event-driven architectures are often more scalable as they can respond efficiently to various events.
Complexity of Control Flow: Since the program flow is dictated by events, it can be challenging to understand and debug the program's execution path.
Race Conditions: Handling multiple events concurrently can lead to race conditions if not properly synchronized.
Memory Management: Improper handling of event handlers can lead to memory leaks, especially if event listeners are not removed correctly.
Call Stack Management: In languages with limited call stacks (such as JavaScript), handling deeply nested callbacks can lead to stack overflow errors.
Event-driven programming is used in many programming languages. Here are some examples of how various languages support this paradigm:
JavaScript is well-known for its support of event-driven programming, especially in web development, where it is frequently used to implement event listeners for user interactions.
Example:
document.getElementById("myButton").addEventListener("click", () => {
console.log("Button clicked!");
});Python supports event-driven programming through libraries such as asyncio, which allows the implementation of asynchronous event-handling mechanisms.
Example with asyncio:
import asyncio
async def say_hello():
print("Hello, World!")
# Initialize Event Loop
loop = asyncio.get_event_loop()
loop.run_until_complete(say_hello())In C#, event-driven programming is commonly used in GUI development with Windows Forms or WPF.
Example:
using System;
using System.Windows.Forms;
public class MyForm : Form
{
private Button myButton;
public MyForm()
{
myButton = new Button();
myButton.Text = "Click Me!";
myButton.Click += new EventHandler(MyButton_Click);
Controls.Add(myButton);
}
private void MyButton_Click(object sender, EventArgs e)
{
MessageBox.Show("Button clicked!");
}
[STAThread]
public static void Main()
{
Application.Run(new MyForm());
}
}Several frameworks and libraries facilitate the development of event-driven applications. Some of these include:
Node.js: A server-side JavaScript platform that supports event-driven programming for network and file system applications.
React.js: A JavaScript library for building user interfaces, using event-driven programming to manage user interactions.
Vue.js: A progressive JavaScript framework for building user interfaces that supports reactive data bindings and an event-driven model.
Flask: A lightweight Python framework used for event-driven web applications.
RxJava: A library for event-driven programming in Java that supports reactive programming.
Event-driven programming is a powerful paradigm that helps developers create flexible, responsive, and asynchronous applications. By enabling programs to dynamically react to events, the user experience is improved, and the development of modern software applications is simplified. It is an essential concept in modern software development, particularly in areas like web development, network programming, and GUI design.
Dependency Injection (DI) is a design pattern in software development that aims to manage and decouple dependencies between different components of a system. It is a form of Inversion of Control (IoC) where the control over the instantiation and lifecycle of objects is transferred from the application itself to an external container or framework.
The main goal of Dependency Injection is to promote loose coupling and high testability in software projects. By explicitly providing a component's dependencies from the outside, the code becomes easier to test, maintain, and extend.
There are three main types of Dependency Injection:
1. Constructor Injection: Dependencies are provided through a class constructor.
public class Car {
private Engine engine;
// Dependency is injected via the constructor
public Car(Engine engine) {
this.engine = engine;
}
}2. Setter Injection: Dependencies are provided through setter methods.
public class Car {
private Engine engine;
// Dependency is injected via a setter method
public void setEngine(Engine engine) {
this.engine = engine;
}
}3. Interface Injection: Dependencies are provided through an interface that the class implements.
public interface EngineInjector {
void injectEngine(Car car);
}
public class Car implements EngineInjector {
private Engine engine;
@Override
public void injectEngine(Car car) {
car.setEngine(new Engine());
}
}To better illustrate the concept, let's look at a concrete example in Java.
public class Car {
private Engine engine;
public Car() {
this.engine = new PetrolEngine(); // Tight coupling to PetrolEngine
}
public void start() {
engine.start();
}
}In this case, the Car class is tightly coupled to a specific implementation (PetrolEngine). If we want to change the engine, we must modify the code in the Car class.
public class Car {
private Engine engine;
// Constructor Injection
public Car(Engine engine) {
this.engine = engine;
}
public void start() {
engine.start();
}
}
public interface Engine {
void start();
}
public class PetrolEngine implements Engine {
@Override
public void start() {
System.out.println("Petrol Engine Started");
}
}
public class ElectricEngine implements Engine {
@Override
public void start() {
System.out.println("Electric Engine Started");
}
}Now, we can provide the Engine dependency at runtime, allowing us to switch between different engine implementations easily:
public class Main {
public static void main(String[] args) {
Engine petrolEngine = new PetrolEngine();
Car carWithPetrolEngine = new Car(petrolEngine);
carWithPetrolEngine.start(); // Output: Petrol Engine Started
Engine electricEngine = new ElectricEngine();
Car carWithElectricEngine = new Car(electricEngine);
carWithElectricEngine.start(); // Output: Electric Engine Started
}
}Many frameworks and libraries support and simplify Dependency Injection, such as:
Dependency Injection is not limited to a specific programming language and can be implemented in many languages. Here are some examples:
public interface IEngine {
void Start();
}
public class PetrolEngine : IEngine {
public void Start() {
Console.WriteLine("Petrol Engine Started");
}
}
public class ElectricEngine : IEngine {
public void Start() {
Console.WriteLine("Electric Engine Started");
}
}
public class Car {
private IEngine _engine;
// Constructor Injection
public Car(IEngine engine) {
_engine = engine;
}
public void Start() {
_engine.Start();
}
}
// Usage
IEngine petrolEngine = new PetrolEngine();
Car carWithPetrolEngine = new Car(petrolEngine);
carWithPetrolEngine.Start(); // Output: Petrol Engine Started
IEngine electricEngine = new ElectricEngine();
Car carWithElectricEngine = new Car(electricEngine);
carWithElectricEngine.Start(); // Output: Electric Engine StartedIn Python, Dependency Injection is also possible, and it's often simpler due to the dynamic nature of the language:
class Engine:
def start(self):
raise NotImplementedError("Start method must be implemented.")
class PetrolEngine(Engine):
def start(self):
print("Petrol Engine Started")
class ElectricEngine(Engine):
def start(self):
print("Electric Engine Started")
class Car:
def __init__(self, engine: Engine):
self._engine = engine
def start(self):
self._engine.start()
# Usage
petrol_engine = PetrolEngine()
car_with_petrol_engine = Car(petrol_engine)
car_with_petrol_engine.start() # Output: Petrol Engine Started
electric_engine = ElectricEngine()
car_with_electric_engine = Car(electric_engine)
car_with_electric_engine.start() # Output: Electric Engine StartedDependency Injection is a powerful design pattern that helps developers create flexible, testable, and maintainable software. By decoupling components and delegating the control of dependencies to a DI framework or container, the code becomes easier to extend and understand. It is a central concept in modern software development and an essential tool for any developer.
In object-oriented programming (OOP), a "trait" is a reusable class that defines methods and properties which can be used in multiple other classes. Traits promote code reuse and modularity without the strict hierarchies of inheritance. They allow sharing methods and properties across different classes without those classes having to be part of an inheritance hierarchy.
Here are some key features and benefits of traits:
Reusability: Traits enable code reuse across multiple classes, making the codebase cleaner and more maintainable.
Multiple Usage: A class can use multiple traits, thereby adopting methods and properties from various traits.
Conflict Resolution: When multiple traits provide methods with the same name, the class using these traits must explicitly specify which method to use, helping to avoid conflicts and maintain clear structure.
Independence from Inheritance Hierarchy: Unlike multiple inheritance, which can be complex and problematic in many programming languages, traits offer a more flexible and safer way to share code.
Here’s a simple example in PHP, a language that supports traits:
trait Logger {
public function log($message) {
echo $message;
}
}
trait Validator {
public function validate($value) {
// Validation logic
return true;
}
}
class User {
use Logger, Validator;
private $name;
public function __construct($name) {
$this->name = $name;
}
public function display() {
$this->log("Displaying user: " . $this->name);
}
}
$user = new User("Alice");
$user->display();In this example, we define two traits, Logger and Validator, and use these traits in the User class. The User class can thus utilize the log and validate methods without having to implement these methods itself.
Vite
