Index | API Documentation

A

Sitemap::addUrl() — Method in class Sitemap
Url::addAlternate() — Method in class Url
Document::appendLink() — Method in class Document: Adds a link tag to the document.
Document::appendStyle() — Method in class Document: Adds a CSS style to the document.
Document::appendScript() — Method in class Document: Adds a JS script to the document.
Document::appendInlineScript() — Method in class Document: Adds an inline JS script to the document.
$ Tag#attributes — Property in class Tag
$ Language#active_language — Property in class Language: The currently active language.
Translator::addPath() — Method in class Translator: Adds a new translation path to the list.
Event::addListener() — Method in class Event: Adds a listener to the event.
File::application_MIME() — Method in class File: Get all application MIME types.
File::audio_MIME() — Method in class File: Get all audio MIME types.
File::all_MIME() — Method in class File: Get all supported MIME types.
ServerRequest::all() — Method in class ServerRequest: Retrieve all query and body parameters.
ServerRequest::addGet() — Method in class ServerRequest: Add a parameter to the query string.
ServerRequest::addToBody() — Method in class ServerRequest: Add a parameter to the request body.
ServerRequest::add() — Method in class ServerRequest: Add a parameter to the request, either to the query string or body based on the HTTP method.
ServerRequest::addFile() — Method in class ServerRequest: Add a file to the uploaded files.
$ View#available_source_paths — Property in class View: List of available source paths for views.
$ View#available_modules_source_paths — Property in class View
View::addModuleSourcePath() — Method in class View: Adds a source path for modules views with a namespace.
View::addSourcePath() — Method in class View: Adds a source path for views, optionally with a namespace.
CSRFVerifier::addException() — Method in class CSRFVerifier: Add a URI pattern to the list of CSRF exceptions.
RouteGroup::addRoute() — Method in class RouteGroup: Add a route to the group.
Router::add() — Method in class Router: Add a route to the router.
Router::addCSRFException() — Method in class Router: Add a CSRF exception.
After — Class in namespace App\System\Validator\Rules

B

Model::boot() — Method in class Model
View::build() — Method in class View: Resolve and build the view.
Project::boot() — Method in class Project: Executes the project boot file if exists
Router::buildDispatcher() — Method in class Router: Build the route dispatcher.
Before — Class in namespace App\System\Validator\Rules

C

$ Url#changefreq — Property in class Url
$ Document#canonical — Property in class Document: Canonical URL of the page.
$ Tag#content — Property in class Tag
Config — Class in namespace App\System
Controller — Class in namespace App\System\MVC
Controller::copyResources() — Method in class Controller: Copies resources from the module to the destination.
$ Model#casts — Property in class Model
$ Model#connection — Property in class Model
Model::creationUser() — Method in class Model: Generic method that returns the user who created the record
Model::categories() — Method in class Model: Generic method that returns the categories of a model
View::compile() — Method in class View: Compile the view content
ModelsObserver::creating() — Method in class ModelsObserver
ModelsObserver::created() — Method in class ModelsObserver
CSRFVerifier — Class in namespace App\System\Router
Router::currentRoute() — Method in class Router: Get the current route.
Session::contains() — Method in class Session: Checks if session contains a value
After::check() — Method in class After
Before::check() — Method in class Before

D

Sitemap::display() — Method in class Sitemap
Document — Class in namespace App\Modules\Document: Handles the generation and management of HTML document tags, such as meta tags, links, styles, scripts, manifest, robots, and sitemap.
Domain — Class in namespace App\Modules\Domains
$ Domain#description — Property in class Domain
Database — Class in namespace App\System
Event::dispatch() — Method in class Event: Dispatches the event to all registered listeners.
ModelsObserver::deleting() — Method in class ModelsObserver
ModelsObserver::deleted() — Method in class ModelsObserver
MiddlewaresDispatcher::dispatch() — Method in class MiddlewaresDispatcher: Dispatch the middleware at the given index.
RouteGroup::delete() — Method in class RouteGroup: Add a DELETE route to the group.
Router::delete() — Method in class Router: Add a DELETE route.
Session::delete() — Method in class Session: Deletes a value from session.

E

Config::exists() — Method in class Config: Check if the config and/or key you are looking for exists
Env — Class in namespace App\System
$ Env#env_vars — Property in class Env
Event — Class in namespace App\System\Events
$ Manager#events — Property in class Manager
View::exists() — Method in class View: Check if a view exists

F

File — Class in namespace App\System
ServerRequest::filled() — Method in class ServerRequest: Check if a specific key is filled.
ServerRequestFactory::fromGlobals() — Method in class ServerRequestFactory: Create a ServerRequest instance from PHP global variables.
Model::findOr404() — Method in class Model: Finds a model or response with 404
ModelsObserver::forceDeleting() — Method in class ModelsObserver
ModelsObserver::forceDeleted() — Method in class ModelsObserver
RouteGroup::fullPrefix() — Method in class RouteGroup: Get the full prefix for the route group, including parent prefixes.
$ After#fillableParams — Property in class After
$ Before#fillableParams — Property in class Before
Validator::fails() — Method in class Validator: Gets if validation fails.
Validator::failed() — Method in class Validator: Gets validation errors.

G

Document::getLinks() — Method in class Document: Returns all links added to the document.
Document::get() — Method in class Document: Returns the singleton instance of the Document class.
Document::getMetaTags() — Method in class Document: Returns all meta tags, or a specific one if provided.
Tag::get_tag_name() — Method in class Tag: Get the tag name
Domain::get() — Method in class Domain: Return the Document object instance. Document object is a singleton
Domain::getHost() — Method in class Domain: Get the current host.
Domain::getOrigin() — Method in class Domain: Get the origin URL.
Domain::getLanguages() — Method in class Domain: Get the available languages for the domain.
Domain::getDefaultLanguage() — Method in class Domain: Get the default language for the domain.
Domain::getModules() — Method in class Domain: Get the project active modules
Domain::getConnectionsConfig() — Method in class Domain: Get all registered connections
Domain::getConnectionConfig() — Method in class Domain: Get a specific registered connection config
Domain::getOwnConnection() — Method in class Domain: Get a connection to the domain database
Language::get() — Method in class Language: Get the active language.
Config::get() — Method in class Config: Get a config value.
Env::get() — Method in class Env: Get an environment variable.
Manager::getEvent() — Method in class Manager: Retrieves an existing event or creates a new one if it doesn't exist.
File::getExtensionFromString() — Method in class File: Get the file extension from a filename string.
File::getExtensionFromMIME() — Method in class File: Get the file extension from a MIME type.
File::getMIME() — Method in class File: Get the MIME type from a file extension.
ServerRequest::get() — Method in class ServerRequest: Get the singleton instance of the ServerRequest.
Controller::getDir() — Method in class Controller: Gets the directory of the current class file.
Controller::getClassName() — Method in class Controller: Gets the short class name of the current class.
View::get() — Method in class View: Get a view from filename
View::getPath() — Method in class View: Get the view path
View::getArguments() — Method in class View: Get the view arguments
Project::get() — Method in class Project: Get the current project.
CSRFVerifier::get() — Method in class CSRFVerifier: Get the singleton instance of the CSRFVerifier.
CSRFVerifier::getToken() — Method in class CSRFVerifier: Get the CSRF token from the session.
CSRFVerifier::getTokenInput() — Method in class CSRFVerifier: Generate an HTML input element containing the CSRF token.
Route::getMethods() — Method in class Route: Get the HTTP methods supported by the route.
Route::getHandler() — Method in class Route: Get the handler for the route.
Route::getMiddlewares() — Method in class Route: Get the list of middlewares applied to the route.
Route::getNamespace() — Method in class Route: Get the namespace of the route.
Route::getName() — Method in class Route: Get the name of the route.
Route::getGroup() — Method in class Route: Get the route group the route belongs to.
Route::getPath() — Method in class Route: Get the path of the route.
Route::getParams() — Method in class Route: Get the parameters for the route.
RouteGroup::getParent() — Method in class RouteGroup: Get the parent route group.
RouteGroup::getPrefix() — Method in class RouteGroup: Get the prefix for the route group.
RouteGroup::getRoutes() — Method in class RouteGroup: Get the list of routes in the group.
RouteGroup::get() — Method in class RouteGroup: Add a GET route to the group.
RouteGroup::getMiddlewares() — Method in class RouteGroup: Get the list of middlewares applied to the group.
Router::get() — Method in class Router: Add a GET route.
Router::group() — Method in class Router: Create a route group with a common prefix.
Session::get() — Method in class Session: Get a session value.
Session::get_message() — Method in class Session: Get session messages
Session::get_input() — Method in class Session: Get session inputs

H

Domain::hasModule() — Method in class Domain: Get if a project has a module
Database::hasConnection() — Method in class Database: Determines if a connection is defined in the ORM.
MiddlewaresDispatcher::handle() — Method in class MiddlewaresDispatcher
RouteGroup::head() — Method in class RouteGroup: Add a HEAD route to the group.
Router::head() — Method in class Router: Add a HEAD route.
Router::handle() — Method in class Router

I

Str::isEmail() — Method in class Str: Determines whether the specified string is email.
$ Document#instance — Property in class Document: Singleton instance of the class.
$ Domain#instance — Property in class Domain
Domain::init() — Method in class Domain: Init and setup the Document object
Languages::init() — Method in class Languages: Initializes the language setting the memorized language and starting translator.
Translator::init() — Method in class Translator: Initializes the translations by loading locale files from modules and the project folder.
File::isImage() — Method in class File: Check if the given MIME type or extension is an image.
File::isVideo() — Method in class File: Check if the given MIME type or extension is a video.
File::image_MIME() — Method in class File: Get all image MIME types.
$ ServerRequest#instance — Property in class ServerRequest
ServerRequest::input() — Method in class ServerRequest: Retrieve a specific input value.
ServerRequest::isAjax() — Method in class ServerRequest: Check if the current request is an AJAX request.
View::initSourcePaths() — Method in class View: Initialize all source paths from configuration.
$ Project#instance — Property in class Project
$ CSRFVerifier#instance — Property in class CSRFVerifier
CSRFVerifier::isException() — Method in class CSRFVerifier: Check if a given URI matches any of the CSRF exceptions.
$ Router#instance — Property in class Router
Router::instance() — Method in class Router: Get or create the singleton instance of the Router.

L

$ Url#loc — Property in class Url
$ Url#lastmod — Property in class Url
Str::lorem_ipsum() — Method in class Str: Get a placeholder text for developing purposes
Language — Class in namespace App\Modules\Languages
Languages — Class in namespace App\Modules\Languages
Translator::locales_recursive() — Method in class Translator: Recursively loads locale files from a given path.
Controller::load_routes() — Method in class Controller: Loads the module routes if the routes.php file exists in the module directory.

M

Manager — Class in namespace App\System\Events
File::message_MIME() — Method in class File: Get all message MIME types.
Controller::modules_paths() — Method in class Controller: Returns an array of module paths locations.
Model — Class in namespace App\System\MVC
View::module() — Method in class View: Get a module view from filename
View::mergeSections() — Method in class View: Merge view sections content with given sections content
ModelsObserver — Class in namespace App\System\Observers
MiddlewaresDispatcher — Class in namespace App\System\Router
Route::middleware() — Method in class Route: Add a middleware to the route.
Route::mergeGroupMiddlewares() — Method in class Route: Merge the middlewares from a route group.
RouteGroup::middleware() — Method in class RouteGroup: Add a middleware to the group.
$ After#message — Property in class After
$ Before#message — Property in class Before

N

$ Domain#name — Property in class Domain
View::notFound() — Method in class View: Throw an exception when a view is not found
Route::name() — Method in class Route: Set the name of the route.
Route::namespace() — Method in class Route: Set the namespace for the route.
RouteGroup::namespace() — Method in class RouteGroup: Set the namespace for the group.

O

$ Database#orm — Property in class Database
Database::orm() — Method in class Database: Get the ORM instance.

P

$ Url#priority — Property in class Url
Document::printMetaTags() — Method in class Document: Prints rendered meta tags.
Document::printStyles() — Method in class Document: Prints rendered links and styles.
Document::printScripts() — Method in class Document: Prints rendered scripts.
Document::printFaviconLinks() — Method in class Document: Prints favicon links if available.
$ Domain#project_folder — Property in class Domain
Response::parse() — Method in class Response: Parse a response object and return a formatted HTTP response.
$ View#parsing_progressive — Property in class View: Progressive counter for parsing operations.
View::parent() — Method in class View: Set the view parent
Project — Class in namespace App\System
RouteGroup::post() — Method in class RouteGroup: Add a POST route to the group.
RouteGroup::patch() — Method in class RouteGroup: Add a PATCH route to the group.
RouteGroup::put() — Method in class RouteGroup: Add a PUT route to the group.
RouteGroup::parseRoutes() — Method in class RouteGroup: Parse the routes in the group, applying parent middlewares and namespaces.
Router::post() — Method in class Router: Add a POST route.
Router::patch() — Method in class Router: Add a PATCH route.
Router::put() — Method in class Router: Add a PUT route.

R

Sitemap::render() — Method in class Sitemap
Url::render() — Method in class Url
Str::remove_accents() — Method in class Str: Removes accents from string
Str::remove_symbols() — Method in class Str: Removes anything that is not a letter, number, or space
Str::rand_letters_string() — Method in class Str: Generates a random letters string of $length.
Document::robots() — Method in class Document: Generates and outputs the robots.txt file.
Document::renderMetaTags() — Method in class Document: Returns rendered meta tags.
Document::renderStyles() — Method in class Document: Returns rendered links and styles.
Document::renderScripts() — Method in class Document: Returns rendered scripts (external and inline).
Tag::render() — Method in class Tag: Render the HTML tag as a string
Translator::refresh() — Method in class Translator: Refreshes the translations by re-initializing them.
Response — Class in namespace App\System\Http
Response::redirect() — Method in class Response: Create a redirect response.
View::render() — Method in class View: Build and print the view.
ModelsObserver::retrieved() — Method in class ModelsObserver
ModelsObserver::restoring() — Method in class ModelsObserver
ModelsObserver::restored() — Method in class ModelsObserver
ModelsObserver::replicating() — Method in class ModelsObserver
Project::root() — Method in class Project: Build an absolute path to project folder resource
Route — Class in namespace App\System\Router
RouteGroup — Class in namespace App\System\Router
Router — Class in namespace App\System\Router

S

Sitemap — Class in namespace App\Classes\Sitemap
Str — Class in namespace App\Classes
Str::sanitize_string() — Method in class Str: Removes accents, makes string lowercase, replaces multiple spaces with $space
Document::sitemap() — Method in class Document: Generates and outputs the XML sitemap.
Document::setMetaTag() — Method in class Document: Adds a meta tag to the document.
Language::set() — Method in class Language: Set the active language.
Env::set() — Method in class Env: Set an environment variable.
Env::setFromArray() — Method in class Env: Set environment variables from array.
Event::setListener() — Method in class Event: Sets a single listener for the event, replacing any existing listeners.
Response::setBody() — Method in class Response: Set the body content of the response.
ServerRequest — Class in namespace App\System\Http
ServerRequestFactory — Class in namespace App\System\Http
Model::syncCategories() — Method in class Model: Generic method that synchronizes the categories of a model
View::section() — Method in class View: Set section position inside the view
View::start_style() — Method in class View: Starts style section.
View::stop_style() — Method in class View: Stops style section.
View::start_script() — Method in class View: Starts script section.
View::stop_script() — Method in class View: Stops script section.
View::start_section() — Method in class View: Starts a section.
View::stop_section() — Method in class View: Stops a section.
View::setSectionContent() — Method in class View: Sets the section content
ModelsObserver::saving() — Method in class ModelsObserver
ModelsObserver::saved() — Method in class ModelsObserver
Route::setGroup() — Method in class Route: Set the route group the route belongs to.
Route::setPath() — Method in class Route: Set the path of the route.
Route::setParams() — Method in class Route: Set the parameters for the route.
Router::start() — Method in class Router: Start the router, build the dispatcher, and handle the request.
Session — Class in namespace App\System
Session::start() — Method in class Session: Starts the session
Session::stop() — Method in class Session: Stops the session
Session::status() — Method in class Session: Get session status
Session::set() — Method in class Session: Set a session value.
Validator::success() — Method in class Validator: Gets if validation succeded.

T

$ Document#title — Property in class Document: Page title.
$ Document#title_append — Property in class Document: Text to append to the title.
Tag — Class in namespace App\Modules\Document
Translator — Class in namespace App\Modules\Languages: Class Translator Handles loading and translating language strings from various sources.
$ Translator#translations — Property in class Translator
Translator::translate() — Method in class Translator: Translates a string using loaded translations and replaces placeholders.
Database::tenant() — Method in class Database: Shortcut for tenant connection.
Database::tableExists() — Method in class Database: Determines if table exists
Database::transaction() — Method in class Database: Starts and wraps the code inside a database transaction.
File::text_MIME() — Method in class File: Get all text MIME types.
ModelsObserver::trashed() — Method in class ModelsObserver
Route::toUrl() — Method in class Route: Generate the URL for the route.

U

Url — Class in namespace App\Classes\Sitemap
Model::user() — Method in class Model: General method that returns the model user
ModelsObserver::updating() — Method in class ModelsObserver
ModelsObserver::updated() — Method in class ModelsObserver

V

File::video_MIME() — Method in class File: Get all video MIME types.
View — Class in namespace App\System\MVC\View
CSRFVerifier::validateRequest() — Method in class CSRFVerifier: Validate the CSRF token in the incoming request.
RouteGroup::view() — Method in class RouteGroup: Add a GET route that returns a view.
Router::view() — Method in class Router: Shortcut for a GET route that returns a view.
Validator — Class in namespace App\System\Validator

W

Document::webmanifest() — Method in class Document: Generates and outputs the web manifest file.

X

File::x_world_MIME() — Method in class File: Get all x-world MIME types.

_

Document::__construct() — Method in class Document: Constructor. Sets the CSRFToken meta tag.
Tag::__construct() — Method in class Tag: Constructor
Domain::__construct() — Method in class Domain: Domain constructor.
Database::__callStatic() — Method in class Database: Allows you to call the ORM's static methods through the Database class
Event::__construct() — Method in class Event: Event constructor.
Model::_delete() — Method in class Model: Illuminate\Database\Eloquent\SoftDeletes updates deleted_at only See main/System/Observers/ModelsObserver.php deleting()
View::__construct() — Method in class View: Creates a new instance.
View::__toString() — Method in class View: Returns a string representation of the object.
Project::__construct() — Method in class Project
CSRFVerifier::__construct() — Method in class CSRFVerifier: Constructor for the CSRFVerifier class.
MiddlewaresDispatcher::__construct() — Method in class MiddlewaresDispatcher
Route::__construct() — Method in class Route: Constructor for the Route class.
RouteGroup::__construct() — Method in class RouteGroup: Constructor for the RouteGroup class.
Router::__construct() — Method in class Router
Validator::__construct() — Method in class Validator