PHPdocs keywords

List of keywords used in phpdoc attributes.

Keyword Value Count
@TODO We don't need to accept null as $uri. 1
Fix a root cause, and this method should be removed. 1
move this to BaseBuilder in 4.5.0 1
if Entity::$casts is readonly, we don't need this method. 1
should be private 1
null for param $uri should be removed. 1
PSR-7: Should be `withUserInfo($user, $password = null)`. 1
PSR-7: Should be `withHost($host)`. 1
PSR-7: Should be `withPort($port)`. 1
PSR-7: Should be `withPath($port)`. 1
PSR-7: Should be `withQuery($query)`. 1
PSR-7: Should be `withFragment($fragment)`. 1
Incompatible return type with PSR-7 1
remove this before v4.6.0 release 1
This method should be moved to an interface that represents foreign key support. 2
Incompatible return value with PSR-7 2
The default controller is only for auto-routing. So this should be 2
This method is not related to the route collection. So this should 2
Fix to camelCase in the next major version. 4
This method is only for auto-routing. So this should be removed in 4
@codeCoverageIgnore This is too exotic 1
Cannot be tested fully as PHPUnit always run in php-cli 1
Not practical to test, as travis runs on linux 1
Can't be tested ... exits 1
* @see \CodeIgniter\Filters\CSRFTest 1
* 11
*/ 25
@deprecated The type 'basic', 'md5', and 'sha1' are deprecated. They are not cryptographically secure. 1
Use Time instead. 1
in favor of the Cache config 1
4.4.0 Moved to ResponseCache::$ttl. No longer used. 1
4.5.0 Will move to MySQLi\Connection. 1
`Config\Cookie` $samesite property is used. 1
4.4.0 Use $this->config->redirect. 1
4.4.0 Use $this->config->expires. 1
4.4.0 Use $this->config->regenerate. 1
4.4.0 Use $this->config->headerName. 1
4.4.0 Use $this->config->tokenName. 1
4.4.0 Use $this->config->csrfProtection. 1
4.4.0 Use $this->config->tokenRandomize. 1
4.4.2 Should be protected, and no longer used. 1
4.4.2 Should be protected. 1
Will become private in a future release 1
This property will be private. 1
4.4.0 Not used. 1
4.4.0 Use SiteURI instead. 1
Use $this->config->matchIP. 1
Use $this->config->expiration. 1
Use $this->config->savePath. 1
Use $this->config->driver. 1
Use $this->config->cookieName. 1
Use $this->config->regenerateDestroy. 1
Use $this->config->timeToUpdate. 1
$returnResponse is deprecated. 1
4.4.0 No longer used. Moved to index.php and spark. 1
4.5.0 No longer used. Moved to ForceHTTPS filter. 1
4.5.0 PageCache required filter is used. No longer used. 1
4.4.2 The parameter $config is deprecated. No longer used. 1
4.4.0 Moved to ResponseCache::setTtl(). No longer used. 1
4.5.0 PerformanceMetrics required filter is used. No longer used. 1
$cacheConfig is deprecated. 1
4.4.2 Use Registrar instead. 1
4.6.0 Already does not work. 1
$ifNotExists is no longer used, and will be removed. 1
Use `error()` instead. 1
4.6.1 Use `write_file()` instead. 1
4.6.1 Use `delete_files()` instead. 1
4.6.1 Use `get_dir_file_info()` instead. 1
4.6.1 Use `get_file_info()` instead. 1
The parameter $config and $getShared are deprecated. 1
Use injectRawData() instead. 1
Use setPad() instead. 1
4.3.0 Use `is_windows()` instead 1
use generateClass() instead 1
Since v4.5.6 1
4.4.4 This method does not work from the beginning. Use `env()`. 1
4.5.0 The param $config is no longer used. 1
4.0.5 Use withMethod() instead for immutability 1
4.4.0 Method not in PSR-7 1
4.4.0 This method will be private. 1
This method will be deleted. 1
4.4.0 Use `withScheme()` instead. 1
4.4.0 This method will be private. The parameter $config is deprecated. No longer used. 1
Use Message::headers() to make room for PSR-7 1
Use Message::header() to make room for PSR-7 1
Use withMethod() instead for immutability 1
4.6.0 Use getSizeByBinaryUnit() or getSizeByMetricUnit() instead 1
Use createFromInstance() instead 1
No longer used. See https://github.com/codeigniter4/CodeIgniter4/issues/7055 1
4.4.0 No longer used. Moved to ExceptionHandler. 1
Use dedicated `clean_path()` function. 1
Use the dedicated `clean_path()` function. 1
Use destroy() instead. 1
* 1
Unused. 1
Unused. Now uses buildReverseRoute(). 1
this function name does not properly describe its behavior so it has been deprecated 1
Not used. Moved to AutoRouter class. 1
Moved to AutoRouter class. 1
This was an unnecessary method, so it is no longer used. 1
4.6.0 No longer used. 2
4.5.0 Moved to system/bootstrap.php. 2
4.4.0 No longer Used. Moved to index.php. 2
4.6.2 Use `sanitize_filename()` instead 2
Use `CookieException::forInvalidSameSite()` instead. 2
This method will be private. 2
Use SiteURI instead. 2
This is no longer used. 3
4.5.0 No longer used. 3
4.5.0 Moved to Autoloader. 3
4.4.0 Moved to SiteURIFactory. 3
4.4.0 No longer used. 4
No longer used. 5
This method should be removed. 5
*/ 7
4.4.0 No longer used. Moved to BaseExceptionHandler. 8
@extends BaseConnection 1
BaseResult 1
BasePreparedQuery 1
BaseConnection 1
BaseResult 1
BasePreparedQuery 1
BaseConnection 1
BaseResult 1
BasePreparedQuery 1
BaseConnection 1
BaseResult 1
BaseConnection 2
BaseResult 2
BasePreparedQuery 2
@final */ 1
@function mount() 1
@immutable */ 1
@implements ResultInterface 1
ConnectionInterface 1
PreparedQueryInterface 1
IteratorAggregate 1
@inheritDoc */ 5
@interal This is internal implementation for the framework. 1
*/ 2
* 3
@internal Outside the framework this should not be used directly. 1
* @see \CodeIgniter\SuperglobalsTest 1
* @see \CodeIgniter\HotReloader\DirectoryHasherTest 1
Used for marking nullable fields. Not covered by BC promise. 1
Used for framework testing, should not be relied on otherwise 1
This is a temporary solution. 1
for testing purposes only 1
param int $maxRequests 1
For test purpose only. 1
For `spl_autoload_register` use. 2
For testing purposes only. 3
For testing only 3
For caching only 3
Used for testing purposes only. 4
* 7
*/ 25
@license https://creativecommons.org/publicdomain/zero/1.0/ CC0 1.0, Public Domain 1
@method $this groupBy($by, ?bool $escape = null) 1
$this groupEnd() 1
$this groupStart() 1
$this having($key, $value = null, ?bool $escape = null) 1
$this havingGroupEnd() 1
$this havingGroupStart() 1
$this havingIn(?string $key = null, $values = null, ?bool $escape = null) 1
$this havingLike($field, string $match = '', string $side = 'both', ?bool $escape = null, bool $insensitiveSearch = false) 1
$this havingNotIn(?string $key = null, $values = null, ?bool $escape = null) 1
$this join(string $table, string $cond, string $type = '', ?bool $escape = null) 1
$this like($field, string $match = '', string $side = 'both', ?bool $escape = null, bool $insensitiveSearch = false) 1
$this limit(?int $value = null, ?int $offset = 0) 1
$this notGroupStart() 1
$this notHavingGroupStart() 1
$this notHavingLike($field, string $match = '', string $side = 'both', ?bool $escape = null, bool $insensitiveSearch = false) 1
$this notLike($field, string $match = '', string $side = 'both', ?bool $escape = null, bool $insensitiveSearch = false) 1
$this offset(int $offset) 1
$this orderBy(string $orderBy, string $direction = '', ?bool $escape = null) 1
$this orGroupStart() 1
$this orHaving($key, $value = null, ?bool $escape = null) 1
$this orHavingGroupStart() 1
$this orHavingIn(?string $key = null, $values = null, ?bool $escape = null) 1
$this orHavingLike($field, string $match = '', string $side = 'both', ?bool $escape = null, bool $insensitiveSearch = false) 1
$this orHavingNotIn(?string $key = null, $values = null, ?bool $escape = null) 1
$this orLike($field, string $match = '', string $side = 'both', ?bool $escape = null, bool $insensitiveSearch = false) 1
$this orNotGroupStart() 1
$this orNotHavingGroupStart() 1
$this orNotHavingLike($field, string $match = '', string $side = 'both', ?bool $escape = null, bool $insensitiveSearch = false) 1
$this orNotLike($field, string $match = '', string $side = 'both', ?bool $escape = null, bool $insensitiveSearch = false) 1
$this orWhere($key, $value = null, ?bool $escape = null) 1
$this orWhereIn(?string $key = null, $values = null, ?bool $escape = null) 1
$this orWhereNotIn(?string $key = null, $values = null, ?bool $escape = null) 1
$this select($select = '*', ?bool $escape = null) 1
$this selectAvg(string $select = '', string $alias = '') 1
$this selectCount(string $select = '', string $alias = '') 1
$this selectMax(string $select = '', string $alias = '') 1
$this selectMin(string $select = '', string $alias = '') 1
$this selectSum(string $select = '', string $alias = '') 1
$this when($condition, callable $callback, ?callable $defaultCallback = null) 1
$this whenNot($condition, callable $callback, ?callable $defaultCallback = null) 1
$this where($key, $value = null, ?bool $escape = null) 1
$this whereIn(?string $key = null, $values = null, ?bool $escape = null) 1
$this whereNotIn(?string $key = null, $values = null, ?bool $escape = null) 1
static BaseConfig|null config(...$arguments) 1
static Model|null models(string $alias, array $options = [], ?ConnectionInterface &$conn = null) 1
static CacheInterface cache(Cache $config = null, $getShared = true) 1
static CLIRequest clirequest(App $config = null, $getShared = true) 1
static CodeIgniter codeigniter(App $config = null, $getShared = true) 1
static Commands commands($getShared = true) 1
static void createRequest(App $config, bool $isCli = false) 1
static ContentSecurityPolicy csp(CSPConfig $config = null, $getShared = true) 1
static CURLRequest curlrequest($options = [], ResponseInterface $response = null, App $config = null, $getShared = true) 1
static Email email($config = null, $getShared = true) 1
static EncrypterInterface encrypter(Encryption $config = null, $getShared = false) 1
static Exceptions exceptions(ConfigExceptions $config = null, $getShared = true) 1
static Filters filters(ConfigFilters $config = null, $getShared = true) 1
static Format format(ConfigFormat $config = null, $getShared = true) 1
static Honeypot honeypot(ConfigHoneyPot $config = null, $getShared = true) 1
static BaseHandler image($handler = null, Images $config = null, $getShared = true) 1
static IncomingRequest incomingrequest(?App $config = null, bool $getShared = true) 1
static Iterator iterator($getShared = true) 1
static Language language($locale = null, $getShared = true) 1
static Logger logger($getShared = true) 1
static MigrationRunner migrations(Migrations $config = null, ConnectionInterface $db = null, $getShared = true) 1
static Negotiate negotiator(RequestInterface $request = null, $getShared = true) 1
static Pager pager(ConfigPager $config = null, RendererInterface $view = null, $getShared = true) 1
static Parser parser($viewPath = null, ConfigView $config = null, $getShared = true) 1
static RedirectResponse redirectresponse(App $config = null, $getShared = true) 1
static View renderer($viewPath = null, ConfigView $config = null, $getShared = true) 1
static IncomingRequest|CLIRequest request(App $config = null, $getShared = true) 1
static ResponseInterface response(App $config = null, $getShared = true) 1
static ResponseCache responsecache(?Cache $config = null, ?CacheInterface $cache = null, bool $getShared = true) 1
static Router router(RouteCollectionInterface $routes = null, Request $request = null, $getShared = true) 1
static RouteCollection routes($getShared = true) 1
static Security security(App $config = null, $getShared = true) 1
static Session session(ConfigSession $config = null, $getShared = true) 1
static SiteURIFactory siteurifactory(App $config = null, Superglobals $superglobals = null, $getShared = true) 1
static Superglobals superglobals(array $server = null, array $get = null, bool $getShared = true) 1
static Throttler throttler($getShared = true) 1
static Timer timer($getShared = true) 1
static Toolbar toolbar(ConfigToolbar $config = null, $getShared = true) 1
static Typography typography($getShared = true) 1
static URI uri($uri = null, $getShared = true) 1
static ValidationInterface validation(ConfigValidation $config = null, $getShared = true) 1
static Cell viewcell($getShared = true) 1
@mixin DOMParser 1
CIUnitTestCase 2
@param list $excludeDirs 1
class-string|string $name 1
string $name Name of the cookie 1
string $value Value of the cookie 1
array $options Array of options to be passed to the cookie 1
list $cookies If `getGlobal` is false, this is passed to CookieStore's constructor 1
bool $getGlobal If false, creates a new instance of CookieStore 1
array|ConnectionInterface|string|null $db 1
array|bool|float|int|object|string|null $default 1
array|string $data 1
string|null $encoding Current encoding for escaping. 1
int $duration How long should the SSL header be set for? (in seconds) 1
string $functionName Function to check for 1
array|string $filenames 1
class-string|string $name 1
string|null $default 1
'attr'|'css'|'html'|'js'|'raw'|'url'|false $escape 1
non-empty-string|null $route Route name or Controller::method 1
DocTypes|null $docTypesConfig New config. For testing purpose only. 1
string $method Route name or Controller::method 1
string $item Config item name 1
array|object|string $attributes string, array, object that can be cast to array 1
non-empty-string|null $name 1
(callable(): mixed)|null $callable 1
array $options Options for saveData or third-party extensions. 1
string $trait 1
bool $newReturn return value to set 1
bool $returnObject True to return an object instead of a string 1
IncomingRequest|null $request A request to use when retrieving the path 1
App|null $altConfig Alternate configuration to use 1
array|string $uri URI string or array of URI segments 1
string $title The link title 1
array|object|string $attributes Any attributes 1
App|null $altConfig Alternate configuration to use 1
string $uri the URL 1
string $title the link title 1
array|false|object|string $attributes any attributes 1
App|null $altConfig Alternate configuration to use 1
string $str the string 1
string $type the type: email, url, or both 1
bool $popup whether to create pop-up links 1
string $str the URL 1
bool $secure set true if you want to force https:// 1
string $controller Route name or Controller::method 1
int|string ...$args One or more parameters to be passed to the route. 1
string $action the URI segments of the form destination 1
array|string $attributes a key/value pair of attributes, or string representation 1
array $hidden a key/value pair hidden data 1
string $action The URI segments of the form destination 1
array|string $attributes A key/value pair of attributes, or the same as a string 1
array $hidden A key/value pair hidden data 1
array|string $name Field name or associative array to create multiple fields 1
array|string $value Field value 1
array|string $name 1
array|string $options 1
array|string $selected 1
array|object|string $extra string, array, object that can be cast to array 1
string $labelText The text to appear onscreen 1
string $id The id the label applies to 1
string $legendText The legend text 1
string $field Field name 1
list|string $default Default value 1
bool $htmlEscape Whether to escape HTML special characters or not 1
array|string $attributes List of attributes 1
array $default Default values 1
non-empty-string|null $timezone 1
string $class Optional class to apply to the select field 1
string $default Default value for initial selection 1
int $what One of the DateTimeZone class constants (for listIdentifiers) 1
string $country A two-letter ISO 3166-1 compatible country code (for listIdentifiers) 1
array|string $src Image source URI, or array of attributes and values 1
bool $indexPage Should `Config\App::$indexPage` be added to the source path 1
array|object|string $attributes Additional HTML attributes 1
string $path Image source path 1
string|null $mime MIME type to use, or null to guess 1
string $type The doctype to be generated 1
array|string $src Script source or an array of attributes 1
bool $indexPage Should `Config\App::$indexPage` be added to the JS path 1
array|string $href Stylesheet href or an array 1
bool $indexPage Should `Config\App::$indexPage` be added to the CSS path. 1
string $unsupportedMessage The message to display if the media tag is not supported by the browser 1
string $unsupportedMessage The message to display if the media tag is not supported by the browser. 1
string $unsupportedMessage The message to display if the media tag is not supported by the browser. 1
string $src The path of the media resource 1
string $type The MIME-type of the resource with optional codecs parameters 1
string $src The path of the .VTT file 1
string $kind How the text track is meant to be used 1
string $srcLanguage Language of the track text data 1
string $label A user-readable title of the text track 1
string $data A resource URL 1
string $type Content-type of the resource 1
bool $indexPage Should `Config\App::$indexPage` be added to the data path 1
string $name The name of the parameter 1
string $value The value of the parameter 1
string $type The MIME-type 1
string $src The path of the resource to embed 1
string $type MIME-type 1
array $array the reference of the array to be sorted 1
array $sortColumns an associative array of columns to sort 1
iterable $array The multi-dimensional array 1
string $id Something to initially prepend to the flattened keys 1
string $filename Input file name 1
string $str the text string 1
array $censored the array of censored words 1
string $replacement the optional replacement value 1
string $str the text string 1
string $str the text string 1
string $phrase the phrase you'd like to highlight 1
string $tagOpen the opening tag to precede the phrase with 1
string $tagClose the closing tag to end the phrase with 1
string $str Input string 1
string $str the text string 1
int $charlim = 76 the number of characters to wrap at 1
string $str String to ellipsize 1
int $maxLength Max length of string 1
float|int $position int (1|0) or float, .5, .2, etc for position to split 1
string $ellipsis ellipsis ; Default '...' 1
array|string $str string or array 1
string $character the character you wish to reduce 1
bool $trim TRUE/FALSE - whether to trim the character from the beginning/end 1
string $type Type of random string. basic, alpha, alnum, numeric, nozero, md5, sha1, and crypto 1
int $len Number of characters 1
string $str Required 1
string $separator What should the duplicate number be appended with 1
int $first Which number should be used for the first dupe increment 1
string ...$args (as many parameters as needed) 1
string $text String to search the phrase 1
string $phrase Phrase that will be searched for. 1
int $radius The amount of characters returned around the phrase. 1
string $ellipsis Ending that will be appended 1
int|string $num Will be cast as int 1
non-empty-string|null $locale [optional] 1
int|string $num Will be cast as int 1
int $precision [optional] The optional number of decimal digits to round to. 1
non-empty-string|null $locale [optional] 1
int|string $num it will convert to int 1
Model|object|string $model Instance or name of the model 1
array|null $overrides Overriding data to pass to Fabricator::setOverrides() 1
bool $persist 1
string $className Fully qualified class name 1
string $value The value of the cookie 1
int $expire The number of seconds until expiration 1
string $domain For site-wide cookie. Usually: .yourdomain.com 1
string $path The cookie path 1
string $prefix The cookie prefix ('': the default prefix) 1
bool|null $secure True makes the cookie secure 1
bool|null $httpOnly True makes the cookie accessible via http(s) only (no javascript) 1
string|null $sameSite The cookie SameSite value 1
string $index 1
string|null $prefix Cookie name prefix. 1
string $domain the cookie domain. Usually: .yourdomain.com 1
string $path the cookie path 1
string $prefix the cookie prefix 1
int $count Number of items 1
string $string Input string 1
string $separator Input separator 1
string $word Word to check 1
int $integer The integer to determine the suffix 1
int $integer The integer to ordinalize 1
string $sourceDir Path to source 1
int $directoryDepth Depth of directories to traverse 1
bool $hidden Whether to show hidden files 1
bool $overwrite Whether individual files overwrite on collision 1
string $path File path 1
string $data Data to write 1
string $mode fopen() mode (default: 'wb') 1
bool $hidden Whether to include hidden files (files beginning with a period) 1
string $sourceDir Path to source 1
bool|null $includePath Whether to include the path as part of the filename; false for no path, null for a relative path, true for full path 1
bool $hidden Whether to include hidden files (files beginning with a period) 1
bool $includeDir Whether to include directories 1
bool $recursion Internal variable to determine recursion status - do not use in calls 1
bool $checkExistence Checks to see if the path exists 1
string|null $proposedExtension - default extension (in case there is more than one with the same mime type) 1
FuncCall $node 1
ClassMethod|Closure|FileWithoutNamespace|Function_|Namespace_ $node 1
FunctionLike|Variable $node 1
TryCatch $node 1
int $duration The number of seconds this link should be 1
array $data The data to validate 1
string|null $dbGroup The database group to use 1
string $table Table 1
array|null $row Data 1
non-empty-string|null $table 1
array|object|string $key Field name, or an array of field/value pairs, or an object 1
bool|float|int|object|string|null $value Field value, if $key is a single field 1
bool|null $escape Whether to escape values 1
array|object $row Data 1
object $object Object 1
bool $recursive If true, inner entities will be cast as array as well 1
bool $returnResponse Used for testing purposes only. 1
int $duration How long the Strict Transport Security 1
RouteCollectionInterface|null $routes A collection interface to use in place 1
Controller $class 1
Cache|null $cacheConfig Deprecated. No longer used. 1
ResponseInterface|string|null $returned 1
string|URI $uri 1
'php-cli'|'web' $context 1
array|int|string|null $id ID 1
bool $reset Reset 1
bool $test Test 1
int $size Size 1
Closure(array|object): mixed $userFunc Callback Function 1
array|int|string|null $id One primary key or an array of primary keys 1
int $limit Limit 1
int $offset Offset 1
array|object|null $row Row data 1
bool|null $escape Whether to escape values 1
bool $testing True means only number of records is returned, false will execute the query 1
array|object|null $row Row data 1
string|null $index The where key 1
bool $returnSQL True means SQL is returned, false will execute the query 1
bool $val Value 1
bool $forceDB Always grab the db error, not validation 1
int|null $perPage Items per page 1
string $group Will be used by the pagination library to identify a unique pagination set. 1
int|null $page Optional page number (useful when the page number is provided in different way) 1
int $segment Optional URI segment number (if page number is provided by URI segment) 1
array $allowedFields Array with names of fields 1
bool $protect Value 1
int|null $userData An optional PHP timestamp to be converted. 1
int $value value 1
Time $value value 1
bool $skip Value 1
array $validationMessages Value 1
string $field Field Name 1
array $fieldMessages Validation messages 1
array|string>|string> $validationRules Value 1
string $field Field Name 1
array|string $fieldRules Validation rules 1
bool $choice Value 1
array $options Options 1
array $rules Array containing field name and rule 1
array $row Row data (@TODO Remove null in param type) 1
bool $val value 1
string $event Event 1
array $eventData Event Data 1
'object'|class-string $class Class Name 1
bool $recursive If true, inner entities will be cast as array as well 1
array $properties 1
bool $recursive If true, inner entities will be casted as array as well 1
array|object|null $row Row data 1
string $type Type of data (insert|update) 1
string $name Name 1
array $params Params 1
array $row Raw data from database 1
'array'|'object'|class-string $returnType 1
int $length Output length 1
string $data Input data 1
string $data Encrypted data 1
int $start 1
int $length 1
FiltersConfig $config 1
string $uri URI path relative to baseURL 1
list $filters `after` filter array 1
bool $remove if true, remove `toolbar` filter 1
string $filter filter_name or filter_name:arguments like 'role:admin,manager' 1
string $filter filter_name or filter_name:arguments like 'role:admin,manager' 1
list $filters filter_name or filter_name:arguments like 'role:admin,manager' 1
string $uri URI to test against 1
array|string $paths The path patterns to test 1
string $uri URI path relative to baseURL (all lowercase) 1
array|string $paths The except path patterns 1
string $uri URI path relative to baseURL (all lowercase, URL-decoded) 1
array $paths The except path patterns 1
array|string $tableName Table name. 1
string $driver Driver name. FQCN can be used. 1
string $class 'Connection'|'Forge'|'Utils' 1
array|ConnectionInterface $argument The constructor parameter or DB connection 1
string $driver DB driver or FQCN for custom driver 1
array|string $params 1
string $actualTable Actual table name 1
string $logicalTable Logical table name (w/o DB prefix) 1
string $schema Schema name 1
string $database Database name 1
string $alias Alias name 1
string $table Table name (w/o DB prefix) 1
string $alias Alias name 1
string $actualTable Actual table name with DB prefix 1
string $alias Alias name 1
string $table Table name (w/o DB prefix) 1
string $schema Schema name 1
string $database Database name 1
string $alias Alias name 1
array|BaseConnection|non-empty-string|null $group The name of the connection group to use, 1
bool $getShared Whether to return a shared instance of the connection. 1
array|ConnectionInterface|string|null $group 1
array|string|null $group 1
TConnection $connID 1
TResult $resultID 1
string $prefix The prefix 1
bool $mode = true 1
array|string|TableName $tableName 1
Closure(BaseConnection): mixed $func 1
array|int|string|TableName $item 1
bool $prefixSingle Prefix a table name with no segments? 1
bool $protectIdentifiers Protect table or column names? 1
bool $fieldExists Supplied $item contains a column name? 1
non-empty-string|TableName $item 1
array|string $item 1
list|string|Stringable $str Input string 1
bool $like Whether the string will be used in a LIKE condition 1
list|string|Stringable $str 1
bool $cached Whether to use data cache 1
array|ConnectionInterface|string|null $db DB group. For testing purposes only. 1
int $targetBatch Target batch number, or negative for a relative batch, 0 for all 1
string|null $group Deprecated. The designation has no effect. 1
string $path Full path to a valid migration file 1
string $path Namespace of the target migration 1
string $path Full path to a valid migration file. 1
object $object migration or $history 1
object $migration 1
object $history 1
string $order 1
string $direction "up" or "down" 1
object $migration The migration to run 1
list|string $fieldName 1
list|string $tableField 1
list|string $columnNames column names to DROP 1
'ADD'|'CHANGE'|'DROP' $alterType 1
array|string $processedFields Processed column definitions 1
array|string|TableName $tableName tablename or tablenames with or without aliases 1
list|RawSql|string $select 1
bool|null $escape Whether to protect identifiers 1
BaseBuilder $from Expected subquery 1
string $alias Subquery alias 1
array|BaseBuilder|(Closure(BaseBuilder):BaseBuilder)|null $values The values searched on, or anonymous function with subquery 1
non-empty-string|null $key 1
array|RawSql|string $field 1
array|string $by 1
array|object|string $key Field name, or an array of field/value pairs, or an object 1
mixed $value Field value, if $key is a single field 1
bool|null $escape Whether to escape values 1
array|string $where 1
'_deleteBatch'|'_insertBatch'|'_updateBatch'|'_upsertBatch' $renderMethod 1
array|object $set 1
string $alias alias for sql table 1
list|list|string $set 1
bool $addToDefault adds update fields to the default ones 1
array|null $ignore ignores items in set 1
array|RawSql|string $set a string of columns, key value pairs, or RawSql 1
BaseBuilder|RawSql $query 1
array|string|null $columns an array or comma delimited string of columns 1
mixed $key 1
string $table Protected table name 1
list $keys Keys of QBSet 1
list $unescapedKeys Values of QBSet 1
list $keys Keys of QBSet 1
list $values Values of QBSet 1
array|object|null $set 1
array|RawSql|string|null $where 1
string $table Protected table name 1
array $values QBSet 1
array|object|null $set a dataset 1
array|RawSql|string|null $constraints 1
array|object $key 1
array|RawSql|string $where 1
array|object|null $set a dataset 1
array|RawSql|null $constraints 1
list $keys QBKeys 1
list $values QBSet 1
array|string $table The table to inspect 1
mixed $selectOverride 1
string $qbKey 'QBWhere' or 'QBHaving' 1
array $qbResetItems An array of fields to reset 1
BaseBuilder|Closure(BaseBuilder): BaseBuilder $builder 1
bool $wrapped Wrap the subquery in brackets 1
string $alias Subquery alias 1
string $className The name of the class to use. 1
array|null $set An associative array of insert values 1
string $table Protected table name. 1
string $fieldName Field name. May be protected. 1
bool $reset Are we want to clear query builder values? 1
bool $selectOverride 1
array $options Options takes an associative array; 1
array $options 1
string $procedureName procedure name to execute 1
array $params params array keys 1
list|string $columnNames 1
list|string $columns Column names to drop. 1
list> $fieldsToModify 1
array|bool $fields 1
array $keys 1
list|string $str Input string 1
array|null $castHandlers Custom convert handlers 1
array|null $types [field => type] 1
object|null $helper Helper object. 1
bool $strict Strict mode? Set to false for casts for Entity. 1
array $types [field => type] 1
mixed $value The value to convert 1
string $field The field name 1
'get'|'set' $method Allowed to "get" and "set" 1
mixed $value Data from database driver 1
mixed $value PHP native value 1
string $key Cache item name 1
array|bool|float|int|object|string|null $value The data to save 1
int $ttl Time To Live, in seconds (default 60) 1
string $key Cache item name. 1
non-empty-string|null $handler 1
non-empty-string|null $backup 1
string $path 1
string $mode 1
int $_level Current directory depth level (default: 0; internal use only) 1
bool $_recursion Internal variable to determine recursion status - do not use in calls 1
string $key The key to validate 1
string $prefix Optional prefix to include in length calculations 1
string $key Cache item name 1
int $ttl Time to live 1
Closure(): mixed $callback Callback return value 1
string $pattern Cache items glob-style pattern 1
array|bool|float|int|object|string|null $val 1
string $key The name of the bucket 1
object|string $model Instance or classname of the model to use 1
array|null $formatters Array of property => formatter 1
string|null $locale Locale for Faker provider 1
int $count Count value 1
array $overrides Array of [field => value] 1
bool $persist Whether these overrides should persist through the next operation 1
bool $reset If set to true, resets the list of existing values 1
int $maxRetries Maximum number of retries to find a unique value, 1
float $weight A probability between 0 and 1, 0 means that we always get the default value. 1
Closure(mixed): bool|null $validator A function returning true for valid values 1
int $maxRetries Maximum number of retries to find a valid value, 1
array|null $formatters Array of [field => formatter], or null to detect 1
string $field Name of the field 1
string|null $className Class name of the object to create; null to use model default 1
bool $mock Whether to execute or mock the insertion 1
array|object|string $test 1
object|string $obj object or class name 1
string $method method name 1
object|string $obj 1
string $property 1
mixed $value value 1
App $appConfig 1
ResponseInterface $response 1
LoggerInterface $logger 1
mixed $level 1
FilterInterface|string $filter The filter instance, class, or alias 1
string $position "before" or "after" 1
array|null $routes Array to set routes 1
array|null $values Array of values, or null to use the current $_SESSION 1
array $headers Array of headers 1
string $format The desired format. Currently supported formats: xml, json 1
string $path URI path relative to baseURL. May include query. 1
string $name Superglobal name (lowercase) 1
non-empty-array|null $params 1
array|null $params The parameters to be formatted and put in the body. 1
string $stage 'setUp' or 'tearDown' 1
string|null $expectedMessage 1
string $header The leading portion of the header we are looking for 1
string $header The leading portion of the header we don't want to find 1
float|int $actual 1
mixed $expected 1
mixed $actual 1
class-string $classname Config classname 1
array $config 1
resource $in 1
resource $out 1
int $consumed 1
bool $closing 1
resource|null $stream 1
int $options 1
false|list|object|resource $return 1
list $inputs 1
int|null $index The output array index. If null, returns all output 1
string $key Cache item name 1
mixed $value the data to save 1
int $ttl Time To Live, in seconds (default 60) 1
string $output 1
string $method 1
int|list|string|null $id One primary key or an array of primary keys 1
TWhen $condition 1
callable(self, TWhen): mixed $callback 1
(callable(self): mixed)|null $defaultCallback 1
mixed $condition 1
TWhenNot $condition 1
callable(self, TWhenNot): mixed $callback 1
(callable(self): mixed)|null $defaultCallback 1
mixed $condition 1
array|EmailConfig|null $config 1
bool $getShared 1
string|null $uri The URI string 1
array|bool|float|int|string|null $property 1
string $component Lowercase, plural component name 1
string $alias Class alias. See the $aliases property. 1
class-string $classname FQCN to be loaded 1
string $alias Class alias. See the $aliases property. 1
array $values option values 1
string|null $component Lowercase, plural component name 1
string $alias Class alias. See the $aliases property. 1
string $key Identifier of the entry to look for. 1
object $mock 1
bool $isCli Set false if you run via Web 1
int $imageType A PHP imagetype constant, e.g. https://www.php.net/manual/en/function.image-type-to-mime-type.php 1
string|null $key If specified, will only return this piece of EXIF data. 1
string $dir Direction to flip, either 'vertical' or 'horizontal' 1
non-empty-string|null $target The path to save the file to. 1
string $targetPath The directory to store the file in 1
string|null $targetName The new name of the copied file. 1
int $perms File permissions to be applied after copy. 1
string $path Image path 1
int $imageType Image type 1
bool $isShadow Whether we are drawing the dropshadow or actual text 1
int $imageType A PHP imageType constant, e.g. https://www.php.net/manual/en/function.image-type-to-mime-type.php 1
string $dir Either 'vertical' or 'horizontal' 1
string|null $key If specified, will only return this piece of EXIF data. 1
bool $silent If true, will not throw our own exceptions. 1
float|int $width 1
float|int|null $height 1
float|int $origWidth 1
float|int $origHeight 1
float|int $width 1
float|int $height 1
float|int $origWidth 1
float|int $origHeight 1
string $position 1
Images $config 1
string $text Text to add. 1
string $pattern Regexp search pattern. 1
string $replace Regexp replacement including text to add. 1
string $after String to search. 1
string $before String to search. 1
list $paths 1
list $uris 1
string $uri Because HTTP\URI is stringable it will still be accepted 1
string $after String to search. 1
string $before String to search. 1
string $from The source file 1
string $to The destination file 1
array $data 1
bool $cast If true, properties will be cast. 1
string|null $key class property 1
DateTime|float|int|string|Time $value 1
bool|float|int|string|null $value Attribute value 1
string $attribute Attribute name 1
string $method Allowed to "get" and "set" 1
array $castHandlers Custom convert handlers 1
array $data DataSource data 1
array $phpData PHP data 1
class-string $classname 1
array $row Raw data from database 1
bool $onlyChanged Only for CodeIgniter's Entity. If true, only returns 1
bool $recursive Only for CodeIgniter's Entity. If true, inner 1
list $args 1
int $extra How many extra spaces to add at the end 1
array $array 1
string $field Output "field" question 1
list|string $options String to a default value, array to a list of options (the first option will be the default value) 1
array|string|null $validation Validation rules 1
array|string $text Output "field" text or an one or two value array where the first value is the text before listing the options 1
array $options A list of options (array(key => description)), the first option will be the default value 1
array|string|null $validation Validation rules 1
string $text Output "field" text or an one or two value array where the first value is the text before listing the options 1
array $options A list of options (array(key => description)), the first option will be the default value 1
string $field Prompt "field" output 1
string $value Input value 1
array|string $rules Validation rules 1
int $num The number of times to beep 1
int $seconds Number of seconds 1
bool $countdown Show a countdown or not 1
string $text The text to color 1
string $foreground The foreground color 1
string|null $background The background color 1
string|null $format Other formatting to apply. Currently only 'underline' is understood 1
bool|int $thisStep 1
bool $useLongOpts Use '--' for long options? 1
bool $trim Trim final string output? 1
array $tbody List of rows 1
array $thead List of columns 1
Logger|null $logger 1
commands_list $commands 1
commands_list $collection 1
string $view namespaced view name that is generated 1
string $target file path 1
string $class namespaced classname or namespaced view. 1
list $search 1
list $replace 1
array $data 1
mixed $flags 1
array|string $mime One or more plugin mime types, separate by spaces 1
string $uri URL to send reports. Set `''` if you want to remove 1
array|string $flags An array of sandbox flags that can be added to the directive. 1
list|string $options 1
array|string|null $values 1
string $directive CSP directive 1
array|string|null $index Index for item to be fetched from $_ENV 1
'cookie'|'get'|'post'|'request'|'server' $name Superglobal name (lowercase) 1
mixed $value 1
'cookie'|'get'|'post'|'request'|'server' $name Superglobal name (lowercase) 1
array|int|string|null $index 1
int|null $filter Filter constant 1
array|int|null $flags Options 1
'cookie'|'get'|'post'|'request'|'server' $name Superglobal name (lowercase) 1
string $relativePath URI path relative to baseURL. May include 1
string|null $host Optional current hostname. 1
'http'|'https'|null $scheme Optional scheme. 'http' or 'https'. 1
array|string $relativePath URI string or array of URI segments 1
string $uri The URI path (relative to baseURL) to redirect to 1
int|null $code HTTP status code 1
string $route Route name or Controller::method 1
string $protocol URIProtocol 1
string $routePath URI path relative to baseURL 1
array|string>|int|string $value 1
array $options 1
string $method HTTP method 1
string $type basic or digest 1
bool $multipart Set TRUE if you are sending CURLFiles 1
array|bool|float|int|object|string|null $data 1
bool $strictMatch If TRUE, will return an empty string when no match found. 1
array $supported App-supported values 1
string $header header string 1
bool $enforceTypes If TRUE, will compare media types and sub-types. 1
bool $strictMatch If TRUE, will return empty string on no match. 1
bool $matchLocales If TRUE, will match locale sub-types to a broad type (fr-FR = fr) 1
list $supportedLocales App-supported values 1
?string $header Compatible 'Accept-Language' header string 1
bool $matchLocales 1
string $method Case-sensitive method. 1
string|null $scheme URI scheme. E.g., http, ftp 1
string|null $uri The URI to parse. 1
array{except?: list|string, only?: list|string} $options 1
int $number Segment number starting at 1 1
string $default Default value 1
int $number Segment number starting at 1 1
string $scheme The scheme to use with the new instance. 1
string $user The user's username 1
string $pass The user's password 1
App $config 1
string $path URI path relative to baseURL 1
App|null $config Optional alternate config to use 1
int|null $filter Filter constant 1
bool $assoc Whether to return objects as associative arrays 1
int $depth How many levels deep to decode 1
int $options Bitmask of options 1
bool $assoc If true, return the result as an associative array. 1
string $format Valid: json, xml 1
string $uri The URI to redirect to 1
int|null $code The type of redirection, defaults to 302 1
string $prefix Cookie name prefix ('': the default prefix) 1
bool|null $secure Whether to only transfer cookies via SSL 1
bool|null $httponly Whether only make the cookie accessible via HTTP (no javascript) 1
string $prefix Cookie prefix. 1
string $filename The name you want the downloaded file to be named 1
string|null $data The data to be downloaded. Set null if the $filename is the file path 1
string $prefix Cookie name prefix 1
bool $secure Whether to only transfer cookies via SSL 1
bool $httponly Whether only make the cookie accessible via HTTP (no javascript) 1
string $uri The URI to redirect to 1
int $code The type of redirection, defaults to 302 1
string $filename The path to the file to send 1
string|null $data The data to be downloaded 1
string $name Case-insensitive header field name. 1
string $method HTTP method 1
ResponseInterface|string $message Response object or a string containing a relative URI. 1
int $code HTTP status code to redirect if $message is a string. 1
string $error The error message 1
bool $overwrite State for indicating whether to overwrite the previously generated file with the same 1
string|null $folderName the folder name to writable/uploads directory. 1
string|null $fileName the name to rename the file to. 1
string $fileID The name of the uploaded file (from the input) 1
array $index The index sequence we are navigating down 1
array $value The portion of the array to process 1
bool|float|int|list|object|resource|string|null $value 1
string $value 1
int $fraction 1
int|string $precision precision or type 1
FileLocatorInterface|null $loader 1
array $options Future options 1
array|string $pattern 1
string $content 1
string $template 1
list $filters 1
array|bool|float|int|object|string|null $value 1
array|list $params 1
array{field?: string} $params 1
string $library Cell class and method name. 1
array|string|null $params Parameters to pass to the method. 1
int $ttl Number of seconds to cache the cell. 1
string|null $cacheName Cache item name. 1
array|float|string|null $params 1
object $instance 1
string $view File name of the view source 1
string $name Section name 1
bool $saveData If true, saves data for subsequent calls, 1
array|null $options 1
bool $saveData 1
array $config (default: array()) 1
array|string $template 1
list $array 1
int $columnLimit 1
array $args 1
string $caption 1
array|BaseResult|null $tableData 1
BaseResult $object Database result object 1
array $data 1
bool $reduceLinebreaks whether to reduce more then two consecutive newlines to two 1
array $data 1
SimpleXMLElement $output 1
string|null $error The error message 1
string $pattern Regex or pseudo-regex string 1
list $files The new file list to use 1
list|string $paths 1
list $directories 1
string|null $scope The directory to limit the scope 1
string|null $scope A directory to limit the scope 1
list $patterns Array of regex or pseudo-regex strings 1
string|null $scope A directory to limit the scope 1
list|string $messages 1
int $status HTTP status code 1
string|null $code Custom, API-specific, error code 1
list|string $errors 1
string $description The error message to show the user. 1
string|null $code A custom, API-specific, error code. 1
string $message A custom "reason" message to return. 1
\Config\Logger $config 1
string|Stringable $message 1
array $context 1
object|string $object 1
array{handles?: list, messageType?: int} $config 1
0|4 $messageType 1
list $headers 1
array $cookies 1
string $name The cookie's name 1
string $value The cookie's value 1
array{prefix?: string, max-age?: int|numeric-string, expires?: DateTimeInterface|int|string, path?: string, domain?: string, secure?: bool, httponly?: bool, samesite?: string, raw?: bool} $options The cookie's options 1
string $offset 1
list $data 1
list $data 1
bool|int|string|null $fieldValue 1
array $params 1
SplFileInfo|string $file 1
list $files 1
array|string|null> $originalLanguageKeys 1
array|string|null> $targetLanguageKeys 1
array{before: list, after: list} $filters 1
array $array 1
string $namespace the default namespace 1
string $routeKey route key regex 1
string $namespace the default namespace 1
list $httpMethods 1
string $string classname or method name 1
string $namespace namespace to search 1
list $protectedControllers List of controllers in Defined 1
list $httpMethods 1
string $prefix URI prefix for Module Routing 1
list> $routes 1
string $class namespaced classname. 1
object|string|null $which 1
callable(mixed): mixed $callback 1
int $priority 1
mixed ...$arguments 1
callable(mixed): mixed $listener 1
string|null $eventName 1
int $timestamp 1
string $format 1
string $datetime 1
DateTimeInterface|self|string|null $datetime 1
DateTimeZone|string|null $timezone 1
DateTimeZone|string $timezone 1
DateTimeInterface|self|string $time 1
list|string> $array 1
int|string|null $sortByIndex 1
non-empty-string|null $encoding 1
string $to 1
mixed &$var Data to dump 1
array $statics array of statics as returned by getStatics 1
array $aliases Call aliases as found in Kint::$aliases 1
array[] $trace Backtrace 1
array $args Arguments 1
array $frame The stack trace frame in question 1
array $args The arguments 1
array $vars Data to dump 1
ContextInterface[] $base The base contexts 1
int $value Amount of bytes 1
string $content The replacement for the getValueShort contents 1
RepresentationInterface|string $rep 1
float $h Hue 1
float $s Saturation 1
float $l Lightness 1
float $red Red 1
float $green Green 1
float $blue Blue 1
int $depth_limit Maximum depth to parse data 1
?string $caller Caller class name 1
int $depth_limit Maximum depth to parse data, 0 for none 1
object &$var 1
bool $clearAttachments 1
string $from 1
string $name 1
string|null $returnPath 1
string $replyto 1
array|string $to 1
string $cc 1
string $bcc 1
string $limit 1
string $subject 1
string $file Can be local path, URL or buffered content 1
string $disposition 'attachment' 1
string|null $newname 1
string $mime 1
string $filename 1
string $header 1
list|string $email 1
bool $wordWrap 1
string $protocol 1
string $newline 1
string $CRLF 1
int|null $charlim Line-length limit 1
string $body Message body to append to 1
string $boundary Multipart boundary 1
string|null $multipart When provided, only attachments of this type will be processed 1
bool $autoClear 1
string $cmd 1
array|string $include List of raw data chunks to include in the output 1
string $msg 1
string $ext 1
int $start 1
int|null $length 1
mixed $value The value to check. 1
string $field The field parameters. 1
array $data Additional data. 1
string|null $fields List of fields that we should check if present 1
array $data Complete list of fields from the form 1
string|null $otherFields The param fields of required_without[]. 1
string|null $field This rule param fields aren't present, this field is required. 1
array|bool|float|int|object|string|null $value Value to validate. 1
array|string $rules 1
list $errors 1
object{ruleSets: list} $config 1
array|bool|float|int|object|string|null $value The data to validate. 1
array|string $rules The validation rules. 1
list $errors The custom error message. 1
array $rules 1
array $data The array of data to validate, with `DBGroup`. 1
string|null $originalField The original asterisk field name like "foo.*.bar". 1
array $data The array of data to validate, with `DBGroup`. 1
array $data The array of data to validate, with `DBGroup`. 1
Closure(bool|float|int|list|object|string|null, bool|float|int|list|object|string|null, string|null, string|null): (bool|string) $rule 1
array|string $rules The validation rules. 1
array $errors The custom error message. 1
array $errors An array of custom error messages 1
non-empty-string|null $label 1
string|null $value The value that caused the validation to fail. 1
string|null $value Value. 1
string|null $ip 1
string|null $which IP protocol: 'ipv4' or 'ipv6' 1
string|null $validSchemes comma separated list of allowed schemes 1
string|null $str 1
non-empty-string|null $format 1
string|null $fields List of fields that we should check if present 1
array $data Complete list of fields from the form 1
string|null $otherFields The param fields of required_without[]. 1
string|null $field This rule param fields aren't present, this field is required. 1
array|bool|float|int|object|string|null $ccNumber 1
array|bool|float|int|object|string|null $value Value. 1
array|bool|float|int|object|string|null $ip 1
string|null $which IP protocol: 'ipv4' or 'ipv6' 1
string|null $validSchemes comma separated list of allowed schemes 1
int|null $count The new "surroundCount" 1
string $template The output template alias to render. 1
int $segment (whether page number is provided by URI segment) 1
string|null $group optional group (i.e. if we'd like to define custom path) 1
non-empty-string $file 1
non-empty-string|null $folder 1
array|non-empty-string>|non-empty-string $namespace 1
array{only?: list, exclude?: list} $composerPackages 1
float $startTime App start time 1
array $collectors 1
string $name The name of this timer. 1
float|null $time Allows user to provide time. 1
string $name The name of this timer. 1
string $name The name of the timer. 1
int $decimals Number of decimal places. 1
int $decimals Number of decimal places 1
string $name The name of the timer 1
callable(): mixed $callable callable to be executed 1
string|null $viewFile 1
array $trace 1
Closure(): mixed $closure 1
string $current Current history time 1
int $limit Max history files 1
string $key Identifier of the session property we are interested in. 1
array $data value to be pushed to existing session key. 1
string $key Identifier of the session property to set. 1
mixed $value 1
string $ipAddress User's IP address 1
string $from The route path (with placeholders or regex) 1
array|(Closure(mixed...): (ResponseInterface|string|void))|string $to The route handler 1
array|null $options The route options 1
string|null $pattern The regex pattern 1
callable|null $callable 1
string|null $from The route path (with placeholders or regex) 1
string $search Named route or Controller::method 1
int|string ...$params 1
list $protectedControllers 1
string $defaultController Short classname 1
string $classname Controller classname that is generated from URI. 1
string $method Controller method name that is generated from URI. 1
callable|string|null $callable 1
string $from The pattern to match against 1
string $to Either a route name or a URI to redirect to 1
int $status The HTTP status code that should be returned with this redirect 1
string $name The name to group/prefix the routes with. 1
array|callable ...$params 1
string $name The name of the resource/controller to route to. 1
string $name The name of the controller to route to. 1
Closure(RouteCollection): void $callback 1
string $search Route name or Controller::method 1
array $params One or more parameters to be passed to the route. 1
list|string $hostname Hostname in route options 1
list|string $subdomains 1
bool $enabled The value status 1
(Closure(mixed...): (ResponseInterface|string|void))|string $handler Handler 1
string $uri The URI path to compare against the routes 1
callable|string $handler 1
false|string $slug 1
non-empty-string|null $id 2
'attr'|'css'|'html'|'js'|'raw'|'url' $context 2
int|string ...$params One or more parameters to be passed to the route. 2
array|string|null $params 2
object|string $class 2
App|null $config Alternate configuration to use. 2
string $email the email address 2
string $title the link title 2
array|object|string $attributes any attributes 2
string $str Input string 2
string $separator Word separator (usually '-' or '_') 2
bool $lowercase Whether to transform the output string to lowercase 2
array $attributes Additional attributes 2
array|string $src Either a source string or an array of sources 2
string $attributes HTML attributes 2
bool $indexPage Should `Config\App::$indexPage` be added to the source path 2
bool $indexPage Should `Config\App::$indexPage` be added to the source path 2
int|string $key 2
array $array Data array (i.e. from query result) 2
array $indexes Indexes to group by. Dot syntax used. Returns $array if empty 2
bool $includeEmpty If true, null and '' are also added as valid keys to group 2
string $endChar the end character. Usually an ellipsis 2
string $path File path 2
bool $delDir Whether to delete any directories found in the path 2
bool $htdocs Whether to skip deleting .htaccess and index page files 2
string $sourceDir Path to source 2
bool $topLevelOnly Look only at the top level directory specified? 2
string $file Path to file 2
array|string $returnedValues Array or comma separated string of information returned 2
int $perms Permissions 2
array $matches */ 2
array $messages An array of custom error messages 2
bool $singleton Single or multiple results 2
array|int|string|null $id One primary key or an array of primary keys 2
int|null $limit Limit 2
int $offset Offset 2
array|null $set An associative array of insert values 2
bool|null $escape Whether to escape values 2
int $batchSize The size of the batch to run 2
bool $testing True means only number of records is returned, false will execute the query 2
array|null $row Row data 2
array|null $set An associative array of update values 2
string|null $index The where key 2
int $batchSize The size of the batch to run 2
bool $returnSQL True means SQL is returned, false will execute the query 2
int $code 2
array|null $row Row data 2
int|string $date timestamp or datetime string 2
list|null $set an associative array of insert values 2
int $batchSize The size of the batch to run 2
object $object Object 2
bool $onlyChanged Only Changed Property 2
array|string|null $params Overridden parameters, specifically the key 2
list}> $filterClassList [[classname, arguments], ...] 2
array|string|null $binds 2
array ...$params 2
string $type The row type. Either 'array', 'object', or a class name to use 2
int|string $n The index of the results to return, or column name. 2
'array'|'object'|class-string $type The type of result object. 'array', 'object' or class name. 2
int $n The index of the results to return. 2
class-string $className 2
array|string $key 2
array|object|stdClass|null $value 2
string|TableName $tableName 2
string $migration A migration filename w/o path. 2
array $attributes Table attributes 2
int $decimals The accuracy of the returned time. 2
array|string $from 2
string $direction ASC, DESC or RANDOM 2
array|object|null $set 2
array|object|null $set a dataset 2
string $table Protected table name 2
string $table Protected table name 2
array|object $object 2
array $attributes Associative array of table attributes 2
array $params 2
string $alterType ALTER type 2
string $table Table name 2
bool $asQuery When true recreates table with key, else partial SQL used with CREATE TABLE 2
string $type SQLite data type (case-insensitive) 2
object|null $helper Helper object. E.g., database connection 2
string $key Cache ID 2
int $offset Step/value to increase by 2
CacheInterface|FileVarExportHandler|null $cache 2
string $key The name to use as the "bucket" name. 2
int $capacity The number of requests the "bucket" can hold 2
int $seconds The time it takes the "bucket" to completely refill 2
int $cost The number of tokens this action uses. 2
list $params 2
object|string $obj object or class name 2
string $property property name 2
IncomingRequest $request 2
string $alias Alias for the anticipated filter 2
string $body 2
string $method HTTP verb 2
mixed $table 2
array{handles?: list, path?: string, fileExtension?: string, filePermissions?: int} $config 2
array $curlOptions 2
int $n 2
string $key Identifier of the entry. 2
string $str Input file name 2
string $source The source string 2
string $string The invalid string 2
bool $maintainRatio If true, will get the closest match possible while keeping aspect ratio true. 2
int|null $x X-axis coord to start cropping from the left of image 2
int|null $y Y-axis coord to start cropping from the top of image 2
Images|null $config 2
bool $silent If true, will ignore exceptions when PHP doesn't support EXIF. 2
array $replaces [search => replace] 2
string $content Whole content. 2
string $line Line to add. 2
bool $replace Whether to overwrite existing files. 2
bool $onlyChanged If true, only return values that have changed since object creation 2
bool $recursive If true, inner entities will be cast as array as well. 2
int $value 2
bool|int|string $value 2
array|string $message 2
string|null $prefix You may specify a string with which to prompt the user. 2
resource $handle 2
resource $resource 2
string $class namespaced classname or namespaced view. 2
array|string|null $index Index for item to fetch from $_GET. 2
int|null $filter A filter name to apply. 2
array|string|null $index Index for item to fetch from $_POST. 2
array|string|null $index Index for item to fetch from $_POST or $_GET 2
array|string|null $index Index for item to be fetched from $_GET or $_POST 2
array|string|null $index Index for item to be fetched from $_COOKIE 2
array|string|null $index 2
array|string|null $value 2
array|string|null $index Index for item to be fetched from $_SERVER 2
string $method 2
array|string>|string|null $value 2
array|string|null $value 2
URI $uri New request URI to use. 2
bool $preserveHost Preserve the original state of the Host header. 2
string ...$params 2
array|string|null $index The variable that you want which can use dot syntax for getting specific values. 2
int|null $filter Filter Constant 2
array|int|null $flags Option 2
int $code The 3-digit integer result code to set. 2
string $reason The reason phrase to use with the 2
array|string $body 2
DateTime|string $date 2
string $value Cookie value 2
int $expire Cookie expiration time in seconds 2
string $domain Cookie domain (e.g.: '.yourdomain.com') 2
string $path Cookie path (default: '/') 2
string|null $samesite 2
bool $setMime Whether to try and send the actual MIME type 2
string $path The temporary location of the uploaded file. 2
string $originalName The client-provided filename. 2
string|null $mimeType The type of file as provided by PHP 2
int|null $size The size of the file, in bytes 2
int|null $error The error constant of the upload (one of PHP's UPLOADERRXXX constants) 2
string|null $clientPath The webkit relative path of the uploaded file. 2
string $targetPath Path to which to move the uploaded file. 2
string|null $name the name to rename the file to. 2
bool $saveData Whether to save data for subsequent calls 2
string $view The view contents 2
array $data 2
mixed $value 2
float|int $value 2
array|null $options Reserved for 3rd-party uses since 2
string $leftDelimiter 2
string $rightDelimiter 2
list $matches 2
array{email?: string, title?: string, attributes?: array|object|string} $params 2
list $params 2
bool|null $saveData If true, saves data for subsequent calls, 2
positive-int $precision 2
string $pattern Regex or pseudo-regex string 2
string $caller The method causing the exception 2
'json'|'xml' $format Response format 2
array{handles?: list} $config 2
DateTimeInterface|int|string $expires 2
list $tables 2
string $uri URI path to find filters for 2
string $method HTTP verb like `GET`,`POST` or `CLI`. 2
string $uri URI path to find filters for 2
class-string $class 2
class-string $classname 2
string $namespace namespace to search 2
string $eventName 2
string $eventName 2
string $index The index as dot array syntax. 2
array|\Config\Email|null $config 2
string $type 2
array|string $email 2
string $email 2
string $str 2
array $data Other field/value pairs 2
array|bool|float|int|object|string|null $value The field value. 2
string|null $param The rule's parameter. 2
array $data The data to be validated. 2
string|null $field The field name. 2
array|null $data The array of data to validate. 2
string|null $group The predefined group of rules to apply. 2
array|BaseConnection|non-empty-string|null $dbGroup The database group to use. 2
string|null $dbGroup The database group to use. 2
array $indexes The dot array syntax pattern to use for filtering. 2
array $array The array to filter. 2
array $data Other field/value pairs 2
non-empty-string $file The relative file path or namespaced file to 2
non-empty-string|null $folder The folder within the namespace that we should 2
string $ext The file extension the file should have. 2
array|object $args 2
bool $destroy Should old session data be destroyed? 2
array|list|string $data Property name or associative array of properties 2
mixed $value Property value if single key provided 2
string|null $key Identifier of the session property to retrieve 2
string $key Identifier of the session property we are interested in. 2
list|string $key Identifier of the session property or properties to remove. 2
string $key Identifier of the session property to remove. 2
array|string $data Property identifier or associative array of properties 2
mixed $value Property value if $data is a scalar 2
string|null $key Property identifier 2
array|list|string $data Session data key or associative array of items 2
mixed $value Value to store 2
int $ttl Time-to-live in seconds 2
string|null $key Session data key 2
string $key Session data key 2
array|list|string $key Property identifier or array of them 2
int $ttl Time to live, in seconds 2
string $sessionID Session ID 2
array|string $placeholder 2
non-empty-string|null $verb HTTP verb like `GET`,`POST` or `*` or `CLI`. 2
bool $includeWildcard Whether to include '*' routes. 2
string $verb HTTP verb 2
string $search routeKey 2
string|null $verb HTTP verb like `GET`,`POST` or `*` or `CLI`. 2
string $httpVerb HTTP verb like `GET`,`POST` 2
bool $validate if true, checks to make sure $dir consists of only PSR4 compliant segments 2
string $routeKey routeKey or route name 2
array|null $options A list of possible ways to customize the routing. 2
string|null $uri URI path relative to baseURL 2
string $page 2
array|bool|float|int|object|string|null ...$params 3
array $list List entries 3
array|object|string $attributes HTML attributes string, array, object 3
bool $relativePath Whether to preserve paths 3
array $vars 3
array|Cookie|string $name Cookie name / array containing binds / Cookie object 3
string $columnName Column Name 3
array|int|string|null $id 3
array|int|string|null $id The rows primary key(s) 3
bool $purge Allows overriding the soft deletes setting. 3
bool $returnSQL Set to true to return Query String 3
array|object|null $row 3
bool $returnID Whether insert ID should be returned or not. 3
string|null $uri URI path relative to baseURL (all lowercase) 3
string $sql 3
non-empty-string|null $group 3
bool $ifNotExists Whether to add IF NOT EXISTS condition 3
array|string $key 3
array|string $fields Field array or Field string 3
mixed $binds 3
RawSql|string $cond 3
BaseBuilder|Closure(BaseBuilder): BaseBuilder $union 3
mixed $where 3
list $params Additional param 3
string $key Cache item name 3
int|null $count Optional number to create a collection 3
string|null $body 3
array $options The array of component-specific directives 3
string $alias Class alias. See the $aliases property. 3
non-empty-string|null $target 3
array|bool|float|int|object|string|null $value 3
App $config 3
int|string|null $value 3
array|object|string $body 3
array|object|string $data 3
mixed $level 3
string $offset 3
array $matches 3
mixed &$var The input variable 3
string $template The output template alias to render. 3
class-string $class The fully qualified class name. 3
array|string $relativePath URI string or array of URI segments. 4
string|null $scheme URI scheme. E.g., http, ftp. If empty 4
string $attributes HTML attributes 4
array|string $rules 4
string $name Name 4
CLIRequest|IncomingRequest $request 4
string $key Property name 4
class-string $className 4
array|string $value 4
string $table Protected table name 4
list $keys QBKeys 4
list> $values QBSet 4
mixed $value 4
array $options Passed to the connection's prepare statement. 4
string $table Name of the target table 4
string|null $value 4
array $where 4
array $data 4
string $component Lowercase, plural component name 4
array|bool|float|int|object|string|null $value Data 4
array $params Additional param 4
array|null $options Reserved for 3rd-party uses since 4
string $level 4
string $string 4
string $group Group. 4
array|bool|float|int|object|string|null $str expects int|string 4
array $segments URI segments 4
array $row Row data 5
array|object $row Row data 5
string $str 5
bool $asQuery When true returns stand alone SQL, else partial SQL used with CREATE TABLE 5
array|RawSql|string $key 5
mixed $value 5
array|string $processedFields Processed column definitions 5
string $route The route to test 5
string $position "before" or "after" 5
int|null $filter A filter name to be applied 5
'attr'|'css'|'html'|'js'|'raw'|'url'|null $context The context to escape it for. 5
string $value 5
array|string|null $data 5
DateTimeInterface|self|string $testTime 5
string $path The path where to store/retrieve the session 5
string $name The session name 5
string $id The session ID 5
string $id The session ID 5
string $data The encoded session data 5
string $id The session ID being destroyed 5
string|null $verb HTTP verb like `GET`,`POST` or `*` or `CLI`. 5
array|null $arguments 6
string $message 6
int|null $filter A filter name to apply 6
list $files 6
int $max_lifetime Sessions that have not updated 6
'after'|'before' $position 7
array{ 7
string|null $tableName If $tableName is provided will return only this table if exists. 7
string|TableName $table 7
int|string $value 7
string $name 8
string $string Input string 8
array|BaseBuilder|(Closure(BaseBuilder): BaseBuilder)|null $values The values searched on, or anonymous function with subquery 8
array|RawSql|string $field 8
list|string $key Property identifier or array of them 8
string $data 9
int|string|null $id 9
array|string $data 10
array|object|string $extra string, array, object that can be cast to array 10
array $params 10
mixed[] $context 10
DateTimeZone|string|null $timezone 11
array|(Closure(mixed...): (ResponseInterface|string|void))|string $to 11
array|int|null $flags 12
array|string $uri 14
list|null $arguments 17
string|null $str 35
array|bool|float|int|object|string|null $str 37
@params int $time time to live in seconds. 1
string $hash CSRF hash 1
string $token CSRF token 1
string $key class property 1
@property array $arguments 1
Commands $commands 1
string $description 1
string $group 1
LoggerInterface $logger 1
string $name 1
array $options 1
string $usage 1
int $age read-only 1
string $day read-only 1
string $dayOfWeek read-only 1
string $dayOfYear read-only 1
bool $dst read-only 1
string $hour read-only 1
bool $local read-only 1
string $minute read-only 1
string $month read-only 1
string $quarter read-only 1
string $second read-only 1
int $timestamp read-only 1
bool $utc read-only 1
string $weekOfMonth read-only 1
string $weekOfYear read-only 1
string $year read-only 1
string $session_id 1
false|object|resource $connID 1
string $returnType 1
string $primaryKey 1
string $dateFormat 1
RequestInterface $request 1
ResponseInterface $response 1
bool $stringAsHtml Whether to treat string data as HTML in JSON response. 1
@return ($key is null ? CacheInterface : mixed) 1
($name is class-string ? ConfigTemplate : object|null) 1
array|bool|float|int|object|string|null 1
bool TRUE if the function exists and is safe to call, 1
($name is class-string ? ModelTemplate : object|null) 1
($val is null ? Session : mixed) 1
string|null The configuration item or NULL if 1
($name is null ? Timer : ($callable is (callable(): mixed) ? mixed : Timer)) 1
string|URI When returning string, the query and fragment parts are removed. 1
array The flattened array 1
string Ellipsized string 1
array|string string or array 1
bool Same or not 1
string|null The mime type found, or none if unable to determine. 1
string|null The extension determined, or null if unable to match. 1
array|object|null The resulting row of data, or null. 1
array|null The resulting row of data, or null if no data found. 1
bool|string SQL string when testMode 1
array|BaseBuilder|bool|float|int|object|string|null 1
$this|array|BaseBuilder|bool|float|int|object|string|null 1
false|ResponseInterface 1
list|string|null Route filters, that is, the filters specified in the routes file 1
ResponseInterface|string|null 1
Controller 1
false|ResponseInterface|string|void 1
array|object|null The resulting row of data, or null. 1
array|object|null The resulting row of data, or null. 1
BaseResult|bool 1
EncrypterInterface 1
array|bool|int|string|null 1
RequestInterface|ResponseInterface|string 1
list}> [[classname, arguments], ...] 1
array{0: string, 1: list} [name, arguments] 1
array|string 1
bool True if any of the paths apply to the URI 1
bool True if the URI matches except paths. 1
RedirectResponse|null 1
BaseBuilder Builder. 1
BaseConnection|BaseUtils|Forge 1
BaseUtils 1
Seeder 1
false|object 1
BasePreparedQuery|null 1
array{code: int|string|null, message: string|null} 1
bool True on success, FALSE on failure or no migrations are found 1
array List of all located migrations by their UID 1
false|object Returns the migration object, or false on failure 1
ConnectionInterface 1
string SQL string 1
($alterType is 'DROP' ? string : false|list|null) 1
object|resource|null 1
false|ResultInterface 1
false|int|list Number of rows inserted or FALSE on failure, SQL array when testMode 1
false|int|list Number of rows inserted or FALSE on no data to perform an insert operation, SQL array when testMode 1
BaseResult|bool|Query 1
string SQL statement 1
array|false|string 1
false|PgSqlConnection 1
false|PgSqlResult 1
PgSqlResult|null 1
int|string when $test = true 1
bool|Query|Result 1
false 1
SQLite3 1
($alterType is 'DROP' ? string : list|null) 1
($fields is array ? array : mixed) 1
array 1
false|mysqli 1
mixed PHP native value 1
mixed Data to pass to database driver 1
array|false|object|null 1
array{data: mixed, ttl: int, time: int}|false 1
int|never 1
object Framework or compatible model 1
string Name of the formatter 1
array An array of faked data 1
object An instance of the class with faked data 1
RequestInterface|null 1
Closure(mixed ...$args): mixed 1
ReflectionProperty 1
Closure(list|null=): mixed 1
list The filter aliases 1
DOMNodeList|false 1
array{tag: string, id: string|null, class: string|null, attr: array|null} 1
Request 1
T 1
BaseResult|bool|Query 1
array{code: int, message: string} 1
list Keys currently present in the store 1
array{expire: int|null}|null Returns null if the item does not exist, 1
float 1
array, 2: list}> 1
CLIRequest 1
Commands 1
ContentSecurityPolicy 1
CURLRequest 1
Email 1
EncrypterInterface Encryption handler 1
Exceptions 1
Format 1
Honeypot 1
Iterator 1
Language 1
Logger 1
Negotiate 1
ResponseCache 1
Pager 1
Parser 1
View 1
RedirectResponse 1
Router 1
Security 1
Session 1
SiteURIFactory 1
Superglobals 1
Throttler 1
Toolbar 1
URI The current URI if $uri is null. 1
ValidationInterface 1
Cell 1
Typography 1
array 1
array The result after applying defaults and normalization 1
object|null Entry. 1
Autoloader 1
FileLocatorInterface 1
string|null HTML string or void in CLI 1
$this|false 1
string CSRF token 1
string CSRF hash 1
ImageHandlerInterface 1
Image 1
ImageMagickHandler 1
bool|ImageMagickHandler 1
array Lines of output from shell command 1
list 1
array 1
string db column name 1
bool|Entity 1
TEntity 1
list|null 1
array|Commands|LoggerInterface|string|null 1
string The user input 1
string The selected key of $options 1
array The selected key(s) and value(s) of $options 1
string The color coded string 1
string|true|null 1
array 1
int Exit code 1
commands_list 1
int|void Exit code 1
CLIException 1
string IP address if it can be detected. 1
string The Route path. 1
string IP address 1
string The route path 1
string|null The current hostname. Returns null if no valid host. 1
string|null The valid hostname. Returns null if not valid. 1
array|string>|string 1
string Best match 1
string Returns the request method. 1
string URI string with only passed parts. Maybe incomplete as a URI. 1
string The URI scheme. 1
string The URI authority, in "[user-info@]host[:port]" format. 1
string|null The URI user information, in "username[:password]" format. 1
string The URI host. 1
int|null The URI port. 1
string The URI path. 1
array 1
string The value of the segment. If you specify the last +1 1
array{string, string} 1
static A new instance with the specified scheme. 1
string The URI it found. 1
array|bool|float|int|stdClass|null 1
UserAgent 1
string HTTP protocol version. 1
bool Returns true if any header names match the given header 1
array An array of the request headers 1
array|Header|null 1
string Returns the request method (always uppercase) 1
URI|null 1
string The filename sent by the client or null if none 1
string The path set or created. 1
string The media type sent by the client or null if none was provided. 1
string The filename sent by the client or null if none was provided. 1
string file full path 1
list|null 1
list|UploadedFile 1
list|UploadedFile|null 1
array|bool|float|int|string|null 1
list 1
array|false 1
array>|list> 1
FormatConfig 1
false|int The file size in bytes, or false on failure 1
false|int|string 1
string The media type we determined it to be. 1
File 1
Generator 1
array{string, int|string} 1
array|string 1
HandlerInterface 1
Traversable 1
array 1
array{'foundLanguageKeys': array>, 'badLanguageKeys': array>, 'countFiles': int} 1
array|string|null> 1
int exit code 1
array 1
array{before: list, after:list} array of aliases 1
array{before: list, after:list} 1
array{before: list, after: list} array of aliases 1
array{before: list, after: list} array of classnames 1
list 1
list 1
string sample URI path 1
string URI path part from the method 1
list 1
list 1
list 1
DateTime 1
TimeDifference 1
DateTime|static 1
IntlCalendar 1
array|bool|DateTimeInterface|DateTimeZone|int|IntlCalendar|self|string|null 1
float|int|null 1
list The index as an array. 1
non-empty-string 1
array Current static settings 1
BaseContext[] Base contexts for the arguments 1
array Call info 1
?array params and modifiers, or null if a specific call could not be determined 1
array Human readable value and unit 1
array List of matching calls on the relevant line 1
int[] RGB array 1
float[] HSL array 1
float Color value 1
bool|Email 1
array The updated archive values 1
array{0: BaseBuilder, 1: string|null, 2: string|null} 1
bool True if valid, else false. 1
array 1
array [rules, customErrors] 1
PagerRenderer 1
list 1
class-string|false The qualified name or false if the path is not found 1
list 1
list List of file paths 1
false|string The path to the file, or false if not found. 1
($prefix is null ? array> : list) 1
false|non-empty-string The mapped file name on success, or boolean false on fail 1
false|non-empty-string The filename on success, false if the file is not loaded 1
string The sanitized filename 1
string JSON encoded data 1
float|null Returns null if timer does not exist by that name. 1
string The filename of the view file to use 1
string The path and filename of the view file to use 1
true 1
array{logs: list} 1
list 1
array The formatted data or an empty array. 1
string The number of queries (in parentheses) or an empty string. 1
array 1
false|string the subdomain 1
array< 1
list controller name list 1
string|null Controller classname 1
Generator 1
RouterInterface 1
array{string, string}|(Closure(string): (ResponseInterface|string|void))|null 1
bool Whether the route was matched or not. 1
CLIRequest|IncomingRequest 2
false|int 2
array|bool|int|object|string|null 2
array Result array where rows are grouped together by indexes values. 2
bool|string Returns a SQL string if in test mode. 2
array|int|string|null 2
($returnID is true ? false|int|string : bool) 2
array Array with raw values. 2
ResponseInterface|void 2
int Exit code. 2
array|null The resulting row of data, or null if no data found. 2
bool|string Returns a string if in test mode. 2
BaseResult|bool|Query 2
Query 2
array|bool|float|int|object|resource|string|null 2
array|bool 2
false|never|string 2
bool|ResultInterface 2
($n is string ? float|int|string|null : ($type is 'object' ? stdClass|null : ($type is 'array' ? array|null : T|null))) 2
T|null 2
object|stdClass|null 2
($item is array ? array : string) 2
float|string 2
ResultInterface 2
false|int|list Number of affected rows or FALSE on failure, SQL array when testMode 2
bool|string TRUE on success, FALSE on failure, string on testMode 2
($alterType is 'DROP' ? string : false|list) 2
resource|null 2
resource 2
($alterType is 'DROP' ? string : list) 2
false|SQLite3Result 2
false|mysqli_result 2
bool|int 2
CacheInterface 2
CodeIgniter 2
false|object|resource 2
class-string|null 2
'json'|'xml'|null 2
bool|int|string 2
RouteCollection 2
GDHandler 2
bool|resource 2
bool Whether all files were copied successfully 2
Time 2
int|void 2
string generated file content 2
array> An array of the Header objects 2
Header|list
|null
2
int Status code. 2
string Reason phrase; must return an empty string if none present. 2
$this|RedirectResponse 2
string The route path (before normalization). 2
array|bool|float|int|stdClass|string|null 2
UploadedFile|null 2
CookieStore 2
array|Cookie|null 2
DownloadResponse|null 2
int One of PHP's UPLOAD_ERR_XXX constants. 2
list> 2
array{before: list, after: list} array of alias/classname:args 2
array{before: list, after: list} array of classname:args 2
string URI path part from the folder(s) and controller 2
list> 2
list> 2
list Rule group. 2
array The filtered array. 2
array|true The modified rules or true if we return early 2
bool True if alpha with spaces, else false. 2
false|non-empty-string The path to the file, or false if not found. 2
(Closure(string): (ResponseInterface|string|void))|string|null 2
array [key => value] 2
list filter_name or filter_name:arguments like 'role:admin,manager' 2
bool true if a controller class is found. 2
false|string The route (URI path relative to baseURL) or false if not found. 3
array|object 3
object 3
bool|int Number of rows inserted or FALSE on failure 3
RequestInterface|ResponseInterface|string|null 3
Filters 3
false|TResult 3
($str is array ? array : float|int|string) 3
bool Success or failure 3
int The new count value 3
array|object An array or object (based on returnType), or an array of returnTypes 3
IncomingRequest 3
bool|null 3
BaseHandler 3
Timer 3
string|null Updated content, or null if not updated. 3
array 3
RendererInterface 3
false|non-empty-string 3
int|null 3
list 3
list List of file paths 3
array [directory_name, controller_name, controller_method, params] 3
array returns an array of remaining uri segments that don't map onto a directory 3
BaseConnection 4
BaseResult|false|Query|string 4
array 4
$this|null 4
array|false|null 4
false|list 4
false|resource 4
CacheException 4
bool|string|null 4
array{} 4
DownloadResponse 4
(Closure(mixed...): (ResponseInterface|string|void))|string Controller classname or Closure 4
string|URI 5
false|int|list Number of rows affected or FALSE on failure, SQL array when testMode 5
ResponseInterface|null 5
false|TConnection 5
Forge 5
array|false 5
Entity|false|object|stdClass 5
object|null 5
($string is non-empty-string ? non-empty-string : string) 5
false|string Returns an encoded string of the read data. 5
array|string 6
list|string 6
array|string|null 6
BaseBuilder 6
array 6
MigrationRunner 6
float|int 6
($key is string ? mixed : array) 6
false|int Returns the number of deleted sessions on success, or false on failure. 6
RouteCollectionInterface 6
RouterException 6
array{ 7
never 8
DataException 8
TestResponse 8
list 9
URI 9
Table 10
false|string 11
array 11
bool|string 11
array|object|null 13
int|string 14
ResponseInterface|string|void 15
array|null 16
array 17
array 17
ResponseInterface 18
string|null 18
array|bool|float|int|object|string|null 19
list 20
HTTPException 20
mixed 23
int 27
string 62
bool 69
static 155
void 264
$this 318
@see https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security 1
http://www.hardened-php.net/suhosin/ 1
https://bugs.php.net/bug.php?id=54709 1
https://simple.wikipedia.org/wiki/Names_for_large_numbers 1
\CodeIgniter\HTTP\Response::setCookie() 1
\CodeIgniter\HTTP\IncomingRequest::getCookie() 1
\CodeIgniter\HTTP\Response::deleteCookie() 1
https://www.html5rocks.com/en/tutorials/security/content-security-policy/ 1
https://kint-php.github.io/kint/ for details on these settings. 1
\CodeIgniter\ControllerTest 1
\CodeIgniter\CodeIgniterTest 1
\CodeIgniter\Encryption\EncryptionTest 1
\CodeIgniter\Encryption\Handlers\OpenSSLHandlerTest 1
https://github.com/jedisct1/libsodium/issues/392 1
\CodeIgniter\Encryption\Handlers\SodiumHandlerTest 1
\CodeIgniter\Filters\DebugToolbarTest 1
\CodeIgniter\Filters\FiltersTest 1
\CodeIgniter\Filters\SecureHeadersTest 1
\CodeIgniter\Filters\InvalidCharsTest 1
\CodeIgniter\Filters\HoneypotTest 1
\CodeIgniter\Filters\CorsTest 1
\CodeIgniter\Database\TableNameTest 1
\CodeIgniter\Database\ConfigTest 1
\CodeIgniter\Database\RawSqlTest 1
\CodeIgniter\Database\BaseConnectionTest 1
\CodeIgniter\Cache\ResponseCacheTest 1
\CodeIgniter\Cache\CacheFactoryTest 1
\CodeIgniter\Cache\Handlers\FileHandlerTest 1
\CodeIgniter\Cache\Handlers\PredisHandlerTest 1
\CodeIgniter\Cache\Handlers\BaseHandlerTest 1
\CodeIgniter\Cache\Handlers\DummyHandlerTest 1
\CodeIgniter\Cache\Handlers\MemcachedHandlerTest 1
\CodeIgniter\Cache\Handlers\RedisHandlerTest 1
https://en.wikipedia.org/wiki/Token_bucket 1
\CodeIgniter\Test\FabricatorTest 1
\CodeIgniter\Test\TestResponseTest 1
\CodeIgniter\Test\TestLoggerTest 1
\CodeIgniter\Test\DOMParserTest 1
\CodeIgniter\Config\DotEnvTest 1
\CodeIgniter\Config\ServicesTest 1
\CodeIgniter\Config\BaseConfigTest 1
\CodeIgniter\Config\FactoriesTest 1
\CodeIgniter\Security\CheckPhpIniTest 1
\CodeIgniter\Security\SecurityTest 1
\CodeIgniter\Images\ImageTest 1
\CodeIgniter\Publisher\ContentReplacerTest 1
\CodeIgniter\Entity\EntityTest 1
\CodeIgniter\DataConverter\DataConverterTest 1
\CodeIgniter\Language\LanguageTest 1
\CodeIgniter\Honeypot\HoneypotTest 1
\CodeIgniter\CLI\CLITest 1
\CodeIgniter\CLI\ConsoleTest 1
\CodeIgniter\HTTP\CLIRequestTest 1
http://content-security-policy.com/ 1
https://www.owasp.org/index.php/Content_Security_Policy 1
\CodeIgniter\HTTP\ContentSecurityPolicyTest 1
\CodeIgniter\HTTP\ResponseTest 1
\CodeIgniter\HTTP\SiteURITest 1
\CodeIgniter\HTTP\RedirectResponseTest 1
\CodeIgniter\HTTP\SiteURIFactoryTest 1
\CodeIgniter\HTTP\RequestTest 1
\CodeIgniter\HTTP\HeaderTest 1
\CodeIgniter\HTTP\CURLRequestTest 1
http://tools.ietf.org/html/rfc7231#section-5.3 1
\CodeIgniter\HTTP\NegotiateTest 1
\CodeIgniter\HTTP\DownloadResponseTest 1
\CodeIgniter\HTTP\URITest 1
\CodeIgniter\HTTP\IncomingRequestTest 1
\CodeIgniter\HTTP\CorsTest 1
\CodeIgniter\HTTP\MessageTest 1
\CodeIgniter\HTTP\UserAgentTest 1
\CodeIgniter\HTTP\OutgoingRequestTest 1
\CodeIgniter\HTTP\Files\FileCollectionTest 1
\CodeIgniter\View\ParserTest 1
\CodeIgniter\View\CellTest 1
\CodeIgniter\View\ViewTest 1
\CodeIgniter\View\TableTest 1
\CodeIgniter\Typography\TypographyTest 1
\CodeIgniter\Format\JSONFormatterTest 1
\CodeIgniter\Format\XMLFormatterTest 1
\CodeIgniter\Format\FormatTest 1
\CodeIgniter\Files\FileTest 1
\CodeIgniter\Files\FileCollectionTest 1
\CodeIgniter\Log\LoggerTest 1
\CodeIgniter\Log\Handlers\FileHandlerTest 1
https://craig.is/writing/chrome-logger 1
\CodeIgniter\Log\Handlers\ChromeLoggerHandlerTest 1
\CodeIgniter\Log\Handlers\ErrorlogHandlerTest 1
\CodeIgniter\Cookie\CookieStoreTest 1
\CodeIgniter\Cookie\CookieTest 1
\CodeIgniter\Commands\Database\ShowTableInfoTest 1
\CodeIgniter\Commands\Database\MigrateStatusTest 1
\CodeIgniter\Commands\Translation\LocalizationFinderTest 1
\CodeIgniter\Commands\Translation\LocalizationSyncTest 1
\CodeIgniter\Commands\Utilities\ConfigCheckTest 1
\CodeIgniter\Commands\Utilities\NamespacesTest 1
\CodeIgniter\Commands\Utilities\Routes\FilterFinderTest 1
\CodeIgniter\Commands\Utilities\Routes\FilterCollectorTest 1
\CodeIgniter\Commands\Utilities\Routes\ControllerMethodReaderTest 1
\CodeIgniter\Commands\Utilities\Routes\ControllerFinderTest 1
\CodeIgniter\Commands\Utilities\Routes\AutoRouteCollectorTest 1
\CodeIgniter\Commands\Utilities\Routes\SampleURIGeneratorTest 1
\CodeIgniter\Commands\Utilities\Routes\AutoRouterImproved\ControllerMethodReaderTest 1
\CodeIgniter\Commands\Utilities\Routes\AutoRouterImproved\AutoRouteCollectorTest 1
\CodeIgniter\RESTful\ResourcePresenterTest 1
\CodeIgniter\RESTful\ResourceControllerTest 1
\CodeIgniter\Events\EventsTest 1
\CodeIgniter\I18n\TimeLegacyTest 1
\CodeIgniter\I18n\TimeTest 1
\CodeIgniter\I18n\TimeDifferenceTest 1
https://codeigniter.com/user_guide/general/modules.html 1
\CodeIgniter\Helpers\Array\ArrayHelperDotKeyExistsTest 1
\CodeIgniter\Helpers\Array\ArrayHelperRecursiveDiffTest 1
\CodeIgniter\Helpers\Array\ArrayHelperSortValuesByNaturalTest 1
\CodeIgniter\Email\EmailTest 1
\CodeIgniter\Validation\RulesTest 1
\CodeIgniter\Validation\FileRulesTest 1
\CodeIgniter\Validation\CreditCardRulesTest 1
\CodeIgniter\Validation\DotArrayFilterTest 1
\CodeIgniter\Validation\ValidationTest 1
\CodeIgniter\Validation\FormatRulesTest 1
\CodeIgniter\Validation\StrictRules\RulesTest 1
\CodeIgniter\Validation\StrictRules\FileRulesTest 1
\CodeIgniter\Validation\StrictRules\CreditCardRulesTest 1
\CodeIgniter\Validation\StrictRules\FormatRulesTest 1
\CodeIgniter\Pager\PagerRendererTest 1
\CodeIgniter\Pager\PagerTest 1
\CodeIgniter\Autoloader\FileLocatorTest 1
\CodeIgniter\Autoloader\FileLocatorCachedTest 1
\CodeIgniter\Autoloader\AutoloaderTest 1
\CodeIgniter\Debug\TimerTest 1
\CodeIgniter\Debug\ExceptionHandlerTest 1
\CodeIgniter\Debug\ExceptionsTest 1
\CodeIgniter\Debug\Toolbar\Collectors\DatabaseTest 1
\CodeIgniter\Debug\Toolbar\Collectors\HistoryTest 1
\CodeIgniter\Session\SessionTest 1
\CodeIgniter\Session\Handlers\Database\PostgreHandlerTest 1
\CodeIgniter\Session\Handlers\Database\MySQLiHandlerTest 1
\CodeIgniter\Router\AutoRouterImprovedTest 1
\CodeIgniter\Router\RouteCollectionTest 1
\CodeIgniter\Router\DefinedRouteCollectorTest 1
\CodeIgniter\Router\RouterTest 1
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie 1
https://github.com/php-fig/http-message/blob/master/src/MessageInterface.php 1
https://github.com/php-fig/http-message/blob/master/src/RequestInterface.php 1
https://github.com/php-fig/http-message/blob/master/src/ResponseInterface.php 1
https://regex101.com/r/OtFn8I/1 1
https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/TRACE 1
https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PUT 1
https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET 1
https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/DELETE 1
https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/CONNECT 1
https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST 1
https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/OPTIONS 1
https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH 1
https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/HEAD 1
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Date 1
https://tools.ietf.org/html/rfc7231#section-7.1.1.2 1
https://www.php.net/manual/en/timezones.php for list of timezones 1
http://php.net/htmlspecialchars for a list of supported charsets. 1
https://codeigniter.com/user_guide/libraries/caching.html#memcached 1
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#attributes 1
https://tools.ietf.org/html/rfc2616#section-2.2 1
https://codeigniter.com/user_guide/concepts/factories.html#config-caching 1
https://codeigniter.com/user_guide/concepts/autoloader.html#file-locator-caching 1
https://codeigniter4.github.io/userguide/libraries/security.html#redirection-on-failure 1
https://codeigniter4.github.io/userguide/models/model.html#setting-validation-rules 1
https://docs.microsoft.com/en-us/sql/relational-databases/system-stored-procedures/sp-rename-transact-sql?view=sql-server-2017 1
https://www.php.net/manual/en/sqlite3.busytimeout 1
https://www.sqlite.org/pragma.html#pragma_synchronous 1
https://www.php.net/manual/en/function.chmod.php 1
https://portswigger.net/web-security/csrf/samesite-cookies 1
http://php.net/manual/en/image.constants.php 1
Email::$protocol 1
Email::$encoding 1
Email::printDebugger() 1
Email::$wordWrap 1
Email::$BCCBatchMode 1
getFieldData() 1
getIndexData() 1
getForeignKeyData() 1
disableForeignKeyChecks() 1
enableForeignKeyChecks() 1
https://regex101.com/r/EUEhay/5 1
https://github.com/codeigniter4/CodeIgniter4/pull/5376 1
https://www.postgresql.org/docs/9.2/static/functions-matching.html 1
http://www.w3.org/TR/CSP/#directive-base-uri 1
http://www.w3.org/TR/CSP/#directive-child-src 1
http://www.w3.org/TR/CSP/#directive-default-src 1
http://www.w3.org/TR/CSP/#directive-font-src 1
http://www.w3.org/TR/CSP/#directive-form-action 1
http://www.w3.org/TR/CSP/#directive-frame-ancestors 1
http://www.w3.org/TR/CSP/#directive-frame-src 1
http://www.w3.org/TR/CSP/#directive-img-src 1
http://www.w3.org/TR/CSP/#directive-media-src 1
https://www.w3.org/TR/CSP/#directive-manifest-src 1
http://www.w3.org/TR/CSP/#directive-object-src 1
http://www.w3.org/TR/CSP/#directive-plugin-types 1
http://www.w3.org/TR/CSP/#directive-report-uri 1
http://www.w3.org/TR/CSP/#directive-sandbox 1
https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2 1
http://tools.ietf.org/html/rfc3986#section-5.2.4 1
https://tools.ietf.org/html/rfc3986#section-3.1 1
https://tools.ietf.org/html/rfc3986#section-3.2 1
http://tools.ietf.org/html/rfc3986#section-3.2.2 1
https://tools.ietf.org/html/rfc3986#section-2 1
https://tools.ietf.org/html/rfc3986#section-3.3 1
https://www.iana.org/assignments/uri-schemes/uri-schemes.xhtml 1
https://tools.ietf.org/html/rfc3986#section-3.5 1
http://tools.ietf.org/html/rfc3986#section-5.2 1
http://tools.ietf.org/html/rfc3986#section-5.2.3 1
http://php.net/manual/en/function.json-decode.php 1
DownloadResponse::noCache() 1
http://php.net/manual/en/reserved.variables.files.php#118294 1
http://www.codexworld.com/convert-array-to-xml-in-php/ 1
https://stackoverflow.com/questions/60001029/invalid-characters-in-xml-tag-name 1
https://regex101.com/r/4sSORp/1 for the regex in action 1
https://github.com/codeigniter4/CodeIgniter/issues/4963 1
https://gist.github.com/Zenexer/40d02da5e07f151adeaeeaa11af9ab36 1
https://tools.ietf.org/html/rfc5321#section-2.3.5 1
http://cbl.abuseat.org/namingproblems.html 1
https://regex101.com/r/XfVY3d/1 1
https://regex101.com/r/6N8dDY/1 1
https://wiki.php.net/rfc/deprecations_php_8_4#sessionsid_length_and_sessionsid_bits_per_character 1
https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS 2
http://blog.ircmaxell.com/2015/11/simple-easy-risk-and-change.html 2
http://www.infoq.com/presentations/Simple-Made-Easy 2
http://www.w3.org/TR/CSP/ 2
http://www.html5rocks.com/en/tutorials/security/content-security-policy/ 2
http://en.wikipedia.org/wiki/Credit_card_number 2
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite 2
http://codeigniter.com/user_guide/general/managing_apps.html 2
https://codeigniter.com/user_guide/incoming/filters.html#provided-filters 2
http://www.ietf.org/rfc/rfc822.txt 2
https://www.sqlite.org/datatype3.html 2
https://datatracker.ietf.org/doc/html/rfc7230#section-3.2 2
http://tools.ietf.org/html/rfc3986#section-4.3 2
http://tools.ietf.org/html/rfc5988 2
http://php.net/is_uploaded_file 2
http://php.net/move_uploaded_file 2
http://php.net/manual/en/features.file-upload.errors.php 2
http://php.net/manual/en/datetimezone.listidentifiers.php 2
http://www.w3.org/TR/CSP/#directive-connect-src 3
http://tools.ietf.org/html/rfc7231#section-6 4
http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml 4
@template ConfigTemplate of BaseConfig 1
ModelTemplate of Model 1
TEntity of object 1
T of \CodeIgniter\Config\BaseConfig 1
TWhen of mixed 1
TWhenNot of mixed 1
TStatement 2
T of object 4
TConnection 6
TResult 6
@testTag Only for test code. The run() calls this, so you don't need to 1
$config is used for testing purposes only. 1
only available to test code 4
*/ 11
@throws EncryptionException If key is empty 1
CacheException 1
InvalidArgumentException When $key is not valid 1
InvalidArgumentException "hex2bin(): Hexadecimal input string must have an even length" 1
PublisherException For collisions and restriction violations 1
CastException 1
InvalidArgumentException for invalid HTTP methods. 1
InvalidArgumentException for invalid or unsupported schemes. 1
HTTPException When the body is invalid as JSON. 1
InvalidArgumentException If the body property is not string or array. 1
InvalidArgumentException if the $path specified is invalid. 1
RuntimeException on the second or subsequent call to the method. 1
FormatException 1
Exception\InvalidArgumentException 1
Exception\RuntimeException 1
ValidationException 1
ErrorException 1
BadRequestException 1
RouterException 2
HTTPException|RedirectException 2
FrameworkException 2
PageNotFoundException 2
HoneypotException 2
HTTPException For invalid protocols 2
DownloadException 2
HTTPException For invalid status code arguments. 2
HTTPException For invalid status code. 2
FileException 2
ValidationException If group not found. 2
FileNotFoundException 3
ModelException 3
FilterException 3
SecurityException 3
BadMethodCallException 3
ConfigException 3
\Psr\Log\InvalidArgumentException 3
HTTPException 4
EncryptionException 4
LogicException 4
InvalidArgumentException If the body property is not array. 4
SessionException 4
ImageException 6
RedisException 6
RuntimeException 7
DataException 9
CookieException 10
RedirectException 11
InvalidArgumentException 20
ReflectionException 22
Exception 79
DatabaseException 83
@todo auto check for TextCastToInt 1
auto check for InsertIndexValue 1
replace: delete index entries before insert 1
Implement nested resource routing (See CakePHP) 1
missing charset & collat 1
missing charset, collat & check for existent 1
address memcache & redis needs 1
implement check for this instead static $insertKeyPermission 1
Support for cascade 1
Recommend removing reliance on config injection 1
Do downloads need CSP or Cookies? Compare with ResponseTrait::send() 1
Recommend researching these directives, might need: 'private', 'no-transform', 'no-store', 'must-revalidate' 1
Determine if this can be refactored to use $this-getMethodParams(). 1
BC set $queryClass default as null in 4.1 2
Recommend moving to Pager 2
@var string '', 'tls' or 'ssl'. 'tls' will issue a STARTTLS command 1
array|string> 1
array>|null 1
array>|null 1
list|ConstructablePluginInterface>|null 1
array> 1
array 1
class-string 1
''|'Lax'|'None'|'Strict' 1
DateTimeInterface|int|string 1
array{only?: list, exclude?: list} 1
list 1
int Number of seconds to set HSTS header 1
list method name 1
BaseBuilder|null 1
array{escape: array, data: array}|array{} 1
float|null 1
Timer 1
CLIRequest|IncomingRequest|null 1
(Closure(mixed...): ResponseInterface|string)|string|null 1
Router 1
'php-cli'|'web'|null 1
'array'|'object'|class-string 1
non-empty-string|null 1
Pager 1
array> 1
array|string>|string>|string 1
EncrypterInterface 1
array 1
array [name => digest size] 1
string|null Null is used for buffer cleanup. 1
array [classname => instance] 1
array|null> [name => params] 1
array|null> [classname => arguments] 1
FiltersConfig 1
Database 1
object 1
Database|null 1
string Raw SQL string 1
TConnection 1
list 1
list 1
false|TConnection 1
array|string> 1
list, keyName?: string}> 1
array{fields?: list, keyName?: string} 1
TStatement|null 1
BaseConnection 1
float|string 1
list true=protect, false=not protect 1
array|list> 1
false|PgSqlResult 1
int|null milliseconds 1
bool Enable Foreign Key constraint or not 1
int<0, 3>|null flag 1
false|SQLite3Result 1
array> [name => attributes] 1
false|mysqli 1
array [field => type] 1
Client 1
Memcache|Memcached 1
Model|object 1
Generator 1
DOMParser 1
Controller 1
list 1
FiltersConfig|null 1
Filters|null 1
DOMDocument 1
MigrationRunner|null 1
CodeIgniter 1
class-string|list> 1
Seeder 1
list 1
array 1
array 1
Modules|null 1
Images 1
Image|null 1
array 1
array 1
(Closure(array): TEntity)|string|null 1
(Closure(TEntity, bool, bool): array)|string|null 1
HoneypotConfig 1
Commands 1
array 1
commands_list 1
Logger 1
array 1
array [name => property] 1
array> 1
array{get?: array, post?: array, request?: array, cookie?: array, server?: array} 1
array|string>|string 1
FileCollection|null 1
UserAgent 1
Negotiate|null 1
ContentSecurityPolicy 1
CookieStore 1
bool|string|null 1
UserAgents 1
URI|null 1
array|null 1
list 1
ViewConfig 1
callable|null 1
list>|list>> 1
FormatterInterface|null 1
'html'|'json'|'xml'|null 1
array, HandlerInterface> 1
0|4 1
array 1
int Unix timestamp 1
list> Table Data. 1
bool Sort the table rows in DESC order or not. 1
string|null The model that holding this resource's data 1
object|null The model that holding this resource's data 1
list 1
array, 2: list}> 1
DateTimeInterface|static|null 1
DateTimeZone|string 1
IntlCalendar 1
mixed Kint mode 1
'html'|'text' 1
''|'ssl'|'tls' 1
'mail'|'sendmail'|'smtp' 1
'7bit'|'8bit' 1
int<1, 5> 1
array}> 1
object{ruleSets: list} 1
PagerConfig 1
list|null 1
Autoloader 1
array> 1
array> 1
array 1
ToolbarConfig 1
list 1
ExceptionsConfig 1
RendererInterface|null 1
array History files 1
SessionHandlerInterface 1
Memcached|null 1
array [routeKey => handler] 1
array [ uri_segment => namespace ] 1
string HTTP verb like `GET`,`POST` or `*` or `CLI` 1
(Closure(string): (ResponseInterface|string|void))|string 1
(Closure(mixed...): (ResponseInterface|string|void))|string 1
RouteCollectionInterface 1
\CodeIgniter\Session\Session; 1
array Paths to preload. 2
array|string> 2
int|list 2
array>>|array> 2
array>> 2
array{before: list, after: list} 2
array> 2
bool|list 2
array 2
list 2
list> 2
string 'cookie' or 'session' 2
ValidationInterface|null 2
int seconds 2
array [column => type] 2
array [type => classname] 2
Modules 2
RequestInterface 2
false|TResult 2
bool|null 2
bool|int 2
array|string|null 2
resource 2
CacheInterface|FileVarExportHandler 2
Redis|null 2
CacheInterface 2
RequestInterface|null 2
RouteCollection|null 2
mixed 2
list array of methods 2
array 2
array [key => instance] 2
Cookie 2
float|int 2
ResponseInterface|null 2
FileLocatorInterface 2
list 2
"\r\n"|"n" 2
RendererInterface 2
array, array|string>> 3
array> 3
array 3
CLIRequest|IncomingRequest 3
App 3
int|string 3
Forge 3
non-empty-string 3
Query 3
ConnectionInterface 3
IncomingRequest 3
array 3
URI 3
list 3
callable 3
array|string> 4
LoggerInterface 4
array|bool 4
false 4
false|string 5
array 5
bool|string 6
int|null 6
Connection 6
resource|null 6
ResponseInterface 7
BaseConnection 7
list|string 8
list|string|null 8
array 8
array|null 8
array{ 9
float 9
array|string 18
string|null 26
int 51
list 57
array 97
array 97
bool 142
string 381