README

A lightweight PHP library that provides HTTP status codes as class constants with utility methods for reverse lookup operations. Perfect for building consistent and type-safe web applications and APIs.

Features

✨ HTTP Status Code Constants: All common HTTP status codes available as class constants 🔍 Reverse Lookup: Static method to get status name from numeric code 🎯 Zero Dependencies: Lightweight package with no external dependencies 🚀 PSR-4 Autoloading: Follows PHP standards for easy integration 📝 IDE Friendly: Full IntelliSense support with class constants ⚡ PHP 7.4+ Compatible with modern PHP versions

Installation

Install via Composer:

composer require uthayakumar-dinesh/statusify

Usage

Basic Usage

<?php

use UthayakumarDinesh\Statusify\Statusify;

// Using class constants
echo Statusify::OK; // 200
echo Statusify::NOT_FOUND; // 404
echo Statusify::INTERNAL_SERVER_ERROR; // 500

// Reverse lookup - get status name from code
echo Statusify::getStatusName(200); // "OK"
echo Statusify::getStatusName(404); // "NOT_FOUND"
echo Statusify::getStatusName(500); // "INTERNAL_SERVER_ERROR"
echo Statusify::getStatusName(999); // "UNKNOWN_STATUS"

Laravel Example

<?php

namespace App\Http\Controllers;

use Illuminate\Http\JsonResponse;
use UthayakumarDinesh\Statusify\Statusify;

class UserController extends Controller
{
    public function show($id): JsonResponse
    {
        $user = User::find($id);

        if (!$user) {
            return response()->json([
                'error' => 'User not found',
                'status_code' => Statusify::NOT_FOUND,
                'status_name' => Statusify::getStatusName(Statusify::NOT_FOUND)
            ], Statusify::NOT_FOUND);
        }

        return response()->json($user, Statusify::OK);
    }

    public function store(Request $request): JsonResponse
    {
        $user = User::create($request->validated());

        return response()->json([
            'data' => $user,
            'status_code' => Statusify::CREATED,
            'status_name' => Statusify::getStatusName(Statusify::CREATED)
        ], Statusify::CREATED);
    }
}

Symfony Example

<?php

namespace App\Controller;

use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\Routing\Annotation\Route;
use UthayakumarDinesh\Statusify\Statusify;

class ApiController
{
    #[Route('/api/users/{id}', methods: ['GET'])]
    public function getUser(int $id): JsonResponse
    {
        $user = $this->userRepository->find($id);

        if (!$user) {
            return new JsonResponse([
                'error' => 'User not found',
                'status_code' => Statusify::NOT_FOUND,
                'status_name' => Statusify::getStatusName(Statusify::NOT_FOUND)
            ], Statusify::NOT_FOUND);
        }

        return new JsonResponse($user, Statusify::OK);
    }
}

API Response Helper Class

<?php

namespace App\Helpers;

use UthayakumarDinesh\Statusify\Statusify;

class ApiResponse
{
    public static function success($data = null, int $statusCode = null): array
    {
        $statusCode = $statusCode ?? Statusify::OK;

        return [
            'success' => true,
            'status_code' => $statusCode,
            'status_name' => Statusify::getStatusName($statusCode),
            'data' => $data
        ];
    }

    public static function error(string $message, int $statusCode = null): array
    {
        $statusCode = $statusCode ?? Statusify::INTERNAL_SERVER_ERROR;

        return [
            'success' => false,
            'status_code' => $statusCode,
            'status_name' => Statusify::getStatusName($statusCode),
            'error' => $message
        ];
    }
}

// Usage
return ApiResponse::success($users, Statusify::OK);
return ApiResponse::error('Validation failed', Statusify::BAD_REQUEST);

Custom Exception Handler

<?php

namespace App\Exceptions;

use UthayakumarDinesh\Statusify\Statusify;
use Exception;

class ApiException extends Exception
{
    private int $statusCode;

    public function __construct(string $message, int $statusCode = null)
    {
        $this->statusCode = $statusCode ?? Statusify::INTERNAL_SERVER_ERROR;
        parent::__construct($message);
    }

    public function getStatusCode(): int
    {
        return $this->statusCode;
    }

    public function getStatusName(): string
    {
        return Statusify::getStatusName($this->statusCode);
    }

    public function toArray(): array
    {
        return [
            'error' => $this->getMessage(),
            'status_code' => $this->getStatusCode(),
            'status_name' => $this->getStatusName()
        ];
    }
}

// Usage
throw new ApiException('User not found', Statusify::NOT_FOUND);
throw new ApiException('Invalid request data', Statusify::BAD_REQUEST);

API Reference

Class Constants

The Statusify class provides HTTP status codes as public constants:

class Statusify
{
    // 1xx Informational
    public const CONTINUE = 100;
    public const SWITCHING_PROTOCOLS = 101;

    // 2xx Success
    public const OK = 200;
    public const CREATED = 201;
    // ... and more
}

Static Methods

getStatusName(int $code): string

Returns the constant name for a given HTTP status code.

Parameters:

• $code (int): The numeric HTTP status code

Returns:

• string: The constant name corresponding to the status code, or "UNKNOWN_STATUS" if not found

Example:

<?php
require 'vendor/autoload.php'; // Make sure your autoloader is set correctly!

use UthayakumarDinesh\Statusify\Statusify;

// Test with a known status code
$code = 200;
echo "Code: $code\n";
echo "Name: " . Statusify::getStatusName($code) . "\n";

// Test with an unknown status code
$unknownCode = 999;
echo "Code: $unknownCode\n";
echo "Name: " . Statusify::getStatusName($unknownCode) . "\n";

Available HTTP Status Codes

1xx Informational

2xx Success

3xx Redirection

4xx Client Errors

5xx Server Errors

Requirements

• PHP 7.4 or higher
• Composer for installation

Framework Compatibility

This package works seamlessly with:

• ✅ Laravel (5.5+)
• ✅ Symfony (4.0+)
• ✅ CodeIgniter (4.0+)
• ✅ CakePHP (4.0+)
• ✅ Slim Framework (4.0+)
• ✅ Laminas (formerly Zend)
• ✅ Pure PHP projects

Testing

# Run tests
composer test

# Run tests with coverage
composer test-coverage

# Run PHP CS Fixer
composer cs-fix

# Run PHPStan
composer phpstan

Contributing

We welcome contributions! Please follow these steps:

1. Fork the repository

   git clone git@github.com:Dineshs737/statusify-php.git

2. Install dependencies

   cd statusify-php
   composer install

3. Create a feature branch

   git checkout -b feature/your-feature-name

4. Make your changes

   • Follow PSR-12 coding standards
   • Add tests for any new functionality
   • Ensure all tests pass: composer test

5. Commit your changes

   git commit -m "feat: add your feature description"

6. Push to your fork and create a Pull Request

Development Setup

# Clone the repository
git clone git@github.com:Dineshs737/statusify-php.git
cd statusify-php

# Install dependencies
composer install

# Run tests
composer test

# Check code style
composer cs-check

# Fix code style
composer cs-fix

# Run static analysis
composer phpstan

Code Standards

• Follow PSR-12 coding standards
• Use meaningful variable and method names
• Add PHPDoc blocks for all public methods
• Write tests for new functionality
• Maintain backward compatibility

Issues and Support

• 🐛 Bug Reports: GitHub Issues
• 💡 Feature Requests: GitHub Issues

Security

If you discover any security-related issues, please email dinesh77saarck@gmail.com instead of using the issue tracker.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Repository

• GitHub: https://github.com/uthayakumar-dinesh/statusify-php
• Packagist: uthayakumar-dinesh/statusify

Made with ❤️ by Uthayakumar Dinesh