Skip to content

API Reference

Welcome to the Fluxor API Reference. Here you'll find detailed documentation for all core classes and methods.

Available Classes

ClassDescription
AppMain application entry point
RequestHTTP request handling
ResponseHTTP response building
FlowElegant route definitions
HttpStatusCodeHTTP status code constants
HelpersGlobal helper functions

Quick Navigation

Core Classes

  • App - Application bootstrap and configuration
  • Request - Access request data, parameters, and headers
  • Response - Build JSON, HTML, and redirect responses

Routing

  • Flow - Chainable route definitions with HTTP methods
  • HttpStatusCode - Standard HTTP status code constants

Utilities

  • Helpers - Global helper functions for common tasks (env(), base_path(), config(), etc.)

Example

php
<?php
// Basic usage with helpers
use Fluxor\App;
use Fluxor\Flow;
use Fluxor\Response;

$app = new Fluxor\App();
$app->run();

// Use helpers
$baseUrl = base_url();
$config = config('app');

// Define a route
Flow::GET()->do(function($req) {
    return Response::json(['users' => []]);
});

Next Steps

  • Browse the App documentation to learn about configuration
  • Check Flow for routing examples
  • Check Response for building responses
  • Check Helpers for global helper functions

Released under the MIT License.