README

Агуулга / Table of Contents

Монгол | 2. English | 3. Getting Started

1. Монгол тайлбар

Хөнгөн, хурдан, объект-суурьтай маршрутчиллын (routing) компонент. Динамик параметрүүд, нэртэй маршрутууд, reverse routing зэрэг бүх шаардлагатай боломжуудыг дэмждэг.

codesaur/router нь codesaur ecosystem-ийн нэг хэсэг бөгөөд хөнгөн жинтэй, фрэймворкоос үл хамааран standalone байдлаар ашиглаж болох PHP routing компонент юм.

Багц нь дараах 3 үндсэн class-аас бүрдэнэ:

Router - маршрут бүртгэх, тааруулах, URL үүсгэх үндсэн класс
RouterInterface - router хэрэгжүүлэх шаардлагуудыг тодорхойлсон интерфэйс
Callback - маршрутын callback болон параметрүүдийг хадгалах wrapper класс

Дэлгэрэнгүй мэдээлэл

📖 Бүрэн танилцуулга - Суурилуулалт, хэрэглээ, жишээнүүд
📚 API тайлбар - Бүх метод, exception-үүдийн тайлбар
🔍 Шалгалтын тайлан - Код шалгалтын тайлан

2. English description

A lightweight, fast, object-oriented routing component. Supports dynamic parameters, named routes, reverse routing, and all essential routing features.

codesaur/router is part of the codesaur ecosystem and is a lightweight PHP routing component that can be used standalone, independent of any framework.

The package consists of the following 3 core classes:

Router - main class for registering routes, matching requests, and generating URLs
RouterInterface - interface defining the requirements for router implementations
Callback - wrapper class for storing route callbacks and their parameters

Documentation

📖 Full Documentation - Installation, usage, examples
📚 API Reference - Complete API documentation
🔍 Review - Code review report

3. Getting Started

Requirements

PHP 8.2.1+
Composer

Installation

Composer ашиглан суулгана / Install via Composer:

composer require codesaur/router

Quick Example

use codesaur\Router\Router;

$router = new Router();

// Энгийн GET маршрут / Simple GET route
$router->GET('/hello', function() {
    echo 'Hello, World!';
});

// Динамик параметртэй маршрут / Route with dynamic parameters
$router->GET('/news/{int:id}', function(int $id) {
    echo "News ID: $id";
})->name('news-view');

// Маршрут тааруулах / Match route
$callback = $router->match('/news/10', 'GET');
if ($callback) {
    $callable = $callback->getCallable();
    $params = $callback->getParameters();
    \call_user_func_array($callable, $params);
}

// URL үүсгэх / Generate URL
$url = $router->generate('news-view', ['id' => 10]); // → /news/10

Running Tests

Тест ажиллуулах / Run tests:

# Бүх тестүүдийг ажиллуулах / Run all tests
composer test

# Coverage-тэй тест ажиллуулах / Run tests with coverage
composer test:coverage

Changelog

📝 CHANGELOG.md - Full version history

Contributing & Security

🤝 Contributing Guide
🔐 Security Policy

License

This project is licensed under the MIT License.

Author

Narankhuu
📧 codesaur@gmail.com
🌐 https://github.com/codesaur

🦖 codesaur ecosystem: https://codesaur.net

codesaur / router

Maintainers

Details