API Reference
About 21 min
API Reference
This is an automatically generated documentation for API Reference.
Namespaces
Hazaar
Classes
| Class | Description |
|---|---|
| Application | The Application. |
| Config | Configuration Class. |
| Controller | Base class for Hazaar HTTP and CLI controllers. |
| Exception | Framework base exception with JSON serialization support. |
| File | File abstraction for backend-agnostic storage operations. |
| Loader | Application path resolver and autoloader coordinator. |
| Log | |
| Session | Session class. |
| View | The View class is used to render views in the Hazaar framework. |
Hazaar\Application
Classes
| Class | Description |
|---|---|
| Config | Application-aware configuration loader and cache. |
| Request | Application-level HTTP request container and helper API. |
| Route | |
| Router | Central HTTP router for application request dispatch. |
| Runtime | Runtime filesystem context manager for application-scoped writable paths. |
| Shutdown | Centralized fatal shutdown/error termination handler for the application. |
| URL | Generate a URL relative to the application. |
Hazaar\Application\Enum
Enums
| Class | Description |
|---|---|
| FilePath | Enum representing various application file path types. |
| MetricsEvent | MetricsEvent enum defines possible metric events for the application. |
Hazaar\Application\Exception
Classes
| Class | Description |
|---|---|
| AppDirNotFound | |
| BadTimezone | |
| RouterUnknown | |
| RuntimeDirNotFound | |
| RuntimeDirNotWritable | |
| RuntimeDirUncreatable | |
| ServerBusy |
Hazaar\Application\Interface
Interfaces
| Interface | Description |
|---|---|
| Request | Application Requests Initiators. |
| Route | |
| Router |
Hazaar\Application\Middleware
Classes
| Class | Description |
|---|---|
| RequestID | Middleware that adds a request identifier to the response headers. |
Hazaar\Application\Router
Classes
| Class | Description |
|---|---|
| Group | Route grouping helper that applies a shared URL prefix and cross-cutting behavior. |
| Loader | Base contract for router definition loaders. |
Hazaar\Application\Router\Exception
Classes
| Class | Description |
|---|---|
| ActionNotFound | Exception thrown when a resolved controller does not expose the requested action. |
| AppNotInitialised | Exception raised when router logic requires an application instance but none exists. |
| ControllerHasNoRoutes | Exception thrown when a controller is discovered but declares no route metadata. |
| ControllerNotFound | Exception thrown when route dispatch resolves to a controller class that cannot be loaded. |
| LoaderNotSupported | Exception thrown when the configured router loader type cannot be resolved. |
| ProtocolNotSupported | Exception thrown when routing is attempted under an unsupported transport protocol. |
| RouteFailed | Exception thrown when a matched route cannot be processed successfully. |
| RouteNotFound | Exception raised when no registered route matches the requested path. |
| RouterInitialisationFailed | Exception thrown when router bootstrap/initialization cannot complete. |
| RouterNotInitialised | Exception raised when router-dependent operations are invoked before router setup. |
Hazaar\Application\Router\Loader
Classes
| Class | Description |
|---|---|
| Advanced | |
| Annotated | Annotation/doc-comment driven route loader. |
| Attribute | PHP attribute-based route loader. |
| Basic | Basic Application Router. |
| File | File-based route loader. |
| Json | JSON Router. |
| None | None Application Router. |
Hazaar\Application\Router\Loader\Exception
Classes
| Class | Description |
|---|---|
| MissingRouteFile | Exception thrown when a configured file-based router definition file is missing. |
Hazaar\Auth
Classes
| Class | Description |
|---|---|
| Adapter | Abstract authentication adapter. |
| ExpiringToken | |
| Result | Authentication outcome value object. |
| TokenPair |
Hazaar\Auth\Adapter
Classes
| Class | Description |
|---|---|
| Basic | |
| DBITable | Database-table backed authentication adapter. |
| HTPasswd | .htpasswd file-backed authentication adapter. |
| Model |
Hazaar\Auth\Adapter\Exception
Classes
| Class | Description |
|---|---|
| HTPasswdFileMissing | Exception thrown when the configured .htpasswd file cannot be found. |
| Unauthorised | Exception representing an authentication failure requiring authorization. |
| UnknownSessionBackend | Exception thrown when a configured auth session backend/transport cannot be resolved. |
Hazaar\Auth\Enum
Enums
| Class | Description |
|---|---|
| TransportPersistence | Describes how a session transport persists tokens between requests. |
Hazaar\Auth\Exception
Classes
| Class | Description |
|---|---|
| BadQueryAuthResponse | Exception thrown when an authentication adapter returns an invalid auth payload. |
Hazaar\Auth\Interface
Interfaces
| Interface | Description |
|---|---|
| AuthenticationAdapter | |
| SessionBackend | |
| SessionTransport | Interface for session token transport (HTTP layer). |
Hazaar\Auth\Middleware
Classes
| Class | Description |
|---|---|
| Session | Authentication session middleware for protected routes. |
Hazaar\Auth\Session\Backend
Classes
| Class | Description |
|---|---|
| Cache | Cache-backed session backend for authentication state. |
| JWT | JWT-based auth session backend. |
| PHPSession | Native PHP session-backed authentication state backend. |
Hazaar\Auth\Session\Exception
Classes
| Class | Description |
|---|---|
| JWTKeyFileNotFound | Exception thrown when a configured JWT key file cannot be located or read. |
| JWTPrivateKeyLoadFailed | Exception thrown when a configured JWT key file can not be loaded. |
| JWTVerifyFailure | Exception raised when JWT signature verification cannot be completed successfully. |
| NoApplication | Exception thrown when auth session logic is used without an active application instance. |
| NoJWTAlgorithm | Exception thrown when JWT signing/verification is attempted without an algorithm. |
| NoJWTPassphrase | Exception thrown when JWT operations require an HMAC passphrase but none is configured. |
| NoJWTPrivateKey | Exception thrown when JWT signing requires a private key but none is available. |
| SessionStartFailed | Exception thrown when a PHP session cannot be started for auth operations. |
| UnsupportedJWTAlgorithm | Exception thrown when a JWT algorithm is unknown or unsupported by the runtime. |
Hazaar\Auth\Session\Transport
Classes
| Class | Description |
|---|---|
| Cookie | Cookie-based auth token transport implementation. |
| Header | Header-based session token transport. |
Hazaar\Cache
Classes
| Class | Description |
|---|---|
| Adapter | Cache frontend/facade for backend-agnostic key/value operations. |
| Backend | Abstract base class for cache backend implementations. |
| Benchmark | |
| Func | Class Func. |
| Output | Output-buffer caching helper. |
Hazaar\Cache\Backend
Classes
| Class | Description |
|---|---|
| Apc | APCu-backed cache backend implementation. |
| Chain | Multi-backend chained cache backend. |
| Dbi | DBI-backed cache storage backend. |
| File | Filesystem/B-Tree cache backend. |
| Memcached | Memcached-backed cache backend. |
| Redis | Redis socket-backed cache backend. |
| Session | PHP session-backed cache backend. |
| Shm | System V shared-memory cache backend. |
Hazaar\Cache\Backend\Exception
Classes
| Class | Description |
|---|---|
| NoAPC | Exception thrown when APC/APCu support is unavailable. |
| NoDBConfig | Exception thrown when required database cache configuration is missing. |
| NoDBTable | Exception thrown when the database cache table configuration is missing. |
| NoMemcached | Exception thrown when the Memcached PHP extension is unavailable. |
| NoSQLite3 | Exception thrown when the SQLite3 extension is unavailable. |
| NoSQLite3DBPath | Exception thrown when the SQLite cache database path is missing. |
| NoZlib | Exception thrown when zlib compression support is unavailable. |
| RedisError | Exception representing an error reply returned by a Redis server. |
Hazaar\Cache\Exception
Classes
| Class | Description |
|---|---|
| InvalidBackend | Exception thrown when a cache backend instance is of an unsupported type. |
| InvalidFrontend | Exception thrown when a cache frontend instance is of an unsupported type. |
| NoBackendAvailable | Exception thrown when no requested cache backend can be used. |
| NoFunction | Exception thrown when a cached function invocation has no callable target. |
Hazaar\Cache\Interface
Interfaces
| Interface | Description |
|---|---|
| Backend | Contract implemented by cache backend adapters. |
Hazaar\Console
Classes
| Class | Description |
|---|---|
| Application | Console application bootstrap and command dispatcher. |
| Argument | Immutable descriptor for a positional console command argument. |
| Command | Console command definition and metadata container. |
| Input | Console input parser and execution context holder. |
| Module | Base class for console command modules. |
| Option | Value object describing a command-line option definition. |
| Output | Console output helper with formatter integration. |
Hazaar\Console\API
Classes
| Class | Description |
|---|---|
| Documentor | Generates API documentation by parsing PHP source files. |
Hazaar\Console\DBI
Classes
| Class | Description |
|---|---|
| CheckpointModule | Console module for creating DBI schema checkpoints. |
| CurrentModule | Console module for inspecting current DBI schema version. |
| ListModule | Console module for listing database schema versions. |
| MigrateModule | Console module for running DBI schema migrations. |
| ReplayModule | Console module for replaying DBI schema migrations. |
| RollbackModule | Console module for rolling back DBI schema migrations. |
| SchemaModule | Console module for inspecting database schema structure. |
| SnapshotModule | Console module for creating DBI schema snapshots. |
| SyncModule | Console module for syncing database schema/data from external files. |
Hazaar\Console\Formatter
Classes
| Class | Description |
|---|---|
| OutputFormatter | Minimal formatter for console output markup. |
Hazaar\Console\Formatter\Enum
Enums
| Class | Description |
|---|---|
| BgColour | |
| FgColour |
Hazaar\Console\Modules
Classes
| Class | Description |
|---|---|
| ConfigModule | Class ConfigModule. |
| CreateModule | Class CreateModule. |
| DocModule | Class DocModule. |
| FileModule | Class FileModule. |
| HelpModule | Built-in console help module. |
| MetricsModule | Class ConfigModule. |
| UserModule | Class UserModule. |
| UtilsModule | Class UtilsModule. |
Hazaar\Controller
Classes
| Class | Description |
|---|---|
| Action | Abstract controller action class. |
| Basic | Basic controller base class. |
| Closure | Closure-backed controller. |
| Diagnostic | Diagnostic controller base class. |
| Dump | Runtime dump diagnostic controller. |
| Error | Application error controller. |
| Info | Class Info. |
| Internal | Internal support controller dispatcher. |
| RPC | RPC controller class that extends the Server class. |
| Response | Base HTTP response implementation. |
| WebDAV | Abstract WebDAV controller. |
Hazaar\Controller\Enums
Enums
| Class | Description |
|---|---|
| ResponseType | Enumerates canonical controller response categories. |
Hazaar\Controller\Exception
Classes
| Class | Description |
|---|---|
| ActionNotFound | Exception thrown when a routed controller action does not exist. |
| ActionNotPublic | Exception thrown when a targeted controller action is not publicly callable. |
| BrowserRootNotDefined | Exception thrown when the internal browser root path is not configured. |
| BrowserRootNotFound | Exception thrown when the configured file-browser root path cannot be found. |
| HeadersSent | Exception thrown when HTTP headers have already been emitted. |
| MethodExists | Exception thrown when attempting to register a duplicate controller method. |
| MethodNotFound | Exception thrown when a required controller method cannot be located. |
| NoAction | Exception thrown when a controller has no executable action. |
| NoDefaultRenderer | Exception thrown when no default view renderer can be initialized. |
| ResponseInvalid | Exception thrown when a controller action returns an unsupported response. |
Hazaar\Controller\Helper
Classes
| Class | Description |
|---|---|
| Response | Controller helper for building typed response objects. |
| Session | Session controller helper for managing authentication state. |
Hazaar\Controller\Interface
Interfaces
| Interface | Description |
|---|---|
| Controller | |
| Helper | |
| Response |
Hazaar\Controller\Internal
Classes
| Class | Description |
|---|---|
| Warlock | Class Warlock. |
Hazaar\Controller\Middleware
Classes
| Class | Description |
|---|---|
| Ratelimiter | Class Ratelimiter. |
Hazaar\Controller\Response
Classes
| Class | Description |
|---|---|
| File | File response class. |
| HTML | HTML response class. |
| Image | Image response class. |
| Info | Diagnostic info view response. |
| JSON | JSON response class. |
| PDF response class. | |
| Stream | Stream response class. |
| Text | Plain text response class. |
| View | Template-backed HTML response. |
| XML | XML response class. |
Hazaar\Controller\Response\Exception
Classes
| Class | Description |
|---|---|
| JSONNotSupported | Exception thrown when the required JSON support is not available in the PHP installation. |
| NoLessSupport | Exception thrown when Less CSS file support is not available. |
| NoRenderer | Exception thrown when a renderer for a specific type cannot be found. |
Hazaar\Controller\Response\HTTP
Classes
| Class | Description |
|---|---|
| Accepted | HTTP 202 Accepted response class. |
| BadRequest | HTTP 400 Bad Request response class. |
| Conflict | HTTP 409 Conflict response class. |
| Created | HTTP 201 Created response class. |
| ExpectationFailed | HTTP 417 Expectation Failed response class. |
| FailedDependency | HTTP 424 Failed Dependency response class. |
| Forbidden | HTTP 403 Forbidden response class. |
| GatewayTimeout | HTTP 504 Gateway Timeout response class. |
| Gone | HTTP 410 Gone response class. |
| HTTPVersionNotSupported | HTTP 505 HTTP Version Not Supported response class. |
| ImATeapot | HTTP 418 I'm a teapot response class. |
| InsufficientStorage | HTTP 507 Insufficient Storage response class. |
| InternalServerError | HTTP 500 Internal Server Error response class. |
| LengthRequired | HTTP 411 Length Required response class. |
| Locked | HTTP 423 Locked response class. |
| LoopDetected | HTTP 508 Loop Detected response class. |
| MethodNotAllowed | HTTP 405 Method Not Allowed response class. |
| NetworkAuthenticationRequired | HTTP 511 Network Authentication Required response class. |
| NoContent | HTTP 204 No Content response class. |
| NonAuthoritativeInformation | HTTP 203 Non-Authoritative Information response class. |
| NotAcceptable | HTTP 406 Not Acceptable response class. |
| NotExtended | HTTP 510 Not Extended response class. |
| NotFound | HTTP 404 Not Found response class. |
| NotImplemented | HTTP 501 Not Implemented response class. |
| NotModified | HTTP 304 Not Modified response class. |
| OK | HTTP 200 OK response class. |
| PartialContent | HTTP 206 Partial Content response class. |
| PayloadTooLarge | HTTP 413 Payload Too Large response class. |
| PaymentRequired | HTTP 402 Payment Required response class. |
| PreconditionFailed | HTTP 412 Precondition Failed response class. |
| PreconditionRequired | HTTP 428 Precondition Required response class. |
| ProxyAuthenticationRequired | HTTP 407 Proxy Authentication Required response class. |
| RangeNotSatisfiable | HTTP 416 Range Not Satisfiable response class. |
| RateLimitExceeded | HTTP 429 Rate Limit Exceeded response class. |
| Redirect | HTTP 302 Redirect response class. |
| RequestHeaderFieldsTooLarge | HTTP 431 Request Header Fields Too Large response class. |
| RequestTimeout | HTTP 408 Request Timeout response class. |
| ResetContent | HTTP 205 Reset Content response class. |
| ServiceUnavailable | HTTP 503 Service Unavailable response class. |
| URITooLong | HTTP 414 URI Too Long response class. |
| Unauthorized | HTTP 401 Unauthorized response class. |
| UnavailableForLegalReasons | HTTP 451 Unavailable For Legal Reasons response class. |
| UnprocessableEntity | HTTP 422 Unprocessable Entity response class. |
| UnsupportedMediaType | HTTP 415 Unsupported Media Type response class. |
| VariantAlsoNegotiates | HTTP 506 Variant Also Negotiates response class. |
Hazaar\DBI
Classes
| Class | Description |
|---|---|
| Adapter | Relational Database Interface |
| LogEntry | Represents a single log entry for DBI operations. |
| Manager | Relational Database Schema Manager. |
| Result | Abstract base class for DBI result sets. |
| Row | |
| SQLParser | SQL query parser for Hazaar DBI. |
| Statement | Represents a prepared SQL statement with query builder integration for Hazaar DBI. |
| Table | Fluent table query facade for building and executing adapter-backed SQL operations. |
Hazaar\DBI\DBD
Classes
| Class | Description |
|---|---|
| Pgsql | PostgreSQL database driver implementing Hazaar DBI backend and API interfaces. |
| Sqlite | SQLite database driver implementation for Hazaar DBI. |
Functions
| Function | Description |
|---|---|
| __construct | |
| createExtension | Creates a PostgreSQL extension. |
| createGroup | Creates a new group (role without login capability) in the PostgreSQL database. |
| createUser | Creates a new user (role with login capability) in the PostgreSQL database. |
| createView | Creates a view using the supplied SQL content. |
| describeTable | Describes columns for a SQLite table. |
| describeView | Retrieves the description of a database view. |
| dropExtension | Drops a PostgreSQL extension from the database. |
| dropGroup | Drops a group (role without login capability) from the PostgreSQL database. |
| dropTrigger | Drops a trigger from the database. |
| dropUser | Drops a user (role with login capability) from the PostgreSQL database. |
| dropView | Drops a view from the database. |
| listExtensions | Retrieves a list of extensions in the specified schema. |
| listGroups | Retrieves a list of groups (roles without login capability) from the PostgreSQL database. |
| listIndexes | Retrieves a list of indexes for a given table or all tables in the specified schema. |
| listTables | Lists tables defined in the SQLite database. |
| listUsers | Retrieves a list of users (roles with login capability) from the PostgreSQL database. |
| listViews | Lists views in the active schema. |
| repair | Performs database maintenance and statistics refresh. |
| setTimezone | Sets the database session timezone. |
| tableExists | Checks whether a table exists in the SQLite database. |
| viewExists | Checks whether a view exists in the active schema. |
Hazaar\DBI\DBD\Enums
Enums
| Class | Description |
|---|---|
| QueryType |
Hazaar\DBI\DBD\Exception
Classes
| Class | Description |
|---|---|
| NoUpdate | Exception thrown when no columns are specified for update in a database operation. |
| NotConnected | Exception thrown when a PDO connection is not available or not connected. |
Hazaar\DBI\DBD\Interface
Interfaces
| Interface | Description |
|---|---|
| Backend | Interface for relational database driver backends. |
Hazaar\DBI\DBD\Traits
Traits
| Trait | Description |
|---|---|
| PDO | Trait providing base PDO operations for relational database drivers. |
| SQL | Trait providing SQL-related utility methods for database drivers. |
Hazaar\DBI\DBD\Traits\PDO
Traits
| Trait | Description |
|---|---|
| Transaction | Trait providing transactional operations for PDO database connections. |
Hazaar\DBI\DBD\Traits\SQL
Traits
| Trait | Description |
|---|---|
| Constraint | Provides SQL constraint management helpers for DBI drivers. |
| Extension | Trait providing extension management methods for SQL-based DBI drivers. |
| Group | Trait providing group management methods for SQL-based DBI drivers. |
| Index | Trait providing index management methods for SQL-based DBI drivers. |
| Schema | Trait providing schema management methods for SQL-based DBI drivers. |
| Sequence | Trait providing sequence management methods for SQL-based DBI drivers. |
| StoredFunction | Trait StoredFunction. |
| Table | Provides SQL table management helpers for DBI drivers. |
| Trigger | Trait Trigger. |
| User | Trait User. |
| View | Trait View. |
Hazaar\DBI\Exception
Classes
| Class | Description |
|---|---|
| BackendNotFound | Exception thrown when a requested DBI backend implementation cannot be found. |
| BackendNotSpecified | Exception thrown when DBI configuration does not specify a backend driver. |
| ConnectionFailed | Exception thrown when establishing a database connection fails. |
| MissingJoin | Exception thrown when a required SQL join is missing in a query context. |
| NotConfigured | Exception thrown when a DBI adapter is used without being configured. |
Hazaar\DBI\Interface
Interfaces
| Interface | Description |
|---|---|
| QueryBuilder | Interface for building SQL queries in a database-agnostic way. |
| Result | Interface for database query result sets. |
Hazaar\DBI\Interface\API
Interfaces
| Interface | Description |
|---|---|
| Constraint | |
| Extension | |
| Group | |
| Index | |
| SQL | |
| Schema | |
| Sequence | |
| Statement | Interface for preparing and managing SQL statement objects. |
| StoredFunction | |
| Table | |
| Transaction | |
| Trigger | |
| User | |
| View |
Hazaar\DBI\Manager
Classes
| Class | Description |
|---|---|
| Data | Represents a data synchronization set for database import/export operations. |
| Migration | Represents a database migration, including events and metadata. |
| Schema | Represents a database schema, including tables, views, constraints, indexes, functions, triggers, and extensions. |
| Snapshot | Represents a database schema snapshot, including version, comment, and migration details. |
| Version | Represents a schema version, including version number, comment, migration, and source file details. |
Hazaar\DBI\Manager\Migration
Classes
| Class | Description |
|---|---|
| Action | Represents a migration action, encapsulating its type, name, message, and specification. |
| Event | Represents a migration event, which is a collection of migration actions to be executed together. |
Hazaar\DBI\Manager\Migration\Action
Classes
| Class | Description |
|---|---|
| BaseAction | Abstract base class for migration actions. |
| Constraint | Represents a database constraint for migration actions. |
| Extension | Represents a set of database extensions for migration actions. |
| Func | Represents a database function for migration actions. |
| Index | Represents a database index for migration actions. |
| Raise | Represents a migration action that raises an error, warning, or notice. |
| Table | Represents a database table for migration actions. |
| Trigger | Represents a database trigger for migration actions. |
| View | Represents a database view for migration actions. |
Hazaar\DBI\Manager\Migration\Action\Component
Classes
| Class | Description |
|---|---|
| BaseComponent | Abstract base class for migration action components. |
| Column | Represents a database column component for migration actions. |
| ConstraintReference | Represents a reference to a table and column for a database constraint. |
| Parameter | Represents a parameter for a database procedure or function in migration actions. |
Hazaar\DBI\Manager\Migration\Action\Exception
Classes
| Class | Description |
|---|---|
| AlterFailed | Exception thrown when an alter operation fails during a migration action. |
| CreateFailed | Exception thrown when a create operation fails during a migration action. |
| DropFailed | Exception thrown when a drop operation fails during a migration action. |
Hazaar\DBI\Manager\Migration\Enum
Enums
| Class | Description |
|---|---|
| ActionName | |
| ActionType | |
| ConstraintType |
Hazaar\DBI\Manager\Migration\Interface
Interfaces
| Interface | Description |
|---|---|
| Spec | Interface for migration action specifications. |
Hazaar\DBI\Manager\Sync
Classes
| Class | Description |
|---|---|
| Item | Represents a synchronization item for database import/export operations. |
| Macro | Represents a macro for dynamic value lookup in database synchronization. |
| Stats | Tracks statistics for database synchronization operations. |
Hazaar\DBI\Manager\Sync\Enums
Enums
| Class | Description |
|---|---|
| RowStatus |
Hazaar\DBI\QueryBuilder
Classes
| Class | Description |
|---|---|
| SQL | SQL query builder for constructing and managing SQL statements in a structured, programmatic way. |
| SurrealQL |
Hazaar\DBI\QueryBuilder\Exception
Classes
| Class | Description |
|---|---|
| NoUpdate | Exception thrown when an UPDATE query is attempted with no columns specified for update. |
Hazaar\DBI\Result
Classes
| Class | Description |
|---|---|
| PDO | PDO result wrapper for Hazaar DBI, providing methods to interact with PDOStatement results. |
Hazaar\DBI\Schema\Exception
Classes
| Class | Description |
|---|---|
| Datasync | Exception thrown when a data synchronization operation fails in DBI schema management. |
| FileSystem | Exception thrown when a file system operation fails in DBI schema management. |
| Migration | Exception thrown when a migration operation fails in DBI schema management. |
| Schema | Exception thrown when a schema operation fails in DBI schema management. |
| Snapshot | Exception thrown when a snapshot operation fails in DBI schema management. |
Hazaar\Events
Classes
| Class | Description |
|---|---|
| Event | Class Event. |
| EventDispatcher | EventDispatcher Class. |
Traits
| Trait | Description |
|---|---|
| Dispatchable | Trait Dispatchable. |
Hazaar\Events\Interface
Interfaces
| Interface | Description |
|---|---|
| Queuable | Interface Queuable. |
Hazaar\Exception
Classes
| Class | Description |
|---|---|
| CallerException | Base exception that rewrites error location to the caller frame. |
| ClassNotFound | |
| ConfigEnvNotFound | Exception thrown when a required configuration environment is not found. |
| ConfigFileNotFound | Exception thrown when a configuration file is not found. |
| ConfigParseError | Exception thrown when a configuration file cannot be parsed due to invalid format. |
| ConfigUnknownFormat | Exception thrown when a configuration file has an unknown or unsupported format. |
| FileNotFound | Exception thrown when a requested file cannot be located. |
| InvalidSearchCriteria | Exception thrown when provided search criteria are invalid. |
| LockedMap | Exception thrown when write operations are attempted on a locked map. |
| MatchReplaceError | Exception thrown when a match-and-replace operation fails. |
| NotImplemented | Exception thrown when a feature or module has not been implemented. |
| NotSupported | Exception thrown when an operation or module is not supported. |
| UnknownStringArray | Exception thrown when a string-array format cannot be recognized. |
Hazaar\File
Classes
| Class | Description |
|---|---|
| BrowserConnector | Coordinates browser-style file operations across one or more storage managers. |
| Dir | Represent dir. |
| GZFile | Represent g z file. |
| Image | File wrapper with image-specific rendering and transformation helpers. |
| Manager | Unified facade for file backends and higher-level file operations. |
| Metric | Class Metric. |
| PDF File class for generating PDFs from HTML. | |
| Temp | Create a temporary file. |
| TempDir | Create a temporary directory. |
| Upload | The file upload manager class. |
Hazaar\File\Backend
Classes
| Class | Description |
|---|---|
| DBI | Represent d b i. |
| Dropbox | Represent dropbox. |
| GoogleDrive | Represent google drive. |
| Local | Represent local. |
| WebDAV | Represent web d a v. |
Hazaar\File\Backend\Exception
Classes
| Class | Description |
|---|---|
| ClassNotFound | Represent class not found. |
| DropboxError | Represent dropbox error. |
| GoogleDriveError | Represent google drive error. |
| Offline | Represent offline. |
Hazaar\File\Exception
Classes
| Class | Description |
|---|---|
| BackendNotFound | Represent backend not found. |
| InternalFileNotFound | Represent internal file not found. |
| InvalidBackend | Represent invalid backend. |
| MoveFailed | Represent move failed. |
| SaveFailed | Represent save failed. |
| SourceNotFound | |
| TargetExists | Represent target exists. |
| TargetNotFound |
Hazaar\File\Exception\WKPDF
Classes
| Class | Description |
|---|---|
| ExecError | Represent exec error. |
| InstallFailed | Represent install failed. |
| NoData | Represent no data. |
| NotExecutable | Represent not executable. |
| SystemError | Represent system error. |
Hazaar\File\Interface
Interfaces
| Interface | Description |
|---|---|
| Backend | Define the contract for backend. |
| Driver | Define the contract for driver. |
| ImageRenderer | Define the contract for image renderer interface. |
| Manageable | Define the contract for manageable. |
Hazaar\File\Renderer
Classes
| Class | Description |
|---|---|
| BaseRenderer | Represent base renderer. |
| GD | GD renderer for image manipulation. |
| Imagick | Imagick renderer for image manipulation. |
Hazaar\HTTP
Classes
| Class | Description |
|---|---|
| Client | HTTP Client for making requests and handling responses. |
| Link | Represents a early hint link for HTTP/2 or HTTP/3. |
| Request | HTTP Request class. |
| Response | |
| URL | |
| WebDAV | WebDAV client for interacting with WebDAV servers. |
Hazaar\HTTP\Exception
Classes
| Class | Description |
|---|---|
| CertificateNotFound | Exception thrown when a local client certificate file cannot be found. |
| DecryptFailed | Exception thrown when decryption of an HTTP response body fails. |
| HostNotFound | Exception thrown when a specified host cannot be found during an HTTP request. |
| NoConnection | Exception thrown when a connection to a specified host cannot be established during an HTTP request. |
| ProtocolPortUnknown | Exception thrown when the port for a specified protocol cannot be determined. |
| RedirectNotAllowed | Exception thrown when a redirection is received on a non-GET HTTP request. |
| TooManyRedirects | Exception thrown when an HTTP request exceeds the maximum allowed number of redirects. |
Hazaar\HTTP\WebDAV
Classes
| Class | Description |
|---|---|
| Collection | |
| Property | Represents a WebDAV property, supporting dynamic elements and attributes. |
Hazaar\HTTP\WebDAV\Lock
Hazaar\HTTP\WebDAV\Lock\Scope
Classes
| Class | Description |
|---|---|
| Exclusive |
Hazaar\HTTP\WebDAV\Lock\Type
Classes
| Class | Description |
|---|---|
| Write |
Hazaar\HTTP\WebDAV\PHPStan
Classes
| Class | Description |
|---|---|
| PropertyPropertyExtension | PHPStan extension for handling dynamic properties in WebDAV Property classes. |
| PropertyPropertyReflection | PHPStan property reflection for dynamic WebDAV Property class properties. |
Hazaar\Logger
Classes
| Class | Description |
|---|---|
| Frontend | Logger frontend implementation. |
Hazaar\Logger\Backend
Classes
| Class | Description |
|---|---|
| Chain | |
| Database | Database logger backend implementation. |
| File | |
| Memory | In-memory logger backend implementation. |
| Syslog |
Hazaar\Logger\Backend\Exception
Classes
| Class | Description |
|---|---|
| OpenLogFileFailed | Exception thrown when a log file cannot be opened. |
Hazaar\Logger\Exception
Classes
| Class | Description |
|---|---|
| NoBackend | Exception thrown when a logging backend cannot be loaded. |
Hazaar\Logger\Interface
Interfaces
| Interface | Description |
|---|---|
| Backend | Logger backend interface. |
Hazaar\Mail
Classes
| Class | Description |
|---|---|
| Adapter | Common class for sending emails via different transport mechanisms. |
| Attachment | Represents an email attachment, extending MIME part functionality. |
| Template | |
| Transport | |
| TransportMessage |
Hazaar\Mail\Interface
Interfaces
| Interface | Description |
|---|---|
| Transport | Mail transport interface. |
Hazaar\Mail\Mime
Classes
| Class | Description |
|---|---|
| Html | MIME part representing an HTML email body. |
| Message | Class Message. |
| Part | MIME part representing a section of an email message. |
Hazaar\Mail\Transport
Classes
| Class | Description |
|---|---|
| HTTP | HTTP mail transport implementation. |
| Local | Local mail transport implementation using PHP's mail() function. |
| SMTP | SMTP mail transport implementation for sending email via an SMTP server. |
Hazaar\Mail\Transport\Exception
Classes
| Class | Description |
|---|---|
| FailConnect | Exception thrown when a mail transport connection fails. |
| NoSendmail | Exception thrown when Sendmail is not available on the system. |
Hazaar\Middleware
Classes
| Class | Description |
|---|---|
| Dispatcher | Class MiddlewareDispatcher. |
| Handler | Middleware registration and execution handler. |
Hazaar\Middleware\Interface
Interfaces
| Interface | Description |
|---|---|
| Middleware |
Hazaar\Model
Classes
| Class | Description |
|---|---|
| Email Address Strict Model. | |
| Schema | |
| Struct | This is an abstract class that implements the \jsonSerializable interface. |
Hazaar\Model\Attribute
Classes
| Class | Description |
|---|---|
| Base | Abstract base class for model attribute rules. |
| Contains | |
| Filter | |
| Format | |
| Hide | |
| Max | |
| MaxLength | |
| Min | |
| MinLength | |
| Pad | |
| Range | |
| Required | |
| Substr | |
| Trim | |
| Truncate |
Hazaar\Model\Exception
Classes
| Class | Description |
|---|---|
| DefineEventHookException | Exception thrown when an event hook cannot be defined on a model class. |
| DefineRuleException | Exception thrown when a rule does not exist in a model class. |
| PropertyAttributeException | Exception thrown when there is an issue with a property attribute. |
| PropertyEnumException | Exception thrown when a property value cannot be implicitly converted to the required type. |
| PropertyException | Exception thrown when there is an issue with a typed property in a Model. |
| PropertyUndefinedException | Exception thrown when a property is not defined in a model class. |
| PropertyUnsetException | Exception thrown when an attempt is made to unset a property in a model class. |
| PropertyValidationException | Exception thrown when a property fails a validation rule in a model class. |
| PropertyValueException | Exception thrown when a property value cannot be implicitly converted to the required type. |
Hazaar\Model\Interface
Interfaces
| Interface | Description |
|---|---|
| AttributeRule | |
| CollectsValidationErrors |
Hazaar\Net
Classes
| Class | Description |
|---|---|
| LDAP | LDAP client wrapper. |
Hazaar\Parser
Classes
| Class | Description |
|---|---|
| DocBlock | Parses PHPDoc/docblock comments into structured data. |
| PHP | Facade for parsing PHP source files into structured parser objects. |
| YAML | Lightweight YAML parser for simple key/value and list structures. |
Hazaar\Parser\Exception
Classes
| Class | Description |
|---|---|
| PHPParseFunctionError | Exception thrown when a PHP function parse error occurs. |
| PHPParseParameterError | Exception thrown when a PHP parameter parse error occurs. |
| PHPParseTokenError | Exception thrown when a specific PHP token cannot be parsed. |
| PHPParserError | Exception thrown when a PHP parsing error occurs. |
| YAMLInvalid | Exception thrown when invalid YAML is encountered during parsing. |
Hazaar\Parser\PHP
Classes
| Class | Description |
|---|---|
| ParserClass | Parses class declarations from a token stream. |
| ParserConstant | Represents a parsed PHP class constant, including its value and access modifier. |
| ParserEnum | Parses class declarations from a token stream. |
| ParserEnumCase | Parses class property declarations. |
| ParserFile | Parses a PHP source file and indexes its top-level declarations. |
| ParserFunction | Parses function and method declarations. |
| ParserInterface | Parses interface declarations using class-parser semantics. |
| ParserNamespace | Parses namespace declarations and stores namespace-scoped symbols. |
| ParserParameter | Parses a function or method parameter declaration. |
| ParserProperty | Parses class property declarations. |
| ParserReturn | Represents a parsed function return type declaration. |
| ParserTrait | Parses trait declarations using class-parser semantics. |
| Token | Wrapper around a token produced by token_get_all(). |
| TokenParser | Base parser for token-based PHP declaration parsers. |
Hazaar\Parser\PHP\Traits
Traits
| Trait | Description |
|---|---|
| CodeBlock | Utility methods for navigating nested tokenised code blocks. |
| DocBlockParser | Helpers for discovering declaration doc comments in token streams. |
| TypedValueParser | Helpers for converting token sequences into typed PHP values. |
Hazaar\RPC
Classes
| Class | Description |
|---|---|
| Client | Abstract base class for RPC clients. |
| Server | Abstract base class for RPC servers. |
Hazaar\RPC\Client
Classes
| Class | Description |
|---|---|
| JSONRPC | JSON-RPC client implementation. |
| XMLRPC | XMLRPC client implementation for Hazaar RPC. |
Hazaar\RPC\Encoder
Classes
| Class | Description |
|---|---|
| JSONEncoder | |
| XMLEncoder | XML-RPC encoder implementation. |
Hazaar\RPC\Exception
Classes
| Class | Description |
|---|---|
| ClientException | Exception thrown for RPC client errors. |
| InvalidRequest | Exception thrown for invalid XML-RPC requests. |
| MethodNotFound | Exception thrown when an RPC method is not found. |
| NoCommunication | Exception thrown when communication with a remote RPC server fails. |
| ServerError |
Hazaar\RPC\Interface
Interfaces
| Interface | Description |
|---|---|
| Encoder |
Hazaar\RPC\Trait
Traits
| Trait | Description |
|---|---|
| JSON | Trait providing JSON encoder registration for RPC clients. |
| XML | Trait providing XML encoder registration for RPC clients. |
Hazaar\Socket
Classes
| Class | Description |
|---|---|
| Client | The socket client class. |
| Server | Abstract socket server class. |
Hazaar\Socket\Exception
Classes
| Class | Description |
|---|---|
| BindFailed | Exception thrown when a socket bind operation fails. |
| CreateFailed | Exception thrown when a socket creation operation fails. |
| ListenFailed | Exception thrown when a socket listen operation fails. |
| OptionFailed | Exception thrown when setting a socket option fails. |
Hazaar\Template
Classes
| Class | Description |
|---|---|
| Smarty | Smarty 2.0 Templates. |
Hazaar\Template\Exception
Classes
| Class | Description |
|---|---|
| IncludeFileNotFound | Exception thrown when a template include file is not found. |
| SmartyTemplateError | Exception thrown for errors encountered during Smarty template rendering. |
| SmartyTemplateFunctionNotFound | Exception thrown when a Smarty template function is not found. |
| SmartyTemplateNoContent | Exception thrown when a Smarty template has no content loaded. |
Hazaar\Template\Smarty
Classes
| Class | Description |
|---|---|
| Compiler | Compiler for Smarty templates. |
| Handler | |
| Modifier | |
| Renderer | Abstract base class for Smarty template rendering. |
Hazaar\Template\Smarty\Modifier
Classes
| Class | Description |
|---|---|
| Capitalize | Capitalize a string. |
| Cat | Concatenate strings. |
| CountCharacters | Count the number of characters in a string. |
| CountParagraphs | Count the number of paragraphs in a string. |
| CountSentences | Count the number of sentences in a string. |
| CountWords | Count the number of words in a string. |
| DateFormat | Formats a date using the specified format. |
| DefaultModifier | Returns the default value if the provided value is null. |
| Dump | Dump the variable using var_dump. |
| Escape | Escape a string for HTML, URL or quotes. |
| Export | Export a variable using var_export. |
| Hash | Class Hash. |
| Implode | Implode values of an array using a glue string. |
| Indent | Indent a string with a specified number of spaces or a custom string. |
| Lower | Convert string to lowercase. |
| Md5 | Class Md5. |
| Nl2br | Replaces newlines with tags. |
| NumberFormat | Format a number with grouped thousands. |
| PrintModifier | Print a variable using print_r. |
| RegexReplace | Replace part of a string with another string using a regular expression. |
| Replace | Replace a string with another string. |
| Spacify | Add spaces or other characters between each character in a string. |
| StringFormat | Format a string using sprintf. |
| Strip | Strip whitespace, newlines and tabs from a string. |
| StripTags | Strip HTML tags from a string. |
| Trim | Trims whitespace or other characters from the beginning and end of a string. |
| Truncate | Truncate a string to a certain length if necessary, optionally splitting in the middle of a word. |
| Type | Return the type of a variable. |
| Upper | Convert string to uppercase. |
| Wordwrap | Wraps a string to a given number of characters using a string break character. |
| Yn | Count the number of words in a string. |
Hazaar\Util
Classes
| Class | Description |
|---|---|
| Arr | Hazaar Array Utility Class. |
| BTree | BTree class provides a B-Tree implementation for storing key-value pairs. |
| Boolean | Boolean utility class. |
| Closure | The Hazaar Closure Class. |
| Cron | This class can be used to parse cron strings and compute schedules. |
| DateTime | The date/time class. |
| Extender | The Class Extender Class. |
| GeoData | The GeoData class for accessing geographic information on countries. |
| Interval | Interval utility class. |
| Money | Money class. |
| Number | Number utility class. |
| Obj | Object Utility. |
| RateLimiter | Class RateLimiter. |
| Socket | The PHP socket extensions class. |
| Str | The Str utility class. |
| Timer | Timer class for measuring how long things take. |
| URL | URL utility class. |
| Version | Represents and manipulates versions according to the Semantic Versioning 2.0.0 specification (SemVer). |
Hazaar\Util\BTree
Classes
| Class | Description |
|---|---|
| Node | Class Node. |
| Record | Class Record. |
Enums
| Class | Description |
|---|---|
| NodeType |
Hazaar\Util\Exception
Classes
| Class | Description |
|---|---|
| ClosureNotInitialised | Exception thrown when a closure is accessed before it has been initialised. |
| ExtenderAccessFailed | Exception thrown when an extender fails to access a property in a class. |
| ExtenderInvokeFailed | Exception thrown when an extender fails to invoke a method in a class. |
| ExtenderMayNotInherit | Exception thrown when an extender attempts to inherit from a forbidden class type. |
| InvalidArrowFunction | Exception thrown when an invalid arrow function is provided. |
| InvalidClosure | Exception thrown when an invalid closure is provided. |
| MethodUndefined | Exception thrown when a call is made to an undefined method in a class. |
| PropertyUndefined | Exception thrown when an undefined property is accessed in a class. |
Hazaar\Util\RateLimiter
Classes
| Class | Description |
|---|---|
| Backend | Abstract base class for rate limiter backends. |
Hazaar\Util\RateLimiter\Backend
Classes
| Class | Description |
|---|---|
| Cache | Rate limiter backend using cache storage. |
| DBI | Rate limiter backend using a database interface (DBI). |
| File | Rate limiter backend using file-based storage. |
Hazaar\Util\RateLimiter\Enum
Enums
| Class | Description |
|---|---|
| EventType |
Hazaar\Util\RateLimiter\Interface
Interfaces
| Interface | Description |
|---|---|
| Backend |
Hazaar\Validation
Classes
| Class | Description |
|---|---|
| Assert | Assert provides a fluent interface for validating values against various criteria. |
| ValidationException | Exception thrown when validation fails in lazy validation mode. |
Hazaar\View
Classes
| Class | Description |
|---|---|
| FunctionHandler | View template function bridge handler. |
| Helper | Base class for view helpers. |
| Layout | Layout view class. |
| ViewableObject | Base class for objects that can render themselves as strings. |
Interfaces
| Interface | Description |
|---|---|
| Viewable | Interface for objects that are writable as a string. |
Hazaar\View\Helper
Classes
| Class | Description |
|---|---|
| Hazaar | View helper that injects the HazaarJS bootstrap snippet and config. |
| Html | HTML helper utilities for view templates. |
| Warlock | View helper that injects the Warlock client bootstrap script. |
Hazaar\View\Interface
Interfaces
| Interface | Description |
|---|---|
| Helper | Base contract for view helper implementations. |
Hazaar\Warlock
Classes
| Class | Description |
|---|---|
| Channel | The Channel class manages a collection of connections to the Warlock server. The purpose of this class is to |
| Client | Control class for Warlock |
| Logger | Logger class for handling logging operations with different log levels. |
| Process | Base process implementation for Warlock clients, agents, and services. |
| Protocol | Hazaar Application Protocol Class |
| REST | HTTP REST client for communicating with a Warlock server endpoint. |
| Service | The Warlock application service class |
Hazaar\Warlock\Agent
Classes
| Class | Description |
|---|---|
| Container | Base process container used by agent-side Warlock components. |
| Main | Main Warlock agent process responsible for task orchestration. |
| Process | Base wrapper around child worker processes managed by the agent. |
| Runner | Standalone runtime process used to execute a single endpoint payload. |
| Task | Base class for executable tasks managed by the agent. |
Hazaar\Warlock\Agent\Struct
Classes
| Class | Description |
|---|---|
| Application | Runtime application metadata passed to spawned Warlock tasks. |
| Endpoint | Serializable endpoint reference for deferred task execution. |
Hazaar\Warlock\Agent\Task
Classes
| Class | Description |
|---|---|
| Internal | Internal recurring task backed by a cron schedule. |
| Runner | Task implementation for executing scheduled callable endpoints. |
| Service | Task wrapper responsible for launching and supervising service endpoints. |
Hazaar\Warlock\Connection
Classes
| Class | Description |
|---|---|
| Pipe | |
| Socket |
Hazaar\Warlock\Console
Classes
| Class | Description |
|---|---|
| AgentModule | Console commands for managing the Warlock agent process. |
| ServerModule | Console commands for managing the Warlock server process. |
Hazaar\Warlock\Enum
Enums
| Class | Description |
|---|---|
| ClientType | Enum representing different types of Warlock clients. |
| ExitCode | Process exit codes used by Warlock service runners. |
| LogLevel | Enum representing log levels for Warlock logging. |
| PacketType | Packet command identifiers exchanged by Warlock components. |
| PcntlSignals | POSIX signals observed by Warlock process handlers. |
| PeerStatus | Enum representing peer connection status for Warlock. |
| ScheduleType | Enum representing different types of schedules. |
| Status | Enum representing service status codes for Warlock. |
| TaskStatus | Enum representing task status codes for Warlock. |
| Version | Version identifiers for Warlock server and agent components. |
Hazaar\Warlock\Exception
Classes
| Class | Description |
|---|---|
| ExtensionNotLoaded | Thrown when a required PHP extension is unavailable. |
Hazaar\Warlock\Interface
Interfaces
| Interface | Description |
|---|---|
| Client | Contract implemented by client connections handled by the server. |
| Connection | Contract for Warlock transport connections. |
| LogWriter | LogWriter interface for writing log messages. |
Hazaar\Warlock\Logger
Classes
| Class | Description |
|---|---|
| EchoWriter | EchoWriter class for writing log messages to the standard output. |
| WarlockWriter | Log writer that forwards messages through a Warlock process channel. |
Hazaar\Warlock\Protocol
Classes
| Class | Description |
|---|---|
| WebSockets | Low-level WebSocket handshake and framing helpers. |
Hazaar\Warlock\Server
Classes
| Class | Description |
|---|---|
| Client | Base server-side client connection abstraction. |
| Functions | Utility functions used by Warlock server runtime. |
| Main | Primary Warlock server runtime and connection orchestrator. |
| Watcher | Process supervisor for local helper processes used by the server. |
Hazaar\Warlock\Server\Client
Classes
| Class | Description |
|---|---|
| Agent | Server-side representation of a connected Warlock agent. |
| Peer | Server-side client wrapper for cluster peer connections. |
| Service | Server-side representation of a connected service process. |
Hazaar\Warlock\Server\Component
Classes
| Class | Description |
|---|---|
| Cluster | Manages peer connectivity and command routing for Warlock clustering. |
| KVStore | In-memory key/value store component with optional persistence. |
Hazaar\XML
Classes
| Class | Description |
|---|---|
| Element | XML element node model. |
Hazaar\XML\PHPStan
Classes
| Class | Description |
|---|---|
| ElementPropertyExtension | PHPStan property extension for dynamic XML Element properties. |
| ElementPropertyReflection | Property reflection model for dynamic XML Element properties. |
Functions
| Function | Description |
|---|---|
| dump | Dumps information about one or more variables and halts the execution of the script. |
| dumpLog | Logs the provided data with a timestamp. |
Generated by Hazaar API Doc Generator on Tue, 21 Apr 2026 04:00:25 +0000