Index | Inphinit API

A

App — Class in namespace Inphinit
Cache::allowHeaders() — Method in class Cache: Check if is HEAD or GET, you can overwrite this method
Dir::application() — Method in class Dir: Return items from application folder
Helper::assoc() — Method in class Helper: Check if array is associative, like [ 'bar' => foo', 'baz' => 'bar']
Negotiation::acceptLanguage() — Method in class Negotiation: Get all languages by Accept-Language header sorted by q-factor (defined by $level)
Negotiation::acceptCharset() — Method in class Negotiation: Get all languages by Accept-Charset header and sort by q-factor (defined by $level)
Negotiation::acceptEncoding() — Method in class Negotiation: Get all languages by Accept-Encoding header and sort by q-factor (defined by $level)
Negotiation::accept() — Method in class Negotiation: Get all document types by Accept header and sorted by q-factor (defined by $level)
Packages::auto() — Method in class Packages: Auto import composer packages
Regex::args() — Method in class Regex: Convert one argument like {:[a-z]+:} to ([a-z]+), this function is used by Router::parse
Redirector::action() — Method in class Redirector: Redirect to route based
Shell::arguments() — Method in class Shell: Get arguments
Storage::autoclean() — Method in class Storage: Clear old files in a folder from storage path

B

Redirect::back() — Method in class Redirect: Return to redirect to new path

C

Cache — Class in namespace Inphinit
Cache::cached() — Method in class Cache: Checks if page (from route) is already cached.
Config — Class in namespace Inphinit
Debug::classes() — Method in class Debug: Get declared classes
Debug::caller() — Method in class Debug: Get backtrace php scripts
Selector::count() — Method in class Selector: Count all nodes matching the given CSS selector
Form::comboRange() — Method in class Form: Generate combo by range
Form::combo() — Method in class Form: Create a select combo based in an array
File::clearstat() — Method in class File: Clear state files and clear size files in Inphinit\File::size
Helper::capitalize() — Method in class Helper: Capitalize words using hyphen or a custom delimiter.
Request::cookie() — Method in class Request: Get a value from $_COOKIE (support path using dots)
Response::cache() — Method in class Response: Set header to cache page (or no-cache)
Response::charset() — Method in class Response: Set charset in content-type
Packages::classmap() — Method in class Packages: Load autoload_classmap.php classes
Group::create() — Method in class Group: Create a new route group
Group::checkSecurity() — Method in class Group: Method is used for check if HTTPS or HTTP or both
Group::checkDomain() — Method in class Group: Method is used for check domain and return arguments if using regex
Group::checkPath() — Method in class Group: Method is used for check path
Quick::create() — Method in class Quick: Create routes based in a \Controller
Quick::canonical() — Method in class Quick: Define route format, Quick::BOTH for create routes like /foo/ and /foo, Quick::SLASH for create routes like /foo/ and Quick::NOSLASH for create routes like /foo
Rest::create() — Method in class Rest: Create REST routes based in a \Controller
Rest::charset() — Method in class Rest: Define the Content-Type charset
Session::commit() — Method in class Session: Lock session file and save variables
Storage::createFolder() — Method in class Storage: Create a folder in storage using 0700 permission (if unix-like)
Uri::canonpath() — Method in class Uri: Canonicalize paths
Uri::canonquery() — Method in class Uri: Reorder querystring by "keys" if: Uri::canonquery('z=1&u=2&a=5') returns a=5&u=2&z=1

D

Debug — Class in namespace Inphinit
Document — Class in namespace Inphinit\Dom
DomException — Class in namespace Inphinit\Dom
Dir — Class in namespace Inphinit\Experimental
Response::dispatch() — Method in class Response: Define registered headers to response
Response::download() — Method in class Response: Force download current page
Maintenance::down() — Method in class Maintenance: Down site to maintenance mode
Group::domain() — Method in class Group: Define domain for group
$Uri#defaultPorts — Property in class Uri: Define default port to schemes, you can customize in a extended class If put a new port with scheme he is removed in final url, eg. 'myscheme:900', ClassExtendedFromUri::normalize('myscheme://host:900/test') => myscheme://host/test
$Uri#defaultSchemes — Property in class Uri: Define default schemes, you can customize in a extended class If put a new scheme the host is converted to lower-case, eg. 'whatsapp', Uri::normalize('whatsapp://SEND?text=foo') => whatsapp://send?text=foo
View::dispatch() — Method in class View: Starts rendering of registered views. After calling this method call it will automatically execute View::forceRender()
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::env() — Method in class App: Set or get environment value
App::exec() — Method in class App: Start application using routes
Exception — Class in namespace Inphinit
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
File::encoding() — Method in class File: Determines whether the file is binary
Helper::extract() — Method in class Helper: Read array or object by path using dot
Maintenance::enable() — Method in class Maintenance: Enable/disable maintenance mode
Uri::encodepath() — Method in class Uri: Convert text to URL format
View::exists() — Method in class View: Check if view exists in ./application/View/ folder

F

Cache::finish() — Method in class Cache: Write cache
Document::fromArray() — Method in class Document: Convert a array in node elements
Document::first() — Method in class Document: Use query-selector like CSS, jQuery, querySelector
Form — Class in namespace Inphinit\Experimental
File — Class in namespace Inphinit
Negotiation::fromString() — Method in class Negotiation: Create a Negotiation instance based in string (eg.: `curl_opt(.
Request::file() — Method in class Request: Get a value from $_FILES (support path using dots)
Router::find() — Method in class Router: Get params from routes using regex
View::forceRender() — Method in class View: Force the View::render method to render at the time it is called

G

Config::get() — Method in class Config: Get all values like array or get specific item by level (multidimensional) using path
Document::getNamespaces() — Method in class Document: Get namespace attributes from root element or specific element
Selector::get() — Method in class Selector: Returns a \DOMNodeList containing all nodes matching the given CSS selector
Negotiation::getLanguage() — Method in class Negotiation: Get the first language with with the greatest q-factor, if it does not exist then return the value of $alternative
Negotiation::getCharset() — Method in class Negotiation: Get the first charset with with the greatest q-factor, if it does not exist then return the value of $alternative
Negotiation::getEncoding() — Method in class Negotiation: Get the first encoding with with the greatest q-factor, if it does not exist then return the value of $alternative
Negotiation::getAccept() — Method in class Negotiation: Get the first "document type" with the greatest q-factor, if it does not exist then return the value of $alternative
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 array( 'baz' => 'bar' => 1); use Request::get('foo.bar.baz'); for return 1
Response::getHeaders() — Method in class Response: Get registered headers
Packages::get() — Method in class Packages: Get libs
Group — Class in namespace Inphinit\Routing
Route::get() — Method in class Route: Get action controller from current route
Session::get() — Method in class Session: Get all values like array or get specific item by level (multidimensional) using path

H

Helper — Class in namespace Inphinit
Negotiation::header() — Method in class Negotiation: Parse any header like TE header or headers with Accepet- prefix
Request::header() — Method in class Request: Get HTTP headers from current request
$Router#httpRoutes — Property in class Router: Store normal routes
$Router#httpParamRoutes — Property in class Router: Store param routes
Shell::hasArgs() — Method in class Shell: Check if using arguments

I

Form::input() — Method in class Form: Create a input or textarea
Helper::iterable() — Method in class Helper: Equivalent to is_iterable from PHP-7.1.0+
Request::is() — Method in class Request: Check if is a specific HTTP method, HTTPS, and xmlhttprequest (Depends on how an ajax call was made)
Maintenance::ignoreif() — Method in class Maintenance: Up the site only in certain conditions, eg. the site administrator of the IP.
Packages::inAutoload() — Method in class Packages: Load ./system/boot/namespaces.php classes
Shell::isCli() — Method in class Shell: Check if script is executed in CLI
Shell::input() — Method in class Shell: Get input data

J

Request::json() — Method in class Request: Get a value input handler

K

Helper::ksort() — Method in class Helper: Check if array is associative, like [ 'bar' => foo', 'baz' => 'bar']

L

Config::load() — Method in class Config: Create a Negotiation instance
$Document#levels — Property in class Document: Used with Document::reporting method or in extended classes
Document::loadXML() — Method in class Document: Load XML from a string
Document::load() — Method in class Document: Load XML from a file
Document::loadHTML() — Method in class Document: Load HTML from a string
Document::loadHTMLFile() — Method in class Document: Load HTML from a file
File::lines() — Method in class File: Read lines from a file
Packages::logs() — Method in class Packages: Get log

M

Cache::match() — Method in class Cache: Check HTTP_IF_MODIFIED_SINCE and HTTP_IF_NONE_MATCH from server If true you can send 304 Not Modified
File::mime() — Method in class File: Get mimetype from file, return false if file is invalid
Status::message() — Method in class Status: Get message by HTTP code
Maintenance — Class in namespace Inphinit

N

Negotiation — Class in namespace Inphinit\Http
Uri::normalize() — Method in class Uri: Normalize URL, include canonicalized path

O

App::on() — Method in class App: Register an event
App::off() — Method in class App: Unregister 1 or all events
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
Redirect::only() — Method in class Redirect: Redirect and stop application execution
Shell::observer() — Method in class Shell: Add callback event to input

P

Debug::performance() — Method in class Debug: Get memory usage and you can also use it to calculate runtime.
File::permission() — Method in class File: Get file/folder permissions in a format more readable.
File::portion() — Method in class File: Read excerpt from a file
Helper::parseVersion() — Method in class Helper: Parse version format
Request::path() — Method in class Request: Get current HTTP path or route 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 array( 'baz' => 'bar' => 1); use Request::post('foo.bar.baz');
Response::putHeader() — Method in class Response: Register a header and return your index, if Response::dispatch was previously executed the header will be set directly and will not be registered
Packages — Class in namespace Inphinit
Packages::psr0() — Method in class Packages: Load autoload_namespaces.php classes, used by PSR-0 packages
Packages::psr4() — Method in class Packages: Load autoload_psr4.php classes, used by PSR-4 packages
Regex::parse() — Method in class Regex: Parse string like.: {:[a-z]+:}.domain.com or /user/{:[a-z]+:}/{:\d+:} to regex
Group::prefixNS() — Method in class Group: Define namespace prefix for group
Group::path() — Method in class Group: Define path for group
Quick::path() — Method in class Quick: Define prefix path for all routes in class
Quick::prepare() — Method in class Quick: Create routes by configurations
Rest::path() — Method in class Rest: Define prefix path for all routes in class
Rest::prepare() — Method in class Rest: Define routes
$Router#prefixNS — Property in class Router: Define namespace prefix to Controllers
$Router#prefixPath — Property in class Router: Define path prefix to routes
Storage::path() — Method in class Storage: Get absolute path from storage location
Storage::put() — Method in class Storage: Create a file in a folder in storage or append data to existing file

Q

Document::query() — Method in class Document: Use query-selector like CSS, jQuery, querySelectorAll
Negotiation::qFactor() — Method in class Negotiation: Parse and sort a custom value with q-factor
Request::query() — Method in class Request: Get querystring, this method is useful for anyone who uses IIS.
Quick — Class in namespace Inphinit\Routing

R

Config::reload() — Method in class Config: Reload configuration from file
Debug::renderError() — Method in class Debug: Render a View to error
Debug::renderPerformance() — Method in class Debug: Render a View to show performance, memory and time to display page
Debug::renderClasses() — Method in class Debug: Render a View to show performance and show declared classes
Document::reporting() — Method in class Document: Set level error for exception, set LIBXML_ERR_NONE (or 0 - zero) for disable exceptions.
Dir::root() — Method in class Dir: Return items from root project folder (probably, will depend on the setting of the INPHINIT_ROOT constant)
Redirect — Class in namespace Inphinit\Http
Request — Class in namespace Inphinit\Http
Request::raw() — Method in class Request: Get a value input handler
Response — Class in namespace Inphinit\Http
Response::removeHeader() — Method in class Response: Remove registered (or setted) header
Regex — Class in namespace Inphinit
Redirector — Class in namespace Inphinit\Routing
Redirector::route() — Method in class Redirector: Redirect to route based
Rest — Class in namespace Inphinit\Routing
Route — Class in namespace Inphinit\Routing
Router — Class in namespace Inphinit\Routing
Session::regenerate() — Method in class Session: Regenerate ID
Storage::resolve() — Method in class Storage: Convert path to storage path
Storage::remove() — Method in class Storage: Delete a file in storage
Storage::removeFolder() — Method in class Storage: Remove recursive folders in storage folder
Uri::root() — Method in class Uri: Create URL based in public root application, for example, if you install inphinit in a sub path like: http://site/foo/bar/myapplication/
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::state() — Method in class App: Return application state
App::stop() — Method in class App: Stop application, send HTTP status
Cache::show() — Method in class Cache: Show cache content from current page (from route) in output
Config::save() — Method in class Config: Reload configuration from file
Config::set() — Method in class Config: Set value by path in specific level (multidimensional)
Debug::source() — Method in class Debug: Get snippet from a file
Debug::searcherror() — Method in class Debug: Convert error message in a link, see system/config/debug.php
Selector — Class in namespace Inphinit\Dom
Dir::storage() — Method in class Dir: Return items from storage folder
Form::setup() — Method in class Form: Define default attributes for all elements
File::size() — Method in class File: Get file size, support for read files with more of 2GB in 32bit.
Helper::seq() — Method in class Helper: Check if array is sequential, like ['foo', 'bar']
Response::status() — Method in class Response: Get or set status code and return last status code
Status — Class in namespace Inphinit\Http: Constant with the most common HTTP codes
Packages::save() — Method in class Packages: Save imported packages path to file in PHP format
Group::secure() — Method in class Group: Access only with HTTPS, or only HTTP, or both
Route::set() — Method in class Route: Register or remove a action from controller for a route
Session — Class in namespace Inphinit
Shell — Class in namespace Inphinit
Storage — Class in namespace Inphinit

T

App::trigger() — Method in class App: Trigger registered event
Document::toJson() — Method in class Document: Convert DOM to JSON string
Document::toArray() — Method in class Document: Convert DOM to Array
Helper::toAscii() — Method in class Helper: Convert string to ASCII
Redirect::to() — Method in class Redirect: Redirects to a valid path within the application
Response::type() — Method in class Response: Set content-type
Group::then() — Method in class Group: Define callback for group, this callback is executed if the request meets the group settings
Rest::type() — Method in class Rest: Define the Content-Type header
Storage::temp() — Method in class Storage: Create a tmp in storage/tmp folder

U

Debug::unregister() — Method in class Debug: Unregister debug events
Maintenance::up() — Method in class Maintenance: Up site
Uri — Class in namespace Inphinit

V

Debug::view() — Method in class Debug: Register a debug views
Packages::version() — Method in class Packages: Get package version from composer.lock file
View — Class in namespace Inphinit\Viewing

W

Cache::write() — Method in class Cache: Write data in cache file.
Storage::write() — Method in class Storage: Create a file in a folder or overwrite existing file

X

Form::xhtml() — Method in class Form: Define new forms for use xhtml (<input />) or html format (<input>)
Request::xml() — Method in class Request: Create a Document instance from HTTP request

_

Cache::__construct() — Method in class Cache: Create a cache instance by route path
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 by ->
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
Document::__construct() — Method in class Document: Create a Document instance
Document::__toString() — Method in class Document: Magic method, return a well-formed XML string
DomException::__construct() — Method in class DomException: Raise an exception
Exception::__construct() — Method in class Exception: Raise an exception
Dir::__construct() — Method in class Dir: Return items from a folder
Negotiation::__construct() — Method in class Negotiation: Create a Negotiation instance
Packages::__construct() — Method in class Packages: Create a Inphinit\Packages instance.
Quick::__construct() — Method in class Quick: Create routes based in a \Controller
Rest::__construct() — Method in class Rest: Create REST routes based in a \Controller
Session::__construct() — Method in class Session: Create cookie session and configure session
Session::__clone() — Method in class Session: Prevent clone session object
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
Shell::__construct() — Method in class Shell: Create a Shell instance for use CLI interface