This blog post demonstrates how to create a simple single-page CRUD (Create, Read, Update, Delete) API using only core PHP. The purpose of this project is to provide a clear and straightforward example for beginners who want to understand how to develop a RESTful API in PHP without using frameworks.

System Requirements

To run this project, ensure you have the following installed:

• PHP: This example uses the latest PHP features and syntax available in version 8.2.
• MariaDB: The example requires a MariaDB or MySQL instance for the database operations.
• cURL: A command-line tool for sending HTTP requests. Note that any REST client can be used to test the API endpoints.
• Composer: The composer.json file is included to provide context for PHP server requirements and dependencies, but it is optional for running this project.

Setup Instructions

1. Create the api.php file: Place the api.php file on any machine that has PHP configured.
2. Configure Database Connection: Ensure the database connection settings in the api.php file are correctly set for your database instance. This will allow the API to connect to the database and perform necessary operations.
3. Run the PHP Server: Start the PHP built-in server in the same folder as api.php to use the example REST calls as-is:

php -S localhost:8080

The Code

<?php

/*
 * CRUD API Example in core PHP.
 *
 * This script provides a basic implementation of a CRUD (Create, Read, Update, Delete) API
 * using PHP, PDO for database interactions, and JSON for data exchange. The API supports
 * creating, reading, updating, and deleting customer records in a MySQL database.
 * It also includes endpoints for setting up and tearing down the customers table, which are
 * available for illustrative purposes and convenience in this example, but should never be 
 * placed in a production environment.
 */

$host = '127.0.0.1';
$dbname = 'testing';
$username = 'username';
$password = 'password';

try {
    /* Establish database connection */
    $pdo = new PDO("mysql:host=$host;dbname=$dbname", $username, $password);
    $pdo->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
} catch (PDOException $exception) {
    die('Database connection failed: ' . $exception->getMessage());
}

/**
 * Validate user input data for creating or updating a customer.
 *
 * @param string[] $data The data to validate
 *
 * @return string[] The array of validation errors
 */
function validateInput(array $data): array
{
    $errors = [];
    if (empty($data['firstName'])) {
        $errors[] = 'First name is required';
    }
    if (empty($data['lastName'])) {
        $errors[] = 'Last name is required';
    }
    if (empty($data['email']) || !filter_var($data['email'], FILTER_VALIDATE_EMAIL)) {
        $errors[] = 'Valid email is required';
    }
    return $errors;
}

/* Retrieve HTTP method and path segments */
$method = $_SERVER['REQUEST_METHOD'];
$path = parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH);
$segments = explode('/', trim($path, '/'));

/* Determine the resource and customer ID (if any) from the URL */
$resource = $segments[1] ?? '';
$customerId = $segments[2] ?? '';

switch ($resource) {
    case 'up':
        if ($method === 'POST') {
            try {
                /* Create 'customers' table if it doesn't exist */
                $sql = 'CREATE TABLE IF NOT EXISTS customers (
                    customerId CHAR(36) DEFAULT uuid() PRIMARY KEY,
                    firstName VARCHAR(255) NOT NULL,
                    lastName VARCHAR(255) NOT NULL,
                    email VARCHAR(255) NOT NULL,
                    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
                )';
                $pdo->exec($sql);
                echo json_encode(['message' => 'Table created successfully']);
            } catch (PDOException $exception) {
                http_response_code(500);
                echo json_encode(['error' => 'Failed to create table: ' . $exception->getMessage()]);
            }
        } else {
            http_response_code(405);
            echo json_encode(['error' => 'Method not allowed']);
        }
        break;

    case 'down':
        if ($method === 'DELETE') {
            try {
                /* Drop 'customers' table if it exists */
                $sql = 'DROP TABLE IF EXISTS customers';
                $pdo->exec($sql);
                echo json_encode(['message' => 'Table dropped successfully']);
            } catch (PDOException $exception) {
                http_response_code(500);
                echo json_encode(['error' => 'Failed to drop table: ' . $exception->getMessage()]);
            }
        } else {
            http_response_code(405);
            echo json_encode(['error' => 'Method not allowed']);
        }
        break;

    case 'customers':
        switch ($method) {
            case 'GET':
                if ($customerId) {
                    /* Read one customer */
                    $stmt = $pdo->prepare('SELECT * FROM customers WHERE customerId = :customerId');
                    $stmt->execute(['customerId' => $customerId]);
                    $customer = $stmt->fetch(PDO::FETCH_ASSOC);
                    if ($customer) {
                        echo json_encode($customer);
                    } else {
                        http_response_code(404);
                        echo json_encode(['error' => 'Customer not found']);
                    }
                } else {
                    /* Read all customers */
                    $stmt = $pdo->query('SELECT * FROM customers');
                    $customers = $stmt->fetchAll(PDO::FETCH_ASSOC);
                    echo json_encode($customers);
                }
                break;

            case 'POST':
                /* Create a new customer */
                $data = json_decode(file_get_contents('php://input'), true);
                $errors = validateInput($data);
                if (empty($errors)) {
                    $stmt = $pdo->prepare('INSERT INTO customers (firstName, lastName, email) VALUES (:firstName, :lastName, :email)');
                    $stmt->execute([
                        'firstName' => $data['firstName'],
                        'lastName' => $data['lastName'],
                        'email' => $data['email']
                    ]);

                    /* Fetch the customerId of the newly created customer */
                    $stmt = $pdo->query('SELECT customerId FROM customers ORDER BY created_at DESC LIMIT 1');
                    $customerId = $stmt->fetchColumn();

                    echo json_encode(['message' => 'Customer created successfully', 'customerId' => $customerId]);
                } else {
                    http_response_code(400);
                    echo json_encode(['errors' => $errors]);
                }
                break;

            case 'PUT':
                if ($customerId) {
                    /* Update an existing customer */
                    $stmt = $pdo->prepare('SELECT COUNT(*) FROM customers WHERE customerId = :customerId');
                    $stmt->execute(['customerId' => $customerId]);
                    $customerExists = $stmt->fetchColumn();

                    if ($customerExists) {
                        $data = json_decode(file_get_contents('php://input'), true);
                        $errors = validateInput($data);
                        if (empty($errors)) {
                            $stmt = $pdo->prepare('UPDATE customers SET firstName = :firstName, lastName = :lastName, email = :email WHERE customerId = :customerId');
                            $stmt->execute([
                                'firstName' => $data['firstName'],
                                'lastName' => $data['lastName'],
                                'email' => $data['email'],
                                'customerId' => $customerId
                            ]);
                            echo json_encode(['message' => 'Customer updated successfully']);
                        } else {
                            http_response_code(400);
                            echo json_encode(['errors' => $errors]);
                        }
                    } else {
                        http_response_code(404);
                        echo json_encode(['error' => 'Customer not found']);
                    }
                } else {
                    http_response_code(400);
                    echo json_encode(['error' => 'Customer ID is required']);
                }
                break;

            case 'DELETE':
                if ($customerId) {
                    /* Delete an existing customer */
                    $stmt = $pdo->prepare('DELETE FROM customers WHERE customerId = :customerId');
                    $stmt->execute(['customerId' => $customerId]);
                    echo json_encode(['message' => 'Customer deleted successfully']);
                } else {
                    http_response_code(400);
                    echo json_encode(['error' => 'Customer ID is required']);
                }
                break;

            default:
                http_response_code(405);
                echo json_encode(['error' => 'Method not allowed']);
                break;
        }
        break;

    default:
        http_response_code(404);
        echo json_encode(['error' => 'Endpoint not found']);
        break;
}

Operation Sequence Diagram

Below is a sequence diagram that shows the flow of API requests and interactions with the database.

API Endpoints

This API provides the following endpoints:

1. Bring the Application Up

• URL: /api.php/up
• Method: POST
• Description: Initializes the application and creates the customers table in the database.

curl --request POST \
  --url http://localhost:8080/api.php/up \
  --header 'Content-Type: application/json'

Example Output:

{
  "message": "Table created successfully"
}

2. Create a New Customer

• URL: /api.php/customers
• Method: POST
• Description: Creates a new customer record.

curl --request POST \
  --url http://localhost:8080/api.php/customers \
  --header 'Content-Type: application/json' \
  --data '{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com"
}'

Example Output:

{
  "message": "Customer created successfully",
  "customerId": "2090a31b-64aa-11ef-9cca-0242ac120002"
}

3. Update an Existing Customer

• URL: /api.php/customers/{customerId}
• Method: PUT
• Description: Updates an existing customer record by ID.

curl --request PUT \
  --url http://localhost:8080/api.php/customers/2090a31b-64aa-11ef-9cca-0242ac120002 \
  --header 'Content-Type: application/json' \
  --data '{
  "firstName": "Janet",
  "lastName": "Smith",
  "email": "jane.smith@example.com"
}'

Example Output:

{
  "message": "Customer updated successfully"
}

4. Retrieve a Customer by ID

• URL: /api.php/customers/{customerId}
• Method: GET
• Description: Retrieves a customer record by ID.

curl --request GET \
  --url http://localhost:8080/api.php/customers/2090a31b-64aa-11ef-9cca-0242ac120002

Example Output:

{
  "customerId": "2090a31b-64aa-11ef-9cca-0242ac120002",
  "firstName": "Janet",
  "lastName": "Smith",
  "email": "jane.smith@example.com",
  "created_at": "2024-08-27 19:25:32"
}

5. Retrieve All Customers

• URL: /api.php/customers
• Method: GET
• Description: Retrieves all customer records.

curl --request GET \
  --url http://localhost:8080/api.php/customers/

Example Output:

[
  {
    "customerId": "2090a31b-64aa-11ef-9cca-0242ac120002",
    "firstName": "Janet",
    "lastName": "Smith",
    "email": "jane.smith@example.com",
    "created_at": "2024-08-27 19:25:32"
  },
  {
    "customerId": "9b9a1019-65c0-11ef-87f6-0242ac140002",
    "firstName": "John",
    "lastName": "Marsh",
    "email": "john.marsh@example.com",
    "created_at": "2024-08-29 04:38:59"
  }
]

6. Delete a Customer

• URL: /api.php/customers/{customerId}
• Method: DELETE
• Description: Deletes a customer record by ID.

curl --request DELETE \
  --url http://localhost:8080/api.php/customers/2090a31b-64aa-11ef-9cca-0242ac120002

Example Output:

{
  "message": "Customer deleted successfully"
}

7. Bring the Application Down

• URL: /api.php/down
• Method: DELETE
• Description: Cleans up and destroys the customers table in the database.

curl --request DELETE \
  --url http://localhost:8080/api.php/down \
  --header 'Content-Type: application/json'

Example Output:

{
  "message": "Table dropped successfully"
}

Conclusion

This example demonstrates a fundamental RESTful API using core PHP and MariaDB. It is an excellent starting point for beginners looking to understand the basics of API development without requiring a framework. You can use this code to build upon and expand your knowledge of RESTful services in PHP.

In the world of PHP development, strings are everywhere—from building dynamic HTML content to handling user input and managing database queries. But how you piece those strings together can significantly impact the performance, readability, and security of your code. While concatenating strings might seem like a basic task, choosing the right method can be the difference between efficient, maintainable code and a sluggish, hard-to-read mess. Let’s dive into the various ways to concatenate strings in PHP, explore their implications, and help you make informed decisions in your coding adventures.

1. Concatenation Operator (.)

The dot (.) operator is the workhorse of PHP string concatenation. It’s simple, intuitive, and widely used.

$str = "Hello" . " " . "World!";

Good Implications:

• Simplicity: The . operator is straightforward and easy to use.
• Ubiquity: It’s the most common method of concatenation in PHP, so it’s easily understood by most developers.

Bad Implications:

• Performance: In loops or when concatenating many strings, using . can lead to performance issues as PHP repeatedly allocates memory for the new strings.
• Readability: Concatenating multiple strings with . can reduce code readability, especially with complex expressions.

2. Concatenation Assignment Operator (.=)

When you want to append a string to an existing variable, the .= operator is your friend.

$str = "Hello";
$str .= " World!";

Good Implications:

• Efficiency: .=, which modifies the original string in place, is more efficient than repeatedly using ..
• Cleaner Code: It reduces the need for multiple variable assignments, making the code more compact.

Bad Implications:

• Performance Overhead: While more efficient than ., it can still cause performance degradation in large loops or heavy string operations.

3. Double-Quoted Strings with Variable Interpolation

PHP’s double-quoted strings allow you to insert variables directly into the string, making it a popular choice for combining strings and variables.

$name = "John";
$str = "Hello, $name!";

Good Implications:

• Readability: Variable interpolation makes your code cleaner and easier to read, especially when combining multiple variables and strings.
• Simplicity: Eliminates the need for explicit concatenation.

Bad Implications:

• Complexity in Expressions: Interpolating complex expressions can lead to confusion and potential syntax errors.
• Security Risks: Direct interpolation of user input can introduce security vulnerabilities if not properly sanitized.
• Limitations with "Deep" Variables: When dealing with "deep" variables (e.g., $parentClass->childClass->variable), simple interpolation can fail or produce unexpected results. In these cases, you should break down the expression or use concatenation with the . operator for clarity.

Example of a Deep Variable Issue:

echo "Variable: $parentClass->childClass->variable"; // This may not work as expected

Workaround:

echo "Variable: " . $parentClass->childClass->variable;

This approach ensures the variable is correctly interpreted, especially when accessing properties of nested objects.

4. Curly Brace Syntax with Variable Interpolation

For cases where variable names might collide with other text or when you want to clarify your code, curly braces {} offer a neat solution.

$name = "John";
$str = "Hello, {$name}!";

Good Implications:

• Clarity: Curly braces improve readability by clearly defining variable boundaries.
• Avoids Ambiguity: Prevents issues where variable names might conflict with adjacent text.

Bad Implications:

• Verbosity: While clear, the curly brace syntax is slightly more verbose than simple interpolation.
• Similar Risks: Shares the same risks as basic interpolation, particularly with unsanitized user input.

5. sprintf() Function

For more complex string formatting, sprintf() offers a powerful alternative, allowing you to embed variables in strings using placeholders.

$name = "John";
$str = sprintf("Hello, %s!", $name);

Good Implications:

• Flexibility: sprintf() is excellent for creating strings with complex layouts or formatting requirements.
• Control: It gives you fine-grained control over the formatting of variables, such as specifying decimal places or padding.

Bad Implications:

• Complexity: It’s more verbose and less intuitive for simple concatenations, which can make your code harder to follow.
• Performance: The formatting process adds a slight performance overhead compared to direct concatenation.

6. Array to String Conversion (implode() or join())

When dealing with arrays of strings, implode() or join() can efficiently combine them into a single string.

$parts = ["Hello", "World", "!"];
$str = implode(" ", $parts);

Good Implications:

• Efficiency: implode() is ideal for joining large numbers of strings, especially when they are already stored in an array.
• Cleaner Code: It provides a more organized way to handle multiple strings compared to repeated concatenation.

Bad Implications:

• Overkill: For simple or one-off string concatenations, using implode() might be more complex than necessary.
• Array Requirement: You need to have your strings in an array, which might not always be practical.

Conclusion

String concatenation in PHP offers multiple methods, each with its own strengths and weaknesses. Whether you’re looking for simplicity, performance, readability, or flexibility, there’s a method that fits your needs. However, understanding the implications of each approach is crucial for writing clean, efficient, and maintainable code. The next time you find yourself piecing strings together in PHP, consider the best tool for the job—and remember that sometimes, the simplest approach is the best one. And if you’re dealing with "deep" variables in classes, keep in mind the limitations of simple interpolation and adjust your approach accordingly. Happy coding!

 HTTP requests are inherently stateless, meaning each request from a client to a server is independent, with no inherent connection to previous requests. This stateless nature poses challenges when maintaining continuity and user-specific data across multiple interactions with a web application. PHP addresses this issue through session management, as depicted in the diagram. By using sessions, PHP allows for the storage of user-specific data on the server, while a session ID stored in the client’s browser cookie ties individual requests together. This approach enables PHP to maintain state across multiple requests, allowing for a consistent user experience despite the stateless nature of HTTP. The diagram illustrates how PHP handles session creation, continuity, and expiration, ensuring that user data persists across different interactions with the application.

Introduction

Procedure

Starting Up

Start by opening Microsoft Excel 2024 and selecting a Blank Workbook. This clean slate will serve as the foundation for your data import journey.

Data Tab Navigation

Direct your attention to the "Data" tab situated in the ribbon at the top of Excel. This hub is where the magic begins!

Acquiring Data

Within the "Data" tab, you will find the "Get Data" button. Click on "From Text (Legacy)" to initiate the import of your CSV file. This step is crucial as it sets the stage for proper file handling.

File Selection

Next, navigate to the location where your Unicode CSV file is stored, select it, and then confirm your selection by clicking the "Get Data" button.

Text Import Wizardry

Upon selection, Excel will display a preview of the data. It might auto-select a file origin type, but here's a critical tip: ensure you alter the "File Origin" to "Unicode (UTF-8)" for accurate Unicode character processing.

Setting the Delimiter

Ascertain that the delimiter is correctly set to "comma" or another appropriate character that segregates your CSV values, then proceed to click "Finish".

Finalizing Import

You are presented with a choice to embed the data into an Existing or New Sheet. Choose according to your data organization preferences.

 Conclusion

By following these methodical steps, you can ensure that your UTF-8 CSV files are imported into Excel 2024 without any character encoding issues, maintaining the integrity of your precious data.

This process may seem intricate at first glance, but with practice, it becomes second nature.

Please comment if you found it helpful!

Introduction

In the modern development environment, creating a robust and flexible local development setup is crucial for success as a programmer. Laravel, a popular PHP framework, has evolved over the years to adapt to these demands. In this article, we will take a closer look at an advanced Dockerfile configuration that extends Laravel 10's out-of-the-box setup to include SSL, local testing databases, Mock API servers, and a mock email server.

The Complete File

version: '3'
services:
    laravel.test:
        build:
            context: ./vendor/laravel/sail/runtimes/8.2
            dockerfile: Dockerfile
            args:
                WWWGROUP: '${WWWGROUP}'
        image: sail-8.2/app
        container_name: ${COMPOSE_PROJECT_NAME}-application
        extra_hosts:
            - 'host.docker.internal:host-gateway'
        ports:
            - '${VITE_PORT:-5173}:${VITE_PORT:-5173}'
        environment:
            WWWUSER: '${WWWUSER}'
            LARAVEL_SAIL: 1
            XDEBUG_MODE: '${SAIL_XDEBUG_MODE:-off}'
            XDEBUG_CONFIG: '${SAIL_XDEBUG_CONFIG:-client_host=host.docker.internal}'
            IGNITION_LOCAL_SITES_PATH: '${PWD}'
        volumes:
            - '.:/var/www/html'
        depends_on:
            - mariadb
            - smtp
            - mockApiServer

    mariadb:
        image: mariadb:10.6
        container_name: ${COMPOSE_PROJECT_NAME}-mariadb
        ports:
            - '${FORWARD_DB_PORT:-3306}:3306'
        environment:
            MYSQL_ROOT_PASSWORD: '${DB_PASSWORD}'
            MYSQL_ROOT_HOST: '%'
            MYSQL_DATABASE: '${DB_DATABASE}'
            MYSQL_USER: '${DB_USERNAME}'
            MYSQL_PASSWORD: '${DB_PASSWORD}'
            MYSQL_ALLOW_EMPTY_PASSWORD: 'yes'
        volumes:
            - './docker/mariadb/storage/data:/var/lib/mysql'
            - './vendor/laravel/sail/database/mysql/create-testing-database.sh:/docker-entrypoint-initdb.d/10-create-testing-database.sh'
        healthcheck:
            test: [ "CMD", "mysqladmin" ,"ping", "-p${DB_PASSWORD}" ]
            retries: 3
            timeout: 5s

    caddy:
        build:
            context: "./docker/caddy"
            dockerfile: Dockerfile
            args:
                WWWGROUP: "${WWWGROUP}"
        container_name: ${COMPOSE_PROJECT_NAME}-caddy
        restart: unless-stopped
        ports:
            - "${APP_PORT:-80}:80"
            - "${APP_SSL_PORT:-443}:443"
        environment:
            LARAVEL_SAIL: 1
            HOST_DOMAIN: laravel.test
        volumes:
            - "./docker/caddy/Caddyfile:/etc/caddy/Caddyfile"
            - ".:/srv:cache"
            - "./docker/caddy/storage/certificates:/data/caddy/certificates/local"
            - "./docker/caddy/storage/authorities:/data/caddy/pki/authorities/local"
            - "./docker/caddy/storage/data:/data:cache"
            - "./docker/caddy/storage/config:/config:cache"
        depends_on:
            - laravel.test

    smtp:
        image: mailhog/mailhog
        container_name: ${COMPOSE_PROJECT_NAME}-email
        logging:
            driver: none  # disable saving logs
        ports:
            - "1025:1025" # smtp server
            - "8025:8025" # web ui

    mockApiServer:
        # Mock API server to test against third-party services
        # without having to hit the real production server. One does need to
        # add any desired API configurations in the mockserver-initializer.json
        # file.
        container_name: ${COMPOSE_PROJECT_NAME}-mock-api-server
        image: mockserver/mockserver
        ports:
            - "1080:1080"
        environment:
            TZ: "America/New_York"
            MOCKSERVER_PROPERTY_FILE: /config/mockserver.properties
            MOCKSERVER_INITIALIZATION_JSON_PATH: /config/mockserver-initializer.json
        volumes:
            - './docker/mockApiServer:/config'
    

The Servers

System Diagram

caddy

The caddy server is an open-source web server with automatic HTTPS. It is used to provide SSL to the Laravel application and handle reverse proxying.

Configuration

laravel.test

This server is responsible for hosting the Laravel application. It handles web requests, communicates with the database and APIs, and sends notifications like email.

Configuration

• WWWGROUP: This variable defines the group ID for the web server process. If unset, the default group ID from the host system is used.
• WWWUSER: This variable defines the user ID for the web server process. If it is not set, the default user ID from the host system is used. These variables are optional and can remain unset, allowing the system to use default values.
• Ports: Maps the application's internal port to an external port on the host system.
• Environment: Contains environment-specific settings like XDEBUG and IGNITION.
• Volumes: Mounts the application code into the container's file system.

mariadb

This server provides the MariaDB database system, a popular and robust open-source SQL database management system, essential for storing and managing data in your Laravel application.

Configuration

smtp

The SMTP server, implemented here using Mailhog, allows for the sending of test email messages. This aids in developing and testing email functionalities within the Laravel application without the risk of accidentally sending test messages outside the local environment to real people.

Configuration

mockApiServer

The Mock API server allows for mimicking interactions with third-party applications, without the need to interact with real production servers. It helps in testing and developing features that rely on external APIs.

Configuration

• Ports: Maps the internal port to allow interactions from the host system.
• Environment: Sets up specific properties like time zones and paths to configurations. For example, mockserver-initializer.json is where you configure mock responses that would normally go to third-party production REST APIs.

COMPOSE_PROJECT_NAME

The variable 'COMPOSE_PROJECT_NAME' is used to customize the naming of Docker containers, networks, and volumes, providing a way to make the Docker compose file more portable and reusable. It affects the prefixes and network name, helping to avoid conflicts and facilitate organization.

The .env File

Located in the same folder as the docker-compose file, the .env file is a powerful way to manage environment-specific settings.

COMPOSE_PROJECT_NAME=my_project

DB_CONNECTION=mysql
DB_HOST=mariadb
DB_PORT=3306
DB_DATABASE=laravel
DB_USERNAME=sail
DB_PASSWORD=password
...

Conclusion

This generic Docker compose file for Laravel 10 projects not only provides a seamless local development environment but also makes it easily adaptable across various projects. By encapsulating complex setups like SSL, test databases, Mock API servers, and email handling, it offers a robust platform that can be tailored to specific needs without unnecessary complexity. Future articles may delve into each server's functionality, providing readers with even more insights into this powerful configuration.

Please let me know in the comments section to tell me about your experiences with using Laravel in Docker. What kinds of challenges have you faced? What problems and solutions have you found? Are there other Docker containers that might be useful for other developers to consider (like Redis)? Would you like additional articles focused on individual servers?