API Reference
About 9 min
API Reference
This is an automatically generated documentation for API Reference.
Namespaces
Hazaar
Classes
| Class | Description |
|---|---|
| Application | The Application. |
| Closure | The Hazaar Closure Class. |
| Controller | Base Controller class. |
| Cron | This class can be used to parse cron strings and compute schedules. |
| DateTime | The date/time class. |
| Extender | The Class Extender Class |
| File | |
| GeoData | The GeoData class for accessing geographic information on countries. |
| Loader | Global class file loader. |
| Model | This is an abstract class that implements the \jsonSerializable interface. |
| Money | Money class |
| RateLimiter | Class RateLimiter. |
| Session | Session class |
| Socket | The PHP socket extensions class. |
| Timer | Timer class for measuring how long things take. |
| Version | The version class |
| View | The View class is used to render views in the Hazaar framework. |
Hazaar\Application
Classes
| Class | Description |
|---|---|
| Config | Application Configuration Class. |
| Protocol | Hazaar Application Protocol Class |
| Request | Controller HTTP Request Class |
| Route | |
| Router | |
| URL | Generate a URL relative to the application |
Functions
| Function | Description |
|---|---|
| fromApplicationNamespace |
Hazaar\Application\Exception
Classes
| Class | Description |
|---|---|
| BadTimezone | |
| ConfigEnvNotFound | |
| RouterUnknown | |
| RuntimeDirNotFound | |
| RuntimeDirNotWritable | |
| RuntimeDirUncreatable | |
| ServerBusy |
Hazaar\Application\Interface
Interfaces
| Interface | Description |
|---|---|
| Request |
Hazaar\Application\Router
Classes
| Class | Description |
|---|---|
| Loader |
Hazaar\Application\Router\Exception
Classes
| Class | Description |
|---|---|
| ActionNotFound | |
| ControllerHasNoRoutes | |
| ControllerNotFound | |
| LoaderNotSupported | |
| ProtocolNotSupported | |
| RouteFailed | |
| RouteNotFound | |
| RouterInitialisationFailed |
Hazaar\Application\Router\Loader
Classes
| Class | Description |
|---|---|
| Advanced | |
| Annotated | The annotated router class. |
| Attribute | |
| Basic | Basic Application Router. |
| File | |
| Json | JSON Router. |
Hazaar\Application\Router\Loader\Exception
Classes
| Class | Description |
|---|---|
| MissingRouteFile |
Hazaar\Auth
Classes
| Class | Description |
|---|---|
| Adapter | Abstract authentication adapter. |
Hazaar\Auth\Adapter
Classes
| Class | Description |
|---|---|
| Basic | |
| DBITable | |
| HTPasswd | |
| Model | |
| OAuth2 | |
| OpenID | OAuth short summary. |
Hazaar\Auth\Adapter\Exception
Classes
| Class | Description |
|---|---|
| HTPasswdFileMissing | |
| Unauthorised | |
| UnknownStorageAdapter |
Hazaar\Auth\Interface
Interfaces
| Interface | Description |
|---|---|
| Adapter | |
| Storage |
Hazaar\Auth\Storage
Classes
| Class | Description |
|---|---|
| Cache | Session based authentication adapter |
| JWT | JWT Authentication Adapter. |
| Session | Session based authentication adapter |
Hazaar\Auth\Storage\Exception
Classes
| Class | Description |
|---|---|
| JWTPrivateKeyFileNotFound | |
| NoApplication | |
| NoJWTAlgorithm | |
| NoJWTPassphrase | |
| NoJWTPrivateKey | |
| SessionStartFailed | |
| UnsupportedJWTAlgorithm |
Hazaar\Cache
Classes
| Class | Description |
|---|---|
| Adapter | The cache frontend. |
| Backend | |
| Benchmark | |
| Func | Class Func. |
| Output |
Hazaar\Cache\Backend
Classes
| Class | Description |
|---|---|
| Apc | The APC cache backend. |
| Chain | The cache backend chaining backend. |
| File | The file cache backend. |
| Memcached | The Memcached cache backend. |
| Redis | The Redis cache backend. |
| Session | Session cache backend class |
| Shm | The PHP-SHM (shared memory) cache backend. |
| Sqlite3 | The SQLite3 cache backend. |
Hazaar\Cache\Backend\Exception
Classes
| Class | Description |
|---|---|
| NoAPC | |
| NoDBConfig | |
| NoDBTable | |
| NoMemcached | |
| NoSQLite3 | |
| NoSQLite3DBPath | |
| NoZlib | |
| RedisError |
Hazaar\Cache\Exception
Classes
| Class | Description |
|---|---|
| InvalidBackend | |
| InvalidFrontend | |
| NoBackendAvailable | |
| NoFunction |
Hazaar\Cache\Interface
Interfaces
| Interface | Description |
|---|---|
| Backend |
Hazaar\Console
Classes
| Class | Description |
|---|---|
| Application | |
| Command | |
| HelpCommand | |
| Input | |
| Output |
Hazaar\Console\API
Classes
| Class | Description |
|---|---|
| Documentor |
Hazaar\Console\DBI
Classes
| Class | Description |
|---|---|
| CheckpointCommand | |
| CurrentCommand | |
| ListCommand | |
| MigrateCommand | |
| ReplayCommand | |
| RollbackCommand | |
| SchemaCommand | |
| SnapshotCommand | |
| SyncCommand |
Hazaar\Console\Formatter
Classes
| Class | Description |
|---|---|
| OutputFormatter |
Hazaar\Console\Tool
Classes
| Class | Description |
|---|---|
| ConfigCommand | |
| CreateCommand | |
| DecryptCommand | |
| DocCommand | |
| EncryptCommand | |
| ToolCommand |
Hazaar\Controller
Classes
| Class | Description |
|---|---|
| Action | Abstract controller action class. |
| Basic | Basic controller class |
| Closure | Class Closure. |
| Diagnostic | Basic controller class |
| Dump | Class Dump. |
| Error | Basic controller class |
| Helper | |
| Info | Class Info. |
| Internal | Class Internal. |
| Response | |
| WebDAV | |
| XMLRPC | Abstract class XMLRPC. |
Hazaar\Controller\Action
Classes
| Class | Description |
|---|---|
| ViewRenderer | Class ViewRenderer. |
Hazaar\Controller\Action\Exception
Classes
| Class | Description |
|---|---|
| InvalidActionController | |
| NoContent |
Hazaar\Controller\Exception
Classes
| Class | Description |
|---|---|
| ActionNotFound | |
| ActionNotPublic | |
| BrowserRootNotDefined | |
| BrowserRootNotFound | |
| HeadersSent | |
| MethodExists | |
| MethodNotFound | |
| NoAction | |
| NoDefaultRenderer | |
| ResponseInvalid |
Hazaar\Controller\Helper
Classes
| Class | Description |
|---|---|
| Response |
Hazaar\Controller\Interface
Interfaces
| Interface | Description |
|---|---|
| Controller | |
| Response |
Hazaar\Controller\Internal
Classes
| Class | Description |
|---|---|
| Warlock | Class Warlock. |
Hazaar\Controller\Response
Classes
| Class | Description |
|---|---|
| File | |
| HTML | |
| Image | |
| Info | |
| JSON | |
| Layout | |
| Stream | |
| Text | |
| View | |
| XML |
Hazaar\Controller\Response\Exception
Classes
| Class | Description |
|---|---|
| ActionNotFound | |
| JSONNotSupported | |
| NoLessSupport | |
| NoRenderer |
Hazaar\Controller\Response\HTTP
Classes
| Class | Description |
|---|---|
| BadRequest | |
| Forbidden | |
| NoContent | |
| NotFound | |
| NotImplemented | |
| OK | |
| RateLimitExceeded | Represents a HTTP response for when the rate limit has been exceeded. |
| Redirect | |
| Unauthorized |
Hazaar\DBI
Classes
| Class | Description |
|---|---|
| Adapter | Relational Database Interface |
| DataMapper | |
| Result | |
| Row | |
| Table |
Hazaar\DBI\DBD
Classes
| Class | Description |
|---|---|
| Pgsql |
Functions
| Function | Description |
|---|---|
| __construct | |
| createExtension | Creates a PostgreSQL extension. |
| createGroup | |
| createUser | |
| createView | |
| describeView | Retrieves the description of a database view. |
| dropExtension | Drops a PostgreSQL extension from the database. |
| dropGroup | |
| dropUser | |
| dropView | |
| listExtensions | Retrieves a list of extensions in the specified schema. |
| listGroups | |
| listIndexes | Retrieves a list of indexes for a given table or all tables in the specified schema. |
| listUsers | |
| listViews | |
| repair | |
| viewExists |
Hazaar\DBI\DBD\Exception
Classes
| Class | Description |
|---|---|
| NoUpdate | |
| NotConnected |
Hazaar\DBI\DBD\Interface
Interfaces
| Interface | Description |
|---|---|
| Driver | Relational Database Driver Interface |
Hazaar\DBI\DBD\Traits
Traits
| Trait | Description |
|---|---|
| PDO | Relational Database Driver - Base Class. |
| SQL |
Hazaar\DBI\DBD\Traits\PDO
Traits
| Trait | Description |
|---|---|
| Transaction |
Hazaar\DBI\DBD\Traits\SQL
Traits
| Trait | Description |
|---|---|
| Constraint | |
| Extension | |
| Group | |
| Index | |
| Schema | |
| Sequence | |
| StoredFunction | |
| Table | |
| Trigger | |
| User | |
| View |
Hazaar\DBI\Exception
Classes
| Class | Description |
|---|---|
| ConnectionFailed | |
| DriverNotFound | |
| DriverNotSpecified | |
| MissingJoin | |
| NotConfigured |
Hazaar\DBI\Interface
Interfaces
| Interface | Description |
|---|---|
| QueryBuilder | |
| Result |
Hazaar\DBI\Interface\API
Interfaces
| Interface | Description |
|---|---|
| Constraint | |
| Extension | |
| Group | |
| Index | |
| SQL | |
| Schema | |
| Sequence | |
| Statement | |
| StoredFunction | |
| Table | |
| Transaction | |
| Trigger | |
| User | |
| View |
Hazaar\DBI\QueryBuilder
Classes
| Class | Description |
|---|---|
| SQL | |
| SurrealQL |
Hazaar\DBI\QueryBuilder\Exception
Classes
| Class | Description |
|---|---|
| NoUpdate |
Hazaar\DBI\Result
Classes
| Class | Description |
|---|---|
| PDO |
Hazaar\DBI\Schema
Classes
| Class | Description |
|---|---|
| Manager | Relational Database Schema Manager. |
Hazaar\DBI\Schema\Exception
Classes
| Class | Description |
|---|---|
| Datasync | |
| FileSystem | |
| Migration | |
| Schema | |
| Snapshot |
Hazaar\Exception
Classes
Hazaar\File
Classes
| Class | Description |
|---|---|
| BTree | B-Tree key/value database file access class. |
| BrowserConnector | |
| Dir | |
| GZFile | |
| Image | |
| Manager | |
| 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 | |
| Dropbox | |
| GoogleDrive | |
| Hazaar | |
| Local | |
| SharePoint | |
| WebDAV |
Hazaar\File\Backend\Exception
Classes
| Class | Description |
|---|---|
| ClassNotFound | |
| DropboxError | |
| GoogleDriveError | |
| Offline | |
| SharePointError |
Hazaar\File\Backend\Interface
Interfaces
| Interface | Description |
|---|---|
| Backend | |
| Driver | |
| Manageable |
Hazaar\File\Exception
Classes
| Class | Description |
|---|---|
| BackendNotFound | |
| InternalFileNotFound | |
| InvalidBackend | |
| MoveFailed | |
| SaveFailed | |
| SourceNotFound | |
| TargetExists | |
| TargetNotFound |
Hazaar\File\Exception\WKPDF
Classes
| Class | Description |
|---|---|
| ExecError | |
| InstallFailed | |
| NoData | |
| NotExecutable | |
| SystemError |
Hazaar\File\Renderer
Classes
| Class | Description |
|---|---|
| BaseRenderer | |
| GD | |
| Imagick |
Interfaces
| Interface | Description |
|---|---|
| ImageRendererInterface |
Hazaar\File\Template
Classes
| Class | Description |
|---|---|
| Smarty | The View\Template class. |
Hazaar\File\Template\Exception
Classes
| Class | Description |
|---|---|
| SmartyRenderException |
Hazaar\HTTP
Classes
| Class | Description |
|---|---|
| Client | |
| Request | HTTP Request class. |
| Response | |
| URL | |
| WebDAV |
Hazaar\HTTP\Exception
Classes
| Class | Description |
|---|---|
| CertificateNotFound | |
| DecryptFailed | |
| HostNotFound | |
| NoConnection | |
| ProtocolPortUnknown | |
| RedirectNotAllowed | |
| TooManyRedirects |
Hazaar\HTTP\WebDAV
Classes
| Class | Description |
|---|---|
| Collection | |
| Property |
Hazaar\HTTP\WebDAV\Lock
Hazaar\HTTP\WebDAV\Lock\Scope
Classes
| Class | Description |
|---|---|
| Exclusive |
Hazaar\HTTP\WebDAV\Lock\Type
Classes
| Class | Description |
|---|---|
| Write |
Hazaar\Logger
Classes
| Class | Description |
|---|---|
| Backend | |
| Frontend |
Hazaar\Logger\Backend
Classes
| Class | Description |
|---|---|
| Chain | |
| Database | |
| File | |
| Memory | |
| Syslog |
Hazaar\Logger\Backend\Exception
Classes
| Class | Description |
|---|---|
| OpenLogFileFailed |
Hazaar\Logger\Exception
Classes
| Class | Description |
|---|---|
| NoBackend |
Hazaar\Logger\Interface
Interfaces
| Interface | Description |
|---|---|
| Backend |
Hazaar\Mail
Classes
| Class | Description |
|---|---|
| Adapter | Common class for sending emails via different transport mechanisms. |
| Attachment | |
| Template | |
| Transport | |
| TransportMessage |
Hazaar\Mail\Interface
Interfaces
| Interface | Description |
|---|---|
| Transport |
Hazaar\Mail\Mime
Classes
| Class | Description |
|---|---|
| Html | |
| Message | |
| Part |
Hazaar\Mail\Transport
Classes
| Class | Description |
|---|---|
| HTTP | |
| Local | |
| SMTP |
Hazaar\Mail\Transport\Exception
Classes
| Class | Description |
|---|---|
| FailConnect | FailConnect short summary. |
| NoSendmail | FailConnect short summary. |
Hazaar\Model
Classes
| Class | Description |
|---|---|
| Email Address Strict Model. |
Hazaar\Model\Attribute
Classes
| Class | Description |
|---|---|
| Base | |
| Contains | |
| Filter | |
| Format | |
| Hide | |
| Max | |
| MaxLength | |
| Min | |
| MinLength | |
| Pad | |
| Range | |
| Required | |
| Trim |
Hazaar\Model\Exception
Classes
| Class | Description |
|---|---|
| DefineEventHookException | |
| PropertyAttributeException | |
| PropertyException | |
| PropertyValidationException | |
| UnsetPropertyException |
Hazaar\Model\Interface
Interfaces
| Interface | Description |
|---|---|
| AttributeRule |
Hazaar\Net
Classes
| Class | Description |
|---|---|
| LDAP | LDAP access class |
Hazaar\Parser
Classes
| Class | Description |
|---|---|
| DocBlock | The docblock parser class. |
| PHP | |
| YAML |
Hazaar\Parser\PHP
Classes
| Class | Description |
|---|---|
| ParserClass | |
| ParserConstant | |
| ParserFile | |
| ParserFunction | |
| ParserInterface | |
| ParserNamespace | |
| ParserParameter | |
| ParserProperty | |
| ParserReturn | |
| ParserTrait | |
| Token | |
| TokenParser |
Hazaar\Parser\PHP\Traits
Traits
| Trait | Description |
|---|---|
| CodeBlock | |
| DocBlockParser | |
| TypedValueParser |
Hazaar\RateLimiter
Classes
| Class | Description |
|---|---|
| Backend |
Hazaar\RateLimiter\Backend
Classes
| Class | Description |
|---|---|
| Cache | |
| File |
Hazaar\RateLimiter\Interface
Interfaces
| Interface | Description |
|---|---|
| Backend |
Hazaar\Socket
Classes
| Class | Description |
|---|---|
| Client | The socket client class. |
| Server | The socket server class. |
Hazaar\Socket\Exception
Classes
| Class | Description |
|---|---|
| BindFailed | |
| CreateFailed | |
| ListenFailed | |
| OptionFailed |
Hazaar\Template
Classes
| Class | Description |
|---|---|
| Smarty | Smarty 2.0 Templates. |
Hazaar\Template\Exception
Classes
| Class | Description |
|---|---|
| IncludeFileNotFound | |
| SmartyTemplateError |
Hazaar\Template\Smarty
Classes
| Class | Description |
|---|---|
| Modifier |
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. |
| 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. |
| 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. |
| 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. |
Hazaar\Test
Classes
| Class | Description |
|---|---|
| BaseClass | This is a test class. |
| TestClass | This is a test class. |
Interfaces
| Interface | Description |
|---|---|
| TestInterface | This is a test interface. |
Functions
| Function | Description |
|---|---|
| testFunction | This is a test function. |
| variaticFunction | This is a variatic function. |
Constants
| Constant | Description |
|---|---|
| TEST_CONSTANT | This is a test constant. |
Hazaar\View
Classes
| Class | Description |
|---|---|
| Helper | |
| Layout | |
| ViewableObject | Abstract class for objects that can be written to a string |
Interfaces
| Interface | Description |
|---|---|
| Viewable | Interface for objects that are writable as a string. |
Hazaar\View\Helper
Classes
| Class | Description |
|---|---|
| Authentication | |
| DateTime | |
| Form | |
| Pagination |
Hazaar\View\Interface
Interfaces
| Interface | Description |
|---|---|
| Helper | Base view helper interface. |
Hazaar\Warlock
Classes
| Class | Description |
|---|---|
| Config | |
| Container | |
| Control | Control class for Warlock |
| Process | |
| Protocol | Hazaar Application Protocol Class |
| REST | |
| Service | The Warlock application service class |
Hazaar\Warlock\Connection
Classes
| Class | Description |
|---|---|
| Pipe | |
| Socket |
Hazaar\Warlock\Interface
Interfaces
| Interface | Description |
|---|---|
| Client | |
| Connection | |
| Task |
Hazaar\Warlock\Protocol
Classes
| Class | Description |
|---|---|
| WebSockets |
Hazaar\Warlock\Server
Classes
| Class | Description |
|---|---|
| Client | |
| Cluster | |
| KVStore | |
| Logger | |
| Master | |
| Process | |
| Task |
Hazaar\Warlock\Server\Client
Classes
| Class | Description |
|---|---|
| Peer | |
| Service |
Hazaar\Warlock\Server\Struct
Classes
| Class | Description |
|---|---|
| Application |
Hazaar\Warlock\Server\Task
Classes
| Class | Description |
|---|---|
| Internal | |
| Runner | |
| Service | |
| Test |
Hazaar\XML
Classes
| Class | Description |
|---|---|
| Element | Represents an element in an XML document. |
Hazaar\XML\RPC\Exception
Classes
| Class | Description |
|---|---|
| ClientException | |
| InvalidRequest | |
| MethodNotFound | |
| NoCommunication | |
| XMLRPCNotInstalled |
Hazaar\Xml\Rpc
Classes
| Class | Description |
|---|---|
| Client | |
| Server |
Classes
| Class | Description |
|---|---|
| MatchReplaceException |
Functions
| Function | Description |
|---|---|
| age | Get the age of a date. |
| ake | Array/Object value normalizer. |
| akr | Array Key Rename. |
| array_build_html | Converts a multi dimensional array into key[key][key] => value syntax that can be used in html INPUT field names. |
| array_collate | Collate a multi-dimensional array into an associative array where $key_item is the key and $value_item is the value. |
| array_diff_assoc_recursive | Recursivly computes the difference of arrays with additional index check. |
| array_diff_key_recursive | Computes the difference of arrays using keys for comparison recursively. |
| array_enhance | Merge two arrays together but only add elements that don't already exist in the target array. |
| array_flatten | Flattens a multidimensional array into a string representation. |
| array_from_dot_notation | Convert a single dimension array in dot notation into a multi-dimensional array. |
| array_pull | Pull an item out of an array by is key. |
| array_remove_empty | Recursively remove all empty values from an array. |
| array_seek | Seek the array cursor forward $count number of elements. |
| array_to_dot_notation | Convert to dot notation. |
| array_to_object | Recursively convert an array into an object. |
| array_unflatten | Converts a flattened string or array into a multidimensional array. |
| array_usearch | Searches the array using a callback function and returns the first corresponding key if successful. |
| base64url_decode | |
| base64url_encode | |
| basicHandler | Handles basic PHP errors. |
| boolify | Normalize boolean values. |
| build_url | Build a correctly formatted URL from argument list. |
| bytes_str | String to bytes formatter. |
| coalesce | Retreive first non-null value from parameter list. |
| days | Convert interval to days. |
| deep_clone | Performs a deep clone on an object or array. |
| dieDieDie | Terminates the script execution and displays an error message. |
| dump | |
| errorAndDie | This function handles errors and terminates the script execution. |
| grammatical_implode | Grammatically correct array implode. |
| guid | |
| hazaar_request_headers | Get the current request headers. |
| hours | Convert interval to hours. |
| http_response_text | Helper function to get the status text for an HTTP response code. |
| in_uarray | Checks if a value exists in an array using a callback function. |
| interval | Return a string interval in a nice readable format. |
| is_assoc | Test of array is an associative array. |
| is_boolean | Test whether a value is a boolean. |
| is_multi_array | Test of array is multi-dimensional. |
| is_reserved | |
| log_dump | |
| match_replace | Use the match/replace algorithm on a string to replace mustache tags with view data. |
| minutes | Convert interval to minutes. |
| money_format | Replacement for the "built-in" PHP function money_format(), which isn't always built-in. |
| object_merge | Object Merge. |
| object_to_array | Recursively convert an object into an array. |
| php_binary | Returns the path to the PHP binary. |
| preg_match_array | Perform a regular expression match on a string using multiple possible regular expressions. |
| recursive_iterator_to_array | Recrusively convert a traversable object into a normal array. |
| replace_property | Replaces a property in an object at key with another value. |
| replace_recursive | Replaces elements from passed arrays or objects into the first array or object recursively. |
| rotateLogFile | Rotate a log file. |
| seconds | Convert a string interval to seconds. |
| str_bytes | Byte to string formatter. |
| str_fixtype | Fix a numeric string. |
| str_ftime | |
| str_putcsv | Convert an array into a CSV line. |
| str_random | Generate a truly random string of characters. |
| strbool | Retrieve string value of boolean. |
| traceAndDie | Traces the current execution and terminates the script. |
| uptime | Convert interval to uptime string. |
| weeks | Convert interval to weeks. |
| years | Convert interval to years. |
| yn | The Yes/No function. |
Generated by Hazaar API Doc Generator