Index | Inphinit API

A

App — Class in namespace Inphinit
App::action() — Method in class App: Register callable or controller for a route
App — Class in namespace Inphinit\Diagnostics
App::action() — Method in class App: Validate method and callback, if valid register callable or controller for a route
$ Debug#assistants — Property in class Debug
Debug::assistant() — Method in class Debug: Convert error message into a link for a search engine or online assistant to analyze the error message. See system/configs/debug.php
Selector::all() — Method in class Selector: Returns a \DOMNodeList that match the specified selector
Console::action() — Method in class Console: Register callable, console controller, and Command instance for a CLI command
FileResponse::available() — Method in class FileResponse: Check if a specific delivery mode is supported by the server environment Note: In the built-in web server, all modes will return true, allowing you to use the simulator to deliver the file
Method::addHeader() — Method in class Method: Adds a request header as an alternative source for determining the HTTP method
Method::addParam() — Method in class Method: Adds a parameter (request body or querystring) as an alternative source for determining the HTTP method
Import::auto() — Method in class Import: Auto import composer packages
Resource::action() — Method in class Resource: Define routes based on class methods
Treaty::action() — Method in class Treaty: Define routes based on class methods
Arrays — Class in namespace Inphinit\Utility
Url::application() — Method in class Url: Get Url instance from current url

B

Env::bool() — Method in class Env: Get value from $_ENV[...] as boolean
$ Version#build — Property in class Version

C

App::config() — Method in class App: Get the application configs from $_ENV with APP_ prefix key.
Config — Class in namespace Inphinit
Config::commit() — Method in class Config: Save configuration to file
App::config() — Method in class App: Validate name and get the application configs from $_ENV with APP_ prefix key.
Checkup — Class in namespace Inphinit\Diagnostics
Debug::classes() — Method in class Debug: Get declared classes
Debug::constants() — Method in class Debug: Get defined constants
Inspector::caller() — Method in class Inspector: Get caller from backtrace php scripts
Selector::count() — Method in class Selector: Count all nodes matching the given CSS selector. If the selector is not valid, it will return false.
Event::clear() — Method in class Event: Clears all registered events and uniqueness flags
Command — Class in namespace Inphinit\Experimental\Cli
Console — Class in namespace Inphinit\Experimental\Cli
Converter — Class in namespace Inphinit\Experimental\Delimited
Converter::csv() — Method in class Converter: Save reader to CSV
Csv — Class in namespace Inphinit\Experimental\Delimited
Reader::converter() — Method in class Reader: Get a Converter instance.
CookieJar — Class in namespace Inphinit\Experimental\Http
File::clearstat() — Method in class File: Clear state files and clear info files from Inphinit\File::permissions
Negotiation::contentTypes() — Method in class Negotiation: Get all document types from Accept header and sorted by q-factor (defined by $sort)
Request::cookie() — Method in class Request: Get a value from $_COOKIE (support path using dots)
Response::cache() — Method in class Response: Set HTTP cache or no-cache Note: $seconds and $modified accept English textual datetime descriptions (e.g., 'now', '+1 day', 'last Monday').
Import::classmap() — Method in class Import: Load autoload_classmap.php classes
Package::cache() — Method in class Package: Cache composer.lock data
$ Resource#contentType — Property in class Resource
Session::commit() — Method in class Session: Save session data
Strings::capitalize() — Method in class Strings: Capitalize words using hyphen or a custom delimiter.
Url::canonpath() — Method in class Url: Canon path
Version::compare() — Method in class Version: Compare current version with another version

D

App::down() — Method in class App: Put the application into maintenance mode
Debug — Class in namespace Inphinit\Diagnostics
Document — Class in namespace Inphinit\Dom
Document::document() — Method in class Document: Get original document
Document::dump() — Method in class Document: Convert document to XML string, HTML string or array
DomException — Class in namespace Inphinit\Dom
Converter::dom() — Method in class Converter: Populate DOMElement with reader entries
Response::download() — Method in class Response: Force download current response
View::dispatch() — Method in class View: Starts rendering of registered views.
View::data() — Method in class View: Share or remove shared data to Views, shared variables will be added as variables to the views that will be executed later

E

App::exec() — Method in class App: Executes the route callback corresponding to the path, otherwise executes system/errors.php.
$ Debug#editors — Property in class Debug
Debug::editor() — Method in class Debug: Creates a link to open a file in your editor via the protocol. See system/configs/debug.php
Inspector::evalSource() — Method in class Inspector: Identify and get the possible source of an error message caused by eval()
Event — Class in namespace Inphinit
Exception — Class in namespace Inphinit
Command::enableResidual() — Method in class Command: If set to true, it will allow the command to receive invalid parameters, which will be passed to the third parameter of the callback
Console::exec() — Method in class Console: Receives the arguments to execute the command If the command is not found, an exception will be thrown
Env — Class in namespace Inphinit\Experimental\Environment
Env::entry() — Method in class Env: Get value from $_ENV[...]. If not exists or empty string return aternate value
EnvException — Class in namespace Inphinit\Experimental\Environment
EnvFile — Class in namespace Inphinit\Experimental\Environment
File::exists() — Method in class File: Check if file exists using case-sensitive, For help developers who using Windows OS and using unix-like for production
Negotiation::entries() — Method in class Negotiation: Parse any header with q-factor value
Negotiation::encodings() — Method in class Negotiation: Get all encodings from Accept-Encoding header and sort by q-factor (defined by $sort)
View::exists() — Method in class View: Check if view exists in ./application/View/ folder

F

$ App#filters — Property in class App
Debug::functions() — Method in class Debug: Get declared functions
Document::fromArray() — Method in class Document: Convert Array to DOM
Selector::first() — Method in class Selector: Returns the first element or node within the document that matches the specified selector.
Reader::fetch() — Method in class Reader: Fetch a row from file pointer
Env::float() — Method in class Env: Get value from $_ENV[...] as float
EnvFile::fill() — Method in class EnvFile: Fill the values of environment variables
FileResponse — Class in namespace Inphinit\Experimental\Http
Forwarded — Class in namespace Inphinit\Experimental\Http
File — Class in namespace Inphinit\Filesystem
Negotiation::fromString() — Method in class Negotiation: Create a Negotiation instance based in string
Import::files() — Method in class Import: Load autoload_files.php classes
$ Treaty#format — Property in class Treaty
$ Url#fragment — Property in class Url
View::forceRender() — Method in class View: Force the View::render method to render at the time it is called

G

Checkup::getErrors() — Method in class Checkup: Retrieve all detected configuration errors
Checkup::getWarnings() — Method in class Checkup: Retrieve all detected configuration warnings
Document::getNamespaces() — Method in class Document: Get namespace attributes from root element or specific element
Command::getName() — Method in class Command: They get the name from the command
Command::getOptions() — Method in class Command: They obtain the (long) options that the command accepts
Command::getShortOptions() — Method in class Command: They obtain the short options that are equivalent to the (long) options
Reader::getHeaders() — Method in class Reader: Get headers from file
Reader::getStream() — Method in class Reader: Get file pointer resource
Forwarded::getParam() — Method in class Forwarded: Returns a value from a specific Forwarded field.
Forwarded::getAll() — Method in class Forwarded: Returns all parsed Forwarded entries as an array.
Size::get() — Method in class Size: Get file size using defined modes Note: If it is not a file or does not exist, this method will return false.
Request::get() — Method in class Request: Get a value from $_GET, if $_GET is a array multidimensional, you can use dot like path: If $_GET['foo'] returns this ['baz' => ['baz' => 1]] use Request::get('foo.bar.baz') for return 1
Import::getLibs() — Method in class Import: Return array of libs
Session::getId() — Method in class Session: Get current ID from session
PropertyAccessor::getValue() — Method in class PropertyAccessor: Read array or object by path using dot

H

Request::header() — Method in class Request: Get HTTP header from current request
Response::header() — Method in class Response: Shortcut for set header Note: While PHP internally discards headers containing line breaks and issues a warning, such content is explicitly forbidden by this function. An exception will now be thrown if line breaks are detected, preventing both silent issues and potential misinterpretations of header behavior.
$ Url#host — Property in class Url

I

Checkup::iniFiles() — Method in class Checkup: Retrieve all ini files
Inspector — Class in namespace Inphinit\Diagnostics
Env::int() — Method in class Env: Get value from $_ENV[...] as integer
Request::is() — Method in class Request: Checks if the request matches a specific type: HTTPS, XHR, Pjax, prefetch, save-data, GPC, or a standard HTTP method (e.g., GET, POST).
Import — Class in namespace Inphinit\Packages
Import::inAutoload() — Method in class Import: Load ./system/boot/namespaces.php classes
Package::info() — Method in class Package: Get package info
Arrays::iterable() — Method in class Arrays: Similar to is_iterable from PHP 7.1.0+
Arrays::indexed() — Method in class Arrays: Check if array is indexed, like ['foo', 'bar']. Similar to array_is_list

J

Converter::json() — Method in class Converter: Save reader to JSON

K

Arrays::ksort() — Method in class Arrays: Ksort recursive

L

Document::load() — Method in class Document: Load string or file
File::lines() — Method in class File: Read lines from a file
Negotiation::languages() — Method in class Negotiation: Get all languages from Accept-Language header sorted by q-factor (defined by $sort)
Import::logs() — Method in class Import: Get log

M

App::maintenance() — Method in class App: Checks if the application is in maintenance mode.
Method — Class in namespace Inphinit\Experimental\Http
Status::message() — Method in class Status: Get message by HTTP code
$ Version#major — Property in class Version
$ Version#minor — Property in class Version

N

$ App#namespacePrefix — Property in class App
$ Console#namespacePrefix — Property in class Console
Negotiation — Class in namespace Inphinit\Http
Url::normalize() — Method in class Url: Normalize path and querystring

O

Event::on() — Method in class Event: Registers a callback to an event with optional priority. Note: If any subscribed callback returns a boolean false, further execution of subsequent callbacks will be halted
Event::once() — Method in class Event: It makes a type of event unique, ensuring that all registered events of that type are triggered only once.
Event::off() — Method in class Event: Removes a specific callback or all callbacks registered for an event.
Parser::output() — Method in class Parser: Get the processed value
Method::override() — Method in class Method: Replaces $_SERVER['REQUEST_METHOD'] with the detected alternative method, using the default settings
Method::original() — Method in class Method: Gets the original HTTP method of the request, before any overrides
File::output() — Method in class File: Show file in output, if use ob_start is auto used ob_flush. You can set delay in microseconds for cycles

P

$ App#pathPrefix — Property in class App
$ App#paramPatterns — Property in class App
Debug::performance() — Method in class Debug: Get memory usage and you can also use it to calculate runtime.
Csv::parse() — Method in class Csv: Parse lines
Tsv::parse() — Method in class Tsv: Parse header and lines
Parser — Class in namespace Inphinit\Experimental\Environment
Parser::putFallback() — Method in class Parser: Adds alternative values if they don't exist in $_ENV[...]
File::permissions() — Method in class File: Get file/folder permissions in a format more readable.
File::portion() — Method in class File: Read excerpt from a file
Request::path() — Method in class Request: Get current HTTP path
Request::post() — Method in class Request: Get a value from $_POST, if $_POST is a array multidimensional, you can use dot like path: If $_POST['foo'] returns this ['baz' => ['baz' => 1]] use Request::post('foo.bar.baz')
Import::psr4() — Method in class Import: Load autoload_psr4.php classes, used by PSR-4 packages
Import::psr0() — Method in class Import: Load autoload_namespaces.php classes, used by PSR-0 packages
Package — Class in namespace Inphinit\Packages
Treaty::parsePath() — Method in class Treaty: Overwrite path parser
PropertyAccessor — Class in namespace Inphinit\Utility
$ Url#port — Property in class Url
$ Url#pass — Property in class Url
$ Url#path — Property in class Url
$ Version#pattern — Property in class Version
$ Version#patch — Property in class Version
$ Version#prerelease — Property in class Version

Q

Negotiation::qFactor() — Method in class Negotiation: Parse and sort a custom value with q-factor
Request::query() — Method in class Request: Get querystring - Note: same as $_SERVER['QUERY_STRING'], but with framework adjustments on IIS web server
$ Url#query — Property in class Url

R

App::routes() — Method in class App: Get routes from current scope and parents
Config::reload() — Method in class Config: Reload configuration from file
Document::root() — Method in class Document: Get root element
Command::response() — Method in class Command: This method will be used automatically by the Inphinit\Cli\Console instance
Console::run() — Method in class Console: Shortcut to execute predefined commands or commands from system/console.php
Reader — Class in namespace Inphinit\Experimental\Delimited
Reader::refresh() — Method in class Reader: Rewind the position of file pointer and refresh headers
EnvFile::refresh() — Method in class EnvFile: Refresh entries from the env file values.
Request — Class in namespace Inphinit\Http
Response — Class in namespace Inphinit\Http
Resource — Class in namespace Inphinit\Routing
Resource::route() — Method in class Resource: Define routes based on class methods
Treaty::route() — Method in class Treaty: Define routes based on class methods
Session::regenerate() — Method in class Session: Regenerate data
View::render() — Method in class View: Register or render a View. If View is registered this method returns the index number from View
View::remove() — Method in class View: Remove a registered View by index

S

App::setNamespace() — Method in class App: Prefixes the namespace in the current scope control
App::setPattern() — Method in class App: Create or replace a pattern for URL slugs
App::scope() — Method in class App: Groups routes within the scope of the defined URI
App::setNamespace() — Method in class App: Validate namespace prefix, if valid define controller prefix on scope
App::setPattern() — Method in class App: Validate pattern, if valid create or replace a pattern for URL slugs
App::scope() — Method in class App: Validate URL pattern, if valid register a callback for isolate routes
Debug::setBeforeView() — Method in class Debug: Set view for display displayed before other defined from a Debug instance Note: This method does not affect behavior in the CLI environment
Debug::setDefinedView() — Method in class Debug: Set view for display defined constants, functions and classes Note: This method does not affect behavior in the CLI environment
Debug::setErrorView() — Method in class Debug: Set view for display errors and exceptions Note: This method does not affect behavior in the CLI environment
Debug::setPerformanceView() — Method in class Debug: Set view for display memory usage after application terminate Note: This method does not affect behavior in the CLI environment
Debug::source() — Method in class Debug: Get snippet from a file
Document::setSeverityLevels() — Method in class Document: Define libXML errors as exceptions
Document::setLoadOptions() — Method in class Document: Define libXML options for load a document or string
Document::setSaveOptions() — Method in class Document: Define libXML options for dump or save a document as file
Document::selector() — Method in class Document: Gets all elements that match the CSS selector
Document::save() — Method in class Document: Save document to file
Selector — Class in namespace Inphinit\Dom
Command::setOption() — Method in class Command: Define a option for command
Console::setNamespace() — Method in class Console: Prefixes the namespace to command controller classes
Converter::setWhitespaceMode() — Method in class Converter: Set the write mode for \n, \r and \t on field entries
$ Csv#separators — Property in class Csv
Csv::setEnclosure() — Method in class Csv: Set enclosure for read CSV
Csv::setProprietaryEscape() — Method in class Csv: Set proprietary escape mechanism for read CSV
Csv::setSeparators() — Method in class Csv: Set separators
$ Reader#separator — Property in class Reader
$ Reader#separators — Property in class Reader
$ Reader#stream — Property in class Reader
Reader::setChunk() — Method in class Reader: Set maximum line length
Reader::setDataTransferObject() — Method in class Reader: Set Data Transfer Object class
Reader::setEndOfLine() — Method in class Reader: Set end-of-line
Reader::setFlags() — Method in class Reader: Set the behavior of the fetch() method, and returns the previously defined flags.
Reader::setFilter() — Method in class Reader: Set a custom filter that can be used to skip specific rows by returning false in the callback, or simply to modify the values received by reference.
Reader::setLimit() — Method in class Reader: Set the maximum number of rows returned and skips a certain number of rows before starting to return rows.
$ Tsv#separators — Property in class Tsv
EnvFile::setOverride() — Method in class EnvFile: This method affect fill() and storeAsVars() methods
EnvFile::storeAsArray() — Method in class EnvFile: Store entries as PHP array
EnvFile::storeAsVars() — Method in class EnvFile: Store entries as $_ENV[] = ; in a PHP script
Parser::setValue() — Method in class Parser: Define the value that will be processed
CookieJar::setDomain() — Method in class CookieJar: Defines the host to which the cookie will be sent.
CookieJar::setPath() — Method in class CookieJar: Indicates the path that must exist in the requested URL for the browser to send the Cookie header.
CookieJar::setExpires() — Method in class CookieJar: Indicates the maximum lifetime of the cookies.
CookieJar::setHttpOnly() — Method in class CookieJar: Forbids JavaScript from accessing the cookie, for example, through the Document.cookie property.
CookieJar::setPartitioned() — Method in class CookieJar: Indicates that the cookie should be stored using partitioned storage.
CookieJar::setSameSite() — Method in class CookieJar: Controls whether or not a cookie is sent with cross-site requests.
CookieJar::setSecure() — Method in class CookieJar: Indicates that the cookie is sent to the server only when a request is made with the https scheme (except on localhost), and therefore, is more resistant to man-in-the-middle attacks.
CookieJar::send() — Method in class CookieJar: Send cookies from jar to headers
FileResponse::send() — Method in class FileResponse: Dispatch the file using the preferred available delivery method
Method::setAllowed() — Method in class Method: Defines which HTTP methods can be used to override the original method
File::strictMode() — Method in class File: Enable or disable strict mode for check if file exists with case-sensitive (available only in development mode)
Size — Class in namespace Inphinit\Filesystem
Response::status() — Method in class Response: Get or set status code and return previous status code.
Status — Class in namespace Inphinit\Http: Constant with the most common HTTP codes
Import::setItem() — Method in class Import: Associate namespace prefix to folder
Import::save() — Method in class Import: Save imported packages path to file in PHP format
Import::saveFiles() — Method in class Import: Save imported autoload files path to file in PHP format
Session — Class in namespace Inphinit
Strings — Class in namespace Inphinit\Utility
$ Url#scheme — Property in class Url
Url::setDefaultPorts() — Method in class Url: Sets default ports
Url::setSlugDict() — Method in class Url: Sets slug dictionary
View::setEncoding() — Method in class View: Set encoding used by escape engine

T

Inspector::type() — Method in class Inspector: Gets the type name of a variable with get_debug_type() when available; otherwise, falls back to gettype()
Document::toArray() — Method in class Document: Convert DOM to Array
Event::trigger() — Method in class Event: Triggers all callbacks registered for a given event
Converter::tsv() — Method in class Converter: Save reader to TSV
Tsv — Class in namespace Inphinit\Experimental\Delimited
Negotiation::top() — Method in class Negotiation: Get the highest priority option from the header
Negotiation::topContentType() — Method in class Negotiation: Get the document type (from Accept header) with the highest priority based on the q value. If it does not exist then return the value of $alternative.
Negotiation::topEncoding() — Method in class Negotiation: Get the encoding (from Accept-Encoding header) with the highest priority based on the q value. If it does not exist then return the value of $alternative.
Negotiation::topLanguage() — Method in class Negotiation: Get the encoding (from Accept-Language header) with the highest priority based on the q value. If it does not exist then return the value of $alternative.
Response::type() — Method in class Response: Set Content-Type header or remove previously headers
Treaty — Class in namespace Inphinit\Routing
Strings::toAscii() — Method in class Strings: Convert string to ASCII

U

App::useFilter() — Method in class App: Add a filter for routes in the current scope
App::up() — Method in class App: Bring the application out of maintenance mode
Debug::unregister() — Method in class Debug: Unregister debug events and views
Url — Class in namespace Inphinit\Utility
$ Url#user — Property in class Url

V

Status::valid() — Method in class Status: Validate HTTP code
$ Resource#valids — Property in class Resource: Define methods and routes
$ Treaty#valids — Property in class Treaty
Version — Class in namespace Inphinit\Utility
Version::valid() — Method in class Version: Validate string version
View — Class in namespace Inphinit\Viewing

X

Selector::xpath() — Method in class Selector: Get DOMXPath instance

_

App::__get() — Method in class App
App::__set() — Method in class App
Config::__construct() — Method in class Config: Return items from a config file in a object (iterator or with ->)
Config::__get() — Method in class Config: Magic method for get specific item
Config::__set() — Method in class Config: Magic method for set value (this method don't save data)
Config::__isset() — Method in class Config: Magic method for check if value exists in top-level
Config::__unset() — Method in class Config: Magic method for unset variable with unset() function
App::__construct() — Method in class App
App::__get() — Method in class App
App::__set() — Method in class App
Checkup::__construct() — Method in class Checkup
Document::__construct() — Method in class Document: Create a Document instance
DomException::__construct() — Method in class DomException: Raise an exception
Selector::__construct() — Method in class Selector: Create a Inphinit\Dom\Selector instance.
Exception::__construct() — Method in class Exception: Create a new exception instance, optionally adjusting file and line based on a specific stack trace depth.
Command::__construct() — Method in class Command: Creates a command to be used with an Inphinit\Cli\Console instance
Converter::__construct() — Method in class Converter: Set reader
Csv::__construct() — Method in class Csv: Open file with comma-separated values
Reader::__construct() — Method in class Reader: Open file
Reader::__destruct() — Method in class Reader
Tsv::__construct() — Method in class Tsv: Open file with tab-separated values
EnvException::__construct() — Method in class EnvException: Create a new exception instance, optionally adjusting file and line based on a specific stack trace depth.
EnvFile::__construct() — Method in class EnvFile: Load variable from .env or from cache (if avaliable)
EnvFile::__set() — Method in class EnvFile: Magic method for set a manual entry
EnvFile::__get() — Method in class EnvFile: Magic method for get specific entry
CookieJar::__construct() — Method in class CookieJar
CookieJar::__get() — Method in class CookieJar: Magic method for get property value from jar
CookieJar::__set() — Method in class CookieJar: Magic method for set or remove cookie jar properties
CookieJar::__isset() — Method in class CookieJar: Magic method for check if variable is setted
FileResponse::__construct() — Method in class FileResponse: Initialize the response with a file path and optional download name
Forwarded::__construct() — Method in class Forwarded: Constructor.
Method::__construct() — Method in class Method: Create a Method instance
Method::__toString() — Method in class Method: Get method from $_POST or $_GET or headers
Size::__construct() — Method in class Size: Define supported modes
Size::__destruct() — Method in class Size
Negotiation::__construct() — Method in class Negotiation: Create a Negotiation instance from request headers or from a Array
Import::__construct() — Method in class Import
Package::__construct() — Method in class Package
Session::__construct() — Method in class Session: Reads and stores session data and creates a cookie
Session::__get() — Method in class Session: Magic method for get session variables (this method also returns variables that have not yet been committed)
Session::__set() — Method in class Session: Magic method for set session variables (this method don't commit data)
Session::__isset() — Method in class Session: Magic method for check if variable is setted (this method also returns variables that have not yet been committed)
Session::__unset() — Method in class Session: Magic method for unset variable with unset() function
Session::__destruct() — Method in class Session
Url::__construct() — Method in class Url: Parse URL
Url::__get() — Method in class Url: Get value for a URL component
Url::__set() — Method in class Url: Set value for a URL component
Url::__toString() — Method in class Url: Compose string
Version::__construct() — Method in class Version: Parse version format
Version::__get() — Method in class Version: Get value for a version component
Version::__set() — Method in class Version: Set value for a version component
Version::__toString() — Method in class Version: Compose string