Wir verpacken Güter, aber warum eigentlich? Die Verpackung dient einerseits dem Schutz der Güter, andererseits übernimmt sie aber auch logistische und Informationsaufgaben. Diese Informationen tragen dazu bei, dass die Güter zur richtigen Zeit am richtigen Ort sind. Verpackungen unterliegen einem stetigen Wandel. Dabei gewinnt die Nachhaltigkeit mehr und mehr an Bedeutung.
Logistiker/In EBA und EFZ
Beginner
Leistungsziele
B4.1 Ich beschreibe die Herkunft, Umweltverträglichkeit und den Einsatz der in der Logistik verwendeten Materialien und Rohstoffe (Verpackungen, Verbrauchsmaterial, Gebinde, Reinigungsmittel, usw.). (K2)
C2.2 Ich beschreibe die Kennzeichnungen von Gütern und Transporteinheiten und deren Bedeutung. (K2)
C2.7 Ich beschreibe Transportschäden (mechanische, klimatische, Temperatur, Schädlinge, physikalische Kräfte beim Transport, usw.) und die entsprechenden Erkennungsmerkmale. (K2)
D1.3 Ich erläutere die geltenden Verpackungsbegriffe gem. DIN-Norm 55405. (K2)
D1.4 Ich beschreibe die Kriterien (ökologische, ökonomische und Sicherheit) für die Wahl der geeigneten Verpackung von Gütern. (K2)
⧉public setQuery(string $sql, $binds = null, bool $setEscape = true): $this Sets the raw query string to use for this statement.
/**
* Sets the raw query string to use for this statement.
*
* @param mixed $binds
*
* @return $this
*/
Defined in <ROOT>/system/Database/Query.php:106
⧉public setBinds(array $binds, bool $setEscape = true): $this Will store the variables to bind into the query later.
/**
* Will store the variables to bind into the query later.
*
* @return $this
*/
Defined in <ROOT>/system/Database/Query.php:137
⧉public getQuery(): string Returns the final, processed query string after binding, etal has been perfor...
/**
* Returns the final, processed query string after binding, etal
* has been performed.
*/
Defined in <ROOT>/system/Database/Query.php:156
⧉public setDuration(float $start, ?float $end = null): $this Records the execution time of the statement using microtime(true) for it's st...
/**
* Records the execution time of the statement using microtime(true)
* for it's start and end values. If no end value is present, will
* use the current time to determine total duration.
*
* @param float $end
*
* @return $this
*/
Defined in <ROOT>/system/Database/Query.php:174
⧉public getStartTime(bool $returnRaw = false, int $decimals = 6): float|string Returns the start time in seconds with microseconds.
/**
* Returns the start time in seconds with microseconds.
*
* @return float|string
*/
Defined in <ROOT>/system/Database/Query.php:192
⧉public getDuration(int $decimals = 6): string Returns the duration of this query during execution, or null if the query has...
/**
* Returns the duration of this query during execution, or null if
* the query has not been executed yet.
*
* @param int $decimals The accuracy of the returned time.
*/
Defined in <ROOT>/system/Database/Query.php:207
⧉public setError(int $code, string $error): $this Stores the error description that happened for this query.
/**
* Stores the error description that happened for this query.
*
* @return $this
*/
Defined in <ROOT>/system/Database/Query.php:217
⧉public hasError(): bool Reports whether this statement created an error not.
/**
* Reports whether this statement created an error not.
*/
Defined in <ROOT>/system/Database/Query.php:228
⧉public getErrorCode(): int Returns the error code created while executing this statement.
/**
* Returns the error code created while executing this statement.
*/
Defined in <ROOT>/system/Database/Query.php:236
⧉public getErrorMessage(): string Returns the error message created while executing this statement.
/**
* Returns the error message created while executing this statement.
*/
Defined in <ROOT>/system/Database/Query.php:244
⧉public isWriteType(): bool Determines if the statement is a write-type query or not.
/**
* Determines if the statement is a write-type query or not.
*/
Defined in <ROOT>/system/Database/Query.php:252
⧉public swapPrefix(string $orig, string $swap): $this Swaps out one table prefix for a new one.
/**
* Swaps out one table prefix for a new one.
*
* @return $this
*/
Defined in <ROOT>/system/Database/Query.php:262
⧉public getOriginalQuery(): string Returns the original SQL that was passed into the system.
/**
* Returns the original SQL that was passed into the system.
*/
Defined in <ROOT>/system/Database/Query.php:279
⧉public debugToolbarDisplay(): string Returns string to display in debug toolbar
/**
* Returns string to display in debug toolbar
*/
Defined in <ROOT>/system/Database/Query.php:371
⧉public __toString(): string Return text representation of the query
/**
* Return text representation of the query
*/
Defined in <ROOT>/system/Database/Query.php:425
⧉protected compileBinds() Escapes and inserts any binds into the finalQueryString property.
/**
* Escapes and inserts any binds into the finalQueryString property.
*
* @see https://regex101.com/r/EUEhay/5
*/
Defined in <ROOT>/system/Database/Query.php:289
⧉protected matchNamedBinds(string $sql, array $binds): string Match bindings
/**
* Match bindings
*/
Defined in <ROOT>/system/Database/Query.php:317
⧉protected matchSimpleBinds(string $sql, array $binds, int $bindCount, int $ml): string Match bindings
/**
* Match bindings
*/
Defined in <ROOT>/system/Database/Query.php:341
⧉public connect(bool $persistent = false): false|mysqli Connect to the database.
/**
* Connect to the database.
*
* @return false|mysqli
*
* @throws DatabaseException
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:82
⧉public reconnect() Keep or establish the connection if no queries have been sent for a length of...
/**
* Keep or establish the connection if no queries have been sent for
* a length of time exceeding the server's idle timeout.
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:228
⧉public setDatabase(string $databaseName): bool Select a specific database table to use.
/**
* Select a specific database table to use.
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:245
⧉public getVersion(): string Returns a string containing the version of the database being used.
/**
* Returns a string containing the version of the database being used.
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:267
⧉public affectedRows(): int Returns the total number of rows affected by this query.
/**
* Returns the total number of rows affected by this query.
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:324
⧉public escapeLikeStringDirect($str): string|string[] Escape Like String Direct There are a few instances where MySQLi queries cann...
/**
* Escape Like String Direct
* There are a few instances where MySQLi queries cannot take the
* additional "ESCAPE x" parameter for specifying the escape character
* in "LIKE" strings, and this handles those directly with a backslash.
*
* @param string|string[] $str Input string
*
* @return string|string[]
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:351
⧉public error(): array Returns the last error code and message. Must return this format: ['code' => ...
/**
* Returns the last error code and message.
* Must return this format: ['code' => string|int, 'message' => string]
* intval(code) === 0 means "no error".
*
* @return array<string, int|string>
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:557
⧉public insertID(): int Insert ID
/**
* Insert ID
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:575
/**
* Saves our connection settings.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:345
⧉public initialize(): void Initializes the database connection/settings.
/**
* Initializes the database connection/settings.
*
* @return void
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:374
⧉public close() Close the database connection.
/**
* Close the database connection.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:441
⧉public persistentConnect(): false|object|resource Create a persistent database connection.
/**
* Create a persistent database connection.
*
* @return false|object|resource
* @phpstan-return false|TConnection
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:462
⧉public getConnection(?string $alias = null): false|object|resource Returns the actual connection object. If both a 'read' and 'write' connection...
/**
* Returns the actual connection object. If both a 'read' and 'write'
* connection has been specified, you can pass either term in to
* get that connection. If you pass either alias in and only a single
* connection is present, it must return the sole connection.
*
* @return false|object|resource
* @phpstan-return TConnection
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:476
⧉public getDatabase(): string Returns the name of the current database being used.
/**
* Returns the name of the current database being used.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:485
⧉public setPrefix(string $prefix = ''): string Set DB Prefix
/**
* Set DB Prefix
*
* Set's the DB Prefix to something new without needing to reconnect
*
* @param string $prefix The prefix
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:497
⧉public getPrefix(): string Returns the database prefix.
/**
* Returns the database prefix.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:505
⧉public getPlatform(): string The name of the platform in use (MySQLi, Postgre, SQLite3, OCI8, etc)
/**
* The name of the platform in use (MySQLi, Postgre, SQLite3, OCI8, etc)
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:513
⧉public setAliasedTables(array $aliases): $this Sets the Table Aliases to use. These are typically collected during use of th...
/**
* Sets the Table Aliases to use. These are typically
* collected during use of the Builder, and set here
* so queries are built correctly.
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:525
⧉public addTableAlias(string $table): $this Add a table alias to our list.
/**
* Add a table alias to our list.
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:537
⧉public query(string $sql, $binds = null, bool $setEscapeFlags = true, string $queryClass = ''): BaseResult|bool|Query BaseResult when “read” type query, bool when “write” type query, Query when prepared query Orchestrates a query against the database. Queries must use Database\Statemen...
/**
* Orchestrates a query against the database. Queries must use
* Database\Statement objects to store the query and build it.
* This method works with the cache.
*
* Should automatically handle different connections for read/write
* queries if needed.
*
* @param array|string|null $binds
*
* @return BaseResult|bool|Query BaseResult when “read” type query, bool when “write” type query, Query when prepared query
* @phpstan-return BaseResult<TConnection, TResult>|bool|Query
*
* @todo BC set $queryClass default as null in 4.1
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:569
⧉public simpleQuery(string $sql): false|object|resource Performs a basic query against the database. No binding or caching is perform...
/**
* Performs a basic query against the database. No binding or caching
* is performed, nor are transactions handled. Simply takes a raw
* query string and returns the database-specific result id.
*
* @return false|object|resource
* @phpstan-return false|TResult
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:686
⧉public transOff() Disable Transactions
/**
* Disable Transactions
*
* This permits transactions to be disabled at run-time.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:700
/**
* Enable/disable Transaction Strict Mode
*
* When strict mode is enabled, if you are running multiple groups of
* transactions, if one group fails all subsequent groups will be
* rolled back.
*
* If strict mode is disabled, each group is treated autonomously,
* meaning a failure of one group will not affect any others
*
* @param bool $mode = true
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:719
/**
* Start Transaction
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:729
⧉public transException(bool $transExcetion): $this If set to true, exceptions are thrown during transactions.
/**
* If set to true, exceptions are thrown during transactions.
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:743
/**
* Complete Transaction
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:753
⧉public transStatus(): bool Lets you retrieve the transaction flag to determine if it has failed
/**
* Lets you retrieve the transaction flag to determine if it has failed
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:779
⧉public transBegin(bool $testMode = false): bool Begin Transaction
/**
* Begin Transaction
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:787
⧉public transCommit(): bool Commit Transaction
/**
* Commit Transaction
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:821
/**
* Rollback Transaction
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:840
⧉public table($tableName): BaseBuilder Returns a non-shared new instance of the query builder for this connection.
/**
* Returns a non-shared new instance of the query builder for this connection.
*
* @param array|string $tableName
*
* @return BaseBuilder
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:880
⧉public newQuery(): CodeIgniter\Database\BaseBuilder Returns a new instance of the BaseBuilder class with a cleared FROM clause.
/**
* Returns a new instance of the BaseBuilder class with a cleared FROM clause.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:894
⧉public prepare(Closure $func, array $options = array()): BasePreparedQuery|null Creates a prepared statement with the database that can then be used to execu...
/**
* Creates a prepared statement with the database that can then
* be used to execute multiple statements against. Within the
* closure, you would build the query in any normal way, though
* the Query Builder is the expected manner.
*
* Example:
* $stmt = $db->prepare(function($db)
* {
* return $db->table('users')
* ->where('id', 1)
* ->get();
* })
*
* @return BasePreparedQuery|null
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:920
⧉public getLastQuery(): Query Returns the last query's statement object.
/**
* Returns the last query's statement object.
*
* @return Query
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:948
⧉public showLastQuery(): string Returns a string representation of the last query's statement object.
/**
* Returns a string representation of the last query's statement object.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:956
⧉public getConnectStart(): ?float Returns the time we started to connect to this database in seconds with micro...
/**
* Returns the time we started to connect to this database in
* seconds with microseconds.
*
* Used by the Debug Toolbar's timeline.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:967
⧉public getConnectDuration(int $decimals = 6): string Returns the number of seconds with microseconds that it took to connect to th...
/**
* Returns the number of seconds with microseconds that it took
* to connect to the database.
*
* Used by the Debug Toolbar's timeline.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:978
/**
* Protect Identifiers
*
* This function is used extensively by the Query Builder class, and by
* a couple functions in this class.
* It takes a column or table name (optionally with an alias) and inserts
* the table prefix onto it. Some logic is necessary in order to deal with
* column names that include the path. Consider a query like this:
*
* SELECT hostname.database.table.column AS c FROM hostname.database.table
*
* Or a query with aliasing:
*
* SELECT m.member_id, m.member_name FROM members AS m
*
* Since the column name can include up to four segments (host, DB, table, column)
* or also have an alias prefix, we need to do a bit of work to figure this out and
* insert the table prefix (if it exists) in the proper position, and escape only
* the correct identifiers.
*
* @param array|string $item
* @param bool $prefixSingle Prefix a table name with no segments?
* @param bool $protectIdentifiers Protect table or column names?
* @param bool $fieldExists Supplied $item contains a column name?
*
* @return array|string
* @phpstan-return ($item is array ? array : string)
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1011
⧉public escapeIdentifiers($item): array|string Escape the SQL Identifiers
/**
* Escape the SQL Identifiers
*
* This function escapes column and table names
*
* @param array|string $item
*
* @return array|string
* @phpstan-return ($item is array ? array : string)
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1171
⧉public prefixTable(string $table = ''): string Prepends a database prefix if one exists in configuration
/**
* Prepends a database prefix if one exists in configuration
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1231
/**
* Escape String
*
* @param string|string[] $str Input string
* @param bool $like Whether or not the string will be used in a LIKE condition
*
* @return string|string[]
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1286
⧉public escapeLikeString($str): string|string[] Escape LIKE String
/**
* Escape LIKE String
*
* Calls the individual driver for platform
* specific escaping for LIKE conditions
*
* @param string|string[] $str
*
* @return string|string[]
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1328
⧉public callFunction(string $functionName, $params): bool This function enables you to call PHP database functions that are not nativel...
/**
* This function enables you to call PHP database functions that are not natively included
* in CodeIgniter, in a platform independent manner.
*
* @param array ...$params
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1351
⧉public listTables(bool $constrainByPrefix = false): array|false Returns an array of table names
/**
* Returns an array of table names
*
* @return array|false
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1389
⧉public tableExists(string $tableName, bool $cached = true): bool Determine if a particular table exists
/**
* Determine if a particular table exists
*
* @param bool $cached Whether to use data cache
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1425
⧉public getFieldNames(string $table): array|false Fetch Field Names
/**
* Fetch Field Names
*
* @return array|false
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1466
⧉public fieldExists(string $fieldName, string $tableName): bool Determine if a particular field exists
/**
* Determine if a particular field exists
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1511
⧉public getFieldData(string $table): stdClass[] Returns an object with field data
/**
* Returns an object with field data
*
* @return stdClass[]
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1521
⧉public getIndexData(string $table): array Returns an object with key data
/**
* Returns an object with key data
*
* @return array
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1531
⧉public getForeignKeyData(string $table): array Returns an object with foreign key data
/**
* Returns an object with foreign key data
*
* @return array
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1541
/**
* Enables foreign key checks temporarily.
*
* @return bool
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1613
⧉public pretend(bool $pretend = true): $this Allows the engine to be set into a mode where queries are not actually execut...
/**
* Allows the engine to be set into a mode where queries are not
* actually executed, but they are still generated, timed, etc.
*
* This is primarily used by the prepared query functionality.
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1633
⧉public resetDataCache(): $this Empties our data cache. Especially helpful during testing.
/**
* Empties our data cache. Especially helpful during testing.
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1645
⧉public isWriteType($sql): bool Determines if the statement is a write-type query or not.
/**
* Determines if the statement is a write-type query or not.
*
* @param string $sql
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1657
⧉public __get(string $key): array|bool|float|int|object|resource|string|null Accessor for properties if they exist.
/**
* Accessor for properties if they exist.
*
* @return array|bool|float|int|object|resource|string|null
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1753
⧉public __isset(string $key): bool Checker for properties existence.
/**
* Checker for properties existence.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1765
⧉protected _close() Close the database connection.
/**
* Close the database connection.
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:237
⧉protected execute(string $sql): false|mysqli_result; Executes the query against the database.
/**
* Executes the query against the database.
*
* @return false|mysqli_result;
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:285
⧉protected prepQuery(string $sql): string Prep the query. If needed, each database adapter can prep the query string
/**
* Prep the query. If needed, each database adapter can prep the query string
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:310
/**
* Platform-dependant string escape
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:332
⧉protected _listTables(bool $prefixLimit = false, ?string $tableName = null): string Generates the SQL for listing tables in a platform-dependent manner. Uses esc...
/**
* Generates the SQL for listing tables in a platform-dependent manner.
* Uses escapeLikeStringDirect().
*
* @param string|null $tableName If $tableName is provided will return only this table if exists.
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:377
⧉protected _listColumns(string $table = ''): string Generates a platform-specific query string so that the column names can be fe...
/**
* Generates a platform-specific query string so that the column names can be fetched.
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:395
⧉protected _fieldData(string $table): array Returns an array of objects with field data
/**
* Returns an array of objects with field data
*
* @return stdClass[]
*
* @throws DatabaseException
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:407
⧉protected _indexData(string $table): array Returns an array of objects with index data
/**
* Returns an array of objects with index data
*
* @return stdClass[]
*
* @throws DatabaseException
* @throws LogicException
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:440
⧉protected _foreignKeyData(string $table): array Returns an array of objects with Foreign key data
/**
* Returns an array of objects with Foreign key data
*
* @return stdClass[]
*
* @throws DatabaseException
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:485
/**
* Rollback Transaction
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:607
⧉protected getDriverFunctionPrefix(): string Get the prefix of the function to access the DB.
/**
* Get the prefix of the function to access the DB.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1373
⧉protected foreignKeyDataToObjects(array $data): array[ Converts array of arrays generated by _foreignKeyData() to array of objects
/**
* Converts array of arrays generated by _foreignKeyData() to array of objects
*
* @return array[
* {constraint_name} =>
* stdClass[
* 'constraint_name' => string,
* 'table_name' => string,
* 'column_name' => string[],
* 'foreign_table_name' => string,
* 'foreign_column_name' => string[],
* 'on_delete' => string,
* 'on_update' => string,
* 'match' => string
* ]
* ]
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1563
list => string (33) "CodeIgniter\Validation\Views\list"
single => string (35) "CodeIgniter\Validation\Views\single"
⧉public __construct() Will attempt to get environment variables with names that match the propertie...
/**
* Will attempt to get environment variables with names
* that match the properties of the child class.
*
* The "shortPrefix" is the lowercase-only config class name.
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in <ROOT>/system/Config/BaseConfig.php:60
/**
* Retrieve an environment-specific configuration setting
*
* @return string|null
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in <ROOT>/system/Config/BaseConfig.php:128
⧉protected registerProperties() Provides external libraries a simple way to register one or more options into...
/**
* Provides external libraries a simple way to register one or more
* options into a config file.
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in <ROOT>/system/Config/BaseConfig.php:174
⧉public shouldDiscover(string $alias): bool Should the application auto-discover the requested resource.
/**
* Should the application auto-discover the requested resource.
*/
Inherited from CodeIgniter\Modules\Modules
Defined in <ROOT>/system/Modules/Modules.php:45
⧉public __construct() Merge the built-in and developer-configured filters and plugins, with prefere...
/**
* Merge the built-in and developer-configured filters and plugins,
* with preference to the developer ones.
*/
Inherited from CodeIgniter\Config\View
Defined in <ROOT>/system/Config/View.php:108
/**
* Retrieve an environment-specific configuration setting
*
* @return string|null
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in <ROOT>/system/Config/BaseConfig.php:128
⧉protected registerProperties() Provides external libraries a simple way to register one or more options into...
/**
* Provides external libraries a simple way to register one or more
* options into a config file.
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in <ROOT>/system/Config/BaseConfig.php:174
⧉public shouldDiscover(string $alias): bool Should the application auto-discover the requested resource.
/**
* Should the application auto-discover the requested resource.
*/
Inherited from CodeIgniter\Modules\Modules
Defined in <ROOT>/system/Modules/Modules.php:45
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:150
⧉public setTable(string $table): $this Specify the table associated with a model
/**
* Specify the table associated with a model
*
* @param string $table Table
*
* @return $this
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:169
⧉public getIdValue($data): array|int|string|null Returns the id value for the data array or object
/**
* Returns the id value for the data array or object
*
* @param array|object $data Data
*
* @return array|int|string|null
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:538
⧉public chunk(int $size, Closure $userFunc) Loops over records in batches, allowing you to operate on them. Works with $t...
/**
* Loops over records in batches, allowing you to operate on them.
* Works with $this->builder to get the Compiled select to
* determine the rows to operate on.
* This method works only with dbCalls.
*
* @throws DataException
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:559
⧉public countAllResults(bool $reset = true, bool $test = false): int|string Override countAllResults to account for soft deleted accounts.
/**
* Override countAllResults to account for soft deleted accounts.
*
* @return int|string
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:593
⧉public builder(?string $table = null): BaseBuilder Provides a shared instance of the Query Builder.
/**
* Provides a shared instance of the Query Builder.
*
* @return BaseBuilder
*
* @throws ModelException
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:616
⧉public set($key, $value = '', ?bool $escape = null): $this Captures the builder's set() method so that we can validate the data here. Th...
/**
* Captures the builder's set() method so that we can validate the
* data here. This allows it to be used with any of the other
* builder methods and still get validated data, like replace.
*
* @param array|object|string $key Field name, or an array of field/value pairs
* @param bool|float|int|object|string|null $value Field value, if $key is a single field
* @param bool|null $escape Whether to escape values
*
* @return $this
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:663
⧉public __get(string $name): mixed Provides/instantiates the builder/db connection and model's table/primary key...
/**
* Provides/instantiates the builder/db connection and model's table/primary key names and return type.
*
* @param string $name Name
*
* @return mixed
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:797
⧉public __isset(string $name): bool Checks for the existence of properties across this model, builder, and db con...
/**
* Checks for the existence of properties across this model, builder, and db connection.
*
* @param string $name Name
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:815
⧉public __call(string $name, array $params): mixed Provides direct access to method in the builder (if available) and the databa...
/**
* Provides direct access to method in the builder (if available)
* and the database connection.
*
* @return mixed
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:830
⧉public find($id = null): array|object|null The resulting row of data, or null. Fetches the row of database.
/**
* Fetches the row of database.
*
* @param array|int|string|null $id One primary key or an array of primary keys
*
* @return array|object|null The resulting row of data, or null.
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:538
⧉public findColumn(string $columnName): array|null The resulting row of data, or null if no data found. Fetches the column of database.
/**
* Fetches the column of database.
*
* @param string $columnName Column Name
*
* @return array|null The resulting row of data, or null if no data found.
*
* @throws DataException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:582
⧉public findAll(int $limit0, int $offset0): array Fetches all results, while optionally limiting them.
/**
* Fetches all results, while optionally limiting them.
*
* @param int $limit Limit
* @param int $offset Offset
*
* @return array
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:601
⧉public first(): array|object|null Returns the first row of the result set.
/**
* Returns the first row of the result set.
*
* @return array|object|null
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:641
⧉public save($data): bool A convenience method that will attempt to determine whether the data should b...
/**
* A convenience method that will attempt to determine whether the
* data should be inserted or updated. Will work with either
* an array or object. When using with custom class objects,
* you must ensure that the class will provide access to the class
* variables, even if through a magic method.
*
* @param array|object $data Data
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:683
⧉public getInsertID(): int|string Returns last insert ID or 0.
/**
* Returns last insert ID or 0.
*
* @return int|string
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:718
⧉public insertBatch(?array $set = null, ?bool $escape = null, int $batchSize = 100, bool $testing = false): bool|int Number of rows inserted or FALSE on failure Compiles batch insert runs the queries, validating each row prior.
/**
* Compiles batch insert runs the queries, validating each row prior.
*
* @param array|null $set an associative array of insert values
* @param bool|null $escape Whether to escape values
* @param int $batchSize The size of the batch to run
* @param bool $testing True means only number of records is returned, false will execute the query
*
* @return bool|int Number of rows inserted or FALSE on failure
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:818
⧉public updateBatch(?array $set = null, ?string $index = null, int $batchSize = 100, bool $returnSQL = false): false|int|string[] Number of rows affected or FALSE on failure, SQL array when testMode Compiles an update and runs the query.
/**
* Compiles an update and runs the query.
*
* @param array|null $set An associative array of update values
* @param string|null $index The where key
* @param int $batchSize The size of the batch to run
* @param bool $returnSQL True means SQL is returned, false will execute the query
*
* @return false|int|string[] Number of rows affected or FALSE on failure, SQL array when testMode
*
* @throws DatabaseException
* @throws ReflectionException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:968
⧉public delete($id = null, bool $purge = false): BaseResult|bool Deletes a single record from the database where $id matches.
/**
* Deletes a single record from the database where $id matches.
*
* @param array|int|string|null $id The rows primary key(s)
* @param bool $purge Allows overriding the soft deletes setting.
*
* @return BaseResult|bool
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1042
⧉public purgeDeleted(): bool|string Returns a string if in test mode. Permanently deletes all rows that have been marked as deleted through soft de...
/**
* Permanently deletes all rows that have been marked as deleted
* through soft deletes (deleted = 1).
*
* @return bool|string Returns a string if in test mode.
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1083
⧉public withDeleted(bool $val = true): $this Sets $useSoftDeletes value so that we can temporarily override the soft delet...
/**
* Sets $useSoftDeletes value so that we can temporarily override
* the soft deletes settings. Can be used for all find* methods.
*
* @param bool $val Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1100
⧉public onlyDeleted(): $this Works with the find* methods to return only the rows that have been deleted.
/**
* Works with the find* methods to return only the rows that
* have been deleted.
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1113
⧉public replace(?array $data = null, bool $returnSQL = false): BaseResult|false|Query|string Compiles a replace and runs the query.
/**
* Compiles a replace and runs the query.
*
* @param array|null $data Data
* @param bool $returnSQL Set to true to return Query String
*
* @return BaseResult|false|Query|string
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1129
⧉public errors(bool $forceDB = false): array<string,string> Grabs the last error(s) that occurred. If data was validated, it will first c...
/**
* Grabs the last error(s) that occurred. If data was validated,
* it will first check for errors there, otherwise will try to
* grab the last error from the Database connection.
*
* The return array should be in the following format:
* ['source' => 'message']
*
* @param bool $forceDB Always grab the db error, not validation
*
* @return array<string,string>
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1155
⧉public paginate(?int $perPage = null, string $group = 'default', ?int $page = null, int $segment0): array|null Works with Pager to get the size and offset parameters. Expects a GET variabl...
/**
* Works with Pager to get the size and offset parameters.
* Expects a GET variable (?page=2) that specifies the page of results
* to display.
*
* @param int|null $perPage Items per page
* @param string $group Will be used by the pagination library to identify a unique pagination set.
* @param int|null $page Optional page number (useful when the page number is provided in different way)
* @param int $segment Optional URI segment number (if page number is provided by URI segment)
*
* @return array|null
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1177
⧉public setAllowedFields(array $allowedFields): $this It could be used when you have to change default or override current allowed ...
/**
* It could be used when you have to change default or override current allowed fields.
*
* @param array $allowedFields Array with names of fields
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1202
⧉public protect(bool $protect = true): $this Sets whether or not we should whitelist data set during updates or inserts ag...
/**
* Sets whether or not we should whitelist data set during
* updates or inserts against $this->availableFields.
*
* @param bool $protect Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1217
⧉public skipValidation(bool $skip = true): $this Set the value of the skipValidation flag.
/**
* Set the value of the skipValidation flag.
*
* @param bool $skip Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1340
⧉public setValidationMessages(array $validationMessages): $this Allows to set validation messages. It could be used when you have to change d...
/**
* Allows to set validation messages.
* It could be used when you have to change default or override current validate messages.
*
* @param array $validationMessages Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1355
⧉public setValidationMessage(string $field, array $fieldMessages): $this Allows to set field wise validation message. It could be used when you have t...
/**
* Allows to set field wise validation message.
* It could be used when you have to change default or override current validate messages.
*
* @param string $field Field Name
* @param array $fieldMessages Validation messages
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1371
⧉public setValidationRules(array $validationRules): $this Allows to set validation rules. It could be used when you have to change defa...
/**
* Allows to set validation rules.
* It could be used when you have to change default or override current validate rules.
*
* @param array $validationRules Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1386
⧉public setValidationRule(string $field, $fieldRules): $this Allows to set field wise validation rules. It could be used when you have to ...
/**
* Allows to set field wise validation rules.
* It could be used when you have to change default or override current validate rules.
*
* @param string $field Field Name
* @param array|string $fieldRules Validation rules
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1402
⧉public cleanRules(bool $choice = false): $this Should validation rules be removed before saving? Most handy when doing updates.
/**
* Should validation rules be removed before saving?
* Most handy when doing updates.
*
* @param bool $choice Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1417
⧉public validate($data): bool Validate the data against the validation rules (or the validation group) spec...
/**
* Validate the data against the validation rules (or the validation group)
* specified in the class property, $validationRules.
*
* @param array|object $data Data
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1430
⧉public getValidationRules(array $options = array()): array Returns the model's defined validation rules so that they can be used elsewhe...
/**
* Returns the model's defined validation rules so that they
* can be used elsewhere, if needed.
*
* @param array $options Options
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1462
⧉public getValidationMessages(): array Returns the model's validation messages, so they can be used elsewhere, if ne...
/**
* Returns the model's validation messages, so they
* can be used elsewhere, if needed.
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1485
⧉public allowCallbacks(bool $val = true): $this Sets $tempAllowCallbacks value so that we can temporarily override the settin...
/**
* Sets $tempAllowCallbacks value so that we can temporarily override
* the setting. Resets after the next method that uses triggers.
*
* @param bool $val value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1521
⧉public asArray(): $this Sets the return type of the results to be as an associative array.
/**
* Sets the return type of the results to be as an associative array.
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1573
⧉public asObject(string $class = 'object'): $this Sets the return type to be of the specified type of object. Defaults to a sim...
/**
* Sets the return type to be of the specified type of object.
* Defaults to a simple object, but can be any class that has
* class vars with the same name as the collection columns,
* or at least allows them to be created.
*
* @param string $class Class Name
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1590
/**
* Sets $allowEmptyInserts.
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1812
⧉protected doFind(bool $singleton, $id = null): array|object|null The resulting row of data, or null. Fetches the row of database from $this->table with a primary key matching $id...
/**
* Fetches the row of database from $this->table with a primary key
* matching $id.
* This method works only with dbCalls.
*
* @param bool $singleton Single or multiple results
* @param array|int|string|null $id One primary key or an array of primary keys
*
* @return array|object|null The resulting row of data, or null.
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:186
⧉protected doFindColumn(string $columnName): array|null The resulting row of data, or null if no data found. Fetches the column of database from $this->table. This method works only with...
/**
* Fetches the column of database from $this->table.
* This method works only with dbCalls.
*
* @param string $columnName Column Name
*
* @return array|null The resulting row of data, or null if no data found.
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:217
⧉protected doFindAll(int $limit0, int $offset0): array Works with the current Query Builder instance to return all results, while op...
/**
* Works with the current Query Builder instance to return
* all results, while optionally limiting them.
* This method works only with dbCalls.
*
* @param int $limit Limit
* @param int $offset Offset
*
* @return array
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:232
⧉protected doFirst(): array|object|null Returns the first row of the result set. Will take any previous Query Builder...
/**
* Returns the first row of the result set. Will take any previous
* Query Builder calls into account when determining the result set.
* This method works only with dbCalls.
*
* @return array|object|null
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:252
⧉protected doInsert(array $data): bool Inserts data into the current table. This method works only with dbCalls.
/**
* Inserts data into the current table.
* This method works only with dbCalls.
*
* @param array $data Data
*
* @return bool
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:279
⧉protected doInsertBatch(?array $set = null, ?bool $escape = null, int $batchSize = 100, bool $testing = false): bool|int Number of rows inserted or FALSE on failure Compiles batch insert strings and runs the queries, validating each row prior...
/**
* Compiles batch insert strings and runs the queries, validating each row prior.
* This method works only with dbCalls.
*
* @param array|null $set An associative array of insert values
* @param bool|null $escape Whether to escape values
* @param int $batchSize The size of the batch to run
* @param bool $testing True means only number of records is returned, false will execute the query
*
* @return bool|int Number of rows inserted or FALSE on failure
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:352
⧉protected doUpdate($id = null, $data = null): bool Updates a single record in $this->table. This method works only with dbCalls.
/**
* Updates a single record in $this->table.
* This method works only with dbCalls.
*
* @param array|int|string|null $id
* @param array|null $data
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:374
⧉protected doUpdateBatch(?array $set = null, ?string $index = null, int $batchSize = 100, bool $returnSQL = false): false|int|string[] Number of rows affected or FALSE on failure, SQL array when testMode Compiles an update string and runs the query This method works only with dbCa...
/**
* Compiles an update string and runs the query
* This method works only with dbCalls.
*
* @param array|null $set An associative array of update values
* @param string|null $index The where key
* @param int $batchSize The size of the batch to run
* @param bool $returnSQL True means SQL is returned, false will execute the query
*
* @return false|int|string[] Number of rows affected or FALSE on failure, SQL array when testMode
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:412
⧉protected doDelete($id = null, bool $purge = false): bool|string Deletes a single record from $this->table where $id matches the table's prima...
/**
* Deletes a single record from $this->table where $id matches
* the table's primaryKey
* This method works only with dbCalls.
*
* @param array|int|string|null $id The rows primary key(s)
* @param bool $purge Allows overriding the soft deletes setting.
*
* @return bool|string
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:429
⧉protected doPurgeDeleted(): bool|string Returns a string if in test mode. Permanently deletes all rows that have been marked as deleted through soft de...
/**
* Permanently deletes all rows that have been marked as deleted
* through soft deletes (deleted = 1)
* This method works only with dbCalls.
*
* @return bool|string Returns a string if in test mode.
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:466
⧉protected doOnlyDeleted() Works with the find* methods to return only the rows that have been deleted. ...
/**
* Works with the find* methods to return only the rows that
* have been deleted.
* This method works only with dbCalls.
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:478
⧉protected doReplace(?array $data = null, bool $returnSQL = false): BaseResult|false|Query|string Compiles a replace into string and runs the query This method works only with...
/**
* Compiles a replace into string and runs the query
* This method works only with dbCalls.
*
* @param array|null $data Data
* @param bool $returnSQL Set to true to return Query String
*
* @return BaseResult|false|Query|string
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:492
⧉protected doErrors(): array<string,string> Grabs the last error(s) that occurred from the Database connection. The retur...
/**
* Grabs the last error(s) that occurred from the Database connection.
* The return array should be in the following format:
* ['source' => 'message']
* This method works only with dbCalls.
*
* @return array<string,string>
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:505
⧉protected idValue($data): array|int|string|null Returns the id value for the data array or object
/**
* Returns the id value for the data array or object
*
* @param array|object $data Data
*
* @return array|int|string|null
*
* @deprecated Use getIdValue() instead. Will be removed in version 5.0.
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:526
⧉protected shouldUpdate($data): bool This method is called on save to determine if entry have to be updated If thi...
/**
* This method is called on save to determine if entry have to be updated
* If this method return false insert operation will be executed
*
* @param array|object $data Data
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:682
⧉protected objectToRawArray($data, bool $onlyChanged = true, bool $recursive = false): ?array Takes a class an returns an array of it's public and protected properties as ...
/**
* Takes a class an returns an array of it's public and protected
* properties as an array with raw values.
*
* @param object|string $data
* @param bool $recursive If true, inner entities will be casted as array as well
*
* @return array|null Array
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:770
⧉protected initialize() Initializes the instance with any additional steps. Optionally implemented by...
/**
* Initializes the instance with any additional steps.
* Optionally implemented by child classes.
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:342
⧉protected doProtectFields(array $data): array Ensures that only the fields that are allowed to be updated are in the data a...
/**
* Ensures that only the fields that are allowed to be updated
* are in the data array.
*
* Used by insert() and update() to protect against mass assignment
* vulnerabilities.
*
* @param array $data Data
*
* @throws DataException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1235
⧉protected setDate(?int $userData = null): int|string Sets the date or current date if null value is passed.
/**
* Sets the date or current date if null value is passed.
*
* @param int|null $userData An optional PHP timestamp to be converted.
*
* @return int|string
*
* @throws ModelException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1263
⧉protected intToDate(int $value): int|string A utility function to allow child models to use the type of date/time format ...
/**
* A utility function to allow child models to use the type of
* date/time format that they prefer. This is primarily used for
* setting created_at, updated_at and deleted_at values, but can be
* used by inheriting classes.
*
* The available time formats are:
* - 'int' - Stores the date as an integer timestamp
* - 'datetime' - Stores the data in the SQL datetime format
* - 'date' - Stores the date (only) in the SQL date format.
*
* @param int $value value
*
* @return int|string
*
* @throws ModelException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1287
⧉protected timeToDate(CodeIgniter\I18n\Time $value): int|string Converts Time value to string using $this->dateFormat.
/**
* Converts Time value to string using $this->dateFormat.
*
* The available time formats are:
* - 'int' - Stores the date as an integer timestamp
* - 'datetime' - Stores the data in the SQL datetime format
* - 'date' - Stores the date (only) in the SQL date format.
*
* @param Time $value value
*
* @return int|string
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1316
⧉protected cleanValidationRules(array $rules, ?array $data = null): array Removes any rules that apply to fields that have not been set currently so th...
/**
* Removes any rules that apply to fields that have not been set
* currently so that rules don't block updating when only updating
* a partial row.
*
* @param array $rules Array containing field name and rule
* @param array|null $data Data
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1498
⧉protected trigger(string $event, array $eventData): array A simple event trigger for Model Events that allows additional data manipulat...
/**
* A simple event trigger for Model Events that allows additional
* data manipulation within the model. Specifically intended for
* usage by child models this can be used to format data,
* save/load related classes, etc.
*
* It is the responsibility of the callback methods to return
* the data itself.
*
* Each $eventData array MUST have a 'data' key with the relevant
* data for callback methods (like an array of key/value pairs to insert
* or update, an array of results, etc.)
*
* If callbacks are not allowed then returns $eventData immediately.
*
* @param string $event Event
* @param array $eventData Event Data
*
* @return array
*
* @throws DataException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1550
⧉protected objectToArray($data, bool $onlyChanged = true, bool $recursive = false): array Takes a class and returns an array of its public and protected properties as ...
/**
* Takes a class and returns an array of its public and protected
* properties as an array suitable for use in creates and updates.
* This method uses objectToRawArray() internally and does conversion
* to string on all Time instances
*
* @param object|string $data Data
* @param bool $onlyChanged Only Changed Property
* @param bool $recursive If true, inner entities will be cast as array as well
*
* @return array Array
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1611
⧉protected transformDataToArray($data, string $type): array Transform data to array.
/**
* Transform data to array.
*
* @param array|object|null $data Data
* @param string $type Type of data (insert|update)
*
* @throws DataException
* @throws InvalidArgumentException
* @throws ReflectionException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1673
⧉protected fillPlaceholders(array $rules, array $data): array Replace any placeholders within the rules with the values that match the 'key...
/**
* Replace any placeholders within the rules with the values that
* match the 'key' of any properties being set. For example, if
* we had the following $data array:
*
* [ 'id' => 13 ]
*
* and the following rule:
*
* 'required|is_unique[users,email,id,{id}]'
*
* The value of {id} would be replaced with the actual id in the form data:
*
* 'required|is_unique[users,email,id,13]'
*
* @param array $rules Validation rules
* @param array $data Data
*
* @codeCoverageIgnore
*
* @deprecated use fillPlaceholders($rules, $data) from Validation instead
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1778
⧉private get_action_html_entity_decode($result)
Defined in <ROOT>/app/Models/Frontend_model.php:122
⇄⧉public static classToArray($data, $primaryKey = null, string $dateFormat = 'datetime', bool $onlyChanged = true): array Takes a class an returns an array of it's public and protected properties as ...
/**
* Takes a class an returns an array of it's public and protected
* properties as an array suitable for use in creates and updates.
*
* @param object|string $data
* @param string|null $primaryKey
*
* @throws ReflectionException
*
* @codeCoverageIgnore
*
* @deprecated since 4.1
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:875
data => string (2) "46"
⧉records => stdClass#91 (17)
Properties (17)
public date_time -> string (19) "2023-11-09 17:00:44"
public department_id -> string (2) "24"
⧉public description -> UTF-8 string (379) "Wir verpacken Güter, aber warum eigentlich? Die Verpackung dient einerseits ...
Wir verpacken Güter, aber warum eigentlich? Die Verpackung dient einerseits dem Schutz der Güter, andererseits übernimmt sie aber auch logistische und Informationsaufgaben. Diese Informationen tragen dazu bei, dass die Güter zur richtigen Zeit am richtigen Ort sind. Verpackungen unterliegen einem stetigen Wandel. Dabei gewinnt die Nachhaltigkeit mehr und mehr an Bedeutung.
public download_link -> string (0) ""
public hour -> string (11) "4 Lektionen"
public id -> string (2) "46"
public level -> string (1) "1"
public name -> string (41) "Modul 602 Versandbereite Pakete erstellen"
public print_link -> string (0) ""
public share_link -> string (0) ""
public skills -> string (2) "9,"
public status -> string (1) "0"
public submitted_by -> string (6) "hodler"
public tags -> string (3) "12,"
public title -> string (41) "Modul 602 Versandbereite Pakete erstellen"
public updated_at -> string (19) "2022-02-11 14:05:26"
public video -> string (36) "https://www.nanoo.tv/link/v/AWtvujqJ"
⧉public initialize(Config\Autoload $config, Config\Modules $modules): $this Reads in the configuration array (described above) and stores the valid parts...
/**
* Reads in the configuration array (described above) and stores
* the valid parts that we'll need.
*
* @return $this
*/
Defined in <ROOT>/system/Autoloader/Autoloader.php:96
⧉public register() Register the loader with the SPL autoloader stack.
/**
* Register the loader with the SPL autoloader stack.
*/
Defined in <ROOT>/system/Autoloader/Autoloader.php:152
⧉public unregister(): void Unregister autoloader.
/**
* Unregister autoloader.
*
* This method is for testing.
*/
Defined in <ROOT>/system/Autoloader/Autoloader.php:171
⧉public addNamespace($namespace, ?string $path = null): $this Registers namespaces with the autoloader.
/**
* Registers namespaces with the autoloader.
*
* @param array<string, array<int, string>|string>|string $namespace
* @phpstan-param array<string, list<string>|string>|string $namespace
*
* @return $this
*/
Defined in <ROOT>/system/Autoloader/Autoloader.php:185
⧉public getNamespace(?string $prefix = null): array Get namespaces with prefixes as keys and paths as values.
/**
* Get namespaces with prefixes as keys and paths as values.
*
* If a prefix param is set, returns only paths to the given prefix.
*
* @return array
*/
Defined in <ROOT>/system/Autoloader/Autoloader.php:215
⧉public removeNamespace(string $namespace): $this Removes a single namespace from the psr4 settings.
/**
* Removes a single namespace from the psr4 settings.
*
* @return $this
*/
Defined in <ROOT>/system/Autoloader/Autoloader.php:229
⧉public loadClassmap(string $class): false|string Load a class using available class mapping.
/**
* Load a class using available class mapping.
*
* @return false|string
*/
Defined in <ROOT>/system/Autoloader/Autoloader.php:243
⧉public loadClass(string $class): false|string The mapped file on success, or boolean false Loads the class file for a given class name.
/**
* Loads the class file for a given class name.
*
* @param string $class The fully qualified class name.
*
* @return false|string The mapped file on success, or boolean false
* on failure.
*/
Defined in <ROOT>/system/Autoloader/Autoloader.php:262
/**
* Check file path.
*
* Checks special characters that are illegal in filenames on certain
* operating systems and special characters requiring special escaping
* to manipulate at the command line. Replaces spaces and consecutive
* dashes with a single dash. Trim period, dash and underscore from beginning
* and end of filename.
*
* @return string The sanitized filename
*/
Defined in <ROOT>/system/Autoloader/Autoloader.php:331
⧉public loadHelpers(): void Loads helpers
/**
* Loads helpers
*/
Defined in <ROOT>/system/Autoloader/Autoloader.php:483
⧉protected loadInNamespace(string $class): false|string The mapped file name on success, or boolean false on fail Loads the class file for a given class name.
/**
* Loads the class file for a given class name.
*
* @param string $class The fully-qualified class name
*
* @return false|string The mapped file name on success, or boolean false on fail
*/
Defined in <ROOT>/system/Autoloader/Autoloader.php:277
⧉protected includeFile(string $file): false|string The filename on success, false if the file is not loaded A central way to include a file. Split out primarily for testing purposes.
/**
* A central way to include a file. Split out primarily for testing purposes.
*
* @return false|string The filename on success, false if the file is not loaded
*/
Defined in <ROOT>/system/Autoloader/Autoloader.php:307
⧉protected discoverComposerNamespaces() Locates autoload information from Composer, if available.
/**
* Locates autoload information from Composer, if available.
*
* @deprecated No longer used.
*/
Defined in <ROOT>/system/Autoloader/Autoloader.php:449
Defined in <ROOT>/system/Autoloader/FileLocator.php:27
⧉public locateFile(string $file, ?string $folder = null, string $ext = 'php'): false|string The path to the file, or false if not found. Attempts to locate a file by examining the name for a namespace and looking t...
/**
* Attempts to locate a file by examining the name for a namespace
* and looking through the PSR-4 namespaced files that we know about.
*
* @param string $file The namespaced file to locate
* @param string|null $folder The folder within the namespace that we should look for the file.
* @param string $ext The file extension the file should have.
*
* @return false|string The path to the file, or false if not found.
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:42
⧉public getClassname(string $file): string Examines a file and returns the fully qualified class name.
/**
* Examines a file and returns the fully qualified class name.
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:113
⧉public search(string $path, string $ext = 'php', bool $prioritizeApp = true): array Searches through all of the defined namespaces looking for a file. Returns an...
/**
* Searches through all of the defined namespaces looking for a file.
* Returns an array of all found locations for the defined file.
*
* Example:
*
* $locator->search('Config/Routes.php');
* // Assuming PSR4 namespaces include foo and bar, might return:
* [
* 'app/Modules/foo/Config/Routes.php',
* 'app/Modules/bar/Config/Routes.php',
* ]
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:166
⧉public findQualifiedNameFromPath(string $path): false|string The qualified name or false if the path is not found Find the qualified name of a file according to the namespace of the first mat...
/**
* Find the qualified name of a file according to
* the namespace of the first matched namespace path.
*
* @return false|string The qualified name or false if the path is not found
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:253
⧉public listFiles(string $path): array Scans the defined namespaces, returning a list of all files that are containe...
/**
* Scans the defined namespaces, returning a list of all files
* that are contained within the subpath specified by $path.
*
* @return string[] List of file paths
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:295
⧉public listNamespaceFiles(string $prefix, string $path): array Scans the provided namespace, returning a list of all files that are containe...
/**
* Scans the provided namespace, returning a list of all files
* that are contained within the sub path specified by $path.
*
* @return string[] List of file paths
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:328
⧉protected ensureExt(string $path, string $ext): string Ensures a extension is at the end of a filename
/**
* Ensures a extension is at the end of a filename
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:199
⧉protected getNamespaces(): array<int, array<string, string>> Return the namespace mappings we know about.
/**
* Return the namespace mappings we know about.
*
* @return array<int, array<string, string>>
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:217
⧉protected legacyLocate(string $file, ?string $folder = null): false|string The path to the file, or false if not found. Checks the app folder to see if the file can be found. Only for use with file...
/**
* Checks the app folder to see if the file can be found.
* Only for use with filenames that DO NOT include namespacing.
*
* @return false|string The path to the file, or false if not found.
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:362
/**
* Constructor.
*
* @param \Config\Logger $config
*
* @throws RuntimeException
*/
Defined in <ROOT>/system/Log/Logger.php:120
⧉public emergency($message, array $context = array()): bool System is unusable.
/**
* System is unusable.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:158
⧉public alert($message, array $context = array()): bool Action must be taken immediately.
/**
* Action must be taken immediately.
*
* Example: Entire website down, database unavailable, etc. This should
* trigger the SMS alerts and wake you up.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:171
⧉public error($message, array $context = array()): bool Runtime errors that do not require immediate action but should typically be l...
/**
* Runtime errors that do not require immediate action but should typically
* be logged and monitored.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:194
⧉public warning($message, array $context = array()): bool Exceptional occurrences that are not errors.
/**
* Exceptional occurrences that are not errors.
*
* Example: Use of deprecated APIs, poor use of an API, undesirable things
* that are not necessarily wrong.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:207
⧉public notice($message, array $context = array()): bool Normal but significant events.
/**
* Normal but significant events.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:217
/**
* Detailed debug information.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:239
⧉public log($level, $message, array $context = array()): bool Logs with an arbitrary level.
/**
* Logs with an arbitrary level.
*
* @param string $level
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:250
⧉public determineFile(): array Determines the file and line that the logging call was made from by analyzing...
/**
* Determines the file and line that the logging call
* was made from by analyzing the backtrace.
* Find the earliest stack frame that is part of our logging system.
*/
Defined in <ROOT>/system/Log/Logger.php:372
⧉protected interpolate($message, array $context = array()): string Replaces any placeholders in the message with variables from the context, as ...
/**
* Replaces any placeholders in the message with variables
* from the context, as well as a few special items like:
*
* {session_vars}
* {post_vars}
* {get_vars}
* {env}
* {env:foo}
* {file}
* {line}
*
* @param string $message
*
* @return string
*/
Defined in <ROOT>/system/Log/Logger.php:316
⧉protected cleanFileNames(string $file): string Cleans the paths of filenames by replacing APPPATH, SYSTEMPATH, FCPATH with t...
/**
* Cleans the paths of filenames by replacing APPPATH, SYSTEMPATH, FCPATH
* with the actual var. i.e.
*
* /var/www/site/app/Controllers/Home.php
* becomes:
* APPPATH/Controllers/Home.php
*
* @deprecated Use dedicated `clean_path()` function.
*/
Defined in <ROOT>/system/Log/Logger.php:422
⧉public render(string $view, ?array $options = null, ?bool $saveData = null): string Builds the output based upon a file name and any data that has already been set.
/**
* Builds the output based upon a file name and any
* data that has already been set.
*
* Valid $options:
* - cache Number of seconds to cache for
* - cache_name Name to use for cache
*
* @param string $view File name of the view source
* @param array|null $options Reserved for 3rd-party uses since
* it might be needed to pass additional info
* to other template engines.
* @param bool|null $saveData If true, saves data for subsequent calls,
* if false, cleans the data after displaying,
* if null, uses the config setting.
*/
Defined in <ROOT>/system/View/View.php:166
⧉public renderString(string $view, ?array $options = null, ?bool $saveData = null): string Builds the output based upon a string and any data that has already been set....
/**
* Builds the output based upon a string and any
* data that has already been set.
* Cache does not apply, because there is no "key".
*
* @param string $view The view contents
* @param array|null $options Reserved for 3rd-party uses since
* it might be needed to pass additional info
* to other template engines.
* @param bool|null $saveData If true, saves data for subsequent calls,
* if false, cleans the data after displaying,
* if null, uses the config setting.
*/
Defined in <ROOT>/system/View/View.php:277
⧉public excerpt(string $string, int $length = 20): string Extract first bit of a long string and add ellipsis
/**
* Extract first bit of a long string and add ellipsis
*/
Defined in <ROOT>/system/View/View.php:300
⧉public setData(array $data = array(), ?string $context = null): CodeIgniter\View\RendererInterface Sets several pieces of view data at once.
/**
* Sets several pieces of view data at once.
*
* @param string|null $context The context to escape it for: html, css, js, url
* If null, no escaping will happen
* @phpstan-param null|'html'|'js'|'css'|'url'|'attr'|'raw' $context
*/
Defined in <ROOT>/system/View/View.php:312
⧉public setVar(string $name, $value = null, ?string $context = null): CodeIgniter\View\RendererInterface Sets a single piece of view data.
/**
* Sets a single piece of view data.
*
* @param mixed $value
* @param string|null $context The context to escape it for: html, css, js, url
* If null, no escaping will happen
* @phpstan-param null|'html'|'js'|'css'|'url'|'attr'|'raw' $context
*/
Defined in <ROOT>/system/View/View.php:332
⧉public resetData(): CodeIgniter\View\RendererInterface Removes all of the view data from the system.
/**
* Removes all of the view data from the system.
*/
Defined in <ROOT>/system/View/View.php:347
⧉public getData(): array Returns the current data that will be displayed in the view.
/**
* Returns the current data that will be displayed in the view.
*/
Defined in <ROOT>/system/View/View.php:357
⧉public extend(string $layout) Specifies that the current view should extend an existing layout.
/**
* Specifies that the current view should extend an existing layout.
*/
Defined in <ROOT>/system/View/View.php:365
⧉public section(string $name) Starts holds content for a section within the layout.
/**
* Starts holds content for a section within the layout.
*
* @param string $name Section name
*/
Defined in <ROOT>/system/View/View.php:375
⧉public endSection() Captures the last section
/**
* Captures the last section
*
* @throws RuntimeException
*/
Defined in <ROOT>/system/View/View.php:389
⧉public renderSection(string $sectionName) Renders a section's contents.
/**
* Renders a section's contents.
*/
Defined in <ROOT>/system/View/View.php:410
⧉public include(string $view, ?array $options = null, $saveData = true): string Used within layout views to include additional views.
/**
* Used within layout views to include additional views.
*
* @param bool $saveData
*/
Defined in <ROOT>/system/View/View.php:429
⧉public getPerformanceData(): array Returns the performance data that might have been collected during the execut...
/**
* Returns the performance data that might have been collected
* during the execution. Used primarily in the Debug Toolbar.
*/
Defined in <ROOT>/system/View/View.php:438
⧉protected decorateOutput(string $html): string Runs the generated output through any declared view decorators.
/**
* Runs the generated output through any declared
* view decorators.
*/
Defined in <ROOT>/system/View/ViewDecoratorTrait.php:22
⧉protected logPerformance(float $start, float $end, string $view) Logs performance data for rendering a view.
/**
* Logs performance data for rendering a view.
*/
Defined in <ROOT>/system/View/View.php:446
/**
* Runs the validation process, returning true/false determining whether
* validation was successful or not.
*
* @param array|null $data The array of data to validate.
* @param string|null $group The predefined group of rules to apply.
* @param string|null $dbGroup The database group to use.
*/
Defined in <ROOT>/system/Validation/Validation.php:110
⧉public check($value, string $rule, array $errors = array()): bool Runs the validation process, returning true or false determining whether vali...
/**
* Runs the validation process, returning true or false
* determining whether validation was successful or not.
*
* @param array|bool|float|int|object|string|null $value
* @param string[] $errors
*/
Defined in <ROOT>/system/Validation/Validation.php:184
⧉public withRequest(CodeIgniter\HTTP\RequestInterface $request): CodeIgniter\Validation\ValidationInterface Takes a Request object and grabs the input data to use from its array values.
/**
* Takes a Request object and grabs the input data to use from its
* array values.
*/
Defined in <ROOT>/system/Validation/Validation.php:392
⧉public setRule(string $field, ?string $label, $rules, array $errors = array()): $this Sets an individual rule and custom error messages for a single field.
/**
* Sets an individual rule and custom error messages for a single field.
*
* The custom error message should be just the messages that apply to
* this field, like so:
*
* [
* 'rule' => 'message',
* 'rule' => 'message',
* ]
*
* @param array|string $rules
*
* @return $this
*
* @throws TypeError
*/
Defined in <ROOT>/system/Validation/Validation.php:429
⧉public setRules(array $rules, array $errors = array()): CodeIgniter\Validation\ValidationInterface Stores the rules that should be used to validate the items. Rules should be a...
/**
* Stores the rules that should be used to validate the items.
* Rules should be an array formatted like:
*
* [
* 'field' => 'rule1|rule2'
* ]
*
* The $errors array should be formatted like:
* [
* 'field' => [
* 'rule' => 'message',
* 'rule' => 'message
* ],
* ]
*
* @param array $errors // An array of custom error messages
*/
Defined in <ROOT>/system/Validation/Validation.php:469
⧉public getRules(): array Returns all of the rules currently defined.
/**
* Returns all of the rules currently defined.
*/
Defined in <ROOT>/system/Validation/Validation.php:496
⧉public hasRule(string $field): bool Checks to see if the rule for key $field has been set or not.
/**
* Checks to see if the rule for key $field has been set or not.
*/
Defined in <ROOT>/system/Validation/Validation.php:504
⧉public getRuleGroup(string $group): array Get rule group.
/**
* Get rule group.
*
* @param string $group Group.
*
* @return string[] Rule group.
*
* @throws ValidationException If group not found.
*/
Defined in <ROOT>/system/Validation/Validation.php:518
⧉public setRuleGroup(string $group) Set rule group.
/**
* Set rule group.
*
* @param string $group Group.
*
* @throws ValidationException If group not found.
*/
Defined in <ROOT>/system/Validation/Validation.php:538
⧉public listErrors(string $template = 'list'): string Returns the rendered HTML of the errors as defined in $template.
/**
* Returns the rendered HTML of the errors as defined in $template.
*
* You can also use validation_list_errors() in Form helper.
*/
Defined in <ROOT>/system/Validation/Validation.php:554
⧉public showError(string $field, string $template = 'single'): string Displays a single error in formatted HTML as defined in the $template view.
/**
* Displays a single error in formatted HTML as defined in the $template view.
*
* You can also use validation_show_error() in Form helper.
*/
Defined in <ROOT>/system/Validation/Validation.php:570
⧉public loadRuleGroup(?string $group = null): array Loads custom rule groups (if set) into the current rules.
/**
* Loads custom rule groups (if set) into the current rules.
*
* Rules can be pre-defined in Config\Validation and can
* be any name, but must all still be an array of the
* same format used with setRules(). Additionally, check
* for {group}_errors for an array of custom error messages.
*
* @return array
*
* @throws ValidationException
*/
Defined in <ROOT>/system/Validation/Validation.php:612
⧉public hasError(string $field): bool Checks to see if an error exists for the given field.
/**
* Checks to see if an error exists for the given field.
*/
Defined in <ROOT>/system/Validation/Validation.php:692
⧉public getError(?string $field = null): string Returns the error(s) for a specified $field (or empty string if not set).
/**
* Returns the error(s) for a specified $field (or empty string if not
* set).
*/
Defined in <ROOT>/system/Validation/Validation.php:703
⧉public getErrors(): array Returns the array of errors that were encountered during a run() call. The ar...
/**
* Returns the array of errors that were encountered during
* a run() call. The array should be in the following format:
*
* [
* 'field1' => 'error message',
* 'field2' => 'error message',
* ]
*
* @return array<string, string>
*
* @codeCoverageIgnore
*/
Defined in <ROOT>/system/Validation/Validation.php:730
⧉public setError(string $field, string $error): CodeIgniter\Validation\ValidationInterface Sets the error for a specific field. Used by custom validation methods.
/**
* Sets the error for a specific field. Used by custom validation methods.
*/
Defined in <ROOT>/system/Validation/Validation.php:738
⧉public reset(): CodeIgniter\Validation\ValidationInterface Resets the class to a blank slate. Should be called whenever you need to proc...
/**
* Resets the class to a blank slate. Should be called whenever
* you need to process more than one array.
*/
Defined in <ROOT>/system/Validation/Validation.php:827
⧉protected processRules(string $field, ?string $label, $value, $rules = null, ?array $data = null, ?string $originalField = null): bool Runs all of $rules against $field, until one fails, or all of them have been ...
/**
* Runs all of $rules against $field, until one fails, or
* all of them have been processed. If one fails, it adds
* the error to $this->errors and moves on to the next,
* so that we can collect all of the first errors.
*
* @param array|string $value
* @param array|null $rules
* @param array|null $data The array of data to validate, with `DBGroup`.
* @param string|null $originalField The original asterisk field name like "foo.*.bar".
*/
Defined in <ROOT>/system/Validation/Validation.php:202
⧉protected loadRuleSets() Loads all of the rulesets classes that have been defined in the Config\Valida...
/**
* Loads all of the rulesets classes that have been defined in the
* Config\Validation and stores them locally so we can use them.
*/
Defined in <ROOT>/system/Validation/Validation.php:589
⧉protected fillPlaceholders(array $rules, array $data): array Replace any placeholders within the rules with the values that match the 'key...
/**
* Replace any placeholders within the rules with the values that
* match the 'key' of any properties being set. For example, if
* we had the following $data array:
*
* [ 'id' => 13 ]
*
* and the following rule:
*
* 'required|is_unique[users,email,id,{id}]'
*
* The value of {id} would be replaced with the actual id in the form data:
*
* 'required|is_unique[users,email,id,13]'
*/
Defined in <ROOT>/system/Validation/Validation.php:654
/**
* Attempts to find the appropriate error message
*
* @param string|null $value The value that caused the validation to fail.
*/
Defined in <ROOT>/system/Validation/Validation.php:750
⧉protected splitRules(string $rules): array Split rules string by pipe operator.
/**
* Split rules string by pipe operator.
*/
Defined in <ROOT>/system/Validation/Validation.php:785
⧉private isClosure($rule): bool
/**
* @param Closure|string $rule
*/
Defined in <ROOT>/system/Validation/Validation.php:357
⧉private isStringList(array $array): bool Is the array a string list `list<string>`?
/**
* Is the array a string list `list<string>`?
*/
Defined in <ROOT>/system/Validation/Validation.php:365
protected validationMessages -> array (0)
protected validationRules -> array (0)
⧉private builderMethodsNotAvailable -> array (3)
0 => string (17) "getCompiledInsert"
1 => string (17) "getCompiledSelect"
2 => string (17) "getCompiledUpdate"
private tempPrimaryKeyValue -> null
⧉public get_custom_query($query = '')
Defined in <ROOT>/app/Models/Frontend_model.php:6
⧉public get_custom_code($query = '')
Defined in <ROOT>/app/Models/Frontend_model.php:15
⧉public get_records($table = '', $where = '')
Defined in <ROOT>/app/Models/Frontend_model.php:24
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:150
⧉public setTable(string $table): $this Specify the table associated with a model
/**
* Specify the table associated with a model
*
* @param string $table Table
*
* @return $this
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:169
⧉public getIdValue($data): array|int|string|null Returns the id value for the data array or object
/**
* Returns the id value for the data array or object
*
* @param array|object $data Data
*
* @return array|int|string|null
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:538
⧉public chunk(int $size, Closure $userFunc) Loops over records in batches, allowing you to operate on them. Works with $t...
/**
* Loops over records in batches, allowing you to operate on them.
* Works with $this->builder to get the Compiled select to
* determine the rows to operate on.
* This method works only with dbCalls.
*
* @throws DataException
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:559
⧉public countAllResults(bool $reset = true, bool $test = false): int|string Override countAllResults to account for soft deleted accounts.
/**
* Override countAllResults to account for soft deleted accounts.
*
* @return int|string
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:593
⧉public builder(?string $table = null): BaseBuilder Provides a shared instance of the Query Builder.
/**
* Provides a shared instance of the Query Builder.
*
* @return BaseBuilder
*
* @throws ModelException
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:616
⧉public set($key, $value = '', ?bool $escape = null): $this Captures the builder's set() method so that we can validate the data here. Th...
/**
* Captures the builder's set() method so that we can validate the
* data here. This allows it to be used with any of the other
* builder methods and still get validated data, like replace.
*
* @param array|object|string $key Field name, or an array of field/value pairs
* @param bool|float|int|object|string|null $value Field value, if $key is a single field
* @param bool|null $escape Whether to escape values
*
* @return $this
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:663
⧉public __get(string $name): mixed Provides/instantiates the builder/db connection and model's table/primary key...
/**
* Provides/instantiates the builder/db connection and model's table/primary key names and return type.
*
* @param string $name Name
*
* @return mixed
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:797
⧉public __isset(string $name): bool Checks for the existence of properties across this model, builder, and db con...
/**
* Checks for the existence of properties across this model, builder, and db connection.
*
* @param string $name Name
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:815
⧉public __call(string $name, array $params): mixed Provides direct access to method in the builder (if available) and the databa...
/**
* Provides direct access to method in the builder (if available)
* and the database connection.
*
* @return mixed
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:830
⧉public find($id = null): array|object|null The resulting row of data, or null. Fetches the row of database.
/**
* Fetches the row of database.
*
* @param array|int|string|null $id One primary key or an array of primary keys
*
* @return array|object|null The resulting row of data, or null.
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:538
⧉public findColumn(string $columnName): array|null The resulting row of data, or null if no data found. Fetches the column of database.
/**
* Fetches the column of database.
*
* @param string $columnName Column Name
*
* @return array|null The resulting row of data, or null if no data found.
*
* @throws DataException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:582
⧉public findAll(int $limit0, int $offset0): array Fetches all results, while optionally limiting them.
/**
* Fetches all results, while optionally limiting them.
*
* @param int $limit Limit
* @param int $offset Offset
*
* @return array
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:601
⧉public first(): array|object|null Returns the first row of the result set.
/**
* Returns the first row of the result set.
*
* @return array|object|null
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:641
⧉public save($data): bool A convenience method that will attempt to determine whether the data should b...
/**
* A convenience method that will attempt to determine whether the
* data should be inserted or updated. Will work with either
* an array or object. When using with custom class objects,
* you must ensure that the class will provide access to the class
* variables, even if through a magic method.
*
* @param array|object $data Data
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:683
⧉public getInsertID(): int|string Returns last insert ID or 0.
/**
* Returns last insert ID or 0.
*
* @return int|string
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:718
⧉public insertBatch(?array $set = null, ?bool $escape = null, int $batchSize = 100, bool $testing = false): bool|int Number of rows inserted or FALSE on failure Compiles batch insert runs the queries, validating each row prior.
/**
* Compiles batch insert runs the queries, validating each row prior.
*
* @param array|null $set an associative array of insert values
* @param bool|null $escape Whether to escape values
* @param int $batchSize The size of the batch to run
* @param bool $testing True means only number of records is returned, false will execute the query
*
* @return bool|int Number of rows inserted or FALSE on failure
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:818
⧉public updateBatch(?array $set = null, ?string $index = null, int $batchSize = 100, bool $returnSQL = false): false|int|string[] Number of rows affected or FALSE on failure, SQL array when testMode Compiles an update and runs the query.
/**
* Compiles an update and runs the query.
*
* @param array|null $set An associative array of update values
* @param string|null $index The where key
* @param int $batchSize The size of the batch to run
* @param bool $returnSQL True means SQL is returned, false will execute the query
*
* @return false|int|string[] Number of rows affected or FALSE on failure, SQL array when testMode
*
* @throws DatabaseException
* @throws ReflectionException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:968
⧉public delete($id = null, bool $purge = false): BaseResult|bool Deletes a single record from the database where $id matches.
/**
* Deletes a single record from the database where $id matches.
*
* @param array|int|string|null $id The rows primary key(s)
* @param bool $purge Allows overriding the soft deletes setting.
*
* @return BaseResult|bool
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1042
⧉public purgeDeleted(): bool|string Returns a string if in test mode. Permanently deletes all rows that have been marked as deleted through soft de...
/**
* Permanently deletes all rows that have been marked as deleted
* through soft deletes (deleted = 1).
*
* @return bool|string Returns a string if in test mode.
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1083
⧉public withDeleted(bool $val = true): $this Sets $useSoftDeletes value so that we can temporarily override the soft delet...
/**
* Sets $useSoftDeletes value so that we can temporarily override
* the soft deletes settings. Can be used for all find* methods.
*
* @param bool $val Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1100
⧉public onlyDeleted(): $this Works with the find* methods to return only the rows that have been deleted.
/**
* Works with the find* methods to return only the rows that
* have been deleted.
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1113
⧉public replace(?array $data = null, bool $returnSQL = false): BaseResult|false|Query|string Compiles a replace and runs the query.
/**
* Compiles a replace and runs the query.
*
* @param array|null $data Data
* @param bool $returnSQL Set to true to return Query String
*
* @return BaseResult|false|Query|string
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1129
⧉public errors(bool $forceDB = false): array<string,string> Grabs the last error(s) that occurred. If data was validated, it will first c...
/**
* Grabs the last error(s) that occurred. If data was validated,
* it will first check for errors there, otherwise will try to
* grab the last error from the Database connection.
*
* The return array should be in the following format:
* ['source' => 'message']
*
* @param bool $forceDB Always grab the db error, not validation
*
* @return array<string,string>
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1155
⧉public paginate(?int $perPage = null, string $group = 'default', ?int $page = null, int $segment0): array|null Works with Pager to get the size and offset parameters. Expects a GET variabl...
/**
* Works with Pager to get the size and offset parameters.
* Expects a GET variable (?page=2) that specifies the page of results
* to display.
*
* @param int|null $perPage Items per page
* @param string $group Will be used by the pagination library to identify a unique pagination set.
* @param int|null $page Optional page number (useful when the page number is provided in different way)
* @param int $segment Optional URI segment number (if page number is provided by URI segment)
*
* @return array|null
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1177
⧉public setAllowedFields(array $allowedFields): $this It could be used when you have to change default or override current allowed ...
/**
* It could be used when you have to change default or override current allowed fields.
*
* @param array $allowedFields Array with names of fields
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1202
⧉public protect(bool $protect = true): $this Sets whether or not we should whitelist data set during updates or inserts ag...
/**
* Sets whether or not we should whitelist data set during
* updates or inserts against $this->availableFields.
*
* @param bool $protect Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1217
⧉public skipValidation(bool $skip = true): $this Set the value of the skipValidation flag.
/**
* Set the value of the skipValidation flag.
*
* @param bool $skip Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1340
⧉public setValidationMessages(array $validationMessages): $this Allows to set validation messages. It could be used when you have to change d...
/**
* Allows to set validation messages.
* It could be used when you have to change default or override current validate messages.
*
* @param array $validationMessages Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1355
⧉public setValidationMessage(string $field, array $fieldMessages): $this Allows to set field wise validation message. It could be used when you have t...
/**
* Allows to set field wise validation message.
* It could be used when you have to change default or override current validate messages.
*
* @param string $field Field Name
* @param array $fieldMessages Validation messages
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1371
⧉public setValidationRules(array $validationRules): $this Allows to set validation rules. It could be used when you have to change defa...
/**
* Allows to set validation rules.
* It could be used when you have to change default or override current validate rules.
*
* @param array $validationRules Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1386
⧉public setValidationRule(string $field, $fieldRules): $this Allows to set field wise validation rules. It could be used when you have to ...
/**
* Allows to set field wise validation rules.
* It could be used when you have to change default or override current validate rules.
*
* @param string $field Field Name
* @param array|string $fieldRules Validation rules
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1402
⧉public cleanRules(bool $choice = false): $this Should validation rules be removed before saving? Most handy when doing updates.
/**
* Should validation rules be removed before saving?
* Most handy when doing updates.
*
* @param bool $choice Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1417
⧉public validate($data): bool Validate the data against the validation rules (or the validation group) spec...
/**
* Validate the data against the validation rules (or the validation group)
* specified in the class property, $validationRules.
*
* @param array|object $data Data
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1430
⧉public getValidationRules(array $options = array()): array Returns the model's defined validation rules so that they can be used elsewhe...
/**
* Returns the model's defined validation rules so that they
* can be used elsewhere, if needed.
*
* @param array $options Options
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1462
⧉public getValidationMessages(): array Returns the model's validation messages, so they can be used elsewhere, if ne...
/**
* Returns the model's validation messages, so they
* can be used elsewhere, if needed.
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1485
⧉public allowCallbacks(bool $val = true): $this Sets $tempAllowCallbacks value so that we can temporarily override the settin...
/**
* Sets $tempAllowCallbacks value so that we can temporarily override
* the setting. Resets after the next method that uses triggers.
*
* @param bool $val value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1521
⧉public asArray(): $this Sets the return type of the results to be as an associative array.
/**
* Sets the return type of the results to be as an associative array.
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1573
⧉public asObject(string $class = 'object'): $this Sets the return type to be of the specified type of object. Defaults to a sim...
/**
* Sets the return type to be of the specified type of object.
* Defaults to a simple object, but can be any class that has
* class vars with the same name as the collection columns,
* or at least allows them to be created.
*
* @param string $class Class Name
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1590
/**
* Sets $allowEmptyInserts.
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1812
⧉protected doFind(bool $singleton, $id = null): array|object|null The resulting row of data, or null. Fetches the row of database from $this->table with a primary key matching $id...
/**
* Fetches the row of database from $this->table with a primary key
* matching $id.
* This method works only with dbCalls.
*
* @param bool $singleton Single or multiple results
* @param array|int|string|null $id One primary key or an array of primary keys
*
* @return array|object|null The resulting row of data, or null.
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:186
⧉protected doFindColumn(string $columnName): array|null The resulting row of data, or null if no data found. Fetches the column of database from $this->table. This method works only with...
/**
* Fetches the column of database from $this->table.
* This method works only with dbCalls.
*
* @param string $columnName Column Name
*
* @return array|null The resulting row of data, or null if no data found.
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:217
⧉protected doFindAll(int $limit0, int $offset0): array Works with the current Query Builder instance to return all results, while op...
/**
* Works with the current Query Builder instance to return
* all results, while optionally limiting them.
* This method works only with dbCalls.
*
* @param int $limit Limit
* @param int $offset Offset
*
* @return array
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:232
⧉protected doFirst(): array|object|null Returns the first row of the result set. Will take any previous Query Builder...
/**
* Returns the first row of the result set. Will take any previous
* Query Builder calls into account when determining the result set.
* This method works only with dbCalls.
*
* @return array|object|null
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:252
⧉protected doInsert(array $data): bool Inserts data into the current table. This method works only with dbCalls.
/**
* Inserts data into the current table.
* This method works only with dbCalls.
*
* @param array $data Data
*
* @return bool
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:279
⧉protected doInsertBatch(?array $set = null, ?bool $escape = null, int $batchSize = 100, bool $testing = false): bool|int Number of rows inserted or FALSE on failure Compiles batch insert strings and runs the queries, validating each row prior...
/**
* Compiles batch insert strings and runs the queries, validating each row prior.
* This method works only with dbCalls.
*
* @param array|null $set An associative array of insert values
* @param bool|null $escape Whether to escape values
* @param int $batchSize The size of the batch to run
* @param bool $testing True means only number of records is returned, false will execute the query
*
* @return bool|int Number of rows inserted or FALSE on failure
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:352
⧉protected doUpdate($id = null, $data = null): bool Updates a single record in $this->table. This method works only with dbCalls.
/**
* Updates a single record in $this->table.
* This method works only with dbCalls.
*
* @param array|int|string|null $id
* @param array|null $data
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:374
⧉protected doUpdateBatch(?array $set = null, ?string $index = null, int $batchSize = 100, bool $returnSQL = false): false|int|string[] Number of rows affected or FALSE on failure, SQL array when testMode Compiles an update string and runs the query This method works only with dbCa...
/**
* Compiles an update string and runs the query
* This method works only with dbCalls.
*
* @param array|null $set An associative array of update values
* @param string|null $index The where key
* @param int $batchSize The size of the batch to run
* @param bool $returnSQL True means SQL is returned, false will execute the query
*
* @return false|int|string[] Number of rows affected or FALSE on failure, SQL array when testMode
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:412
⧉protected doDelete($id = null, bool $purge = false): bool|string Deletes a single record from $this->table where $id matches the table's prima...
/**
* Deletes a single record from $this->table where $id matches
* the table's primaryKey
* This method works only with dbCalls.
*
* @param array|int|string|null $id The rows primary key(s)
* @param bool $purge Allows overriding the soft deletes setting.
*
* @return bool|string
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:429
⧉protected doPurgeDeleted(): bool|string Returns a string if in test mode. Permanently deletes all rows that have been marked as deleted through soft de...
/**
* Permanently deletes all rows that have been marked as deleted
* through soft deletes (deleted = 1)
* This method works only with dbCalls.
*
* @return bool|string Returns a string if in test mode.
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:466
⧉protected doOnlyDeleted() Works with the find* methods to return only the rows that have been deleted. ...
/**
* Works with the find* methods to return only the rows that
* have been deleted.
* This method works only with dbCalls.
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:478
⧉protected doReplace(?array $data = null, bool $returnSQL = false): BaseResult|false|Query|string Compiles a replace into string and runs the query This method works only with...
/**
* Compiles a replace into string and runs the query
* This method works only with dbCalls.
*
* @param array|null $data Data
* @param bool $returnSQL Set to true to return Query String
*
* @return BaseResult|false|Query|string
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:492
⧉protected doErrors(): array<string,string> Grabs the last error(s) that occurred from the Database connection. The retur...
/**
* Grabs the last error(s) that occurred from the Database connection.
* The return array should be in the following format:
* ['source' => 'message']
* This method works only with dbCalls.
*
* @return array<string,string>
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:505
⧉protected idValue($data): array|int|string|null Returns the id value for the data array or object
/**
* Returns the id value for the data array or object
*
* @param array|object $data Data
*
* @return array|int|string|null
*
* @deprecated Use getIdValue() instead. Will be removed in version 5.0.
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:526
⧉protected shouldUpdate($data): bool This method is called on save to determine if entry have to be updated If thi...
/**
* This method is called on save to determine if entry have to be updated
* If this method return false insert operation will be executed
*
* @param array|object $data Data
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:682
⧉protected objectToRawArray($data, bool $onlyChanged = true, bool $recursive = false): ?array Takes a class an returns an array of it's public and protected properties as ...
/**
* Takes a class an returns an array of it's public and protected
* properties as an array with raw values.
*
* @param object|string $data
* @param bool $recursive If true, inner entities will be casted as array as well
*
* @return array|null Array
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:770
⧉protected initialize() Initializes the instance with any additional steps. Optionally implemented by...
/**
* Initializes the instance with any additional steps.
* Optionally implemented by child classes.
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:342
⧉protected doProtectFields(array $data): array Ensures that only the fields that are allowed to be updated are in the data a...
/**
* Ensures that only the fields that are allowed to be updated
* are in the data array.
*
* Used by insert() and update() to protect against mass assignment
* vulnerabilities.
*
* @param array $data Data
*
* @throws DataException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1235
⧉protected setDate(?int $userData = null): int|string Sets the date or current date if null value is passed.
/**
* Sets the date or current date if null value is passed.
*
* @param int|null $userData An optional PHP timestamp to be converted.
*
* @return int|string
*
* @throws ModelException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1263
⧉protected intToDate(int $value): int|string A utility function to allow child models to use the type of date/time format ...
/**
* A utility function to allow child models to use the type of
* date/time format that they prefer. This is primarily used for
* setting created_at, updated_at and deleted_at values, but can be
* used by inheriting classes.
*
* The available time formats are:
* - 'int' - Stores the date as an integer timestamp
* - 'datetime' - Stores the data in the SQL datetime format
* - 'date' - Stores the date (only) in the SQL date format.
*
* @param int $value value
*
* @return int|string
*
* @throws ModelException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1287
⧉protected timeToDate(CodeIgniter\I18n\Time $value): int|string Converts Time value to string using $this->dateFormat.
/**
* Converts Time value to string using $this->dateFormat.
*
* The available time formats are:
* - 'int' - Stores the date as an integer timestamp
* - 'datetime' - Stores the data in the SQL datetime format
* - 'date' - Stores the date (only) in the SQL date format.
*
* @param Time $value value
*
* @return int|string
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1316
⧉protected cleanValidationRules(array $rules, ?array $data = null): array Removes any rules that apply to fields that have not been set currently so th...
/**
* Removes any rules that apply to fields that have not been set
* currently so that rules don't block updating when only updating
* a partial row.
*
* @param array $rules Array containing field name and rule
* @param array|null $data Data
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1498
⧉protected trigger(string $event, array $eventData): array A simple event trigger for Model Events that allows additional data manipulat...
/**
* A simple event trigger for Model Events that allows additional
* data manipulation within the model. Specifically intended for
* usage by child models this can be used to format data,
* save/load related classes, etc.
*
* It is the responsibility of the callback methods to return
* the data itself.
*
* Each $eventData array MUST have a 'data' key with the relevant
* data for callback methods (like an array of key/value pairs to insert
* or update, an array of results, etc.)
*
* If callbacks are not allowed then returns $eventData immediately.
*
* @param string $event Event
* @param array $eventData Event Data
*
* @return array
*
* @throws DataException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1550
⧉protected objectToArray($data, bool $onlyChanged = true, bool $recursive = false): array Takes a class and returns an array of its public and protected properties as ...
/**
* Takes a class and returns an array of its public and protected
* properties as an array suitable for use in creates and updates.
* This method uses objectToRawArray() internally and does conversion
* to string on all Time instances
*
* @param object|string $data Data
* @param bool $onlyChanged Only Changed Property
* @param bool $recursive If true, inner entities will be cast as array as well
*
* @return array Array
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1611
⧉protected transformDataToArray($data, string $type): array Transform data to array.
/**
* Transform data to array.
*
* @param array|object|null $data Data
* @param string $type Type of data (insert|update)
*
* @throws DataException
* @throws InvalidArgumentException
* @throws ReflectionException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1673
⧉protected fillPlaceholders(array $rules, array $data): array Replace any placeholders within the rules with the values that match the 'key...
/**
* Replace any placeholders within the rules with the values that
* match the 'key' of any properties being set. For example, if
* we had the following $data array:
*
* [ 'id' => 13 ]
*
* and the following rule:
*
* 'required|is_unique[users,email,id,{id}]'
*
* The value of {id} would be replaced with the actual id in the form data:
*
* 'required|is_unique[users,email,id,13]'
*
* @param array $rules Validation rules
* @param array $data Data
*
* @codeCoverageIgnore
*
* @deprecated use fillPlaceholders($rules, $data) from Validation instead
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1778
⧉private get_action_html_entity_decode($result)
Defined in <ROOT>/app/Models/Frontend_model.php:122
⇄⧉public static classToArray($data, $primaryKey = null, string $dateFormat = 'datetime', bool $onlyChanged = true): array Takes a class an returns an array of it's public and protected properties as ...
/**
* Takes a class an returns an array of it's public and protected
* properties as an array suitable for use in creates and updates.
*
* @param object|string $data
* @param string|null $primaryKey
*
* @throws ReflectionException
*
* @codeCoverageIgnore
*
* @deprecated since 4.1
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:875
⧉public setQuery(string $sql, $binds = null, bool $setEscape = true): $this Sets the raw query string to use for this statement.
/**
* Sets the raw query string to use for this statement.
*
* @param mixed $binds
*
* @return $this
*/
Defined in <ROOT>/system/Database/Query.php:106
⧉public setBinds(array $binds, bool $setEscape = true): $this Will store the variables to bind into the query later.
/**
* Will store the variables to bind into the query later.
*
* @return $this
*/
Defined in <ROOT>/system/Database/Query.php:137
⧉public getQuery(): string Returns the final, processed query string after binding, etal has been perfor...
/**
* Returns the final, processed query string after binding, etal
* has been performed.
*/
Defined in <ROOT>/system/Database/Query.php:156
⧉public setDuration(float $start, ?float $end = null): $this Records the execution time of the statement using microtime(true) for it's st...
/**
* Records the execution time of the statement using microtime(true)
* for it's start and end values. If no end value is present, will
* use the current time to determine total duration.
*
* @param float $end
*
* @return $this
*/
Defined in <ROOT>/system/Database/Query.php:174
⧉public getStartTime(bool $returnRaw = false, int $decimals = 6): float|string Returns the start time in seconds with microseconds.
/**
* Returns the start time in seconds with microseconds.
*
* @return float|string
*/
Defined in <ROOT>/system/Database/Query.php:192
⧉public getDuration(int $decimals = 6): string Returns the duration of this query during execution, or null if the query has...
/**
* Returns the duration of this query during execution, or null if
* the query has not been executed yet.
*
* @param int $decimals The accuracy of the returned time.
*/
Defined in <ROOT>/system/Database/Query.php:207
⧉public setError(int $code, string $error): $this Stores the error description that happened for this query.
/**
* Stores the error description that happened for this query.
*
* @return $this
*/
Defined in <ROOT>/system/Database/Query.php:217
⧉public hasError(): bool Reports whether this statement created an error not.
/**
* Reports whether this statement created an error not.
*/
Defined in <ROOT>/system/Database/Query.php:228
⧉public getErrorCode(): int Returns the error code created while executing this statement.
/**
* Returns the error code created while executing this statement.
*/
Defined in <ROOT>/system/Database/Query.php:236
⧉public getErrorMessage(): string Returns the error message created while executing this statement.
/**
* Returns the error message created while executing this statement.
*/
Defined in <ROOT>/system/Database/Query.php:244
⧉public isWriteType(): bool Determines if the statement is a write-type query or not.
/**
* Determines if the statement is a write-type query or not.
*/
Defined in <ROOT>/system/Database/Query.php:252
⧉public swapPrefix(string $orig, string $swap): $this Swaps out one table prefix for a new one.
/**
* Swaps out one table prefix for a new one.
*
* @return $this
*/
Defined in <ROOT>/system/Database/Query.php:262
⧉public getOriginalQuery(): string Returns the original SQL that was passed into the system.
/**
* Returns the original SQL that was passed into the system.
*/
Defined in <ROOT>/system/Database/Query.php:279
⧉public debugToolbarDisplay(): string Returns string to display in debug toolbar
/**
* Returns string to display in debug toolbar
*/
Defined in <ROOT>/system/Database/Query.php:371
⧉public __toString(): string Return text representation of the query
/**
* Return text representation of the query
*/
Defined in <ROOT>/system/Database/Query.php:425
⧉protected compileBinds() Escapes and inserts any binds into the finalQueryString property.
/**
* Escapes and inserts any binds into the finalQueryString property.
*
* @see https://regex101.com/r/EUEhay/5
*/
Defined in <ROOT>/system/Database/Query.php:289
⧉protected matchNamedBinds(string $sql, array $binds): string Match bindings
/**
* Match bindings
*/
Defined in <ROOT>/system/Database/Query.php:317
⧉protected matchSimpleBinds(string $sql, array $binds, int $bindCount, int $ml): string Match bindings
/**
* Match bindings
*/
Defined in <ROOT>/system/Database/Query.php:341
⧉public connect(bool $persistent = false): false|mysqli Connect to the database.
/**
* Connect to the database.
*
* @return false|mysqli
*
* @throws DatabaseException
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:82
⧉public reconnect() Keep or establish the connection if no queries have been sent for a length of...
/**
* Keep or establish the connection if no queries have been sent for
* a length of time exceeding the server's idle timeout.
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:228
⧉public setDatabase(string $databaseName): bool Select a specific database table to use.
/**
* Select a specific database table to use.
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:245
⧉public getVersion(): string Returns a string containing the version of the database being used.
/**
* Returns a string containing the version of the database being used.
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:267
⧉public affectedRows(): int Returns the total number of rows affected by this query.
/**
* Returns the total number of rows affected by this query.
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:324
⧉public escapeLikeStringDirect($str): string|string[] Escape Like String Direct There are a few instances where MySQLi queries cann...
/**
* Escape Like String Direct
* There are a few instances where MySQLi queries cannot take the
* additional "ESCAPE x" parameter for specifying the escape character
* in "LIKE" strings, and this handles those directly with a backslash.
*
* @param string|string[] $str Input string
*
* @return string|string[]
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:351
⧉public error(): array Returns the last error code and message. Must return this format: ['code' => ...
/**
* Returns the last error code and message.
* Must return this format: ['code' => string|int, 'message' => string]
* intval(code) === 0 means "no error".
*
* @return array<string, int|string>
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:557
⧉public insertID(): int Insert ID
/**
* Insert ID
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:575
/**
* Saves our connection settings.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:345
⧉public initialize(): void Initializes the database connection/settings.
/**
* Initializes the database connection/settings.
*
* @return void
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:374
⧉public close() Close the database connection.
/**
* Close the database connection.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:441
⧉public persistentConnect(): false|object|resource Create a persistent database connection.
/**
* Create a persistent database connection.
*
* @return false|object|resource
* @phpstan-return false|TConnection
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:462
⧉public getConnection(?string $alias = null): false|object|resource Returns the actual connection object. If both a 'read' and 'write' connection...
/**
* Returns the actual connection object. If both a 'read' and 'write'
* connection has been specified, you can pass either term in to
* get that connection. If you pass either alias in and only a single
* connection is present, it must return the sole connection.
*
* @return false|object|resource
* @phpstan-return TConnection
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:476
⧉public getDatabase(): string Returns the name of the current database being used.
/**
* Returns the name of the current database being used.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:485
⧉public setPrefix(string $prefix = ''): string Set DB Prefix
/**
* Set DB Prefix
*
* Set's the DB Prefix to something new without needing to reconnect
*
* @param string $prefix The prefix
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:497
⧉public getPrefix(): string Returns the database prefix.
/**
* Returns the database prefix.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:505
⧉public getPlatform(): string The name of the platform in use (MySQLi, Postgre, SQLite3, OCI8, etc)
/**
* The name of the platform in use (MySQLi, Postgre, SQLite3, OCI8, etc)
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:513
⧉public setAliasedTables(array $aliases): $this Sets the Table Aliases to use. These are typically collected during use of th...
/**
* Sets the Table Aliases to use. These are typically
* collected during use of the Builder, and set here
* so queries are built correctly.
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:525
⧉public addTableAlias(string $table): $this Add a table alias to our list.
/**
* Add a table alias to our list.
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:537
⧉public query(string $sql, $binds = null, bool $setEscapeFlags = true, string $queryClass = ''): BaseResult|bool|Query BaseResult when “read” type query, bool when “write” type query, Query when prepared query Orchestrates a query against the database. Queries must use Database\Statemen...
/**
* Orchestrates a query against the database. Queries must use
* Database\Statement objects to store the query and build it.
* This method works with the cache.
*
* Should automatically handle different connections for read/write
* queries if needed.
*
* @param array|string|null $binds
*
* @return BaseResult|bool|Query BaseResult when “read” type query, bool when “write” type query, Query when prepared query
* @phpstan-return BaseResult<TConnection, TResult>|bool|Query
*
* @todo BC set $queryClass default as null in 4.1
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:569
⧉public simpleQuery(string $sql): false|object|resource Performs a basic query against the database. No binding or caching is perform...
/**
* Performs a basic query against the database. No binding or caching
* is performed, nor are transactions handled. Simply takes a raw
* query string and returns the database-specific result id.
*
* @return false|object|resource
* @phpstan-return false|TResult
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:686
⧉public transOff() Disable Transactions
/**
* Disable Transactions
*
* This permits transactions to be disabled at run-time.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:700
/**
* Enable/disable Transaction Strict Mode
*
* When strict mode is enabled, if you are running multiple groups of
* transactions, if one group fails all subsequent groups will be
* rolled back.
*
* If strict mode is disabled, each group is treated autonomously,
* meaning a failure of one group will not affect any others
*
* @param bool $mode = true
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:719
/**
* Start Transaction
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:729
⧉public transException(bool $transExcetion): $this If set to true, exceptions are thrown during transactions.
/**
* If set to true, exceptions are thrown during transactions.
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:743
/**
* Complete Transaction
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:753
⧉public transStatus(): bool Lets you retrieve the transaction flag to determine if it has failed
/**
* Lets you retrieve the transaction flag to determine if it has failed
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:779
⧉public transBegin(bool $testMode = false): bool Begin Transaction
/**
* Begin Transaction
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:787
⧉public transCommit(): bool Commit Transaction
/**
* Commit Transaction
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:821
/**
* Rollback Transaction
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:840
⧉public table($tableName): BaseBuilder Returns a non-shared new instance of the query builder for this connection.
/**
* Returns a non-shared new instance of the query builder for this connection.
*
* @param array|string $tableName
*
* @return BaseBuilder
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:880
⧉public newQuery(): CodeIgniter\Database\BaseBuilder Returns a new instance of the BaseBuilder class with a cleared FROM clause.
/**
* Returns a new instance of the BaseBuilder class with a cleared FROM clause.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:894
⧉public prepare(Closure $func, array $options = array()): BasePreparedQuery|null Creates a prepared statement with the database that can then be used to execu...
/**
* Creates a prepared statement with the database that can then
* be used to execute multiple statements against. Within the
* closure, you would build the query in any normal way, though
* the Query Builder is the expected manner.
*
* Example:
* $stmt = $db->prepare(function($db)
* {
* return $db->table('users')
* ->where('id', 1)
* ->get();
* })
*
* @return BasePreparedQuery|null
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:920
⧉public getLastQuery(): Query Returns the last query's statement object.
/**
* Returns the last query's statement object.
*
* @return Query
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:948
⧉public showLastQuery(): string Returns a string representation of the last query's statement object.
/**
* Returns a string representation of the last query's statement object.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:956
⧉public getConnectStart(): ?float Returns the time we started to connect to this database in seconds with micro...
/**
* Returns the time we started to connect to this database in
* seconds with microseconds.
*
* Used by the Debug Toolbar's timeline.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:967
⧉public getConnectDuration(int $decimals = 6): string Returns the number of seconds with microseconds that it took to connect to th...
/**
* Returns the number of seconds with microseconds that it took
* to connect to the database.
*
* Used by the Debug Toolbar's timeline.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:978
/**
* Protect Identifiers
*
* This function is used extensively by the Query Builder class, and by
* a couple functions in this class.
* It takes a column or table name (optionally with an alias) and inserts
* the table prefix onto it. Some logic is necessary in order to deal with
* column names that include the path. Consider a query like this:
*
* SELECT hostname.database.table.column AS c FROM hostname.database.table
*
* Or a query with aliasing:
*
* SELECT m.member_id, m.member_name FROM members AS m
*
* Since the column name can include up to four segments (host, DB, table, column)
* or also have an alias prefix, we need to do a bit of work to figure this out and
* insert the table prefix (if it exists) in the proper position, and escape only
* the correct identifiers.
*
* @param array|string $item
* @param bool $prefixSingle Prefix a table name with no segments?
* @param bool $protectIdentifiers Protect table or column names?
* @param bool $fieldExists Supplied $item contains a column name?
*
* @return array|string
* @phpstan-return ($item is array ? array : string)
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1011
⧉public escapeIdentifiers($item): array|string Escape the SQL Identifiers
/**
* Escape the SQL Identifiers
*
* This function escapes column and table names
*
* @param array|string $item
*
* @return array|string
* @phpstan-return ($item is array ? array : string)
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1171
⧉public prefixTable(string $table = ''): string Prepends a database prefix if one exists in configuration
/**
* Prepends a database prefix if one exists in configuration
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1231
/**
* Escape String
*
* @param string|string[] $str Input string
* @param bool $like Whether or not the string will be used in a LIKE condition
*
* @return string|string[]
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1286
⧉public escapeLikeString($str): string|string[] Escape LIKE String
/**
* Escape LIKE String
*
* Calls the individual driver for platform
* specific escaping for LIKE conditions
*
* @param string|string[] $str
*
* @return string|string[]
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1328
⧉public callFunction(string $functionName, $params): bool This function enables you to call PHP database functions that are not nativel...
/**
* This function enables you to call PHP database functions that are not natively included
* in CodeIgniter, in a platform independent manner.
*
* @param array ...$params
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1351
⧉public listTables(bool $constrainByPrefix = false): array|false Returns an array of table names
/**
* Returns an array of table names
*
* @return array|false
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1389
⧉public tableExists(string $tableName, bool $cached = true): bool Determine if a particular table exists
/**
* Determine if a particular table exists
*
* @param bool $cached Whether to use data cache
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1425
⧉public getFieldNames(string $table): array|false Fetch Field Names
/**
* Fetch Field Names
*
* @return array|false
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1466
⧉public fieldExists(string $fieldName, string $tableName): bool Determine if a particular field exists
/**
* Determine if a particular field exists
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1511
⧉public getFieldData(string $table): stdClass[] Returns an object with field data
/**
* Returns an object with field data
*
* @return stdClass[]
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1521
⧉public getIndexData(string $table): array Returns an object with key data
/**
* Returns an object with key data
*
* @return array
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1531
⧉public getForeignKeyData(string $table): array Returns an object with foreign key data
/**
* Returns an object with foreign key data
*
* @return array
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1541
/**
* Enables foreign key checks temporarily.
*
* @return bool
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1613
⧉public pretend(bool $pretend = true): $this Allows the engine to be set into a mode where queries are not actually execut...
/**
* Allows the engine to be set into a mode where queries are not
* actually executed, but they are still generated, timed, etc.
*
* This is primarily used by the prepared query functionality.
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1633
⧉public resetDataCache(): $this Empties our data cache. Especially helpful during testing.
/**
* Empties our data cache. Especially helpful during testing.
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1645
⧉public isWriteType($sql): bool Determines if the statement is a write-type query or not.
/**
* Determines if the statement is a write-type query or not.
*
* @param string $sql
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1657
⧉public __get(string $key): array|bool|float|int|object|resource|string|null Accessor for properties if they exist.
/**
* Accessor for properties if they exist.
*
* @return array|bool|float|int|object|resource|string|null
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1753
⧉public __isset(string $key): bool Checker for properties existence.
/**
* Checker for properties existence.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1765
⧉protected _close() Close the database connection.
/**
* Close the database connection.
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:237
⧉protected execute(string $sql): false|mysqli_result; Executes the query against the database.
/**
* Executes the query against the database.
*
* @return false|mysqli_result;
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:285
⧉protected prepQuery(string $sql): string Prep the query. If needed, each database adapter can prep the query string
/**
* Prep the query. If needed, each database adapter can prep the query string
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:310
/**
* Platform-dependant string escape
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:332
⧉protected _listTables(bool $prefixLimit = false, ?string $tableName = null): string Generates the SQL for listing tables in a platform-dependent manner. Uses esc...
/**
* Generates the SQL for listing tables in a platform-dependent manner.
* Uses escapeLikeStringDirect().
*
* @param string|null $tableName If $tableName is provided will return only this table if exists.
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:377
⧉protected _listColumns(string $table = ''): string Generates a platform-specific query string so that the column names can be fe...
/**
* Generates a platform-specific query string so that the column names can be fetched.
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:395
⧉protected _fieldData(string $table): array Returns an array of objects with field data
/**
* Returns an array of objects with field data
*
* @return stdClass[]
*
* @throws DatabaseException
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:407
⧉protected _indexData(string $table): array Returns an array of objects with index data
/**
* Returns an array of objects with index data
*
* @return stdClass[]
*
* @throws DatabaseException
* @throws LogicException
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:440
⧉protected _foreignKeyData(string $table): array Returns an array of objects with Foreign key data
/**
* Returns an array of objects with Foreign key data
*
* @return stdClass[]
*
* @throws DatabaseException
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:485
/**
* Rollback Transaction
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:607
⧉protected getDriverFunctionPrefix(): string Get the prefix of the function to access the DB.
/**
* Get the prefix of the function to access the DB.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1373
⧉protected foreignKeyDataToObjects(array $data): array[ Converts array of arrays generated by _foreignKeyData() to array of objects
/**
* Converts array of arrays generated by _foreignKeyData() to array of objects
*
* @return array[
* {constraint_name} =>
* stdClass[
* 'constraint_name' => string,
* 'table_name' => string,
* 'column_name' => string[],
* 'foreign_table_name' => string,
* 'foreign_column_name' => string[],
* 'on_delete' => string,
* 'on_update' => string,
* 'match' => string
* ]
* ]
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1563
list => string (33) "CodeIgniter\Validation\Views\list"
single => string (35) "CodeIgniter\Validation\Views\single"
⧉public __construct() Will attempt to get environment variables with names that match the propertie...
/**
* Will attempt to get environment variables with names
* that match the properties of the child class.
*
* The "shortPrefix" is the lowercase-only config class name.
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in <ROOT>/system/Config/BaseConfig.php:60
/**
* Retrieve an environment-specific configuration setting
*
* @return string|null
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in <ROOT>/system/Config/BaseConfig.php:128
⧉protected registerProperties() Provides external libraries a simple way to register one or more options into...
/**
* Provides external libraries a simple way to register one or more
* options into a config file.
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in <ROOT>/system/Config/BaseConfig.php:174
⧉public shouldDiscover(string $alias): bool Should the application auto-discover the requested resource.
/**
* Should the application auto-discover the requested resource.
*/
Inherited from CodeIgniter\Modules\Modules
Defined in <ROOT>/system/Modules/Modules.php:45
⧉public __construct() Merge the built-in and developer-configured filters and plugins, with prefere...
/**
* Merge the built-in and developer-configured filters and plugins,
* with preference to the developer ones.
*/
Inherited from CodeIgniter\Config\View
Defined in <ROOT>/system/Config/View.php:108
/**
* Retrieve an environment-specific configuration setting
*
* @return string|null
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in <ROOT>/system/Config/BaseConfig.php:128
⧉protected registerProperties() Provides external libraries a simple way to register one or more options into...
/**
* Provides external libraries a simple way to register one or more
* options into a config file.
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in <ROOT>/system/Config/BaseConfig.php:174
Defined in <ROOT>/system/Autoloader/FileLocator.php:27
⧉public locateFile(string $file, ?string $folder = null, string $ext = 'php'): false|string The path to the file, or false if not found. Attempts to locate a file by examining the name for a namespace and looking t...
/**
* Attempts to locate a file by examining the name for a namespace
* and looking through the PSR-4 namespaced files that we know about.
*
* @param string $file The namespaced file to locate
* @param string|null $folder The folder within the namespace that we should look for the file.
* @param string $ext The file extension the file should have.
*
* @return false|string The path to the file, or false if not found.
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:42
⧉public getClassname(string $file): string Examines a file and returns the fully qualified class name.
/**
* Examines a file and returns the fully qualified class name.
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:113
⧉public search(string $path, string $ext = 'php', bool $prioritizeApp = true): array Searches through all of the defined namespaces looking for a file. Returns an...
/**
* Searches through all of the defined namespaces looking for a file.
* Returns an array of all found locations for the defined file.
*
* Example:
*
* $locator->search('Config/Routes.php');
* // Assuming PSR4 namespaces include foo and bar, might return:
* [
* 'app/Modules/foo/Config/Routes.php',
* 'app/Modules/bar/Config/Routes.php',
* ]
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:166
⧉public findQualifiedNameFromPath(string $path): false|string The qualified name or false if the path is not found Find the qualified name of a file according to the namespace of the first mat...
/**
* Find the qualified name of a file according to
* the namespace of the first matched namespace path.
*
* @return false|string The qualified name or false if the path is not found
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:253
⧉public listFiles(string $path): array Scans the defined namespaces, returning a list of all files that are containe...
/**
* Scans the defined namespaces, returning a list of all files
* that are contained within the subpath specified by $path.
*
* @return string[] List of file paths
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:295
⧉public listNamespaceFiles(string $prefix, string $path): array Scans the provided namespace, returning a list of all files that are containe...
/**
* Scans the provided namespace, returning a list of all files
* that are contained within the sub path specified by $path.
*
* @return string[] List of file paths
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:328
⧉protected ensureExt(string $path, string $ext): string Ensures a extension is at the end of a filename
/**
* Ensures a extension is at the end of a filename
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:199
⧉protected getNamespaces(): array<int, array<string, string>> Return the namespace mappings we know about.
/**
* Return the namespace mappings we know about.
*
* @return array<int, array<string, string>>
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:217
⧉protected legacyLocate(string $file, ?string $folder = null): false|string The path to the file, or false if not found. Checks the app folder to see if the file can be found. Only for use with file...
/**
* Checks the app folder to see if the file can be found.
* Only for use with filenames that DO NOT include namespacing.
*
* @return false|string The path to the file, or false if not found.
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:362
/**
* Constructor.
*
* @param \Config\Logger $config
*
* @throws RuntimeException
*/
Defined in <ROOT>/system/Log/Logger.php:120
⧉public emergency($message, array $context = array()): bool System is unusable.
/**
* System is unusable.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:158
⧉public alert($message, array $context = array()): bool Action must be taken immediately.
/**
* Action must be taken immediately.
*
* Example: Entire website down, database unavailable, etc. This should
* trigger the SMS alerts and wake you up.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:171
⧉public error($message, array $context = array()): bool Runtime errors that do not require immediate action but should typically be l...
/**
* Runtime errors that do not require immediate action but should typically
* be logged and monitored.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:194
⧉public warning($message, array $context = array()): bool Exceptional occurrences that are not errors.
/**
* Exceptional occurrences that are not errors.
*
* Example: Use of deprecated APIs, poor use of an API, undesirable things
* that are not necessarily wrong.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:207
⧉public notice($message, array $context = array()): bool Normal but significant events.
/**
* Normal but significant events.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:217
/**
* Detailed debug information.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:239
⧉public log($level, $message, array $context = array()): bool Logs with an arbitrary level.
/**
* Logs with an arbitrary level.
*
* @param string $level
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:250
⧉public determineFile(): array Determines the file and line that the logging call was made from by analyzing...
/**
* Determines the file and line that the logging call
* was made from by analyzing the backtrace.
* Find the earliest stack frame that is part of our logging system.
*/
Defined in <ROOT>/system/Log/Logger.php:372
⧉protected interpolate($message, array $context = array()): string Replaces any placeholders in the message with variables from the context, as ...
/**
* Replaces any placeholders in the message with variables
* from the context, as well as a few special items like:
*
* {session_vars}
* {post_vars}
* {get_vars}
* {env}
* {env:foo}
* {file}
* {line}
*
* @param string $message
*
* @return string
*/
Defined in <ROOT>/system/Log/Logger.php:316
⧉protected cleanFileNames(string $file): string Cleans the paths of filenames by replacing APPPATH, SYSTEMPATH, FCPATH with t...
/**
* Cleans the paths of filenames by replacing APPPATH, SYSTEMPATH, FCPATH
* with the actual var. i.e.
*
* /var/www/site/app/Controllers/Home.php
* becomes:
* APPPATH/Controllers/Home.php
*
* @deprecated Use dedicated `clean_path()` function.
*/
Defined in <ROOT>/system/Log/Logger.php:422
⧉public render(string $view, ?array $options = null, ?bool $saveData = null): string Builds the output based upon a file name and any data that has already been set.
/**
* Builds the output based upon a file name and any
* data that has already been set.
*
* Valid $options:
* - cache Number of seconds to cache for
* - cache_name Name to use for cache
*
* @param string $view File name of the view source
* @param array|null $options Reserved for 3rd-party uses since
* it might be needed to pass additional info
* to other template engines.
* @param bool|null $saveData If true, saves data for subsequent calls,
* if false, cleans the data after displaying,
* if null, uses the config setting.
*/
Defined in <ROOT>/system/View/View.php:166
⧉public renderString(string $view, ?array $options = null, ?bool $saveData = null): string Builds the output based upon a string and any data that has already been set....
/**
* Builds the output based upon a string and any
* data that has already been set.
* Cache does not apply, because there is no "key".
*
* @param string $view The view contents
* @param array|null $options Reserved for 3rd-party uses since
* it might be needed to pass additional info
* to other template engines.
* @param bool|null $saveData If true, saves data for subsequent calls,
* if false, cleans the data after displaying,
* if null, uses the config setting.
*/
Defined in <ROOT>/system/View/View.php:277
⧉public excerpt(string $string, int $length = 20): string Extract first bit of a long string and add ellipsis
/**
* Extract first bit of a long string and add ellipsis
*/
Defined in <ROOT>/system/View/View.php:300
⧉public setData(array $data = array(), ?string $context = null): CodeIgniter\View\RendererInterface Sets several pieces of view data at once.
/**
* Sets several pieces of view data at once.
*
* @param string|null $context The context to escape it for: html, css, js, url
* If null, no escaping will happen
* @phpstan-param null|'html'|'js'|'css'|'url'|'attr'|'raw' $context
*/
Defined in <ROOT>/system/View/View.php:312
⧉public setVar(string $name, $value = null, ?string $context = null): CodeIgniter\View\RendererInterface Sets a single piece of view data.
/**
* Sets a single piece of view data.
*
* @param mixed $value
* @param string|null $context The context to escape it for: html, css, js, url
* If null, no escaping will happen
* @phpstan-param null|'html'|'js'|'css'|'url'|'attr'|'raw' $context
*/
Defined in <ROOT>/system/View/View.php:332
⧉public resetData(): CodeIgniter\View\RendererInterface Removes all of the view data from the system.
/**
* Removes all of the view data from the system.
*/
Defined in <ROOT>/system/View/View.php:347
⧉public getData(): array Returns the current data that will be displayed in the view.
/**
* Returns the current data that will be displayed in the view.
*/
Defined in <ROOT>/system/View/View.php:357
⧉public extend(string $layout) Specifies that the current view should extend an existing layout.
/**
* Specifies that the current view should extend an existing layout.
*/
Defined in <ROOT>/system/View/View.php:365
⧉public section(string $name) Starts holds content for a section within the layout.
/**
* Starts holds content for a section within the layout.
*
* @param string $name Section name
*/
Defined in <ROOT>/system/View/View.php:375
⧉public endSection() Captures the last section
/**
* Captures the last section
*
* @throws RuntimeException
*/
Defined in <ROOT>/system/View/View.php:389
⧉public renderSection(string $sectionName) Renders a section's contents.
/**
* Renders a section's contents.
*/
Defined in <ROOT>/system/View/View.php:410
⧉public include(string $view, ?array $options = null, $saveData = true): string Used within layout views to include additional views.
/**
* Used within layout views to include additional views.
*
* @param bool $saveData
*/
Defined in <ROOT>/system/View/View.php:429
⧉public getPerformanceData(): array Returns the performance data that might have been collected during the execut...
/**
* Returns the performance data that might have been collected
* during the execution. Used primarily in the Debug Toolbar.
*/
Defined in <ROOT>/system/View/View.php:438
⧉protected decorateOutput(string $html): string Runs the generated output through any declared view decorators.
/**
* Runs the generated output through any declared
* view decorators.
*/
Defined in <ROOT>/system/View/ViewDecoratorTrait.php:22
⧉protected logPerformance(float $start, float $end, string $view) Logs performance data for rendering a view.
/**
* Logs performance data for rendering a view.
*/
Defined in <ROOT>/system/View/View.php:446
/**
* Runs the validation process, returning true/false determining whether
* validation was successful or not.
*
* @param array|null $data The array of data to validate.
* @param string|null $group The predefined group of rules to apply.
* @param string|null $dbGroup The database group to use.
*/
Defined in <ROOT>/system/Validation/Validation.php:110
⧉public check($value, string $rule, array $errors = array()): bool Runs the validation process, returning true or false determining whether vali...
/**
* Runs the validation process, returning true or false
* determining whether validation was successful or not.
*
* @param array|bool|float|int|object|string|null $value
* @param string[] $errors
*/
Defined in <ROOT>/system/Validation/Validation.php:184
⧉public withRequest(CodeIgniter\HTTP\RequestInterface $request): CodeIgniter\Validation\ValidationInterface Takes a Request object and grabs the input data to use from its array values.
/**
* Takes a Request object and grabs the input data to use from its
* array values.
*/
Defined in <ROOT>/system/Validation/Validation.php:392
⧉public setRule(string $field, ?string $label, $rules, array $errors = array()): $this Sets an individual rule and custom error messages for a single field.
/**
* Sets an individual rule and custom error messages for a single field.
*
* The custom error message should be just the messages that apply to
* this field, like so:
*
* [
* 'rule' => 'message',
* 'rule' => 'message',
* ]
*
* @param array|string $rules
*
* @return $this
*
* @throws TypeError
*/
Defined in <ROOT>/system/Validation/Validation.php:429
⧉public setRules(array $rules, array $errors = array()): CodeIgniter\Validation\ValidationInterface Stores the rules that should be used to validate the items. Rules should be a...
/**
* Stores the rules that should be used to validate the items.
* Rules should be an array formatted like:
*
* [
* 'field' => 'rule1|rule2'
* ]
*
* The $errors array should be formatted like:
* [
* 'field' => [
* 'rule' => 'message',
* 'rule' => 'message
* ],
* ]
*
* @param array $errors // An array of custom error messages
*/
Defined in <ROOT>/system/Validation/Validation.php:469
⧉public getRules(): array Returns all of the rules currently defined.
/**
* Returns all of the rules currently defined.
*/
Defined in <ROOT>/system/Validation/Validation.php:496
⧉public hasRule(string $field): bool Checks to see if the rule for key $field has been set or not.
/**
* Checks to see if the rule for key $field has been set or not.
*/
Defined in <ROOT>/system/Validation/Validation.php:504
⧉public getRuleGroup(string $group): array Get rule group.
/**
* Get rule group.
*
* @param string $group Group.
*
* @return string[] Rule group.
*
* @throws ValidationException If group not found.
*/
Defined in <ROOT>/system/Validation/Validation.php:518
⧉public setRuleGroup(string $group) Set rule group.
/**
* Set rule group.
*
* @param string $group Group.
*
* @throws ValidationException If group not found.
*/
Defined in <ROOT>/system/Validation/Validation.php:538
⧉public listErrors(string $template = 'list'): string Returns the rendered HTML of the errors as defined in $template.
/**
* Returns the rendered HTML of the errors as defined in $template.
*
* You can also use validation_list_errors() in Form helper.
*/
Defined in <ROOT>/system/Validation/Validation.php:554
⧉public showError(string $field, string $template = 'single'): string Displays a single error in formatted HTML as defined in the $template view.
/**
* Displays a single error in formatted HTML as defined in the $template view.
*
* You can also use validation_show_error() in Form helper.
*/
Defined in <ROOT>/system/Validation/Validation.php:570
⧉public loadRuleGroup(?string $group = null): array Loads custom rule groups (if set) into the current rules.
/**
* Loads custom rule groups (if set) into the current rules.
*
* Rules can be pre-defined in Config\Validation and can
* be any name, but must all still be an array of the
* same format used with setRules(). Additionally, check
* for {group}_errors for an array of custom error messages.
*
* @return array
*
* @throws ValidationException
*/
Defined in <ROOT>/system/Validation/Validation.php:612
⧉public hasError(string $field): bool Checks to see if an error exists for the given field.
/**
* Checks to see if an error exists for the given field.
*/
Defined in <ROOT>/system/Validation/Validation.php:692
⧉public getError(?string $field = null): string Returns the error(s) for a specified $field (or empty string if not set).
/**
* Returns the error(s) for a specified $field (or empty string if not
* set).
*/
Defined in <ROOT>/system/Validation/Validation.php:703
⧉public getErrors(): array Returns the array of errors that were encountered during a run() call. The ar...
/**
* Returns the array of errors that were encountered during
* a run() call. The array should be in the following format:
*
* [
* 'field1' => 'error message',
* 'field2' => 'error message',
* ]
*
* @return array<string, string>
*
* @codeCoverageIgnore
*/
Defined in <ROOT>/system/Validation/Validation.php:730
⧉public setError(string $field, string $error): CodeIgniter\Validation\ValidationInterface Sets the error for a specific field. Used by custom validation methods.
/**
* Sets the error for a specific field. Used by custom validation methods.
*/
Defined in <ROOT>/system/Validation/Validation.php:738
⧉public reset(): CodeIgniter\Validation\ValidationInterface Resets the class to a blank slate. Should be called whenever you need to proc...
/**
* Resets the class to a blank slate. Should be called whenever
* you need to process more than one array.
*/
Defined in <ROOT>/system/Validation/Validation.php:827
⧉protected processRules(string $field, ?string $label, $value, $rules = null, ?array $data = null, ?string $originalField = null): bool Runs all of $rules against $field, until one fails, or all of them have been ...
/**
* Runs all of $rules against $field, until one fails, or
* all of them have been processed. If one fails, it adds
* the error to $this->errors and moves on to the next,
* so that we can collect all of the first errors.
*
* @param array|string $value
* @param array|null $rules
* @param array|null $data The array of data to validate, with `DBGroup`.
* @param string|null $originalField The original asterisk field name like "foo.*.bar".
*/
Defined in <ROOT>/system/Validation/Validation.php:202
⧉protected loadRuleSets() Loads all of the rulesets classes that have been defined in the Config\Valida...
/**
* Loads all of the rulesets classes that have been defined in the
* Config\Validation and stores them locally so we can use them.
*/
Defined in <ROOT>/system/Validation/Validation.php:589
⧉protected fillPlaceholders(array $rules, array $data): array Replace any placeholders within the rules with the values that match the 'key...
/**
* Replace any placeholders within the rules with the values that
* match the 'key' of any properties being set. For example, if
* we had the following $data array:
*
* [ 'id' => 13 ]
*
* and the following rule:
*
* 'required|is_unique[users,email,id,{id}]'
*
* The value of {id} would be replaced with the actual id in the form data:
*
* 'required|is_unique[users,email,id,13]'
*/
Defined in <ROOT>/system/Validation/Validation.php:654
/**
* Attempts to find the appropriate error message
*
* @param string|null $value The value that caused the validation to fail.
*/
Defined in <ROOT>/system/Validation/Validation.php:750
⧉protected splitRules(string $rules): array Split rules string by pipe operator.
/**
* Split rules string by pipe operator.
*/
Defined in <ROOT>/system/Validation/Validation.php:785
⧉private isClosure($rule): bool
/**
* @param Closure|string $rule
*/
Defined in <ROOT>/system/Validation/Validation.php:357
⧉private isStringList(array $array): bool Is the array a string list `list<string>`?
/**
* Is the array a string list `list<string>`?
*/
Defined in <ROOT>/system/Validation/Validation.php:365
protected validationMessages -> array (0)
protected validationRules -> array (0)
⧉private builderMethodsNotAvailable -> array (3)
0 => string (17) "getCompiledInsert"
1 => string (17) "getCompiledSelect"
2 => string (17) "getCompiledUpdate"
private tempPrimaryKeyValue -> null
⧉public get_custom_query($query = '')
Defined in <ROOT>/app/Models/Frontend_model.php:6
⧉public get_custom_code($query = '')
Defined in <ROOT>/app/Models/Frontend_model.php:15
⧉public get_records($table = '', $where = '')
Defined in <ROOT>/app/Models/Frontend_model.php:24
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:150
⧉public setTable(string $table): $this Specify the table associated with a model
/**
* Specify the table associated with a model
*
* @param string $table Table
*
* @return $this
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:169
⧉public getIdValue($data): array|int|string|null Returns the id value for the data array or object
/**
* Returns the id value for the data array or object
*
* @param array|object $data Data
*
* @return array|int|string|null
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:538
⧉public chunk(int $size, Closure $userFunc) Loops over records in batches, allowing you to operate on them. Works with $t...
/**
* Loops over records in batches, allowing you to operate on them.
* Works with $this->builder to get the Compiled select to
* determine the rows to operate on.
* This method works only with dbCalls.
*
* @throws DataException
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:559
⧉public countAllResults(bool $reset = true, bool $test = false): int|string Override countAllResults to account for soft deleted accounts.
/**
* Override countAllResults to account for soft deleted accounts.
*
* @return int|string
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:593
⧉public builder(?string $table = null): BaseBuilder Provides a shared instance of the Query Builder.
/**
* Provides a shared instance of the Query Builder.
*
* @return BaseBuilder
*
* @throws ModelException
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:616
⧉public set($key, $value = '', ?bool $escape = null): $this Captures the builder's set() method so that we can validate the data here. Th...
/**
* Captures the builder's set() method so that we can validate the
* data here. This allows it to be used with any of the other
* builder methods and still get validated data, like replace.
*
* @param array|object|string $key Field name, or an array of field/value pairs
* @param bool|float|int|object|string|null $value Field value, if $key is a single field
* @param bool|null $escape Whether to escape values
*
* @return $this
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:663
⧉public __get(string $name): mixed Provides/instantiates the builder/db connection and model's table/primary key...
/**
* Provides/instantiates the builder/db connection and model's table/primary key names and return type.
*
* @param string $name Name
*
* @return mixed
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:797
⧉public __isset(string $name): bool Checks for the existence of properties across this model, builder, and db con...
/**
* Checks for the existence of properties across this model, builder, and db connection.
*
* @param string $name Name
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:815
⧉public __call(string $name, array $params): mixed Provides direct access to method in the builder (if available) and the databa...
/**
* Provides direct access to method in the builder (if available)
* and the database connection.
*
* @return mixed
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:830
⧉public find($id = null): array|object|null The resulting row of data, or null. Fetches the row of database.
/**
* Fetches the row of database.
*
* @param array|int|string|null $id One primary key or an array of primary keys
*
* @return array|object|null The resulting row of data, or null.
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:538
⧉public findColumn(string $columnName): array|null The resulting row of data, or null if no data found. Fetches the column of database.
/**
* Fetches the column of database.
*
* @param string $columnName Column Name
*
* @return array|null The resulting row of data, or null if no data found.
*
* @throws DataException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:582
⧉public findAll(int $limit0, int $offset0): array Fetches all results, while optionally limiting them.
/**
* Fetches all results, while optionally limiting them.
*
* @param int $limit Limit
* @param int $offset Offset
*
* @return array
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:601
⧉public first(): array|object|null Returns the first row of the result set.
/**
* Returns the first row of the result set.
*
* @return array|object|null
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:641
⧉public save($data): bool A convenience method that will attempt to determine whether the data should b...
/**
* A convenience method that will attempt to determine whether the
* data should be inserted or updated. Will work with either
* an array or object. When using with custom class objects,
* you must ensure that the class will provide access to the class
* variables, even if through a magic method.
*
* @param array|object $data Data
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:683
⧉public getInsertID(): int|string Returns last insert ID or 0.
/**
* Returns last insert ID or 0.
*
* @return int|string
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:718
⧉public insertBatch(?array $set = null, ?bool $escape = null, int $batchSize = 100, bool $testing = false): bool|int Number of rows inserted or FALSE on failure Compiles batch insert runs the queries, validating each row prior.
/**
* Compiles batch insert runs the queries, validating each row prior.
*
* @param array|null $set an associative array of insert values
* @param bool|null $escape Whether to escape values
* @param int $batchSize The size of the batch to run
* @param bool $testing True means only number of records is returned, false will execute the query
*
* @return bool|int Number of rows inserted or FALSE on failure
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:818
⧉public updateBatch(?array $set = null, ?string $index = null, int $batchSize = 100, bool $returnSQL = false): false|int|string[] Number of rows affected or FALSE on failure, SQL array when testMode Compiles an update and runs the query.
/**
* Compiles an update and runs the query.
*
* @param array|null $set An associative array of update values
* @param string|null $index The where key
* @param int $batchSize The size of the batch to run
* @param bool $returnSQL True means SQL is returned, false will execute the query
*
* @return false|int|string[] Number of rows affected or FALSE on failure, SQL array when testMode
*
* @throws DatabaseException
* @throws ReflectionException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:968
⧉public delete($id = null, bool $purge = false): BaseResult|bool Deletes a single record from the database where $id matches.
/**
* Deletes a single record from the database where $id matches.
*
* @param array|int|string|null $id The rows primary key(s)
* @param bool $purge Allows overriding the soft deletes setting.
*
* @return BaseResult|bool
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1042
⧉public purgeDeleted(): bool|string Returns a string if in test mode. Permanently deletes all rows that have been marked as deleted through soft de...
/**
* Permanently deletes all rows that have been marked as deleted
* through soft deletes (deleted = 1).
*
* @return bool|string Returns a string if in test mode.
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1083
⧉public withDeleted(bool $val = true): $this Sets $useSoftDeletes value so that we can temporarily override the soft delet...
/**
* Sets $useSoftDeletes value so that we can temporarily override
* the soft deletes settings. Can be used for all find* methods.
*
* @param bool $val Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1100
⧉public onlyDeleted(): $this Works with the find* methods to return only the rows that have been deleted.
/**
* Works with the find* methods to return only the rows that
* have been deleted.
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1113
⧉public replace(?array $data = null, bool $returnSQL = false): BaseResult|false|Query|string Compiles a replace and runs the query.
/**
* Compiles a replace and runs the query.
*
* @param array|null $data Data
* @param bool $returnSQL Set to true to return Query String
*
* @return BaseResult|false|Query|string
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1129
⧉public errors(bool $forceDB = false): array<string,string> Grabs the last error(s) that occurred. If data was validated, it will first c...
/**
* Grabs the last error(s) that occurred. If data was validated,
* it will first check for errors there, otherwise will try to
* grab the last error from the Database connection.
*
* The return array should be in the following format:
* ['source' => 'message']
*
* @param bool $forceDB Always grab the db error, not validation
*
* @return array<string,string>
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1155
⧉public paginate(?int $perPage = null, string $group = 'default', ?int $page = null, int $segment0): array|null Works with Pager to get the size and offset parameters. Expects a GET variabl...
/**
* Works with Pager to get the size and offset parameters.
* Expects a GET variable (?page=2) that specifies the page of results
* to display.
*
* @param int|null $perPage Items per page
* @param string $group Will be used by the pagination library to identify a unique pagination set.
* @param int|null $page Optional page number (useful when the page number is provided in different way)
* @param int $segment Optional URI segment number (if page number is provided by URI segment)
*
* @return array|null
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1177
⧉public setAllowedFields(array $allowedFields): $this It could be used when you have to change default or override current allowed ...
/**
* It could be used when you have to change default or override current allowed fields.
*
* @param array $allowedFields Array with names of fields
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1202
⧉public protect(bool $protect = true): $this Sets whether or not we should whitelist data set during updates or inserts ag...
/**
* Sets whether or not we should whitelist data set during
* updates or inserts against $this->availableFields.
*
* @param bool $protect Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1217
⧉public skipValidation(bool $skip = true): $this Set the value of the skipValidation flag.
/**
* Set the value of the skipValidation flag.
*
* @param bool $skip Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1340
⧉public setValidationMessages(array $validationMessages): $this Allows to set validation messages. It could be used when you have to change d...
/**
* Allows to set validation messages.
* It could be used when you have to change default or override current validate messages.
*
* @param array $validationMessages Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1355
⧉public setValidationMessage(string $field, array $fieldMessages): $this Allows to set field wise validation message. It could be used when you have t...
/**
* Allows to set field wise validation message.
* It could be used when you have to change default or override current validate messages.
*
* @param string $field Field Name
* @param array $fieldMessages Validation messages
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1371
⧉public setValidationRules(array $validationRules): $this Allows to set validation rules. It could be used when you have to change defa...
/**
* Allows to set validation rules.
* It could be used when you have to change default or override current validate rules.
*
* @param array $validationRules Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1386
⧉public setValidationRule(string $field, $fieldRules): $this Allows to set field wise validation rules. It could be used when you have to ...
/**
* Allows to set field wise validation rules.
* It could be used when you have to change default or override current validate rules.
*
* @param string $field Field Name
* @param array|string $fieldRules Validation rules
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1402
⧉public cleanRules(bool $choice = false): $this Should validation rules be removed before saving? Most handy when doing updates.
/**
* Should validation rules be removed before saving?
* Most handy when doing updates.
*
* @param bool $choice Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1417
⧉public validate($data): bool Validate the data against the validation rules (or the validation group) spec...
/**
* Validate the data against the validation rules (or the validation group)
* specified in the class property, $validationRules.
*
* @param array|object $data Data
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1430
⧉public getValidationRules(array $options = array()): array Returns the model's defined validation rules so that they can be used elsewhe...
/**
* Returns the model's defined validation rules so that they
* can be used elsewhere, if needed.
*
* @param array $options Options
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1462
⧉public getValidationMessages(): array Returns the model's validation messages, so they can be used elsewhere, if ne...
/**
* Returns the model's validation messages, so they
* can be used elsewhere, if needed.
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1485
⧉public allowCallbacks(bool $val = true): $this Sets $tempAllowCallbacks value so that we can temporarily override the settin...
/**
* Sets $tempAllowCallbacks value so that we can temporarily override
* the setting. Resets after the next method that uses triggers.
*
* @param bool $val value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1521
⧉public asArray(): $this Sets the return type of the results to be as an associative array.
/**
* Sets the return type of the results to be as an associative array.
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1573
⧉public asObject(string $class = 'object'): $this Sets the return type to be of the specified type of object. Defaults to a sim...
/**
* Sets the return type to be of the specified type of object.
* Defaults to a simple object, but can be any class that has
* class vars with the same name as the collection columns,
* or at least allows them to be created.
*
* @param string $class Class Name
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1590
/**
* Sets $allowEmptyInserts.
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1812
⧉protected doFind(bool $singleton, $id = null): array|object|null The resulting row of data, or null. Fetches the row of database from $this->table with a primary key matching $id...
/**
* Fetches the row of database from $this->table with a primary key
* matching $id.
* This method works only with dbCalls.
*
* @param bool $singleton Single or multiple results
* @param array|int|string|null $id One primary key or an array of primary keys
*
* @return array|object|null The resulting row of data, or null.
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:186
⧉protected doFindColumn(string $columnName): array|null The resulting row of data, or null if no data found. Fetches the column of database from $this->table. This method works only with...
/**
* Fetches the column of database from $this->table.
* This method works only with dbCalls.
*
* @param string $columnName Column Name
*
* @return array|null The resulting row of data, or null if no data found.
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:217
⧉protected doFindAll(int $limit0, int $offset0): array Works with the current Query Builder instance to return all results, while op...
/**
* Works with the current Query Builder instance to return
* all results, while optionally limiting them.
* This method works only with dbCalls.
*
* @param int $limit Limit
* @param int $offset Offset
*
* @return array
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:232
⧉protected doFirst(): array|object|null Returns the first row of the result set. Will take any previous Query Builder...
/**
* Returns the first row of the result set. Will take any previous
* Query Builder calls into account when determining the result set.
* This method works only with dbCalls.
*
* @return array|object|null
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:252
⧉protected doInsert(array $data): bool Inserts data into the current table. This method works only with dbCalls.
/**
* Inserts data into the current table.
* This method works only with dbCalls.
*
* @param array $data Data
*
* @return bool
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:279
⧉protected doInsertBatch(?array $set = null, ?bool $escape = null, int $batchSize = 100, bool $testing = false): bool|int Number of rows inserted or FALSE on failure Compiles batch insert strings and runs the queries, validating each row prior...
/**
* Compiles batch insert strings and runs the queries, validating each row prior.
* This method works only with dbCalls.
*
* @param array|null $set An associative array of insert values
* @param bool|null $escape Whether to escape values
* @param int $batchSize The size of the batch to run
* @param bool $testing True means only number of records is returned, false will execute the query
*
* @return bool|int Number of rows inserted or FALSE on failure
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:352
⧉protected doUpdate($id = null, $data = null): bool Updates a single record in $this->table. This method works only with dbCalls.
/**
* Updates a single record in $this->table.
* This method works only with dbCalls.
*
* @param array|int|string|null $id
* @param array|null $data
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:374
⧉protected doUpdateBatch(?array $set = null, ?string $index = null, int $batchSize = 100, bool $returnSQL = false): false|int|string[] Number of rows affected or FALSE on failure, SQL array when testMode Compiles an update string and runs the query This method works only with dbCa...
/**
* Compiles an update string and runs the query
* This method works only with dbCalls.
*
* @param array|null $set An associative array of update values
* @param string|null $index The where key
* @param int $batchSize The size of the batch to run
* @param bool $returnSQL True means SQL is returned, false will execute the query
*
* @return false|int|string[] Number of rows affected or FALSE on failure, SQL array when testMode
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:412
⧉protected doDelete($id = null, bool $purge = false): bool|string Deletes a single record from $this->table where $id matches the table's prima...
/**
* Deletes a single record from $this->table where $id matches
* the table's primaryKey
* This method works only with dbCalls.
*
* @param array|int|string|null $id The rows primary key(s)
* @param bool $purge Allows overriding the soft deletes setting.
*
* @return bool|string
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:429
⧉protected doPurgeDeleted(): bool|string Returns a string if in test mode. Permanently deletes all rows that have been marked as deleted through soft de...
/**
* Permanently deletes all rows that have been marked as deleted
* through soft deletes (deleted = 1)
* This method works only with dbCalls.
*
* @return bool|string Returns a string if in test mode.
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:466
⧉protected doOnlyDeleted() Works with the find* methods to return only the rows that have been deleted. ...
/**
* Works with the find* methods to return only the rows that
* have been deleted.
* This method works only with dbCalls.
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:478
⧉protected doReplace(?array $data = null, bool $returnSQL = false): BaseResult|false|Query|string Compiles a replace into string and runs the query This method works only with...
/**
* Compiles a replace into string and runs the query
* This method works only with dbCalls.
*
* @param array|null $data Data
* @param bool $returnSQL Set to true to return Query String
*
* @return BaseResult|false|Query|string
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:492
⧉protected doErrors(): array<string,string> Grabs the last error(s) that occurred from the Database connection. The retur...
/**
* Grabs the last error(s) that occurred from the Database connection.
* The return array should be in the following format:
* ['source' => 'message']
* This method works only with dbCalls.
*
* @return array<string,string>
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:505
⧉protected idValue($data): array|int|string|null Returns the id value for the data array or object
/**
* Returns the id value for the data array or object
*
* @param array|object $data Data
*
* @return array|int|string|null
*
* @deprecated Use getIdValue() instead. Will be removed in version 5.0.
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:526
⧉protected shouldUpdate($data): bool This method is called on save to determine if entry have to be updated If thi...
/**
* This method is called on save to determine if entry have to be updated
* If this method return false insert operation will be executed
*
* @param array|object $data Data
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:682
⧉protected objectToRawArray($data, bool $onlyChanged = true, bool $recursive = false): ?array Takes a class an returns an array of it's public and protected properties as ...
/**
* Takes a class an returns an array of it's public and protected
* properties as an array with raw values.
*
* @param object|string $data
* @param bool $recursive If true, inner entities will be casted as array as well
*
* @return array|null Array
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:770
⧉protected initialize() Initializes the instance with any additional steps. Optionally implemented by...
/**
* Initializes the instance with any additional steps.
* Optionally implemented by child classes.
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:342
⧉protected doProtectFields(array $data): array Ensures that only the fields that are allowed to be updated are in the data a...
/**
* Ensures that only the fields that are allowed to be updated
* are in the data array.
*
* Used by insert() and update() to protect against mass assignment
* vulnerabilities.
*
* @param array $data Data
*
* @throws DataException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1235
⧉protected setDate(?int $userData = null): int|string Sets the date or current date if null value is passed.
/**
* Sets the date or current date if null value is passed.
*
* @param int|null $userData An optional PHP timestamp to be converted.
*
* @return int|string
*
* @throws ModelException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1263
⧉protected intToDate(int $value): int|string A utility function to allow child models to use the type of date/time format ...
/**
* A utility function to allow child models to use the type of
* date/time format that they prefer. This is primarily used for
* setting created_at, updated_at and deleted_at values, but can be
* used by inheriting classes.
*
* The available time formats are:
* - 'int' - Stores the date as an integer timestamp
* - 'datetime' - Stores the data in the SQL datetime format
* - 'date' - Stores the date (only) in the SQL date format.
*
* @param int $value value
*
* @return int|string
*
* @throws ModelException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1287
⧉protected timeToDate(CodeIgniter\I18n\Time $value): int|string Converts Time value to string using $this->dateFormat.
/**
* Converts Time value to string using $this->dateFormat.
*
* The available time formats are:
* - 'int' - Stores the date as an integer timestamp
* - 'datetime' - Stores the data in the SQL datetime format
* - 'date' - Stores the date (only) in the SQL date format.
*
* @param Time $value value
*
* @return int|string
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1316
⧉protected cleanValidationRules(array $rules, ?array $data = null): array Removes any rules that apply to fields that have not been set currently so th...
/**
* Removes any rules that apply to fields that have not been set
* currently so that rules don't block updating when only updating
* a partial row.
*
* @param array $rules Array containing field name and rule
* @param array|null $data Data
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1498
⧉protected trigger(string $event, array $eventData): array A simple event trigger for Model Events that allows additional data manipulat...
/**
* A simple event trigger for Model Events that allows additional
* data manipulation within the model. Specifically intended for
* usage by child models this can be used to format data,
* save/load related classes, etc.
*
* It is the responsibility of the callback methods to return
* the data itself.
*
* Each $eventData array MUST have a 'data' key with the relevant
* data for callback methods (like an array of key/value pairs to insert
* or update, an array of results, etc.)
*
* If callbacks are not allowed then returns $eventData immediately.
*
* @param string $event Event
* @param array $eventData Event Data
*
* @return array
*
* @throws DataException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1550
⧉protected objectToArray($data, bool $onlyChanged = true, bool $recursive = false): array Takes a class and returns an array of its public and protected properties as ...
/**
* Takes a class and returns an array of its public and protected
* properties as an array suitable for use in creates and updates.
* This method uses objectToRawArray() internally and does conversion
* to string on all Time instances
*
* @param object|string $data Data
* @param bool $onlyChanged Only Changed Property
* @param bool $recursive If true, inner entities will be cast as array as well
*
* @return array Array
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1611
⧉protected transformDataToArray($data, string $type): array Transform data to array.
/**
* Transform data to array.
*
* @param array|object|null $data Data
* @param string $type Type of data (insert|update)
*
* @throws DataException
* @throws InvalidArgumentException
* @throws ReflectionException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1673
⧉protected fillPlaceholders(array $rules, array $data): array Replace any placeholders within the rules with the values that match the 'key...
/**
* Replace any placeholders within the rules with the values that
* match the 'key' of any properties being set. For example, if
* we had the following $data array:
*
* [ 'id' => 13 ]
*
* and the following rule:
*
* 'required|is_unique[users,email,id,{id}]'
*
* The value of {id} would be replaced with the actual id in the form data:
*
* 'required|is_unique[users,email,id,13]'
*
* @param array $rules Validation rules
* @param array $data Data
*
* @codeCoverageIgnore
*
* @deprecated use fillPlaceholders($rules, $data) from Validation instead
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1778
⧉private get_action_html_entity_decode($result)
Defined in <ROOT>/app/Models/Frontend_model.php:122
⇄⧉public static classToArray($data, $primaryKey = null, string $dateFormat = 'datetime', bool $onlyChanged = true): array Takes a class an returns an array of it's public and protected properties as ...
/**
* Takes a class an returns an array of it's public and protected
* properties as an array suitable for use in creates and updates.
*
* @param object|string $data
* @param string|null $primaryKey
*
* @throws ReflectionException
*
* @codeCoverageIgnore
*
* @deprecated since 4.1
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:875
data => string (2) "46"
⧉records => stdClass#91 (17)
Properties (17)
public date_time -> string (19) "2023-11-09 17:00:44"
public department_id -> string (2) "24"
⧉public description -> UTF-8 string (379) "Wir verpacken Güter, aber warum eigentlich? Die Verpackung dient einerseits ...
Wir verpacken Güter, aber warum eigentlich? Die Verpackung dient einerseits dem Schutz der Güter, andererseits übernimmt sie aber auch logistische und Informationsaufgaben. Diese Informationen tragen dazu bei, dass die Güter zur richtigen Zeit am richtigen Ort sind. Verpackungen unterliegen einem stetigen Wandel. Dabei gewinnt die Nachhaltigkeit mehr und mehr an Bedeutung.
public download_link -> string (0) ""
public hour -> string (11) "4 Lektionen"
public id -> string (2) "46"
public level -> string (1) "1"
public name -> string (41) "Modul 602 Versandbereite Pakete erstellen"
public print_link -> string (0) ""
public share_link -> string (0) ""
public skills -> string (2) "9,"
public status -> string (1) "0"
public submitted_by -> string (6) "hodler"
public tags -> string (3) "12,"
public title -> string (41) "Modul 602 Versandbereite Pakete erstellen"
public updated_at -> string (19) "2022-02-11 14:05:26"
public video -> string (36) "https://www.nanoo.tv/link/v/AWtvujqJ"
/**
* Constructor
*/
Defined in <ROOT>/system/Log/Handlers/FileHandler.php:46
⧉public handle($level, $message): bool Handles logging the message. If the handler returns false, then execution of ...
/**
* Handles logging the message.
* If the handler returns false, then execution of handlers
* will stop. Any handlers that have not run, yet, will not
* be run.
*
* @param string $level
* @param string $message
*
* @throws Exception
*/
Defined in <ROOT>/system/Log/Handlers/FileHandler.php:69
⧉public canHandle(string $level): bool Checks whether the Handler will handle logging items of this log Level.
/**
* Checks whether the Handler will handle logging items of this
* log Level.
*/
Inherited from CodeIgniter\Log\Handlers\BaseHandler
Defined in <ROOT>/system/Log/Handlers/BaseHandler.php:45
⧉public setDateFormat(string $format): CodeIgniter\Log\Handlers\HandlerInterface Stores the date format to use while logging messages.
/**
* Stores the date format to use while logging messages.
*/
Inherited from CodeIgniter\Log\Handlers\BaseHandler
Defined in <ROOT>/system/Log/Handlers/BaseHandler.php:53
/**
* Constructor.
*
* @param \Config\Logger $config
*
* @throws RuntimeException
*/
Defined in <ROOT>/system/Log/Logger.php:120
⧉public emergency($message, array $context = array()): bool System is unusable.
/**
* System is unusable.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:158
⧉public alert($message, array $context = array()): bool Action must be taken immediately.
/**
* Action must be taken immediately.
*
* Example: Entire website down, database unavailable, etc. This should
* trigger the SMS alerts and wake you up.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:171
⧉public error($message, array $context = array()): bool Runtime errors that do not require immediate action but should typically be l...
/**
* Runtime errors that do not require immediate action but should typically
* be logged and monitored.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:194
⧉public warning($message, array $context = array()): bool Exceptional occurrences that are not errors.
/**
* Exceptional occurrences that are not errors.
*
* Example: Use of deprecated APIs, poor use of an API, undesirable things
* that are not necessarily wrong.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:207
⧉public notice($message, array $context = array()): bool Normal but significant events.
/**
* Normal but significant events.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:217
/**
* Detailed debug information.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:239
⧉public log($level, $message, array $context = array()): bool Logs with an arbitrary level.
/**
* Logs with an arbitrary level.
*
* @param string $level
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:250
⧉public determineFile(): array Determines the file and line that the logging call was made from by analyzing...
/**
* Determines the file and line that the logging call
* was made from by analyzing the backtrace.
* Find the earliest stack frame that is part of our logging system.
*/
Defined in <ROOT>/system/Log/Logger.php:372
⧉protected interpolate($message, array $context = array()): string Replaces any placeholders in the message with variables from the context, as ...
/**
* Replaces any placeholders in the message with variables
* from the context, as well as a few special items like:
*
* {session_vars}
* {post_vars}
* {get_vars}
* {env}
* {env:foo}
* {file}
* {line}
*
* @param string $message
*
* @return string
*/
Defined in <ROOT>/system/Log/Logger.php:316
⧉protected cleanFileNames(string $file): string Cleans the paths of filenames by replacing APPPATH, SYSTEMPATH, FCPATH with t...
/**
* Cleans the paths of filenames by replacing APPPATH, SYSTEMPATH, FCPATH
* with the actual var. i.e.
*
* /var/www/site/app/Controllers/Home.php
* becomes:
* APPPATH/Controllers/Home.php
*
* @deprecated Use dedicated `clean_path()` function.
*/
Defined in <ROOT>/system/Log/Logger.php:422
⧉public __construct() Will attempt to get environment variables with names that match the propertie...
/**
* Will attempt to get environment variables with names
* that match the properties of the child class.
*
* The "shortPrefix" is the lowercase-only config class name.
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in <ROOT>/system/Config/BaseConfig.php:60
/**
* Retrieve an environment-specific configuration setting
*
* @return string|null
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in <ROOT>/system/Config/BaseConfig.php:128
⧉protected registerProperties() Provides external libraries a simple way to register one or more options into...
/**
* Provides external libraries a simple way to register one or more
* options into a config file.
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in <ROOT>/system/Config/BaseConfig.php:174
⧉public shouldDiscover(string $alias): bool Should the application auto-discover the requested resource.
/**
* Should the application auto-discover the requested resource.
*/
Inherited from CodeIgniter\Modules\Modules
Defined in <ROOT>/system/Modules/Modules.php:45
/**
* Constructor.
*
* @param string|null $uri The URI to parse.
*
* @throws HTTPException
*
* @TODO null for param $uri should be removed.
* See https://www.php-fig.org/psr/psr-17/#26-urifactoryinterface
*/
Defined in <ROOT>/system/HTTP/URI.php:250
⧉public setSilent(bool $silent = true): URI If $silent == true, then will not throw exceptions and will attempt to contin...
/**
* If $silent == true, then will not throw exceptions and will
* attempt to continue gracefully.
*
* @return URI
*/
Defined in <ROOT>/system/HTTP/URI.php:263
⧉public useRawQueryString(bool $raw = true): URI If $raw == true, then will use parseStr() method instead of native parse_str(...
/**
* If $raw == true, then will use parseStr() method
* instead of native parse_str() function.
*
* @return URI
*/
Defined in <ROOT>/system/HTTP/URI.php:276
⧉public setURI(?string $uri = null): URI Sets and overwrites any current URI information.
/**
* Sets and overwrites any current URI information.
*
* @return URI
*
* @throws HTTPException
*/
Defined in <ROOT>/system/HTTP/URI.php:290
⧉public getScheme(): string Retrieve the scheme component of the URI.
/**
* Retrieve the scheme component of the URI.
*
* If no scheme is present, this method MUST return an empty string.
*
* The value returned MUST be normalized to lowercase, per RFC 3986
* Section 3.1.
*
* The trailing ":" character is not part of the scheme and MUST NOT be
* added.
*
* @see https://tools.ietf.org/html/rfc3986#section-3.1
*
* @return string The URI scheme.
*/
Defined in <ROOT>/system/HTTP/URI.php:324
⧉public getAuthority(bool $ignorePort = false): string Retrieve the authority component of the URI.
/**
* Retrieve the authority component of the URI.
*
* If no authority information is present, this method MUST return an empty
* string.
*
* The authority syntax of the URI is:
*
* <pre>
* [user-info@]host[:port]
* </pre>
*
* If the port component is not set or is the standard port for the current
* scheme, it SHOULD NOT be included.
*
* @see https://tools.ietf.org/html/rfc3986#section-3.2
*
* @return string The URI authority, in "[user-info@]host[:port]" format.
*/
Defined in <ROOT>/system/HTTP/URI.php:348
⧉public getUserInfo(): string|null The URI user information, in "username[:password]" format. Retrieve the user information component of the URI.
/**
* Retrieve the user information component of the URI.
*
* If no user information is present, this method MUST return an empty
* string.
*
* If a user is present in the URI, this will return that value;
* additionally, if the password is also present, it will be appended to the
* user value, with a colon (":") separating the values.
*
* NOTE that be default, the password, if available, will NOT be shown
* as a security measure as discussed in RFC 3986, Section 7.5. If you know
* the password is not a security issue, you can force it to be shown
* with $this->showPassword();
*
* The trailing "@" character is not part of the user information and MUST
* NOT be added.
*
* @return string|null The URI user information, in "username[:password]" format.
*/
Defined in <ROOT>/system/HTTP/URI.php:391
⧉public showPassword(bool $val = true): URI Temporarily sets the URI to show a password in userInfo. Will reset itself af...
/**
* Temporarily sets the URI to show a password in userInfo. Will
* reset itself after the first call to authority().
*
* @return URI
*/
Defined in <ROOT>/system/HTTP/URI.php:408
⧉public getHost(): string Retrieve the host component of the URI.
/**
* Retrieve the host component of the URI.
*
* If no host is present, this method MUST return an empty string.
*
* The value returned MUST be normalized to lowercase, per RFC 3986
* Section 3.2.2.
*
* @see http://tools.ietf.org/html/rfc3986#section-3.2.2
*
* @return string The URI host.
*/
Defined in <ROOT>/system/HTTP/URI.php:427
⧉public getPort(): int|null The URI port. Retrieve the port component of the URI.
/**
* Retrieve the port component of the URI.
*
* If a port is present, and it is non-standard for the current scheme,
* this method MUST return it as an integer. If the port is the standard port
* used with the current scheme, this method SHOULD return null.
*
* If no port is present, and no scheme is present, this method MUST return
* a null value.
*
* If no port is present, but a scheme is present, this method MAY return
* the standard port for that scheme, but SHOULD return null.
*
* @return int|null The URI port.
*/
Defined in <ROOT>/system/HTTP/URI.php:447
⧉public getPath(): string Retrieve the path component of the URI.
/**
* Retrieve the path component of the URI.
*
* The path can either be empty or absolute (starting with a slash) or
* rootless (not starting with a slash). Implementations MUST support all
* three syntaxes.
*
* Normally, the empty path "" and absolute path "/" are considered equal as
* defined in RFC 7230 Section 2.7.3. But this method MUST NOT automatically
* do this normalization because in contexts with a trimmed base path, e.g.
* the front controller, this difference becomes significant. It's the task
* of the user to handle both "" and "/".
*
* The value returned MUST be percent-encoded, but MUST NOT double-encode
* any characters. To determine what characters to encode, please refer to
* RFC 3986, Sections 2 and 3.3.
*
* As an example, if the value should include a slash ("/") not intended as
* delimiter between path segments, that value MUST be passed in encoded
* form (e.g., "%2F") to the instance.
*
* @see https://tools.ietf.org/html/rfc3986#section-2
* @see https://tools.ietf.org/html/rfc3986#section-3.3
*
* @return string The URI path.
*/
Defined in <ROOT>/system/HTTP/URI.php:478
⧉public getQuery(array $options = array()): string Retrieve the query string
/**
* Retrieve the query string
*/
Defined in <ROOT>/system/HTTP/URI.php:486
⧉public getFragment(): string Retrieve a URI fragment
/**
* Retrieve a URI fragment
*/
Defined in <ROOT>/system/HTTP/URI.php:520
⧉public getSegments(): array Returns the segments of the path as an array.
/**
* Returns the segments of the path as an array.
*/
Defined in <ROOT>/system/HTTP/URI.php:528
⧉public getSegment(int $number, string $default = ''): string Returns the value of a specific segment of the URI path.
/**
* Returns the value of a specific segment of the URI path.
*
* @param int $number Segment number
* @param string $default Default value
*
* @return string The value of the segment. If no segment is found,
* throws InvalidArgumentError
*/
Defined in <ROOT>/system/HTTP/URI.php:542
⧉public setSegment(int $number, $value): $this Set the value of a specific segment of the URI path. Allows to set only exist...
/**
* Set the value of a specific segment of the URI path.
* Allows to set only existing segments or add new one.
*
* @param mixed $value (string or int)
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/URI.php:563
⧉public getTotalSegments(): int Returns the total number of segments.
/**
* Returns the total number of segments.
*/
Defined in <ROOT>/system/HTTP/URI.php:586
⧉public __toString(): string Formats the URI as a string.
/**
* Formats the URI as a string.
*
* Warning: For backwards-compatability this method
* assumes URIs with the same host as baseURL should
* be relative to the project's configuration.
* This aspect of __toString() is deprecated and should be avoided.
*/
Defined in <ROOT>/system/HTTP/URI.php:599
⧉public setAuthority(string $str): $this Parses the given string and saves the appropriate authority pieces.
/**
* Parses the given string and saves the appropriate authority pieces.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/URI.php:654
⧉public setScheme(string $str): $this Sets the scheme for this URI.
/**
* Sets the scheme for this URI.
*
* Because of the large number of valid schemes we cannot limit this
* to only http or https.
*
* @see https://www.iana.org/assignments/uri-schemes/uri-schemes.xhtml
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/URI.php:682
⧉public setUserInfo(string $user, string $pass): $this Sets the userInfo/Authority portion of the URI.
/**
* Sets the userInfo/Authority portion of the URI.
*
* @param string $user The user's username
* @param string $pass The user's password
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/URI.php:698
⧉public setHost(string $str): $this Sets the host name to use.
/**
* Sets the host name to use.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/URI.php:711
⧉public setPort(?int $port = null): $this Sets the port portion of the URI.
/**
* Sets the port portion of the URI.
*
* @param int $port
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/URI.php:725
⧉public setPath(string $path): $this Sets the path portion of the URI.
/**
* Sets the path portion of the URI.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/URI.php:749
⧉public setBaseURL(string $baseURL): void Sets the current baseURL.
/**
* Sets the current baseURL.
*
* @interal
*/
Defined in <ROOT>/system/HTTP/URI.php:765
⧉public getBaseURL(): string Returns the current baseURL.
/**
* Returns the current baseURL.
*
* @interal
*/
Defined in <ROOT>/system/HTTP/URI.php:775
⧉public refreshPath(): $this Sets the path portion of the URI based on segments.
/**
* Sets the path portion of the URI based on segments.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/URI.php:789
⧉public setQuery(string $query): $this Sets the query portion of the URI, while attempting to clean the various part...
/**
* Sets the query portion of the URI, while attempting
* to clean the various parts of the query keys and values.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/URI.php:806
⧉public setQueryArray(array $query): URI A convenience method to pass an array of items in as the Query portion of the...
/**
* A convenience method to pass an array of items in as the Query
* portion of the URI.
*
* @return URI
*/
Defined in <ROOT>/system/HTTP/URI.php:836
⧉public addQuery(string $key, $value = null): $this Adds a single new element to the query vars.
/**
* Adds a single new element to the query vars.
*
* @param mixed $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/URI.php:850
⧉public stripQuery($params): $this Removes one or more query vars from the URI.
/**
* Removes one or more query vars from the URI.
*
* @param string ...$params
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/URI.php:864
⧉public keepQuery($params): $this Filters the query variables so that only the keys passed in are kept. The res...
/**
* Filters the query variables so that only the keys passed in
* are kept. The rest are removed from the object.
*
* @param string ...$params
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/URI.php:881
⧉public setFragment(string $string): $this Sets the fragment portion of the URI.
/**
* Sets the fragment portion of the URI.
*
* @see https://tools.ietf.org/html/rfc3986#section-3.5
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/URI.php:905
⧉public resolveRelativeURI(string $uri): URI Combines one URI string with this one based on the rules set out in RFC 3986 ...
/**
* Combines one URI string with this one based on the rules set out in
* RFC 3986 Section 2
*
* @see http://tools.ietf.org/html/rfc3986#section-5.2
*
* @return URI
*/
Defined in <ROOT>/system/HTTP/URI.php:1000
⧉protected filterPath(?string $path = null): string Encodes any dangerous characters, and removes dot segments. While dot segment...
/**
* Encodes any dangerous characters, and removes dot segments.
* While dot segments have valid uses according to the spec,
* this URI class does not allow them.
*/
Defined in <ROOT>/system/HTTP/URI.php:917
⧉protected applyParts(array $parts) Saves our parts from a parse_url call.
/**
* Saves our parts from a parse_url call.
*/
Defined in <ROOT>/system/HTTP/URI.php:949
⧉protected mergePaths(self $base, self $reference): string Given 2 paths, will merge them according to rules set out in RFC 2986, Sectio...
/**
* Given 2 paths, will merge them according to rules set out in RFC 2986,
* Section 5.2
*
* @see http://tools.ietf.org/html/rfc3986#section-5.2.3
*/
Defined in <ROOT>/system/HTTP/URI.php:1056
⧉protected parseStr(string $query): array This is equivalent to the native PHP parse_str() function. This version allow...
/**
* This is equivalent to the native PHP parse_str() function.
* This version allows the dot to be used as a key of the query string.
*/
Defined in <ROOT>/system/HTTP/URI.php:1078
⧉private changeSchemeAndPath(string $scheme, string $path): array Change the path (and scheme) assuming URIs with the same host as baseURL shou...
/**
* Change the path (and scheme) assuming URIs with the same host as baseURL
* should be relative to the project's configuration.
*
* @deprecated This method will be deleted.
*/
Defined in <ROOT>/system/HTTP/URI.php:622
⇄⧉public static createURIString(?string $scheme = null, ?string $authority = null, ?string $path = null, ?string $query = null, ?string $fragment = null): string Builds a representation of the string from the component parts.
/**
* Builds a representation of the string from the component parts.
*
* @param string|null $scheme URI scheme. E.g., http, ftp
*
* @return string URI string with only passed parts. Maybe incomplete as a URI.
*/
Defined in <ROOT>/system/HTTP/URI.php:155
⇄⧉public static removeDotSegments(string $path): string Used when resolving and merging paths to correctly interpret and remove singl...
/**
* Used when resolving and merging paths to correctly interpret and
* remove single and double dot segments from the path per
* RFC 3986 Section 5.2.4
*
* @see http://tools.ietf.org/html/rfc3986#section-5.2.4
*
* @internal
*/
Defined in <ROOT>/system/HTTP/URI.php:197
⧉public __construct(string $name, $value = null) Header constructor. name is mandatory, if a value is provided, it will be set.
/**
* Header constructor. name is mandatory, if a value is provided, it will be set.
*
* @param array<int|string, array<string, string>|string>|string|null $value
*/
Defined in <ROOT>/system/HTTP/Header.php:49
⧉public getName(): string Returns the name of the header, in the same case it was set.
/**
* Returns the name of the header, in the same case it was set.
*/
Defined in <ROOT>/system/HTTP/Header.php:58
⧉public getValue(): array<int|string, array<string, string>|string>|string Gets the raw value of the header. This may return either a string of an array...
/**
* Gets the raw value of the header. This may return either a string
* of an array, depending on whether the header has multiple values or not.
*
* @return array<int|string, array<string, string>|string>|string
*/
Defined in <ROOT>/system/HTTP/Header.php:69
⧉public setName(string $name): $this Sets the name of the header, overwriting any previous value.
/**
* Sets the name of the header, overwriting any previous value.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:79
⧉public setValue($value = null): $this Sets the value of the header, overwriting any previous value(s).
/**
* Sets the value of the header, overwriting any previous value(s).
*
* @param array<int|string, array<string, string>|string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:93
⧉public appendValue($value = null): $this Appends a value to the list of values for this header. If the header is a sin...
/**
* Appends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:108
⧉public prependValue($value = null): $this Prepends a value to the list of values for this header. If the header is a si...
/**
* Prepends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:133
⧉public getValueLine(): string Retrieves a comma-separated string of the values for a single header.
/**
* Retrieves a comma-separated string of the values for a single header.
*
* NOTE: Not all header values may be appropriately represented using
* comma concatenation. For such headers, use getHeader() instead
* and supply your own delimiter when concatenating.
*
* @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
*/
Defined in <ROOT>/system/HTTP/Header.php:157
⧉public __toString(): string Returns a representation of the entire header string, including the header na...
/**
* Returns a representation of the entire header string, including
* the header name and all values converted to the proper format.
*/
Defined in <ROOT>/system/HTTP/Header.php:186
protected value -> string (23) "gzip, deflate, br, zstd"
⧉public __construct(string $name, $value = null) Header constructor. name is mandatory, if a value is provided, it will be set.
/**
* Header constructor. name is mandatory, if a value is provided, it will be set.
*
* @param array<int|string, array<string, string>|string>|string|null $value
*/
Defined in <ROOT>/system/HTTP/Header.php:49
⧉public getName(): string Returns the name of the header, in the same case it was set.
/**
* Returns the name of the header, in the same case it was set.
*/
Defined in <ROOT>/system/HTTP/Header.php:58
⧉public getValue(): array<int|string, array<string, string>|string>|string Gets the raw value of the header. This may return either a string of an array...
/**
* Gets the raw value of the header. This may return either a string
* of an array, depending on whether the header has multiple values or not.
*
* @return array<int|string, array<string, string>|string>|string
*/
Defined in <ROOT>/system/HTTP/Header.php:69
⧉public setName(string $name): $this Sets the name of the header, overwriting any previous value.
/**
* Sets the name of the header, overwriting any previous value.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:79
⧉public setValue($value = null): $this Sets the value of the header, overwriting any previous value(s).
/**
* Sets the value of the header, overwriting any previous value(s).
*
* @param array<int|string, array<string, string>|string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:93
⧉public appendValue($value = null): $this Appends a value to the list of values for this header. If the header is a sin...
/**
* Appends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:108
⧉public prependValue($value = null): $this Prepends a value to the list of values for this header. If the header is a si...
/**
* Prepends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:133
⧉public getValueLine(): string Retrieves a comma-separated string of the values for a single header.
/**
* Retrieves a comma-separated string of the values for a single header.
*
* NOTE: Not all header values may be appropriately represented using
* comma concatenation. For such headers, use getHeader() instead
* and supply your own delimiter when concatenating.
*
* @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
*/
Defined in <ROOT>/system/HTTP/Header.php:157
⧉public __toString(): string Returns a representation of the entire header string, including the header na...
/**
* Returns a representation of the entire header string, including
* the header name and all values converted to the proper format.
*/
Defined in <ROOT>/system/HTTP/Header.php:186
⧉Sec-Fetch-Dest => CodeIgniter\HTTP\Header#16 (2)
Properties (2)
Available methods (9)
protected name -> string (14) "Sec-Fetch-Dest"
protected value -> string (8) "document"
⧉public __construct(string $name, $value = null) Header constructor. name is mandatory, if a value is provided, it will be set.
/**
* Header constructor. name is mandatory, if a value is provided, it will be set.
*
* @param array<int|string, array<string, string>|string>|string|null $value
*/
Defined in <ROOT>/system/HTTP/Header.php:49
⧉public getName(): string Returns the name of the header, in the same case it was set.
/**
* Returns the name of the header, in the same case it was set.
*/
Defined in <ROOT>/system/HTTP/Header.php:58
⧉public getValue(): array<int|string, array<string, string>|string>|string Gets the raw value of the header. This may return either a string of an array...
/**
* Gets the raw value of the header. This may return either a string
* of an array, depending on whether the header has multiple values or not.
*
* @return array<int|string, array<string, string>|string>|string
*/
Defined in <ROOT>/system/HTTP/Header.php:69
⧉public setName(string $name): $this Sets the name of the header, overwriting any previous value.
/**
* Sets the name of the header, overwriting any previous value.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:79
⧉public setValue($value = null): $this Sets the value of the header, overwriting any previous value(s).
/**
* Sets the value of the header, overwriting any previous value(s).
*
* @param array<int|string, array<string, string>|string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:93
⧉public appendValue($value = null): $this Appends a value to the list of values for this header. If the header is a sin...
/**
* Appends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:108
⧉public prependValue($value = null): $this Prepends a value to the list of values for this header. If the header is a si...
/**
* Prepends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:133
⧉public getValueLine(): string Retrieves a comma-separated string of the values for a single header.
/**
* Retrieves a comma-separated string of the values for a single header.
*
* NOTE: Not all header values may be appropriately represented using
* comma concatenation. For such headers, use getHeader() instead
* and supply your own delimiter when concatenating.
*
* @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
*/
Defined in <ROOT>/system/HTTP/Header.php:157
⧉public __toString(): string Returns a representation of the entire header string, including the header na...
/**
* Returns a representation of the entire header string, including
* the header name and all values converted to the proper format.
*/
Defined in <ROOT>/system/HTTP/Header.php:186
⧉Sec-Fetch-User => CodeIgniter\HTTP\Header#17 (2)
Properties (2)
Available methods (9)
protected name -> string (14) "Sec-Fetch-User"
protected value -> string (2) "?1"
⧉public __construct(string $name, $value = null) Header constructor. name is mandatory, if a value is provided, it will be set.
/**
* Header constructor. name is mandatory, if a value is provided, it will be set.
*
* @param array<int|string, array<string, string>|string>|string|null $value
*/
Defined in <ROOT>/system/HTTP/Header.php:49
⧉public getName(): string Returns the name of the header, in the same case it was set.
/**
* Returns the name of the header, in the same case it was set.
*/
Defined in <ROOT>/system/HTTP/Header.php:58
⧉public getValue(): array<int|string, array<string, string>|string>|string Gets the raw value of the header. This may return either a string of an array...
/**
* Gets the raw value of the header. This may return either a string
* of an array, depending on whether the header has multiple values or not.
*
* @return array<int|string, array<string, string>|string>|string
*/
Defined in <ROOT>/system/HTTP/Header.php:69
⧉public setName(string $name): $this Sets the name of the header, overwriting any previous value.
/**
* Sets the name of the header, overwriting any previous value.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:79
⧉public setValue($value = null): $this Sets the value of the header, overwriting any previous value(s).
/**
* Sets the value of the header, overwriting any previous value(s).
*
* @param array<int|string, array<string, string>|string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:93
⧉public appendValue($value = null): $this Appends a value to the list of values for this header. If the header is a sin...
/**
* Appends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:108
⧉public prependValue($value = null): $this Prepends a value to the list of values for this header. If the header is a si...
/**
* Prepends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:133
⧉public getValueLine(): string Retrieves a comma-separated string of the values for a single header.
/**
* Retrieves a comma-separated string of the values for a single header.
*
* NOTE: Not all header values may be appropriately represented using
* comma concatenation. For such headers, use getHeader() instead
* and supply your own delimiter when concatenating.
*
* @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
*/
Defined in <ROOT>/system/HTTP/Header.php:157
⧉public __toString(): string Returns a representation of the entire header string, including the header na...
/**
* Returns a representation of the entire header string, including
* the header name and all values converted to the proper format.
*/
Defined in <ROOT>/system/HTTP/Header.php:186
⧉Sec-Fetch-Mode => CodeIgniter\HTTP\Header#18 (2)
Properties (2)
Available methods (9)
protected name -> string (14) "Sec-Fetch-Mode"
protected value -> string (8) "navigate"
⧉public __construct(string $name, $value = null) Header constructor. name is mandatory, if a value is provided, it will be set.
/**
* Header constructor. name is mandatory, if a value is provided, it will be set.
*
* @param array<int|string, array<string, string>|string>|string|null $value
*/
Defined in <ROOT>/system/HTTP/Header.php:49
⧉public getName(): string Returns the name of the header, in the same case it was set.
/**
* Returns the name of the header, in the same case it was set.
*/
Defined in <ROOT>/system/HTTP/Header.php:58
⧉public getValue(): array<int|string, array<string, string>|string>|string Gets the raw value of the header. This may return either a string of an array...
/**
* Gets the raw value of the header. This may return either a string
* of an array, depending on whether the header has multiple values or not.
*
* @return array<int|string, array<string, string>|string>|string
*/
Defined in <ROOT>/system/HTTP/Header.php:69
⧉public setName(string $name): $this Sets the name of the header, overwriting any previous value.
/**
* Sets the name of the header, overwriting any previous value.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:79
⧉public setValue($value = null): $this Sets the value of the header, overwriting any previous value(s).
/**
* Sets the value of the header, overwriting any previous value(s).
*
* @param array<int|string, array<string, string>|string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:93
⧉public appendValue($value = null): $this Appends a value to the list of values for this header. If the header is a sin...
/**
* Appends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:108
⧉public prependValue($value = null): $this Prepends a value to the list of values for this header. If the header is a si...
/**
* Prepends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:133
⧉public getValueLine(): string Retrieves a comma-separated string of the values for a single header.
/**
* Retrieves a comma-separated string of the values for a single header.
*
* NOTE: Not all header values may be appropriately represented using
* comma concatenation. For such headers, use getHeader() instead
* and supply your own delimiter when concatenating.
*
* @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
*/
Defined in <ROOT>/system/HTTP/Header.php:157
⧉public __toString(): string Returns a representation of the entire header string, including the header na...
/**
* Returns a representation of the entire header string, including
* the header name and all values converted to the proper format.
*/
Defined in <ROOT>/system/HTTP/Header.php:186
⧉Sec-Fetch-Site => CodeIgniter\HTTP\Header#19 (2)
Properties (2)
Available methods (9)
protected name -> string (14) "Sec-Fetch-Site"
protected value -> string (4) "none"
⧉public __construct(string $name, $value = null) Header constructor. name is mandatory, if a value is provided, it will be set.
/**
* Header constructor. name is mandatory, if a value is provided, it will be set.
*
* @param array<int|string, array<string, string>|string>|string|null $value
*/
Defined in <ROOT>/system/HTTP/Header.php:49
⧉public getName(): string Returns the name of the header, in the same case it was set.
/**
* Returns the name of the header, in the same case it was set.
*/
Defined in <ROOT>/system/HTTP/Header.php:58
⧉public getValue(): array<int|string, array<string, string>|string>|string Gets the raw value of the header. This may return either a string of an array...
/**
* Gets the raw value of the header. This may return either a string
* of an array, depending on whether the header has multiple values or not.
*
* @return array<int|string, array<string, string>|string>|string
*/
Defined in <ROOT>/system/HTTP/Header.php:69
⧉public setName(string $name): $this Sets the name of the header, overwriting any previous value.
/**
* Sets the name of the header, overwriting any previous value.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:79
⧉public setValue($value = null): $this Sets the value of the header, overwriting any previous value(s).
/**
* Sets the value of the header, overwriting any previous value(s).
*
* @param array<int|string, array<string, string>|string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:93
⧉public appendValue($value = null): $this Appends a value to the list of values for this header. If the header is a sin...
/**
* Appends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:108
⧉public prependValue($value = null): $this Prepends a value to the list of values for this header. If the header is a si...
/**
* Prepends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:133
⧉public getValueLine(): string Retrieves a comma-separated string of the values for a single header.
/**
* Retrieves a comma-separated string of the values for a single header.
*
* NOTE: Not all header values may be appropriately represented using
* comma concatenation. For such headers, use getHeader() instead
* and supply your own delimiter when concatenating.
*
* @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
*/
Defined in <ROOT>/system/HTTP/Header.php:157
⧉public __toString(): string Returns a representation of the entire header string, including the header na...
/**
* Returns a representation of the entire header string, including
* the header name and all values converted to the proper format.
*/
Defined in <ROOT>/system/HTTP/Header.php:186
⧉Accept => CodeIgniter\HTTP\Header#20 (2)
Properties (2)
Available methods (9)
protected name -> string (6) "Accept"
⧉protected value -> string (135) "text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,...
⧉public __construct(string $name, $value = null) Header constructor. name is mandatory, if a value is provided, it will be set.
/**
* Header constructor. name is mandatory, if a value is provided, it will be set.
*
* @param array<int|string, array<string, string>|string>|string|null $value
*/
Defined in <ROOT>/system/HTTP/Header.php:49
⧉public getName(): string Returns the name of the header, in the same case it was set.
/**
* Returns the name of the header, in the same case it was set.
*/
Defined in <ROOT>/system/HTTP/Header.php:58
⧉public getValue(): array<int|string, array<string, string>|string>|string Gets the raw value of the header. This may return either a string of an array...
/**
* Gets the raw value of the header. This may return either a string
* of an array, depending on whether the header has multiple values or not.
*
* @return array<int|string, array<string, string>|string>|string
*/
Defined in <ROOT>/system/HTTP/Header.php:69
⧉public setName(string $name): $this Sets the name of the header, overwriting any previous value.
/**
* Sets the name of the header, overwriting any previous value.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:79
⧉public setValue($value = null): $this Sets the value of the header, overwriting any previous value(s).
/**
* Sets the value of the header, overwriting any previous value(s).
*
* @param array<int|string, array<string, string>|string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:93
⧉public appendValue($value = null): $this Appends a value to the list of values for this header. If the header is a sin...
/**
* Appends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:108
⧉public prependValue($value = null): $this Prepends a value to the list of values for this header. If the header is a si...
/**
* Prepends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:133
⧉public getValueLine(): string Retrieves a comma-separated string of the values for a single header.
/**
* Retrieves a comma-separated string of the values for a single header.
*
* NOTE: Not all header values may be appropriately represented using
* comma concatenation. For such headers, use getHeader() instead
* and supply your own delimiter when concatenating.
*
* @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
*/
Defined in <ROOT>/system/HTTP/Header.php:157
⧉public __toString(): string Returns a representation of the entire header string, including the header na...
/**
* Returns a representation of the entire header string, including
* the header name and all values converted to the proper format.
*/
Defined in <ROOT>/system/HTTP/Header.php:186
⧉User-Agent => CodeIgniter\HTTP\Header#21 (2)
Properties (2)
Available methods (9)
protected name -> string (10) "User-Agent"
⧉protected value -> string (103) "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0...
Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)
⧉public __construct(string $name, $value = null) Header constructor. name is mandatory, if a value is provided, it will be set.
/**
* Header constructor. name is mandatory, if a value is provided, it will be set.
*
* @param array<int|string, array<string, string>|string>|string|null $value
*/
Defined in <ROOT>/system/HTTP/Header.php:49
⧉public getName(): string Returns the name of the header, in the same case it was set.
/**
* Returns the name of the header, in the same case it was set.
*/
Defined in <ROOT>/system/HTTP/Header.php:58
⧉public getValue(): array<int|string, array<string, string>|string>|string Gets the raw value of the header. This may return either a string of an array...
/**
* Gets the raw value of the header. This may return either a string
* of an array, depending on whether the header has multiple values or not.
*
* @return array<int|string, array<string, string>|string>|string
*/
Defined in <ROOT>/system/HTTP/Header.php:69
⧉public setName(string $name): $this Sets the name of the header, overwriting any previous value.
/**
* Sets the name of the header, overwriting any previous value.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:79
⧉public setValue($value = null): $this Sets the value of the header, overwriting any previous value(s).
/**
* Sets the value of the header, overwriting any previous value(s).
*
* @param array<int|string, array<string, string>|string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:93
⧉public appendValue($value = null): $this Appends a value to the list of values for this header. If the header is a sin...
/**
* Appends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:108
⧉public prependValue($value = null): $this Prepends a value to the list of values for this header. If the header is a si...
/**
* Prepends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:133
⧉public getValueLine(): string Retrieves a comma-separated string of the values for a single header.
/**
* Retrieves a comma-separated string of the values for a single header.
*
* NOTE: Not all header values may be appropriately represented using
* comma concatenation. For such headers, use getHeader() instead
* and supply your own delimiter when concatenating.
*
* @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
*/
Defined in <ROOT>/system/HTTP/Header.php:157
⧉public __toString(): string Returns a representation of the entire header string, including the header na...
/**
* Returns a representation of the entire header string, including
* the header name and all values converted to the proper format.
*/
Defined in <ROOT>/system/HTTP/Header.php:186
protected name -> string (25) "Upgrade-Insecure-Requests"
protected value -> string (1) "1"
⧉public __construct(string $name, $value = null) Header constructor. name is mandatory, if a value is provided, it will be set.
/**
* Header constructor. name is mandatory, if a value is provided, it will be set.
*
* @param array<int|string, array<string, string>|string>|string|null $value
*/
Defined in <ROOT>/system/HTTP/Header.php:49
⧉public getName(): string Returns the name of the header, in the same case it was set.
/**
* Returns the name of the header, in the same case it was set.
*/
Defined in <ROOT>/system/HTTP/Header.php:58
⧉public getValue(): array<int|string, array<string, string>|string>|string Gets the raw value of the header. This may return either a string of an array...
/**
* Gets the raw value of the header. This may return either a string
* of an array, depending on whether the header has multiple values or not.
*
* @return array<int|string, array<string, string>|string>|string
*/
Defined in <ROOT>/system/HTTP/Header.php:69
⧉public setName(string $name): $this Sets the name of the header, overwriting any previous value.
/**
* Sets the name of the header, overwriting any previous value.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:79
⧉public setValue($value = null): $this Sets the value of the header, overwriting any previous value(s).
/**
* Sets the value of the header, overwriting any previous value(s).
*
* @param array<int|string, array<string, string>|string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:93
⧉public appendValue($value = null): $this Appends a value to the list of values for this header. If the header is a sin...
/**
* Appends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:108
⧉public prependValue($value = null): $this Prepends a value to the list of values for this header. If the header is a si...
/**
* Prepends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:133
⧉public getValueLine(): string Retrieves a comma-separated string of the values for a single header.
/**
* Retrieves a comma-separated string of the values for a single header.
*
* NOTE: Not all header values may be appropriately represented using
* comma concatenation. For such headers, use getHeader() instead
* and supply your own delimiter when concatenating.
*
* @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
*/
Defined in <ROOT>/system/HTTP/Header.php:157
⧉public __toString(): string Returns a representation of the entire header string, including the header na...
/**
* Returns a representation of the entire header string, including
* the header name and all values converted to the proper format.
*/
Defined in <ROOT>/system/HTTP/Header.php:186
protected name -> string (18) "Sec-Ch-Ua-Platform"
protected value -> string (9) ""Windows""
⧉public __construct(string $name, $value = null) Header constructor. name is mandatory, if a value is provided, it will be set.
/**
* Header constructor. name is mandatory, if a value is provided, it will be set.
*
* @param array<int|string, array<string, string>|string>|string|null $value
*/
Defined in <ROOT>/system/HTTP/Header.php:49
⧉public getName(): string Returns the name of the header, in the same case it was set.
/**
* Returns the name of the header, in the same case it was set.
*/
Defined in <ROOT>/system/HTTP/Header.php:58
⧉public getValue(): array<int|string, array<string, string>|string>|string Gets the raw value of the header. This may return either a string of an array...
/**
* Gets the raw value of the header. This may return either a string
* of an array, depending on whether the header has multiple values or not.
*
* @return array<int|string, array<string, string>|string>|string
*/
Defined in <ROOT>/system/HTTP/Header.php:69
⧉public setName(string $name): $this Sets the name of the header, overwriting any previous value.
/**
* Sets the name of the header, overwriting any previous value.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:79
⧉public setValue($value = null): $this Sets the value of the header, overwriting any previous value(s).
/**
* Sets the value of the header, overwriting any previous value(s).
*
* @param array<int|string, array<string, string>|string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:93
⧉public appendValue($value = null): $this Appends a value to the list of values for this header. If the header is a sin...
/**
* Appends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:108
⧉public prependValue($value = null): $this Prepends a value to the list of values for this header. If the header is a si...
/**
* Prepends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:133
⧉public getValueLine(): string Retrieves a comma-separated string of the values for a single header.
/**
* Retrieves a comma-separated string of the values for a single header.
*
* NOTE: Not all header values may be appropriately represented using
* comma concatenation. For such headers, use getHeader() instead
* and supply your own delimiter when concatenating.
*
* @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
*/
Defined in <ROOT>/system/HTTP/Header.php:157
⧉public __toString(): string Returns a representation of the entire header string, including the header na...
/**
* Returns a representation of the entire header string, including
* the header name and all values converted to the proper format.
*/
Defined in <ROOT>/system/HTTP/Header.php:186
⧉public __construct(string $name, $value = null) Header constructor. name is mandatory, if a value is provided, it will be set.
/**
* Header constructor. name is mandatory, if a value is provided, it will be set.
*
* @param array<int|string, array<string, string>|string>|string|null $value
*/
Defined in <ROOT>/system/HTTP/Header.php:49
⧉public getName(): string Returns the name of the header, in the same case it was set.
/**
* Returns the name of the header, in the same case it was set.
*/
Defined in <ROOT>/system/HTTP/Header.php:58
⧉public getValue(): array<int|string, array<string, string>|string>|string Gets the raw value of the header. This may return either a string of an array...
/**
* Gets the raw value of the header. This may return either a string
* of an array, depending on whether the header has multiple values or not.
*
* @return array<int|string, array<string, string>|string>|string
*/
Defined in <ROOT>/system/HTTP/Header.php:69
⧉public setName(string $name): $this Sets the name of the header, overwriting any previous value.
/**
* Sets the name of the header, overwriting any previous value.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:79
⧉public setValue($value = null): $this Sets the value of the header, overwriting any previous value(s).
/**
* Sets the value of the header, overwriting any previous value(s).
*
* @param array<int|string, array<string, string>|string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:93
⧉public appendValue($value = null): $this Appends a value to the list of values for this header. If the header is a sin...
/**
* Appends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:108
⧉public prependValue($value = null): $this Prepends a value to the list of values for this header. If the header is a si...
/**
* Prepends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:133
⧉public getValueLine(): string Retrieves a comma-separated string of the values for a single header.
/**
* Retrieves a comma-separated string of the values for a single header.
*
* NOTE: Not all header values may be appropriately represented using
* comma concatenation. For such headers, use getHeader() instead
* and supply your own delimiter when concatenating.
*
* @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
*/
Defined in <ROOT>/system/HTTP/Header.php:157
⧉public __toString(): string Returns a representation of the entire header string, including the header na...
/**
* Returns a representation of the entire header string, including
* the header name and all values converted to the proper format.
*/
Defined in <ROOT>/system/HTTP/Header.php:186
⧉Sec-Ch-Ua => CodeIgniter\HTTP\Header#25 (2)
Properties (2)
Available methods (9)
protected name -> string (9) "Sec-Ch-Ua"
protected value -> string (65) ""HeadlessChrome";v="129", "Not=A?Brand";v="8", "Chromium";v="129""
⧉public __construct(string $name, $value = null) Header constructor. name is mandatory, if a value is provided, it will be set.
/**
* Header constructor. name is mandatory, if a value is provided, it will be set.
*
* @param array<int|string, array<string, string>|string>|string|null $value
*/
Defined in <ROOT>/system/HTTP/Header.php:49
⧉public getName(): string Returns the name of the header, in the same case it was set.
/**
* Returns the name of the header, in the same case it was set.
*/
Defined in <ROOT>/system/HTTP/Header.php:58
⧉public getValue(): array<int|string, array<string, string>|string>|string Gets the raw value of the header. This may return either a string of an array...
/**
* Gets the raw value of the header. This may return either a string
* of an array, depending on whether the header has multiple values or not.
*
* @return array<int|string, array<string, string>|string>|string
*/
Defined in <ROOT>/system/HTTP/Header.php:69
⧉public setName(string $name): $this Sets the name of the header, overwriting any previous value.
/**
* Sets the name of the header, overwriting any previous value.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:79
⧉public setValue($value = null): $this Sets the value of the header, overwriting any previous value(s).
/**
* Sets the value of the header, overwriting any previous value(s).
*
* @param array<int|string, array<string, string>|string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:93
⧉public appendValue($value = null): $this Appends a value to the list of values for this header. If the header is a sin...
/**
* Appends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:108
⧉public prependValue($value = null): $this Prepends a value to the list of values for this header. If the header is a si...
/**
* Prepends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:133
⧉public getValueLine(): string Retrieves a comma-separated string of the values for a single header.
/**
* Retrieves a comma-separated string of the values for a single header.
*
* NOTE: Not all header values may be appropriately represented using
* comma concatenation. For such headers, use getHeader() instead
* and supply your own delimiter when concatenating.
*
* @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
*/
Defined in <ROOT>/system/HTTP/Header.php:157
⧉public __toString(): string Returns a representation of the entire header string, including the header na...
/**
* Returns a representation of the entire header string, including
* the header name and all values converted to the proper format.
*/
Defined in <ROOT>/system/HTTP/Header.php:186
⧉Cache-Control => CodeIgniter\HTTP\Header#26 (2)
Properties (2)
Available methods (9)
protected name -> string (13) "Cache-Control"
protected value -> string (8) "no-cache"
⧉public __construct(string $name, $value = null) Header constructor. name is mandatory, if a value is provided, it will be set.
/**
* Header constructor. name is mandatory, if a value is provided, it will be set.
*
* @param array<int|string, array<string, string>|string>|string|null $value
*/
Defined in <ROOT>/system/HTTP/Header.php:49
⧉public getName(): string Returns the name of the header, in the same case it was set.
/**
* Returns the name of the header, in the same case it was set.
*/
Defined in <ROOT>/system/HTTP/Header.php:58
⧉public getValue(): array<int|string, array<string, string>|string>|string Gets the raw value of the header. This may return either a string of an array...
/**
* Gets the raw value of the header. This may return either a string
* of an array, depending on whether the header has multiple values or not.
*
* @return array<int|string, array<string, string>|string>|string
*/
Defined in <ROOT>/system/HTTP/Header.php:69
⧉public setName(string $name): $this Sets the name of the header, overwriting any previous value.
/**
* Sets the name of the header, overwriting any previous value.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:79
⧉public setValue($value = null): $this Sets the value of the header, overwriting any previous value(s).
/**
* Sets the value of the header, overwriting any previous value(s).
*
* @param array<int|string, array<string, string>|string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:93
⧉public appendValue($value = null): $this Appends a value to the list of values for this header. If the header is a sin...
/**
* Appends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:108
⧉public prependValue($value = null): $this Prepends a value to the list of values for this header. If the header is a si...
/**
* Prepends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:133
⧉public getValueLine(): string Retrieves a comma-separated string of the values for a single header.
/**
* Retrieves a comma-separated string of the values for a single header.
*
* NOTE: Not all header values may be appropriately represented using
* comma concatenation. For such headers, use getHeader() instead
* and supply your own delimiter when concatenating.
*
* @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
*/
Defined in <ROOT>/system/HTTP/Header.php:157
⧉public __toString(): string Returns a representation of the entire header string, including the header na...
/**
* Returns a representation of the entire header string, including
* the header name and all values converted to the proper format.
*/
Defined in <ROOT>/system/HTTP/Header.php:186
⧉Pragma => CodeIgniter\HTTP\Header#27 (2)
Properties (2)
Available methods (9)
protected name -> string (6) "Pragma"
protected value -> string (8) "no-cache"
⧉public __construct(string $name, $value = null) Header constructor. name is mandatory, if a value is provided, it will be set.
/**
* Header constructor. name is mandatory, if a value is provided, it will be set.
*
* @param array<int|string, array<string, string>|string>|string|null $value
*/
Defined in <ROOT>/system/HTTP/Header.php:49
⧉public getName(): string Returns the name of the header, in the same case it was set.
/**
* Returns the name of the header, in the same case it was set.
*/
Defined in <ROOT>/system/HTTP/Header.php:58
⧉public getValue(): array<int|string, array<string, string>|string>|string Gets the raw value of the header. This may return either a string of an array...
/**
* Gets the raw value of the header. This may return either a string
* of an array, depending on whether the header has multiple values or not.
*
* @return array<int|string, array<string, string>|string>|string
*/
Defined in <ROOT>/system/HTTP/Header.php:69
⧉public setName(string $name): $this Sets the name of the header, overwriting any previous value.
/**
* Sets the name of the header, overwriting any previous value.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:79
⧉public setValue($value = null): $this Sets the value of the header, overwriting any previous value(s).
/**
* Sets the value of the header, overwriting any previous value(s).
*
* @param array<int|string, array<string, string>|string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:93
⧉public appendValue($value = null): $this Appends a value to the list of values for this header. If the header is a sin...
/**
* Appends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:108
⧉public prependValue($value = null): $this Prepends a value to the list of values for this header. If the header is a si...
/**
* Prepends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:133
⧉public getValueLine(): string Retrieves a comma-separated string of the values for a single header.
/**
* Retrieves a comma-separated string of the values for a single header.
*
* NOTE: Not all header values may be appropriately represented using
* comma concatenation. For such headers, use getHeader() instead
* and supply your own delimiter when concatenating.
*
* @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
*/
Defined in <ROOT>/system/HTTP/Header.php:157
⧉public __toString(): string Returns a representation of the entire header string, including the header na...
/**
* Returns a representation of the entire header string, including
* the header name and all values converted to the proper format.
*/
Defined in <ROOT>/system/HTTP/Header.php:186
⧉Connection => CodeIgniter\HTTP\Header#28 (2)
Properties (2)
Available methods (9)
protected name -> string (10) "Connection"
protected value -> string (5) "close"
⧉public __construct(string $name, $value = null) Header constructor. name is mandatory, if a value is provided, it will be set.
/**
* Header constructor. name is mandatory, if a value is provided, it will be set.
*
* @param array<int|string, array<string, string>|string>|string|null $value
*/
Defined in <ROOT>/system/HTTP/Header.php:49
⧉public getName(): string Returns the name of the header, in the same case it was set.
/**
* Returns the name of the header, in the same case it was set.
*/
Defined in <ROOT>/system/HTTP/Header.php:58
⧉public getValue(): array<int|string, array<string, string>|string>|string Gets the raw value of the header. This may return either a string of an array...
/**
* Gets the raw value of the header. This may return either a string
* of an array, depending on whether the header has multiple values or not.
*
* @return array<int|string, array<string, string>|string>|string
*/
Defined in <ROOT>/system/HTTP/Header.php:69
⧉public setName(string $name): $this Sets the name of the header, overwriting any previous value.
/**
* Sets the name of the header, overwriting any previous value.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:79
⧉public setValue($value = null): $this Sets the value of the header, overwriting any previous value(s).
/**
* Sets the value of the header, overwriting any previous value(s).
*
* @param array<int|string, array<string, string>|string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:93
⧉public appendValue($value = null): $this Appends a value to the list of values for this header. If the header is a sin...
/**
* Appends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:108
⧉public prependValue($value = null): $this Prepends a value to the list of values for this header. If the header is a si...
/**
* Prepends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:133
⧉public getValueLine(): string Retrieves a comma-separated string of the values for a single header.
/**
* Retrieves a comma-separated string of the values for a single header.
*
* NOTE: Not all header values may be appropriately represented using
* comma concatenation. For such headers, use getHeader() instead
* and supply your own delimiter when concatenating.
*
* @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
*/
Defined in <ROOT>/system/HTTP/Header.php:157
⧉public __toString(): string Returns a representation of the entire header string, including the header na...
/**
* Returns a representation of the entire header string, including
* the header name and all values converted to the proper format.
*/
Defined in <ROOT>/system/HTTP/Header.php:186
protected value -> string (31) "/internal-nginx-static-location"
⧉public __construct(string $name, $value = null) Header constructor. name is mandatory, if a value is provided, it will be set.
/**
* Header constructor. name is mandatory, if a value is provided, it will be set.
*
* @param array<int|string, array<string, string>|string>|string|null $value
*/
Defined in <ROOT>/system/HTTP/Header.php:49
⧉public getName(): string Returns the name of the header, in the same case it was set.
/**
* Returns the name of the header, in the same case it was set.
*/
Defined in <ROOT>/system/HTTP/Header.php:58
⧉public getValue(): array<int|string, array<string, string>|string>|string Gets the raw value of the header. This may return either a string of an array...
/**
* Gets the raw value of the header. This may return either a string
* of an array, depending on whether the header has multiple values or not.
*
* @return array<int|string, array<string, string>|string>|string
*/
Defined in <ROOT>/system/HTTP/Header.php:69
⧉public setName(string $name): $this Sets the name of the header, overwriting any previous value.
/**
* Sets the name of the header, overwriting any previous value.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:79
⧉public setValue($value = null): $this Sets the value of the header, overwriting any previous value(s).
/**
* Sets the value of the header, overwriting any previous value(s).
*
* @param array<int|string, array<string, string>|string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:93
⧉public appendValue($value = null): $this Appends a value to the list of values for this header. If the header is a sin...
/**
* Appends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:108
⧉public prependValue($value = null): $this Prepends a value to the list of values for this header. If the header is a si...
/**
* Prepends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:133
⧉public getValueLine(): string Retrieves a comma-separated string of the values for a single header.
/**
* Retrieves a comma-separated string of the values for a single header.
*
* NOTE: Not all header values may be appropriately represented using
* comma concatenation. For such headers, use getHeader() instead
* and supply your own delimiter when concatenating.
*
* @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
*/
Defined in <ROOT>/system/HTTP/Header.php:157
⧉public __toString(): string Returns a representation of the entire header string, including the header na...
/**
* Returns a representation of the entire header string, including
* the header name and all values converted to the proper format.
*/
Defined in <ROOT>/system/HTTP/Header.php:186
⧉X-Real-Ip => CodeIgniter\HTTP\Header#30 (2)
Properties (2)
Available methods (9)
protected name -> string (9) "X-Real-Ip"
protected value -> string (11) "13.59.69.96"
⧉public __construct(string $name, $value = null) Header constructor. name is mandatory, if a value is provided, it will be set.
/**
* Header constructor. name is mandatory, if a value is provided, it will be set.
*
* @param array<int|string, array<string, string>|string>|string|null $value
*/
Defined in <ROOT>/system/HTTP/Header.php:49
⧉public getName(): string Returns the name of the header, in the same case it was set.
/**
* Returns the name of the header, in the same case it was set.
*/
Defined in <ROOT>/system/HTTP/Header.php:58
⧉public getValue(): array<int|string, array<string, string>|string>|string Gets the raw value of the header. This may return either a string of an array...
/**
* Gets the raw value of the header. This may return either a string
* of an array, depending on whether the header has multiple values or not.
*
* @return array<int|string, array<string, string>|string>|string
*/
Defined in <ROOT>/system/HTTP/Header.php:69
⧉public setName(string $name): $this Sets the name of the header, overwriting any previous value.
/**
* Sets the name of the header, overwriting any previous value.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:79
⧉public setValue($value = null): $this Sets the value of the header, overwriting any previous value(s).
/**
* Sets the value of the header, overwriting any previous value(s).
*
* @param array<int|string, array<string, string>|string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:93
⧉public appendValue($value = null): $this Appends a value to the list of values for this header. If the header is a sin...
/**
* Appends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:108
⧉public prependValue($value = null): $this Prepends a value to the list of values for this header. If the header is a si...
/**
* Prepends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:133
⧉public getValueLine(): string Retrieves a comma-separated string of the values for a single header.
/**
* Retrieves a comma-separated string of the values for a single header.
*
* NOTE: Not all header values may be appropriately represented using
* comma concatenation. For such headers, use getHeader() instead
* and supply your own delimiter when concatenating.
*
* @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
*/
Defined in <ROOT>/system/HTTP/Header.php:157
⧉public __toString(): string Returns a representation of the entire header string, including the header na...
/**
* Returns a representation of the entire header string, including
* the header name and all values converted to the proper format.
*/
Defined in <ROOT>/system/HTTP/Header.php:186
⧉Host => CodeIgniter\HTTP\Header#31 (2)
Properties (2)
Available methods (9)
protected name -> string (4) "Host"
protected value -> string (22) "entersite-education.ch"
⧉public __construct(string $name, $value = null) Header constructor. name is mandatory, if a value is provided, it will be set.
/**
* Header constructor. name is mandatory, if a value is provided, it will be set.
*
* @param array<int|string, array<string, string>|string>|string|null $value
*/
Defined in <ROOT>/system/HTTP/Header.php:49
⧉public getName(): string Returns the name of the header, in the same case it was set.
/**
* Returns the name of the header, in the same case it was set.
*/
Defined in <ROOT>/system/HTTP/Header.php:58
⧉public getValue(): array<int|string, array<string, string>|string>|string Gets the raw value of the header. This may return either a string of an array...
/**
* Gets the raw value of the header. This may return either a string
* of an array, depending on whether the header has multiple values or not.
*
* @return array<int|string, array<string, string>|string>|string
*/
Defined in <ROOT>/system/HTTP/Header.php:69
⧉public setName(string $name): $this Sets the name of the header, overwriting any previous value.
/**
* Sets the name of the header, overwriting any previous value.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:79
⧉public setValue($value = null): $this Sets the value of the header, overwriting any previous value(s).
/**
* Sets the value of the header, overwriting any previous value(s).
*
* @param array<int|string, array<string, string>|string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:93
⧉public appendValue($value = null): $this Appends a value to the list of values for this header. If the header is a sin...
/**
* Appends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:108
⧉public prependValue($value = null): $this Prepends a value to the list of values for this header. If the header is a si...
/**
* Prepends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:133
⧉public getValueLine(): string Retrieves a comma-separated string of the values for a single header.
/**
* Retrieves a comma-separated string of the values for a single header.
*
* NOTE: Not all header values may be appropriately represented using
* comma concatenation. For such headers, use getHeader() instead
* and supply your own delimiter when concatenating.
*
* @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
*/
Defined in <ROOT>/system/HTTP/Header.php:157
⧉public __toString(): string Returns a representation of the entire header string, including the header na...
/**
* Returns a representation of the entire header string, including
* the header name and all values converted to the proper format.
*/
Defined in <ROOT>/system/HTTP/Header.php:186
⧉public __construct() Will attempt to get environment variables with names that match the propertie...
/**
* Will attempt to get environment variables with names
* that match the properties of the child class.
*
* The "shortPrefix" is the lowercase-only config class name.
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in <ROOT>/system/Config/BaseConfig.php:60
/**
* Retrieve an environment-specific configuration setting
*
* @return string|null
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in <ROOT>/system/Config/BaseConfig.php:128
⧉protected registerProperties() Provides external libraries a simple way to register one or more options into...
/**
* Provides external libraries a simple way to register one or more
* options into a config file.
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in <ROOT>/system/Config/BaseConfig.php:174
⧉public shouldDiscover(string $alias): bool Should the application auto-discover the requested resource.
/**
* Should the application auto-discover the requested resource.
*/
Inherited from CodeIgniter\Modules\Modules
Defined in <ROOT>/system/Modules/Modules.php:45
/**
* Constructor
*
* @param App $config
* @param string|null $body
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:151
⧉public detectLocale($config) Handles setting up the locale, perhaps auto-detecting through content negotia...
/**
* Handles setting up the locale, perhaps auto-detecting through
* content negotiation.
*
* @param App $config
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:212
⧉public detectPath(string $protocol = ''): string Detects the relative path based on the URIProtocol Config setting.
/**
* Detects the relative path based on
* the URIProtocol Config setting.
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:239
⧉public negotiate(string $type, array $supported, bool $strictMatch = false): string Provides a convenient way to work with the Negotiate class for content negoti...
/**
* Provides a convenient way to work with the Negotiate class
* for content negotiation.
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:355
⧉public is(string $type): bool Checks this request type.
/**
* Checks this request type.
*
* @param string $type HTTP verb or 'json' or 'ajax'
* @phpstan-param string|'get'|'post'|'put'|'delete'|'head'|'patch'|'options'|'json'|'ajax' $type
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:384
⧉public isCLI(): bool Determines if this request was made from the command line (CLI).
/**
* Determines if this request was made from the command line (CLI).
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:408
⧉public isAJAX(): bool Test to see if a request contains the HTTP_X_REQUESTED_WITH header.
/**
* Test to see if a request contains the HTTP_X_REQUESTED_WITH header.
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:416
⧉public isSecure(): bool Attempts to detect if the current connection is secure through a few differen...
/**
* Attempts to detect if the current connection is secure through
* a few different methods.
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:426
⧉public setPath(string $path, ?Config\App $config = null): $this Sets the relative path and updates the URI object.
/**
* Sets the relative path and updates the URI object.
*
* Note: Since current_url() accesses the shared request
* instance, this can be used to change the "current URL"
* for testing.
*
* @param string $path URI path relative to baseURL
* @param App|null $config Optional alternate config to use
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:451
⧉public getPath(): string Returns the URI path relative to baseURL, running detection as necessary.
/**
* Returns the URI path relative to baseURL,
* running detection as necessary.
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:523
⧉public setLocale(string $locale): IncomingRequest Sets the locale string for this request.
/**
* Sets the locale string for this request.
*
* @return IncomingRequest
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:537
⧉public getLocale(): string Gets the current locale, with a fallback to the default locale if none is set.
/**
* Gets the current locale, with a fallback to the default
* locale if none is set.
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:555
⧉public getDefaultLocale(): string Returns the default locale as set in Config\App.php
/**
* Returns the default locale as set in Config\App.php
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:563
⧉public getVar($index = null, $filter = null, $flags = null): array|bool|float|int|stdClass|string|null Fetch an item from JSON input stream with fallback to $_REQUEST object. This ...
/**
* Fetch an item from JSON input stream with fallback to $_REQUEST object. This is the simplest way
* to grab data from the request object and can be used in lieu of the
* other get* methods in most cases.
*
* @param array|string|null $index
* @param int|null $filter Filter constant
* @param array|int|null $flags
*
* @return array|bool|float|int|stdClass|string|null
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:579
⧉public getJSON(bool $assoc = false, int $depth = 512, int $options0): array|bool|float|int|stdClass|null A convenience method that grabs the raw input stream and decodes the JSON int...
/**
* A convenience method that grabs the raw input stream and decodes
* the JSON into an array.
*
* If $assoc == true, then all objects in the response will be converted
* to associative arrays.
*
* @param bool $assoc Whether to return objects as associative arrays
* @param int $depth How many levels deep to decode
* @param int $options Bitmask of options
*
* @see http://php.net/manual/en/function.json-decode.php
*
* @return array|bool|float|int|stdClass|null
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:606
⧉public getJsonVar($index = null, bool $assoc = false, ?int $filter = null, $flags = null): array|bool|float|int|stdClass|string|null Get a specific variable from a JSON input stream
/**
* Get a specific variable from a JSON input stream
*
* @param array|string|null $index The variable that you want which can use dot syntax for getting specific values.
* @param bool $assoc If true, return the result as an associative array.
* @param int|null $filter Filter Constant
* @param array|int|null $flags Option
*
* @return array|bool|float|int|stdClass|string|null
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:621
⧉public getRawInput(): array A convenience method that grabs the raw input stream(send method in PUT, PATC...
/**
* A convenience method that grabs the raw input stream(send method in PUT, PATCH, DELETE) and decodes
* the String into an array.
*
* @return array
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:696
⧉public getRawInputVar($index = null, ?int $filter = null, $flags = null): array|bool|float|int|object|string|null Gets a specific variable from raw input stream (send method in PUT, PATCH, DE...
/**
* Gets a specific variable from raw input stream (send method in PUT, PATCH, DELETE).
*
* @param array|string|null $index The variable that you want which can use dot syntax for getting specific values.
* @param int|null $filter Filter Constant
* @param array|int|null $flags Option
*
* @return array|bool|float|int|object|string|null
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:712
⧉public getGet($index = null, $filter = null, $flags = null): array|bool|float|int|object|string|null Fetch an item from GET data.
/**
* Fetch an item from GET data.
*
* @param array|string|null $index Index for item to fetch from $_GET.
* @param int|null $filter A filter name to apply.
* @param array|int|null $flags
*
* @return array|bool|float|int|object|string|null
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:766
⧉public getPost($index = null, $filter = null, $flags = null): array|bool|float|int|object|string|null Fetch an item from POST.
/**
* Fetch an item from POST.
*
* @param array|string|null $index Index for item to fetch from $_POST.
* @param int|null $filter A filter name to apply
* @param array|int|null $flags
*
* @return array|bool|float|int|object|string|null
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:780
⧉public getPostGet($index = null, $filter = null, $flags = null): array|bool|float|int|object|string|null Fetch an item from POST data with fallback to GET.
/**
* Fetch an item from POST data with fallback to GET.
*
* @param array|string|null $index Index for item to fetch from $_POST or $_GET
* @param int|null $filter A filter name to apply
* @param array|int|null $flags
*
* @return array|bool|float|int|object|string|null
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:794
⧉public getGetPost($index = null, $filter = null, $flags = null): array|bool|float|int|object|string|null Fetch an item from GET data with fallback to POST.
/**
* Fetch an item from GET data with fallback to POST.
*
* @param array|string|null $index Index for item to be fetched from $_GET or $_POST
* @param int|null $filter A filter name to apply
* @param array|int|null $flags
*
* @return array|bool|float|int|object|string|null
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:816
⧉public getCookie($index = null, $filter = null, $flags = null): array|bool|float|int|object|string|null Fetch an item from the COOKIE array.
/**
* Fetch an item from the COOKIE array.
*
* @param array|string|null $index Index for item to be fetched from $_COOKIE
* @param int|null $filter A filter name to be applied
* @param array|int|null $flags
*
* @return array|bool|float|int|object|string|null
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:838
⧉public getUserAgent(): UserAgent Fetch the user agent string
/**
* Fetch the user agent string
*
* @return UserAgent
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:848
⧉public getOldInput(string $key): array|string|null Attempts to get old Input data that has been flashed to the session with redi...
/**
* Attempts to get old Input data that has been flashed to the session
* with redirect_with_input(). It first checks for the data in the old
* POST data, then the old GET data and finally check for dot arrays
*
* @return array|string|null
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:860
⧉public getFiles(): array Returns an array of all files that have been uploaded with this request. Each...
/**
* Returns an array of all files that have been uploaded with this
* request. Each file is represented by an UploadedFile instance.
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:904
⧉public getFileMultiple(string $fileID): array|null Verify if a file exist, by the name of the input field used to upload it, in ...
/**
* Verify if a file exist, by the name of the input field used to upload it, in the collection
* of uploaded files and if is have been uploaded with multiple option.
*
* @return array|null
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:919
⧉public getFile(string $fileID): UploadedFile|null Retrieves a single file by the name of the input field used to upload it.
/**
* Retrieves a single file by the name of the input field used
* to upload it.
*
* @return UploadedFile|null
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:934
⧉public getIPAddress(): string Gets the user's IP address.
/**
* Gets the user's IP address.
*
* @return string IP address if it can be detected.
* If the IP address is not a valid IP address,
* then will return '0.0.0.0'.
*/
Inherited from CodeIgniter\HTTP\Request
Defined in <ROOT>/system/HTTP/RequestTrait.php:51
⧉public isValidIP(?string $ip = null, ?string $which = null): bool Validate an IP address
/**
* Validate an IP address
*
* @param string $ip IP Address
* @param string $which IP protocol: 'ipv4' or 'ipv6'
*
* @deprecated Use Validation instead
*
* @codeCoverageIgnore
*/
Inherited from CodeIgniter\HTTP\Request
Defined in <ROOT>/system/HTTP/Request.php:66
⧉public getMethod(bool $upper = false): string Get the request method.
/**
* Get the request method.
*
* @param bool $upper Whether to return in upper or lower case.
*
* @deprecated The $upper functionality will be removed and this will revert to its PSR-7 equivalent
*
* @codeCoverageIgnore
*/
Inherited from CodeIgniter\HTTP\Request
Defined in <ROOT>/system/HTTP/Request.php:80
⧉public setMethod(string $method): $this Sets the request method. Used when spoofing the request.
/**
* Sets the request method. Used when spoofing the request.
*
* @return $this
*
* @deprecated Use withMethod() instead for immutability
*
* @codeCoverageIgnore
*/
Inherited from CodeIgniter\HTTP\Request
Defined in <ROOT>/system/HTTP/Request.php:94
⧉public withMethod($method): static Returns an instance with the specified method.
/**
* Returns an instance with the specified method.
*
* @param string $method
*
* @return static
*/
Inherited from CodeIgniter\HTTP\Request
Defined in <ROOT>/system/HTTP/Request.php:108
⧉public getUri(): URI Retrieves the URI instance.
/**
* Retrieves the URI instance.
*
* @return URI
*/
Inherited from CodeIgniter\HTTP\Request
Defined in <ROOT>/system/HTTP/Request.php:122
⧉public getServer($index = null, $filter = null, $flags = null): mixed Fetch an item from the $_SERVER array.
/**
* Fetch an item from the $_SERVER array.
*
* @param array|string|null $index Index for item to be fetched from $_SERVER
* @param int|null $filter A filter name to be applied
* @param array|int|null $flags
*
* @return mixed
*/
Inherited from CodeIgniter\HTTP\Request
Defined in <ROOT>/system/HTTP/RequestTrait.php:199
⧉public getEnv($index = null, $filter = null, $flags = null): mixed Fetch an item from the $_ENV array.
/**
* Fetch an item from the $_ENV array.
*
* @param array|string|null $index Index for item to be fetched from $_ENV
* @param int|null $filter A filter name to be applied
* @param array|int|null $flags
*
* @return mixed
*/
Inherited from CodeIgniter\HTTP\Request
Defined in <ROOT>/system/HTTP/RequestTrait.php:213
⧉public setGlobal(string $method, $value): $this Allows manually setting the value of PHP global, like $_GET, $_POST, etc.
/**
* Allows manually setting the value of PHP global, like $_GET, $_POST, etc.
*
* @param mixed $value
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Request
Defined in <ROOT>/system/HTTP/RequestTrait.php:225
⧉public fetchGlobal(string $method, $index = null, ?int $filter = null, $flags = null): array|bool|float|int|object|string|null Fetches one or more items from a global, like cookies, get, post, etc. Can op...
/**
* Fetches one or more items from a global, like cookies, get, post, etc.
* Can optionally filter the input when you retrieve it by passing in
* a filter.
*
* If $type is an array, it must conform to the input allowed by the
* filter_input_array method.
*
* http://php.net/manual/en/filter.filters.sanitize.php
*
* @param string $method Input filter constant
* @param array|string|null $index
* @param int|null $filter Filter constant
* @param array|int|null $flags Options
*
* @return array|bool|float|int|object|string|null
*/
Inherited from CodeIgniter\HTTP\Request
Defined in <ROOT>/system/HTTP/RequestTrait.php:249
⧉public withUri(CodeIgniter\HTTP\URI $uri, $preserveHost = false): static Returns an instance with the provided URI.
/**
* Returns an instance with the provided URI.
*
* @param URI $uri New request URI to use.
* @param bool $preserveHost Preserve the original state of the Host header.
*
* @return static
*/
Inherited from CodeIgniter\HTTP\OutgoingRequest
Defined in <ROOT>/system/HTTP/OutgoingRequest.php:125
⧉public getBody(): string|null Returns the Message's body.
/**
* Returns the Message's body.
*
* @return string|null
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/Message.php:52
⧉public setBody($data): self Sets the body of the current message.
/**
* Sets the body of the current message.
*
* @param string $data
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:52
⧉public appendBody($data): self Appends data to the body of the current message.
/**
* Appends data to the body of the current message.
*
* @param mixed $data
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:66
⧉public getHeaders(): array Returns an array containing all headers.
/**
* Returns an array containing all headers.
*
* @return array<string, Header> An array of the request headers
*
* @deprecated Use Message::headers() to make room for PSR-7
*
* @TODO Incompatible return value with PSR-7
*
* @codeCoverageIgnore
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/Message.php:68
⧉public populateHeaders(): void Populates the $headers array with any headers the server knows about.
/**
* Populates the $headers array with any headers the server knows about.
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:80
⧉public getHeader(string $name): array|Header|null Returns a single header object. If multiple headers with the same name exist,...
/**
* Returns a single header object. If multiple headers with the same
* name exist, then will return an array of header objects.
*
* @return array|Header|null
*
* @deprecated Use Message::header() to make room for PSR-7
*
* @TODO Incompatible return value with PSR-7
*
* @codeCoverageIgnore
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/Message.php:85
⧉public hasHeader(string $name): bool Determines whether a header exists.
/**
* Determines whether a header exists.
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/Message.php:93
⧉public headers(): array Returns an array containing all Headers.
/**
* Returns an array containing all Headers.
*
* @return array<string, Header> An array of the Header objects
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:107
⧉public getHeaderLine(string $name): string Retrieves a comma-separated string of the values for a single header.
/**
* Retrieves a comma-separated string of the values for a single header.
*
* This method returns all of the header values of the given
* case-insensitive header name as a string concatenated together using
* a comma.
*
* NOTE: Not all header values may be appropriately represented using
* comma concatenation. For such headers, use getHeader() instead
* and supply your own delimiter when concatenating.
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/Message.php:111
⧉public getProtocolVersion(): string Returns the HTTP Protocol Version.
/**
* Returns the HTTP Protocol Version.
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/Message.php:125
⧉public header($name): array|Header|null Returns a single Header object. If multiple headers with the same name exist,...
/**
* Returns a single Header object. If multiple headers with the same
* name exist, then will return an array of header objects.
*
* @param string $name
*
* @return array|Header|null
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:127
⧉public setHeader(string $name, $value): self Sets a header and it's value.
/**
* Sets a header and it's value.
*
* @param array|string|null $value
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:141
⧉public removeHeader(string $name): self Removes a header from the list of headers we track.
/**
* Removes a header from the list of headers we track.
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:166
⧉public appendHeader(string $name, ?string $value): self Adds an additional header value to any headers that accept multiple values (i...
/**
* Adds an additional header value to any headers that accept
* multiple values (i.e. are an array or implement ArrayAccess)
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:180
⧉public prependHeader(string $name, string $value): self Adds an additional header value to any headers that accept multiple values (i...
/**
* Adds an additional header value to any headers that accept
* multiple values (i.e. are an array or implement ArrayAccess)
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:197
⧉public setProtocolVersion(string $version): self Sets the HTTP protocol version.
/**
* Sets the HTTP protocol version.
*
* @return $this
*
* @throws HTTPException For invalid protocols
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:222
⧉protected detectURI(string $protocol, string $baseURL) Sets up our URI object based on the information we have. This is either provi...
/**
* Sets up our URI object based on the information we have. This is
* either provided by the user in the baseURL Config setting, or
* determined from the environment as needed.
*
* @deprecated $protocol and $baseURL are deprecated. No longer used.
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:230
⧉protected parseRequestURI(): string Will parse the REQUEST_URI and automatically detect the URI from it, fixing t...
/**
* Will parse the REQUEST_URI and automatically detect the URI from it,
* fixing the query string if necessary.
*
* @return string The URI it found.
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:269
/**
* Parse QUERY_STRING
*
* Will parse QUERY_STRING and automatically detect the URI from it.
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:327
⧉protected removeRelativeDirectory(string $uri): string Remove relative directory (../) and multi slashes (///)
/**
* Remove relative directory (../) and multi slashes (///)
*
* Do some final cleaning of the URI and return it, currently only used in static::_parse_request_uri()
*
* @deprecated Use URI::removeDotSegments() directly
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:950
⧉protected populateGlobals(string $method) Saves a copy of the current state of one of several PHP globals so we can ret...
/**
* Saves a copy of the current state of one of several PHP globals
* so we can retrieve them later.
*/
Inherited from CodeIgniter\HTTP\Request
Defined in <ROOT>/system/HTTP/RequestTrait.php:337
⧉protected getHeaderName(string $name): string Takes a header name in any case, and returns the normal-case version of the h...
/**
* Takes a header name in any case, and returns the
* normal-case version of the header.
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:210
⧉private getPostMaxSize(): int
Defined in <ROOT>/system/HTTP/IncomingRequest.php:182
/**
* Constructor.
*
* Stores our default values from the Config file.
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:242
⧉public enabled(): bool Whether Content Security Policy is being enforced.
/**
* Whether Content Security Policy is being enforced.
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:265
⧉public getStyleNonce(): string Get the nonce for the style tag.
/**
* Get the nonce for the style tag.
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:273
⧉public getScriptNonce(): string Get the nonce for the script tag.
/**
* Get the nonce for the script tag.
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:286
⧉public finalize(CodeIgniter\HTTP\ResponseInterface $response) Compiles and sets the appropriate headers in the request.
/**
* Compiles and sets the appropriate headers in the request.
*
* Should be called just prior to sending the response to the user agent.
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:301
⧉public reportOnly(bool $value = true): $this If TRUE, nothing will be restricted. Instead all violations will be reported ...
/**
* If TRUE, nothing will be restricted. Instead all violations will
* be reported to the reportURI for monitoring. This is useful when
* you are just starting to implement the policy, and will help
* determine what errors need to be addressed before you turn on
* all filtering.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:319
⧉public addBaseURI($uri, ?bool $explicitReporting = null): $this Adds a new base_uri value. Can be either a URI class or a simple string.
/**
* Adds a new base_uri value. Can be either a URI class or a simple string.
*
* base_uri restricts the URLs that can appear in a page’s <base> element.
*
* @see http://www.w3.org/TR/CSP/#directive-base-uri
*
* @param array|string $uri
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:337
⧉public addChildSrc($uri, ?bool $explicitReporting = null): $this Adds a new valid endpoint for a form's action. Can be either a URI class or a...
/**
* Adds a new valid endpoint for a form's action. Can be either
* a URI class or a simple string.
*
* child-src lists the URLs for workers and embedded frame contents.
* For example: child-src https://youtube.com would enable embedding
* videos from YouTube but not from other origins.
*
* @see http://www.w3.org/TR/CSP/#directive-child-src
*
* @param array|string $uri
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:358
⧉public addConnectSrc($uri, ?bool $explicitReporting = null): $this Adds a new valid endpoint for a form's action. Can be either a URI class or a...
/**
* Adds a new valid endpoint for a form's action. Can be either
* a URI class or a simple string.
*
* connect-src limits the origins to which you can connect
* (via XHR, WebSockets, and EventSource).
*
* @see http://www.w3.org/TR/CSP/#directive-connect-src
*
* @param array|string $uri
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:378
⧉public setDefaultSrc($uri, ?bool $explicitReporting = null): $this Adds a new valid endpoint for a form's action. Can be either a URI class or a...
/**
* Adds a new valid endpoint for a form's action. Can be either
* a URI class or a simple string.
*
* default_src is the URI that is used for many of the settings when
* no other source has been set.
*
* @see http://www.w3.org/TR/CSP/#directive-default-src
*
* @param array|string $uri
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:398
⧉public addFontSrc($uri, ?bool $explicitReporting = null): $this Adds a new valid endpoint for a form's action. Can be either a URI class or a...
/**
* Adds a new valid endpoint for a form's action. Can be either
* a URI class or a simple string.
*
* font-src specifies the origins that can serve web fonts.
*
* @see http://www.w3.org/TR/CSP/#directive-font-src
*
* @param array|string $uri
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:417
⧉public addFormAction($uri, ?bool $explicitReporting = null): $this Adds a new valid endpoint for a form's action. Can be either a URI class or a...
/**
* Adds a new valid endpoint for a form's action. Can be either
* a URI class or a simple string.
*
* @see http://www.w3.org/TR/CSP/#directive-form-action
*
* @param array|string $uri
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:434
⧉public addFrameAncestor($uri, ?bool $explicitReporting = null): $this Adds a new resource that should allow embedding the resource using <frame>, <...
/**
* Adds a new resource that should allow embedding the resource using
* <frame>, <iframe>, <object>, <embed>, or <applet>
*
* @see http://www.w3.org/TR/CSP/#directive-frame-ancestors
*
* @param array|string $uri
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:451
⧉public addFrameSrc($uri, ?bool $explicitReporting = null): $this Adds a new valid endpoint for valid frame sources. Can be either a URI class ...
/**
* Adds a new valid endpoint for valid frame sources. Can be either
* a URI class or a simple string.
*
* @see http://www.w3.org/TR/CSP/#directive-frame-src
*
* @param array|string $uri
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:468
⧉public addImageSrc($uri, ?bool $explicitReporting = null): $this Adds a new valid endpoint for valid image sources. Can be either a URI class ...
/**
* Adds a new valid endpoint for valid image sources. Can be either
* a URI class or a simple string.
*
* @see http://www.w3.org/TR/CSP/#directive-img-src
*
* @param array|string $uri
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:485
⧉public addMediaSrc($uri, ?bool $explicitReporting = null): $this Adds a new valid endpoint for valid video and audio. Can be either a URI clas...
/**
* Adds a new valid endpoint for valid video and audio. Can be either
* a URI class or a simple string.
*
* @see http://www.w3.org/TR/CSP/#directive-media-src
*
* @param array|string $uri
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:502
⧉public addManifestSrc($uri, ?bool $explicitReporting = null): $this Adds a new valid endpoint for manifest sources. Can be either a URI class or ...
/**
* Adds a new valid endpoint for manifest sources. Can be either
* a URI class or simple string.
*
* @see https://www.w3.org/TR/CSP/#directive-manifest-src
*
* @param array|string $uri
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:519
⧉public addObjectSrc($uri, ?bool $explicitReporting = null): $this Adds a new valid endpoint for Flash and other plugin sources. Can be either a...
/**
* Adds a new valid endpoint for Flash and other plugin sources. Can be either
* a URI class or a simple string.
*
* @see http://www.w3.org/TR/CSP/#directive-object-src
*
* @param array|string $uri
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:536
⧉public addPluginType($mime, ?bool $explicitReporting = null): $this Limits the types of plugins that can be used. Can be either a URI class or a ...
/**
* Limits the types of plugins that can be used. Can be either
* a URI class or a simple string.
*
* @see http://www.w3.org/TR/CSP/#directive-plugin-types
*
* @param array|string $mime One or more plugin mime types, separate by spaces
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:553
⧉public setReportURI(string $uri): $this Specifies a URL where a browser will send reports when a content security pol...
/**
* Specifies a URL where a browser will send reports when a content
* security policy is violated. Can be either a URI class or a simple string.
*
* @see http://www.w3.org/TR/CSP/#directive-report-uri
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:568
⧉public addSandbox($flags, ?bool $explicitReporting = null): $this specifies an HTML sandbox policy that the user agent applies to the protected...
/**
* specifies an HTML sandbox policy that the user agent applies to
* the protected resource.
*
* @see http://www.w3.org/TR/CSP/#directive-sandbox
*
* @param array|string $flags An array of sandbox flags that can be added to the directive.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:585
⧉public addScriptSrc($uri, ?bool $explicitReporting = null): $this Adds a new valid endpoint for javascript file sources. Can be either a URI cl...
/**
* Adds a new valid endpoint for javascript file sources. Can be either
* a URI class or a simple string.
*
* @see http://www.w3.org/TR/CSP/#directive-connect-src
*
* @param array|string $uri
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:602
⧉public addStyleSrc($uri, ?bool $explicitReporting = null): $this Adds a new valid endpoint for CSS file sources. Can be either a URI class or ...
/**
* Adds a new valid endpoint for CSS file sources. Can be either
* a URI class or a simple string.
*
* @see http://www.w3.org/TR/CSP/#directive-connect-src
*
* @param array|string $uri
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:619
⧉public upgradeInsecureRequests(bool $value = true): $this Sets whether the user agents should rewrite URL schemes, changing HTTP to HTTPS.
/**
* Sets whether the user agents should rewrite URL schemes, changing
* HTTP to HTTPS.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:632
⧉protected addOption($options, string $target, ?bool $explicitReporting = null) DRY method to add an string or array to a class property.
/**
* DRY method to add an string or array to a class property.
*
* @param array|string $options
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:644
⧉protected generateNonces(CodeIgniter\HTTP\ResponseInterface $response) Scans the body of the request message and replaces any nonce placeholders wit...
/**
* Scans the body of the request message and replaces any nonce
* placeholders with actual nonces, that we'll then add to our
* headers.
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:665
⧉protected buildHeaders(CodeIgniter\HTTP\ResponseInterface $response) Based on the current state of the elements, will add the appropriate Content-...
/**
* Based on the current state of the elements, will add the appropriate
* Content-Security-Policy and Content-Security-Policy-Report-Only headers
* with their values to the response object.
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:691
⧉protected addToHeader(string $name, $values = null) Adds a directive and it's options to the appropriate header. The $values arra...
/**
* Adds a directive and it's options to the appropriate header. The $values
* array might have options that are geared toward either the regular or the
* reportOnly header, since it's viable to have both simultaneously.
*
* @param array|string|null $values
*/
Defined in <ROOT>/system/HTTP/ContentSecurityPolicy.php:771
/**
* @param Cookie[] $cookies
*
* @throws CookieException
*/
Defined in <ROOT>/system/Cookie/CookieStore.php:66
⧉public has(string $name, string $prefix = '', ?string $value = null): bool Checks if a `Cookie` object identified by name and prefix is present in the c...
/**
* Checks if a `Cookie` object identified by name and
* prefix is present in the collection.
*/
Defined in <ROOT>/system/Cookie/CookieStore.php:79
⧉public get(string $name, string $prefix = ''): CodeIgniter\Cookie\Cookie Retrieves an instance of `Cookie` identified by a name and prefix. This throw...
/**
* Retrieves an instance of `Cookie` identified by a name and prefix.
* This throws an exception if not found.
*
* @throws CookieException
*/
Defined in <ROOT>/system/Cookie/CookieStore.php:104
⧉public put(CodeIgniter\Cookie\Cookie $cookie): static Store a new cookie and return a new collection. The original collection is le...
/**
* Store a new cookie and return a new collection. The original collection
* is left unchanged.
*
* @return static
*/
Defined in <ROOT>/system/Cookie/CookieStore.php:123
⧉public remove(string $name, string $prefix = ''): static Removes a cookie from a collection and returns an updated collection. The ori...
/**
* Removes a cookie from a collection and returns an updated collection.
* The original collection is left unchanged.
*
* Removing a cookie from the store **DOES NOT** delete it from the browser.
* If you intend to delete a cookie *from the browser*, you must put an empty
* value cookie with the same name to the store.
*
* @return static
*/
Defined in <ROOT>/system/Cookie/CookieStore.php:142
⧉public dispatch(): void Dispatches all cookies in store.
/**
* Dispatches all cookies in store.
*
* @deprecated Response should dispatch cookies.
*/
Defined in <ROOT>/system/Cookie/CookieStore.php:164
⧉public display(): array Returns all cookie instances in store.
/**
* Returns all cookie instances in store.
*
* @return array<string, Cookie>
*/
Defined in <ROOT>/system/Cookie/CookieStore.php:186
⧉public clear(): void Clears the cookie collection.
/**
* Clears the cookie collection.
*/
Defined in <ROOT>/system/Cookie/CookieStore.php:194
⧉public count(): int Gets the Cookie count in this collection.
/**
* Gets the Cookie count in this collection.
*/
Defined in <ROOT>/system/Cookie/CookieStore.php:202
⧉public getIterator(): Traversable Gets the iterator for the cookie collection.
/**
* Gets the iterator for the cookie collection.
*
* @return Traversable<string, Cookie>
*/
Defined in <ROOT>/system/Cookie/CookieStore.php:212
⧉protected validateCookies(array $cookies): void Validates all cookies passed to be instances of Cookie.
/**
* Validates all cookies passed to be instances of Cookie.
*
* @throws CookieException
*/
Defined in <ROOT>/system/Cookie/CookieStore.php:222
⧉protected setRawCookie(string $name, string $value, array $options): void Extracted call to `setrawcookie()` in order to run unit tests on it.
/**
* Extracted call to `setrawcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*
* @deprecated
*/
Defined in <ROOT>/system/Cookie/CookieStore.php:240
⧉protected setCookie(string $name, string $value, array $options): void Extracted call to `setcookie()` in order to run unit tests on it.
/**
* Extracted call to `setcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*
* @deprecated
*/
Defined in <ROOT>/system/Cookie/CookieStore.php:252
⇄⧉public static fromCookieHeaders(array $headers, bool $raw = false): static Creates a CookieStore from an array of `Set-Cookie` headers.
/**
* Creates a CookieStore from an array of `Set-Cookie` headers.
*
* @param string[] $headers
*
* @return static
*
* @throws CookieException
*/
Defined in <ROOT>/system/Cookie/CookieStore.php:43
protected CSPEnabled -> boolean false
⧉protected headerMap -> array (2)
cache-control => string (13) "Cache-Control"
content-type => string (12) "Content-Type"
⧉protected headers -> array (2)
⧉Cache-Control => CodeIgniter\HTTP\Header#33 (2)
Properties (2)
Available methods (9)
protected name -> string (13) "Cache-Control"
⧉protected value -> array (3)
0 => string (8) "no-store"
1 => string (9) "max-age=0"
2 => string (8) "no-cache"
⧉public __construct(string $name, $value = null) Header constructor. name is mandatory, if a value is provided, it will be set.
/**
* Header constructor. name is mandatory, if a value is provided, it will be set.
*
* @param array<int|string, array<string, string>|string>|string|null $value
*/
Defined in <ROOT>/system/HTTP/Header.php:49
⧉public getName(): string Returns the name of the header, in the same case it was set.
/**
* Returns the name of the header, in the same case it was set.
*/
Defined in <ROOT>/system/HTTP/Header.php:58
⧉public getValue(): array<int|string, array<string, string>|string>|string Gets the raw value of the header. This may return either a string of an array...
/**
* Gets the raw value of the header. This may return either a string
* of an array, depending on whether the header has multiple values or not.
*
* @return array<int|string, array<string, string>|string>|string
*/
Defined in <ROOT>/system/HTTP/Header.php:69
⧉public setName(string $name): $this Sets the name of the header, overwriting any previous value.
/**
* Sets the name of the header, overwriting any previous value.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:79
⧉public setValue($value = null): $this Sets the value of the header, overwriting any previous value(s).
/**
* Sets the value of the header, overwriting any previous value(s).
*
* @param array<int|string, array<string, string>|string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:93
⧉public appendValue($value = null): $this Appends a value to the list of values for this header. If the header is a sin...
/**
* Appends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:108
⧉public prependValue($value = null): $this Prepends a value to the list of values for this header. If the header is a si...
/**
* Prepends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:133
⧉public getValueLine(): string Retrieves a comma-separated string of the values for a single header.
/**
* Retrieves a comma-separated string of the values for a single header.
*
* NOTE: Not all header values may be appropriately represented using
* comma concatenation. For such headers, use getHeader() instead
* and supply your own delimiter when concatenating.
*
* @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
*/
Defined in <ROOT>/system/HTTP/Header.php:157
⧉public __toString(): string Returns a representation of the entire header string, including the header na...
/**
* Returns a representation of the entire header string, including
* the header name and all values converted to the proper format.
*/
Defined in <ROOT>/system/HTTP/Header.php:186
⧉Content-Type => CodeIgniter\HTTP\Header#38 (2)
Properties (2)
Available methods (9)
protected name -> string (12) "Content-Type"
protected value -> string (24) "text/html; charset=UTF-8"
⧉public __construct(string $name, $value = null) Header constructor. name is mandatory, if a value is provided, it will be set.
/**
* Header constructor. name is mandatory, if a value is provided, it will be set.
*
* @param array<int|string, array<string, string>|string>|string|null $value
*/
Defined in <ROOT>/system/HTTP/Header.php:49
⧉public getName(): string Returns the name of the header, in the same case it was set.
/**
* Returns the name of the header, in the same case it was set.
*/
Defined in <ROOT>/system/HTTP/Header.php:58
⧉public getValue(): array<int|string, array<string, string>|string>|string Gets the raw value of the header. This may return either a string of an array...
/**
* Gets the raw value of the header. This may return either a string
* of an array, depending on whether the header has multiple values or not.
*
* @return array<int|string, array<string, string>|string>|string
*/
Defined in <ROOT>/system/HTTP/Header.php:69
⧉public setName(string $name): $this Sets the name of the header, overwriting any previous value.
/**
* Sets the name of the header, overwriting any previous value.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:79
⧉public setValue($value = null): $this Sets the value of the header, overwriting any previous value(s).
/**
* Sets the value of the header, overwriting any previous value(s).
*
* @param array<int|string, array<string, string>|string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:93
⧉public appendValue($value = null): $this Appends a value to the list of values for this header. If the header is a sin...
/**
* Appends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:108
⧉public prependValue($value = null): $this Prepends a value to the list of values for this header. If the header is a si...
/**
* Prepends a value to the list of values for this header. If the
* header is a single value string, it will be converted to an array.
*
* @param array<string, string>|string|null $value
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/Header.php:133
⧉public getValueLine(): string Retrieves a comma-separated string of the values for a single header.
/**
* Retrieves a comma-separated string of the values for a single header.
*
* NOTE: Not all header values may be appropriately represented using
* comma concatenation. For such headers, use getHeader() instead
* and supply your own delimiter when concatenating.
*
* @see https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
*/
Defined in <ROOT>/system/HTTP/Header.php:157
⧉public __toString(): string Returns a representation of the entire header string, including the header na...
/**
* Returns a representation of the entire header string, including
* the header name and all values converted to the proper format.
*/
Defined in <ROOT>/system/HTTP/Header.php:186
protected pretend -> boolean false
protected protocolVersion -> string (3) "1.0"
protected reason -> string (2) "OK"
protected statusCode -> integer 200
⧉protected validProtocolVersions -> array (4)
0 => string (3) "1.0"
1 => string (3) "1.1"
2 => string (3) "2.0"
3 => string (3) "3.0"
⧉public __construct($config) Constructor
/**
* Constructor
*
* @param App $config
*
* @todo Recommend removing reliance on config injection
*/
Defined in <ROOT>/system/HTTP/Response.php:148
⧉public setStatusCode(int $code, string $reason = ''): $this Return an instance with the specified status code and, optionally, reason phr...
/**
* Return an instance with the specified status code and, optionally, reason phrase.
*
* If no reason phrase is specified, will default recommended reason phrase for
* the response's status code.
*
* @see http://tools.ietf.org/html/rfc7231#section-6
* @see http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
*
* @param int $code The 3-digit integer result code to set.
* @param string $reason The reason phrase to use with the
* provided status code; if none is provided, will
* default to the IANA name.
*
* @return $this
*
* @throws HTTPException For invalid status code arguments.
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:151
⧉public setDate(DateTime $date): $this Sets the date header
/**
* Sets the date header
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:179
⧉public setLink(CodeIgniter\Pager\PagerInterface $pager): $this Set the Link Header
/**
* Set the Link Header
*
* @see http://tools.ietf.org/html/rfc5988
*
* @return $this
*
* @todo Recommend moving to Pager
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:197
⧉public pretend(bool $pretend = true): $this Turns "pretend" mode on or off to aid in testing.
/**
* Turns "pretend" mode on or off to aid in testing.
*
* Note that this is not a part of the interface so
* should not be relied on outside of internal testing.
*
* @return $this
*
* @testTag only available to test code
*/
Defined in <ROOT>/system/HTTP/Response.php:199
⧉public getStatusCode(): int Gets the response status code.
/**
* Gets the response status code.
*
* The status code is a 3-digit integer result code of the server's attempt
* to understand and satisfy the request.
*
* @return int Status code.
*/
Defined in <ROOT>/system/HTTP/Response.php:214
⧉public setContentType(string $mime, string $charset = 'UTF-8'): $this Sets the Content Type header for this response with the mime type and, option...
/**
* Sets the Content Type header for this response with the mime type
* and, optionally, the charset.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:226
⧉public getReason(): string Gets the response response phrase associated with the status code.
/**
* Gets the response response phrase associated with the status code.
*
* @see http://tools.ietf.org/html/rfc7231#section-6
* @see http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
*
* @deprecated Use getReasonPhrase()
*
* @codeCoverageIgnore
*/
Defined in <ROOT>/system/HTTP/Response.php:233
⧉public setJSON($body, bool $unencoded = false): $this Converts the $body into JSON and sets the Content Type header.
/**
* Converts the $body into JSON and sets the Content Type header.
*
* @param array|string $body
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:246
⧉public getReasonPhrase(): string Reason phrase; must return an empty string if none present. Gets the response reason phrase associated with the status code.
/**
* Gets the response reason phrase associated with the status code.
*
* Because a reason phrase is not a required element in a response
* status line, the reason phrase value MAY be null. Implementations MAY
* choose to return the default RFC 7231 recommended reason phrase (or those
* listed in the IANA HTTP Status Code Registry) for the response's
* status code.
*
* @see http://tools.ietf.org/html/rfc7231#section-6
* @see http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
*
* @return string Reason phrase; must return an empty string if none present.
*/
Defined in <ROOT>/system/HTTP/Response.php:252
⧉public getJSON(): string|null Returns the current body, converted to JSON is it isn't already.
/**
* Returns the current body, converted to JSON is it isn't already.
*
* @return string|null
*
* @throws InvalidArgumentException If the body property is not array.
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:260
⧉public setXML($body): $this Converts $body into XML, and sets the correct Content-Type.
/**
* Converts $body into XML, and sets the correct Content-Type.
*
* @param array|string $body
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:278
⧉public getXML(): bool|string|null Retrieves the current body into XML and returns it.
/**
* Retrieves the current body into XML and returns it.
*
* @return bool|string|null
*
* @throws InvalidArgumentException If the body property is not array.
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:292
⧉public noCache(): $this Sets the appropriate headers to ensure this response is not cached by the bro...
/**
* Sets the appropriate headers to ensure this response
* is not cached by the browsers.
*
* @return $this
*
* @todo Recommend researching these directives, might need: 'private', 'no-transform', 'no-store', 'must-revalidate'
*
* @see DownloadResponse::noCache()
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:344
⧉public setCache(array $options = array()): $this A shortcut method that allows the developer to set all of the cache-control h...
/**
* A shortcut method that allows the developer to set all of the
* cache-control headers in one method call.
*
* The options array is used to provide the cache-control directives
* for the header. It might look something like:
*
* $options = [
* 'max-age' => 300,
* 's-maxage' => 900
* 'etag' => 'abcde',
* ];
*
* Typical options are:
* - etag
* - last-modified
* - max-age
* - s-maxage
* - private
* - public
* - must-revalidate
* - proxy-revalidate
* - no-transform
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:378
⧉public setLastModified($date): $this Sets the Last-Modified date header.
/**
* Sets the Last-Modified date header.
*
* $date can be either a string representation of the date or,
* preferably, an instance of DateTime.
*
* @param DateTime|string $date
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:415
⧉public send(): $this Sends the output to the browser.
/**
* Sends the output to the browser.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:436
⧉public sendHeaders(): $this Sends the headers of this HTTP response to the browser.
/**
* Sends the headers of this HTTP response to the browser.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:458
⧉public sendBody(): $this Sends the Body of the message to the browser.
/**
* Sends the Body of the message to the browser.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:487
⧉public redirect(string $uri, string $method = 'auto', ?int $code = null): $this Perform a redirect to a new URL, in two flavors: header or location.
/**
* Perform a redirect to a new URL, in two flavors: header or location.
*
* @param string $uri The URI to redirect to
* @param int|null $code The type of redirection, defaults to 302
*
* @return $this
*
* @throws HTTPException For invalid status code.
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:504
/**
* Set a cookie
*
* Accepts an arbitrary number of binds (up to 7) or an associative
* array in the first parameter containing all the values.
*
* @param array|Cookie|string $name Cookie name / array containing binds / Cookie object
* @param string $value Cookie value
* @param string $expire Cookie expiration time in seconds
* @param string $domain Cookie domain (e.g.: '.yourdomain.com')
* @param string $path Cookie path (default: '/')
* @param string $prefix Cookie name prefix ('': the default prefix)
* @param bool|null $secure Whether to only transfer cookies via SSL
* @param bool|null $httponly Whether only make the cookie accessible via HTTP (no javascript)
* @param string|null $samesite
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:567
⧉public getCookieStore(): CookieStore Returns the `CookieStore` instance.
/**
* Returns the `CookieStore` instance.
*
* @return CookieStore
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:626
⧉public hasCookie(string $name, ?string $value = null, string $prefix = ''): bool Checks to see if the Response has a specified cookie or not.
/**
* Checks to see if the Response has a specified cookie or not.
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:634
/**
* Returns the cookie
*
* @param string $prefix Cookie prefix.
* '': the default prefix
*
* @return Cookie|Cookie[]|null
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:649
⧉public deleteCookie(string $name = '', string $domain = '', string $path = '/', string $prefix = ''): $this Sets a cookie to be deleted when the response is sent.
/**
* Sets a cookie to be deleted when the response is sent.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:671
⧉public getCookies(): Cookie[] Returns all cookies currently set.
/**
* Returns all cookies currently set.
*
* @return Cookie[]
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:714
⧉public download(string $filename = '', $data = '', bool $setMime = false): DownloadResponse|null Force a download.
/**
* Force a download.
*
* Generates the headers that force a download to happen. And
* sends the file to the browser.
*
* @param string $filename The name you want the downloaded file to be named
* or the path to the file to send
* @param string|null $data The data to be downloaded. Set null if the $filename is the file path
* @param bool $setMime Whether to try and send the actual MIME type
*
* @return DownloadResponse|null
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:788
Defined in <ROOT>/system/HTTP/ResponseTrait.php:812
⧉public getBody(): string|null Returns the Message's body.
/**
* Returns the Message's body.
*
* @return string|null
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/Message.php:52
⧉public setBody($data): self Sets the body of the current message.
/**
* Sets the body of the current message.
*
* @param string $data
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:52
⧉public appendBody($data): self Appends data to the body of the current message.
/**
* Appends data to the body of the current message.
*
* @param mixed $data
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:66
⧉public getHeaders(): array Returns an array containing all headers.
/**
* Returns an array containing all headers.
*
* @return array<string, Header> An array of the request headers
*
* @deprecated Use Message::headers() to make room for PSR-7
*
* @TODO Incompatible return value with PSR-7
*
* @codeCoverageIgnore
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/Message.php:68
⧉public populateHeaders(): void Populates the $headers array with any headers the server knows about.
/**
* Populates the $headers array with any headers the server knows about.
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:80
⧉public getHeader(string $name): array|Header|null Returns a single header object. If multiple headers with the same name exist,...
/**
* Returns a single header object. If multiple headers with the same
* name exist, then will return an array of header objects.
*
* @return array|Header|null
*
* @deprecated Use Message::header() to make room for PSR-7
*
* @TODO Incompatible return value with PSR-7
*
* @codeCoverageIgnore
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/Message.php:85
⧉public hasHeader(string $name): bool Determines whether a header exists.
/**
* Determines whether a header exists.
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/Message.php:93
⧉public headers(): array Returns an array containing all Headers.
/**
* Returns an array containing all Headers.
*
* @return array<string, Header> An array of the Header objects
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:107
⧉public getHeaderLine(string $name): string Retrieves a comma-separated string of the values for a single header.
/**
* Retrieves a comma-separated string of the values for a single header.
*
* This method returns all of the header values of the given
* case-insensitive header name as a string concatenated together using
* a comma.
*
* NOTE: Not all header values may be appropriately represented using
* comma concatenation. For such headers, use getHeader() instead
* and supply your own delimiter when concatenating.
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/Message.php:111
⧉public getProtocolVersion(): string Returns the HTTP Protocol Version.
/**
* Returns the HTTP Protocol Version.
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/Message.php:125
⧉public header($name): array|Header|null Returns a single Header object. If multiple headers with the same name exist,...
/**
* Returns a single Header object. If multiple headers with the same
* name exist, then will return an array of header objects.
*
* @param string $name
*
* @return array|Header|null
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:127
⧉public setHeader(string $name, $value): self Sets a header and it's value.
/**
* Sets a header and it's value.
*
* @param array|string|null $value
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:141
⧉public removeHeader(string $name): self Removes a header from the list of headers we track.
/**
* Removes a header from the list of headers we track.
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:166
⧉public appendHeader(string $name, ?string $value): self Adds an additional header value to any headers that accept multiple values (i...
/**
* Adds an additional header value to any headers that accept
* multiple values (i.e. are an array or implement ArrayAccess)
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:180
⧉public prependHeader(string $name, string $value): self Adds an additional header value to any headers that accept multiple values (i...
/**
* Adds an additional header value to any headers that accept
* multiple values (i.e. are an array or implement ArrayAccess)
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:197
⧉public setProtocolVersion(string $version): self Sets the HTTP protocol version.
/**
* Sets the HTTP protocol version.
*
* @return $this
*
* @throws HTTPException For invalid protocols
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:222
⧉protected formatBody($body, string $format): mixed Handles conversion of the data into the appropriate format, and sets the corr...
/**
* Handles conversion of the data into the appropriate format,
* and sets the correct Content-Type header for our response.
*
* @param array|string $body
* @param string $format Valid: json, xml
*
* @return mixed
*
* @throws InvalidArgumentException If the body property is not string or array.
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:314
⧉protected sendCookies() Actually sets the cookies.
/**
* Actually sets the cookies.
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:722
⧉protected getHeaderName(string $name): string Takes a header name in any case, and returns the normal-case version of the h...
/**
* Takes a header name in any case, and returns the
* normal-case version of the header.
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:210
⧉private dispatchCookies(): void
Defined in <ROOT>/system/HTTP/ResponseTrait.php:731
⧉private doSetRawCookie(string $name, string $value, array $options): void Extracted call to `setrawcookie()` in order to run unit tests on it.
/**
* Extracted call to `setrawcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:760
⧉private doSetCookie(string $name, string $value, array $options): void Extracted call to `setcookie()` in order to run unit tests on it.
/**
* Extracted call to `setcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:770
⧉final public __construct(string $name, string $value = '', array $options = array()) Construct a new Cookie instance.
/**
* Construct a new Cookie instance.
*
* @param string $name The cookie's name
* @param string $value The cookie's value
* @param array<string, bool|int|string> $options The cookie's options
*
* @throws CookieException
*/
Defined in <ROOT>/system/Cookie/Cookie.php:204
⧉public getId(): string {@inheritDoc}
/**
* {@inheritDoc}
*/
Defined in <ROOT>/system/Cookie/Cookie.php:251
⧉public getPrefix(): string {@inheritDoc}
/**
* {@inheritDoc}
*/
Defined in <ROOT>/system/Cookie/Cookie.php:259
⧉public getName(): string {@inheritDoc}
/**
* {@inheritDoc}
*/
Defined in <ROOT>/system/Cookie/Cookie.php:267
⧉public getPrefixedName(): string {@inheritDoc}
/**
* {@inheritDoc}
*/
Defined in <ROOT>/system/Cookie/Cookie.php:275
⧉public getValue(): string {@inheritDoc}
/**
* {@inheritDoc}
*/
Defined in <ROOT>/system/Cookie/Cookie.php:294
⧉public getExpiresTimestamp(): int {@inheritDoc}
/**
* {@inheritDoc}
*/
Defined in <ROOT>/system/Cookie/Cookie.php:302
⧉public getExpiresString(): string {@inheritDoc}
/**
* {@inheritDoc}
*/
Defined in <ROOT>/system/Cookie/Cookie.php:310
⧉public isExpired(): bool {@inheritDoc}
/**
* {@inheritDoc}
*/
Defined in <ROOT>/system/Cookie/Cookie.php:318
⧉public getMaxAge(): int {@inheritDoc}
/**
* {@inheritDoc}
*/
Defined in <ROOT>/system/Cookie/Cookie.php:326
⧉public getPath(): string {@inheritDoc}
/**
* {@inheritDoc}
*/
Defined in <ROOT>/system/Cookie/Cookie.php:336
⧉public getDomain(): string {@inheritDoc}
/**
* {@inheritDoc}
*/
Defined in <ROOT>/system/Cookie/Cookie.php:344
⧉public isSecure(): bool {@inheritDoc}
/**
* {@inheritDoc}
*/
Defined in <ROOT>/system/Cookie/Cookie.php:352
⧉public isHTTPOnly(): bool {@inheritDoc}
/**
* {@inheritDoc}
*/
Defined in <ROOT>/system/Cookie/Cookie.php:360
⧉public getSameSite(): string {@inheritDoc}
/**
* {@inheritDoc}
*/
Defined in <ROOT>/system/Cookie/Cookie.php:368
⧉public isRaw(): bool {@inheritDoc}
/**
* {@inheritDoc}
*/
Defined in <ROOT>/system/Cookie/Cookie.php:376
⧉public getOptions(): array {@inheritDoc}
/**
* {@inheritDoc}
*/
Defined in <ROOT>/system/Cookie/Cookie.php:384
/**
* {@inheritDoc}
*/
Defined in <ROOT>/system/Cookie/Cookie.php:537
⧉public withRaw(bool $raw = true) {@inheritDoc}
/**
* {@inheritDoc}
*/
Defined in <ROOT>/system/Cookie/Cookie.php:551
⧉public offsetExists($offset): bool Whether an offset exists.
/**
* Whether an offset exists.
*
* @param string $offset
*/
Defined in <ROOT>/system/Cookie/Cookie.php:571
⧉public offsetGet($offset): bool|int|string Offset to retrieve.
/**
* Offset to retrieve.
*
* @param string $offset
*
* @return bool|int|string
*
* @throws InvalidArgumentException
*/
Defined in <ROOT>/system/Cookie/Cookie.php:586
⧉public offsetSet($offset, $value): void Offset to set.
/**
* Offset to set.
*
* @param string $offset
* @param bool|int|string $value
*
* @throws LogicException
*/
Defined in <ROOT>/system/Cookie/Cookie.php:603
⧉public offsetUnset($offset): void Offset to unset.
/**
* Offset to unset.
*
* @param string $offset
*
* @throws LogicException
*/
Defined in <ROOT>/system/Cookie/Cookie.php:615
⧉public toHeaderString(): string {@inheritDoc}
/**
* {@inheritDoc}
*/
Defined in <ROOT>/system/Cookie/Cookie.php:627
⧉public __toString(): string {@inheritDoc}
/**
* {@inheritDoc}
*/
Defined in <ROOT>/system/Cookie/Cookie.php:635
⧉public toArray(): array {@inheritDoc}
/**
* {@inheritDoc}
*/
Defined in <ROOT>/system/Cookie/Cookie.php:686
⧉protected validateName(string $name, bool $raw): void Validates the cookie name per RFC 2616.
/**
* Validates the cookie name per RFC 2616.
*
* If `$raw` is true, names should not contain invalid characters
* as `setrawcookie()` will reject this.
*
* @throws CookieException
*/
Defined in <ROOT>/system/Cookie/Cookie.php:734
⧉protected validatePrefix(string $prefix, bool $secure, string $path, string $domain): void Validates the special prefixes if some attribute requirements are met.
/**
* Validates the special prefixes if some attribute requirements are met.
*
* @throws CookieException
*/
Defined in <ROOT>/system/Cookie/Cookie.php:750
⧉protected validateSameSite(string $samesite, bool $secure): void Validates the `SameSite` to be within the allowed types.
/**
* Validates the `SameSite` to be within the allowed types.
*
* @throws CookieException
*
* @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite
*/
Defined in <ROOT>/system/Cookie/Cookie.php:768
⇄⧉public static setDefaults($config = array()): array<string, mixed> The old defaults array. Useful for resetting. Set the default attributes to a Cookie instance by injecting the values from ...
/**
* Set the default attributes to a Cookie instance by injecting
* the values from the `CookieConfig` config or an array.
*
* This method is called from Response::__construct().
*
* @param array<string, bool|int|string>|CookieConfig $config
*
* @return array<string, mixed> The old defaults array. Useful for resetting.
*/
Defined in <ROOT>/system/Cookie/Cookie.php:131
⇄⧉public static fromHeaderString(string $cookie, bool $raw = false): static Create a new Cookie instance from a `Set-Cookie` header.
/**
* Create a new Cookie instance from a `Set-Cookie` header.
*
* @return static
*
* @throws CookieException
*/
Defined in <ROOT>/system/Cookie/Cookie.php:169
⧉protected static convertExpiresTimestamp($expires0): int Converts expires time to Unix format.
/**
* Converts expires time to Unix format.
*
* @param DateTimeInterface|int|string $expires
*/
Defined in <ROOT>/system/Cookie/Cookie.php:701
/**
* Constructor
*/
Defined in <ROOT>/system/Log/Handlers/FileHandler.php:46
⧉public handle($level, $message): bool Handles logging the message. If the handler returns false, then execution of ...
/**
* Handles logging the message.
* If the handler returns false, then execution of handlers
* will stop. Any handlers that have not run, yet, will not
* be run.
*
* @param string $level
* @param string $message
*
* @throws Exception
*/
Defined in <ROOT>/system/Log/Handlers/FileHandler.php:69
⧉public canHandle(string $level): bool Checks whether the Handler will handle logging items of this log Level.
/**
* Checks whether the Handler will handle logging items of this
* log Level.
*/
Inherited from CodeIgniter\Log\Handlers\BaseHandler
Defined in <ROOT>/system/Log/Handlers/BaseHandler.php:45
⧉public setDateFormat(string $format): CodeIgniter\Log\Handlers\HandlerInterface Stores the date format to use while logging messages.
/**
* Stores the date format to use while logging messages.
*/
Inherited from CodeIgniter\Log\Handlers\BaseHandler
Defined in <ROOT>/system/Log/Handlers/BaseHandler.php:53
/**
* Constructor.
*
* @param \Config\Logger $config
*
* @throws RuntimeException
*/
Defined in <ROOT>/system/Log/Logger.php:120
⧉public emergency($message, array $context = array()): bool System is unusable.
/**
* System is unusable.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:158
⧉public alert($message, array $context = array()): bool Action must be taken immediately.
/**
* Action must be taken immediately.
*
* Example: Entire website down, database unavailable, etc. This should
* trigger the SMS alerts and wake you up.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:171
⧉public error($message, array $context = array()): bool Runtime errors that do not require immediate action but should typically be l...
/**
* Runtime errors that do not require immediate action but should typically
* be logged and monitored.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:194
⧉public warning($message, array $context = array()): bool Exceptional occurrences that are not errors.
/**
* Exceptional occurrences that are not errors.
*
* Example: Use of deprecated APIs, poor use of an API, undesirable things
* that are not necessarily wrong.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:207
⧉public notice($message, array $context = array()): bool Normal but significant events.
/**
* Normal but significant events.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:217
/**
* Detailed debug information.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:239
⧉public log($level, $message, array $context = array()): bool Logs with an arbitrary level.
/**
* Logs with an arbitrary level.
*
* @param string $level
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:250
⧉public determineFile(): array Determines the file and line that the logging call was made from by analyzing...
/**
* Determines the file and line that the logging call
* was made from by analyzing the backtrace.
* Find the earliest stack frame that is part of our logging system.
*/
Defined in <ROOT>/system/Log/Logger.php:372
⧉protected interpolate($message, array $context = array()): string Replaces any placeholders in the message with variables from the context, as ...
/**
* Replaces any placeholders in the message with variables
* from the context, as well as a few special items like:
*
* {session_vars}
* {post_vars}
* {get_vars}
* {env}
* {env:foo}
* {file}
* {line}
*
* @param string $message
*
* @return string
*/
Defined in <ROOT>/system/Log/Logger.php:316
⧉protected cleanFileNames(string $file): string Cleans the paths of filenames by replacing APPPATH, SYSTEMPATH, FCPATH with t...
/**
* Cleans the paths of filenames by replacing APPPATH, SYSTEMPATH, FCPATH
* with the actual var. i.e.
*
* /var/www/site/app/Controllers/Home.php
* becomes:
* APPPATH/Controllers/Home.php
*
* @deprecated Use dedicated `clean_path()` function.
*/
Defined in <ROOT>/system/Log/Logger.php:422
Defined in <ROOT>/system/Session/Handlers/FileHandler.php:66
⧉public open($path, $name): bool Re-initialize existing session, or creates a new one.
/**
* Re-initialize existing session, or creates a new one.
*
* @param string $path The path where to store/retrieve the session
* @param string $name The session name
*
* @throws SessionException
*/
Defined in <ROOT>/system/Session/Handlers/FileHandler.php:94
⧉public read($id): false|string Returns an encoded string of the read data. Reads the session data from the session storage, and returns the results.
/**
* Reads the session data from the session storage, and returns the results.
*
* @param string $id The session ID
*
* @return false|string Returns an encoded string of the read data.
* If nothing was read, it must return false.
*/
Defined in <ROOT>/system/Session/Handlers/FileHandler.php:121
⧉public write($id, $data): bool Writes the session data to the session storage.
/**
* Writes the session data to the session storage.
*
* @param string $id The session ID
* @param string $data The encoded session data
*/
Defined in <ROOT>/system/Session/Handlers/FileHandler.php:179
⧉public close(): bool Closes the current session.
/**
* Closes the current session.
*/
Defined in <ROOT>/system/Session/Handlers/FileHandler.php:224
⧉public destroy($id): bool Destroys a session
/**
* Destroys a session
*
* @param string $id The session ID being destroyed
*/
Defined in <ROOT>/system/Session/Handlers/FileHandler.php:242
⧉public gc($max_lifetime): false|int Returns the number of deleted sessions on success, or false on failure. Cleans up expired sessions.
/**
* Cleans up expired sessions.
*
* @param int $max_lifetime Sessions that have not updated
* for the last max_lifetime seconds will be removed.
*
* @return false|int Returns the number of deleted sessions on success, or false on failure.
*/
Defined in <ROOT>/system/Session/Handlers/FileHandler.php:270
⧉public setLogger(Psr\Log\LoggerInterface $logger) Sets a logger.
/**
* Sets a logger.
*
* @param LoggerInterface $logger
*/
Inherited from CodeIgniter\Session\Handlers\BaseHandler
Defined in <ROOT>/system/ThirdParty/PSR/Log/LoggerAwareTrait.php:22
⧉protected configureSessionIDRegex() Configure Session ID regular expression
/**
* Configure Session ID regular expression
*/
Defined in <ROOT>/system/Session/Handlers/FileHandler.php:311
⧉protected destroyCookie(): bool Internal method to force removal of a cookie by the client when session_destr...
/**
* Internal method to force removal of a cookie by the client
* when session_destroy() is called.
*/
Inherited from CodeIgniter\Session\Handlers\BaseHandler
Defined in <ROOT>/system/Session/Handlers/BaseHandler.php:149
⧉protected lockSession(string $sessionID): bool A dummy method allowing drivers with no locking functionality (databases othe...
/**
* A dummy method allowing drivers with no locking functionality
* (databases other than PostgreSQL and MySQL) to act as if they
* do acquire a lock.
*/
Inherited from CodeIgniter\Session\Handlers\BaseHandler
Defined in <ROOT>/system/Session/Handlers/BaseHandler.php:163
⧉protected releaseLock(): bool Releases the lock, if any.
/**
* Releases the lock, if any.
*/
Inherited from CodeIgniter\Session\Handlers\BaseHandler
Defined in <ROOT>/system/Session/Handlers/BaseHandler.php:173
⧉protected fail(): bool Drivers other than the 'files' one don't (need to) use the session.save_path ...
/**
* Drivers other than the 'files' one don't (need to) use the
* session.save_path INI setting, but that leads to confusing
* error messages emitted by PHP when open() or write() fail,
* as the message contains session.save_path ...
*
* To work around the problem, the drivers will call this method
* so that the INI is set just in time for the error message to
* be properly generated.
*/
Inherited from CodeIgniter\Session\Handlers\BaseHandler
Defined in <ROOT>/system/Session/Handlers/BaseHandler.php:190
/**
* Constructor
*/
Defined in <ROOT>/system/Log/Handlers/FileHandler.php:46
⧉public handle($level, $message): bool Handles logging the message. If the handler returns false, then execution of ...
/**
* Handles logging the message.
* If the handler returns false, then execution of handlers
* will stop. Any handlers that have not run, yet, will not
* be run.
*
* @param string $level
* @param string $message
*
* @throws Exception
*/
Defined in <ROOT>/system/Log/Handlers/FileHandler.php:69
⧉public canHandle(string $level): bool Checks whether the Handler will handle logging items of this log Level.
/**
* Checks whether the Handler will handle logging items of this
* log Level.
*/
Inherited from CodeIgniter\Log\Handlers\BaseHandler
Defined in <ROOT>/system/Log/Handlers/BaseHandler.php:45
⧉public setDateFormat(string $format): CodeIgniter\Log\Handlers\HandlerInterface Stores the date format to use while logging messages.
/**
* Stores the date format to use while logging messages.
*/
Inherited from CodeIgniter\Log\Handlers\BaseHandler
Defined in <ROOT>/system/Log/Handlers/BaseHandler.php:53
/**
* Constructor.
*
* @param \Config\Logger $config
*
* @throws RuntimeException
*/
Defined in <ROOT>/system/Log/Logger.php:120
⧉public emergency($message, array $context = array()): bool System is unusable.
/**
* System is unusable.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:158
⧉public alert($message, array $context = array()): bool Action must be taken immediately.
/**
* Action must be taken immediately.
*
* Example: Entire website down, database unavailable, etc. This should
* trigger the SMS alerts and wake you up.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:171
⧉public error($message, array $context = array()): bool Runtime errors that do not require immediate action but should typically be l...
/**
* Runtime errors that do not require immediate action but should typically
* be logged and monitored.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:194
⧉public warning($message, array $context = array()): bool Exceptional occurrences that are not errors.
/**
* Exceptional occurrences that are not errors.
*
* Example: Use of deprecated APIs, poor use of an API, undesirable things
* that are not necessarily wrong.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:207
⧉public notice($message, array $context = array()): bool Normal but significant events.
/**
* Normal but significant events.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:217
/**
* Detailed debug information.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:239
⧉public log($level, $message, array $context = array()): bool Logs with an arbitrary level.
/**
* Logs with an arbitrary level.
*
* @param string $level
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:250
⧉public determineFile(): array Determines the file and line that the logging call was made from by analyzing...
/**
* Determines the file and line that the logging call
* was made from by analyzing the backtrace.
* Find the earliest stack frame that is part of our logging system.
*/
Defined in <ROOT>/system/Log/Logger.php:372
⧉protected interpolate($message, array $context = array()): string Replaces any placeholders in the message with variables from the context, as ...
/**
* Replaces any placeholders in the message with variables
* from the context, as well as a few special items like:
*
* {session_vars}
* {post_vars}
* {get_vars}
* {env}
* {env:foo}
* {file}
* {line}
*
* @param string $message
*
* @return string
*/
Defined in <ROOT>/system/Log/Logger.php:316
⧉protected cleanFileNames(string $file): string Cleans the paths of filenames by replacing APPPATH, SYSTEMPATH, FCPATH with t...
/**
* Cleans the paths of filenames by replacing APPPATH, SYSTEMPATH, FCPATH
* with the actual var. i.e.
*
* /var/www/site/app/Controllers/Home.php
* becomes:
* APPPATH/Controllers/Home.php
*
* @deprecated Use dedicated `clean_path()` function.
*/
Defined in <ROOT>/system/Log/Logger.php:422
/**
* Constructor.
*
* Extract configuration settings and save them here.
*/
Defined in <ROOT>/system/Session/Session.php:164
⧉public start(): $this|void Initialize the session container and starts up the session.
/**
* Initialize the session container and starts up the session.
*
* @return $this|void
*/
Defined in <ROOT>/system/Session/Session.php:218
⧉public stop() Does a full stop of the session:
/**
* Does a full stop of the session:
*
* - destroys the session
* - unsets the session id
* - destroys the session cookie
*/
Defined in <ROOT>/system/Session/Session.php:281
⧉public regenerate(bool $destroy = false) Regenerates the session ID.
/**
* Regenerates the session ID.
*
* @param bool $destroy Should old session data be destroyed?
*/
Defined in <ROOT>/system/Session/Session.php:420
⧉public destroy() Destroys the current session.
/**
* Destroys the current session.
*/
Defined in <ROOT>/system/Session/Session.php:451
⧉public set($data, $value = null) Sets user data into the session.
/**
* Sets user data into the session.
*
* If $data is a string, then it is interpreted as a session property
* key, and $value is expected to be non-null.
*
* If $data is an array, it is expected to be an array of key/value pairs
* to be set as session properties.
*
* @param array|string $data Property name or associative array of properties
* @param array|bool|float|int|object|string|null $value Property value if single key provided
*/
Defined in <ROOT>/system/Session/Session.php:472
⧉public get(?string $key = null): array|bool|float|int|object|string|null The property value(s) Get user data that has been set in the session.
/**
* Get user data that has been set in the session.
*
* If the property exists as "normal", returns it.
* Otherwise, returns an array of any temp or flash data values with the
* property key.
*
* Replaces the legacy method $session->userdata();
*
* @param string|null $key Identifier of the session property to retrieve
*
* @return array|bool|float|int|object|string|null The property value(s)
*/
Defined in <ROOT>/system/Session/Session.php:502
⧉public has(string $key): bool Returns whether an index exists in the session array.
/**
* Returns whether an index exists in the session array.
*
* @param string $key Identifier of the session property we are interested in.
*/
Defined in <ROOT>/system/Session/Session.php:535
⧉public push(string $key, array $data) Push new value onto session value that is array.
/**
* Push new value onto session value that is array.
*
* @param string $key Identifier of the session property we are interested in.
* @param array $data value to be pushed to existing session key.
*/
Defined in <ROOT>/system/Session/Session.php:546
⧉public remove($key) Remove one or more session properties.
/**
* Remove one or more session properties.
*
* If $key is an array, it is interpreted as an array of string property
* identifiers to remove. Otherwise, it is interpreted as the identifier
* of a specific session property to remove.
*
* @param array|string $key Identifier of the session property or properties to remove.
*/
Defined in <ROOT>/system/Session/Session.php:562
⧉public __set(string $key, $value) Magic method to set variables in the session by simply calling $session->foo ...
/**
* Magic method to set variables in the session by simply calling
* $session->foo = bar;
*
* @param string $key Identifier of the session property to set.
* @param array|string $value
*/
Defined in <ROOT>/system/Session/Session.php:582
⧉public __get(string $key): string|null Magic method to get session variables by simply calling $foo = $session->foo;
/**
* Magic method to get session variables by simply calling
* $foo = $session->foo;
*
* @param string $key Identifier of the session property to remove.
*
* @return string|null
*/
Defined in <ROOT>/system/Session/Session.php:595
⧉public __isset(string $key): bool Magic method to check for session variables. Different from has() in that it ...
/**
* Magic method to check for session variables.
* Different from has() in that it will validate 'session_id' as well.
* Mostly used by internal PHP functions, users should stick to has()
*
* @param string $key Identifier of the session property to remove.
*/
Defined in <ROOT>/system/Session/Session.php:617
⧉public setFlashdata($data, $value = null) Sets data into the session that will only last for a single request. Perfect ...
/**
* Sets data into the session that will only last for a single request.
* Perfect for use with single-use status update messages.
*
* If $data is an array, it is interpreted as an associative array of
* key/value pairs for flashdata properties.
* Otherwise, it is interpreted as the identifier of a specific
* flashdata property, with $value containing the property value.
*
* @param array|string $data Property identifier or associative array of properties
* @param array|bool|float|int|object|string|null $value Property value if $data is a scalar
*/
Defined in <ROOT>/system/Session/Session.php:634
⧉public getFlashdata(?string $key = null): array|null The requested property value, or an associative array of them Retrieve one or more items of flash data from the session.
/**
* Retrieve one or more items of flash data from the session.
*
* If the item key is null, return all flashdata.
*
* @param string $key Property identifier
*
* @return array|null The requested property value, or an associative array of them
*/
Defined in <ROOT>/system/Session/Session.php:649
⧉public keepFlashdata($key) Keeps a single piece of flash data alive for one more request.
/**
* Keeps a single piece of flash data alive for one more request.
*
* @param array|string $key Property identifier or array of them
*/
Defined in <ROOT>/system/Session/Session.php:674
⧉public markAsFlashdata($key): bool Mark a session property or properties as flashdata.
/**
* Mark a session property or properties as flashdata.
*
* @param array|string $key Property identifier or array of them
*
* @return bool False if any of the properties are not already set
*/
Defined in <ROOT>/system/Session/Session.php:686
⧉public unmarkFlashdata($key) Unmark data in the session as flashdata.
/**
* Unmark data in the session as flashdata.
*
* @param array|string $key Property identifier or array of them
*/
Defined in <ROOT>/system/Session/Session.php:716
⧉public getFlashKeys(): array Retrieve all of the keys for session data marked as flashdata.
/**
* Retrieve all of the keys for session data marked as flashdata.
*
* @return array The property names of all flashdata
*/
Defined in <ROOT>/system/Session/Session.php:742
⧉public setTempdata($data, $value = null, int $ttl = 300) Sets new data into the session, and marks it as temporary data with a set lif...
/**
* Sets new data into the session, and marks it as temporary data
* with a set lifespan.
*
* @param array|string $data Session data key or associative array of items
* @param array|bool|float|int|object|string|null $value Value to store
* @param int $ttl Time-to-live in seconds
*/
Defined in <ROOT>/system/Session/Session.php:767
⧉public getTempdata(?string $key = null): array|bool|float|int|object|string|null Session data value or null if not found. Returns either a single piece of tempdata, or all temp data currently in the ...
/**
* Returns either a single piece of tempdata, or all temp data currently
* in the session.
*
* @param string $key Session data key
*
* @return array|bool|float|int|object|string|null Session data value or null if not found.
*/
Defined in <ROOT>/system/Session/Session.php:781
⧉public removeTempdata(string $key) Removes a single piece of temporary data from the session.
/**
* Removes a single piece of temporary data from the session.
*
* @param string $key Session data key
*/
Defined in <ROOT>/system/Session/Session.php:806
⧉public markAsTempdata($key, int $ttl = 300): bool Mark one of more pieces of data as being temporary, meaning that it has a set...
/**
* Mark one of more pieces of data as being temporary, meaning that
* it has a set lifespan within the session.
*
* @param array|string $key Property identifier or array of them
* @param int $ttl Time to live, in seconds
*
* @return bool False if any of the properties were not set
*/
Defined in <ROOT>/system/Session/Session.php:821
⧉public unmarkTempdata($key) Unmarks temporary data in the session, effectively removing its lifespan and ...
/**
* Unmarks temporary data in the session, effectively removing its
* lifespan and allowing it to live as long as the session does.
*
* @param array|string $key Property identifier or array of them
*/
Defined in <ROOT>/system/Session/Session.php:866
⧉public getTempKeys(): array Retrieve the keys of all session data that have been marked as temporary data.
/**
* Retrieve the keys of all session data that have been marked as temporary data.
*/
Defined in <ROOT>/system/Session/Session.php:890
⧉protected configure() Configuration.
/**
* Configuration.
*
* Handle input binds and configuration defaults.
*/
Defined in <ROOT>/system/Session/Session.php:297
⧉protected configureSidLength() Configure session ID length
/**
* Configure session ID length
*
* To make life easier, we used to force SHA-1 and 4 bits per
* character on everyone. And of course, someone was unhappy.
*
* Then PHP 7.1 broke backwards-compatibility because ext/session
* is such a mess that nobody wants to touch it with a pole stick,
* and the one guy who does, nobody has the energy to argue with.
*
* So we were forced to make changes, and OF COURSE something was
* going to break and now we have this pile of shit. -- Narf
*/
Defined in <ROOT>/system/Session/Session.php:351
⧉protected initVars() Handle temporary variables
/**
* Handle temporary variables
*
* Clears old "flash" data, marks the new one for deletion and handles
* "temp" data deletion.
*/
Defined in <ROOT>/system/Session/Session.php:392
⧉protected setSaveHandler() Sets the driver as the session handler in PHP. Extracted for easier testing.
/**
* Sets the driver as the session handler in PHP.
* Extracted for easier testing.
*/
Defined in <ROOT>/system/Session/Session.php:911
⧉protected startSession() Starts the session. Extracted for testing reasons.
/**
* Starts the session.
* Extracted for testing reasons.
*/
Defined in <ROOT>/system/Session/Session.php:920
⧉protected setCookie() Takes care of setting the cookie on the client side.
/**
* Takes care of setting the cookie on the client side.
*
* @codeCoverageIgnore
*/
Defined in <ROOT>/system/Session/Session.php:936
⧉private removeOldSessionCookie(): void
Defined in <ROOT>/system/Session/Session.php:428
protected validator -> null
protected vendorId -> string (0) ""
⇄⧉public __construct()
new \App\Controllers\Frontend()
Defined in <ROOT>/app/Controllers/Frontend.php:12
⇄⧉public index()
$value->index()
Defined in <ROOT>/app/Controllers/Frontend.php:22
⇄⧉public index_new($id)
$value->index_new($id)
Defined in <ROOT>/app/Controllers/Frontend.php:29
⇄⧉public entersiteag()
$value->entersiteag()
Defined in <ROOT>/app/Controllers/Frontend.php:69
⇄⧉public ziele()
$value->ziele()
Defined in <ROOT>/app/Controllers/Frontend.php:76
⇄⧉public vorges()
$value->vorges()
Defined in <ROOT>/app/Controllers/Frontend.php:83
⇄⧉public unter()
$value->unter()
Defined in <ROOT>/app/Controllers/Frontend.php:90
⇄⧉public abtei()
$value->abtei()
Defined in <ROOT>/app/Controllers/Frontend.php:98
⇄⧉public demo()
$value->demo()
Defined in <ROOT>/app/Controllers/Frontend.php:108
⇄⧉public daten()
$value->daten()
Defined in <ROOT>/app/Controllers/Frontend.php:116
⇄⧉public story()
$value->story()
Defined in <ROOT>/app/Controllers/Frontend.php:125
⇄⧉public portfolio()
$value->portfolio()
Defined in <ROOT>/app/Controllers/Frontend.php:134
⇄⧉public uberbetrieblichemain()
$value->uberbetrieblichemain()
Defined in <ROOT>/app/Controllers/Frontend.php:145
⇄⧉public uberbetrieblicheuk()
$value->uberbetrieblicheuk()
Defined in <ROOT>/app/Controllers/Frontend.php:153
⇄⧉public beruflicheschule()
$value->beruflicheschule()
Defined in <ROOT>/app/Controllers/Frontend.php:164
⇄⧉public beruflicheschulebws()
$value->beruflicheschulebws()
Defined in <ROOT>/app/Controllers/Frontend.php:170
⇄⧉public zusatzlichematerialien()
$value->zusatzlichematerialien()
Defined in <ROOT>/app/Controllers/Frontend.php:178
⇄⧉public ausbildungsbetrieb()
$value->ausbildungsbetrieb()
Defined in <ROOT>/app/Controllers/Frontend.php:187
⇄⧉public zusatzlichesmaterial()
$value->zusatzlichesmaterial()
Defined in <ROOT>/app/Controllers/Frontend.php:198
⇄⧉public zusatzmaterialberufsschule()
$value->zusatzmaterialberufsschule()
Defined in <ROOT>/app/Controllers/Frontend.php:207
⇄⧉public qualifikationsverfahren()
$value->qualifikationsverfahren()
Defined in <ROOT>/app/Controllers/Frontend.php:217
⇄⧉public ausbildungsbetriebe()
$value->ausbildungsbetriebe()
Defined in <ROOT>/app/Controllers/Frontend.php:226
⇄⧉public podcast()
$value->podcast()
Defined in <ROOT>/app/Controllers/Frontend.php:234
⇄⧉public ausbildungsordnung()
$value->ausbildungsordnung()
Defined in <ROOT>/app/Controllers/Frontend.php:242
⇄⧉public lernzielkontrollen()
$value->lernzielkontrollen()
Defined in <ROOT>/app/Controllers/Frontend.php:250
⇄⧉public lernzielkontrollen_result($id)
$value->lernzielkontrollen_result($id)
Defined in <ROOT>/app/Controllers/Frontend.php:261
⇄⧉public lernziel_detail($id)
$value->lernziel_detail($id)
Defined in <ROOT>/app/Controllers/Frontend.php:278
⇄⧉public lernzielkontrollen_detail($id)
$value->lernzielkontrollen_detail($id)
Defined in <ROOT>/app/Controllers/Frontend.php:285
⇄⧉public lernzielkontrollen_test($id)
$value->lernzielkontrollen_test($id)
Defined in <ROOT>/app/Controllers/Frontend.php:293
⇄⧉public get_sub($id)
$value->get_sub($id)
Defined in <ROOT>/app/Controllers/Frontend.php:305
⇄⧉public get_child($id)
$value->get_child($id)
Defined in <ROOT>/app/Controllers/Frontend.php:313
/**
* Constructor.
*
* @throws HTTPException
*/
Inherited from CodeIgniter\Controller
Defined in <ROOT>/system/Controller.php:74
⧉protected forceHTTPS(int $duration = 31536000) A convenience method to use when you need to ensure that a single method is r...
/**
* A convenience method to use when you need to ensure that a single
* method is reached only via HTTPS. If it isn't, then a redirect
* will happen back to this method and HSTS header will be sent
* to have modern browsers transform requests automatically.
*
* @param int $duration The number of seconds this link should be
* considered secure for. Only with HSTS header.
* Default value is 1 year.
*
* @throws HTTPException
*/
Inherited from CodeIgniter\Controller
Defined in <ROOT>/system/Controller.php:100
⧉protected cachePage(int $time) Provides a simple way to tie into the main CodeIgniter class and tell it how ...
/**
* Provides a simple way to tie into the main CodeIgniter class and
* tell it how long to cache the current page for.
*/
Inherited from CodeIgniter\Controller
Defined in <ROOT>/system/Controller.php:109
/**
* Handles "auto-loading" helper files.
*
* @deprecated Use `helper` function instead of using this method.
*
* @codeCoverageIgnore
*/
Inherited from CodeIgniter\Controller
Defined in <ROOT>/system/Controller.php:121
⧉protected validate($rules, array $messages = array()): bool A shortcut to performing validation on Request data.
/**
* A shortcut to performing validation on Request data.
*
* @param array|string $rules
* @param array $messages An array of custom error messages
*/
Inherited from CodeIgniter\Controller
Defined in <ROOT>/system/Controller.php:136
⧉protected validateData(array $data, $rules, array $messages = array(), ?string $dbGroup = null): bool A shortcut to performing validation on any input data.
/**
* A shortcut to performing validation on any input data.
*
* @param array $data The data to validate
* @param array|string $rules
* @param array $messages An array of custom error messages
* @param string|null $dbGroup The database group to use
*/
Inherited from CodeIgniter\Controller
Defined in <ROOT>/system/Controller.php:151
⧉public setQuery(string $sql, $binds = null, bool $setEscape = true): $this Sets the raw query string to use for this statement.
/**
* Sets the raw query string to use for this statement.
*
* @param mixed $binds
*
* @return $this
*/
Defined in <ROOT>/system/Database/Query.php:106
⧉public setBinds(array $binds, bool $setEscape = true): $this Will store the variables to bind into the query later.
/**
* Will store the variables to bind into the query later.
*
* @return $this
*/
Defined in <ROOT>/system/Database/Query.php:137
⧉public getQuery(): string Returns the final, processed query string after binding, etal has been perfor...
/**
* Returns the final, processed query string after binding, etal
* has been performed.
*/
Defined in <ROOT>/system/Database/Query.php:156
⧉public setDuration(float $start, ?float $end = null): $this Records the execution time of the statement using microtime(true) for it's st...
/**
* Records the execution time of the statement using microtime(true)
* for it's start and end values. If no end value is present, will
* use the current time to determine total duration.
*
* @param float $end
*
* @return $this
*/
Defined in <ROOT>/system/Database/Query.php:174
⧉public getStartTime(bool $returnRaw = false, int $decimals = 6): float|string Returns the start time in seconds with microseconds.
/**
* Returns the start time in seconds with microseconds.
*
* @return float|string
*/
Defined in <ROOT>/system/Database/Query.php:192
⧉public getDuration(int $decimals = 6): string Returns the duration of this query during execution, or null if the query has...
/**
* Returns the duration of this query during execution, or null if
* the query has not been executed yet.
*
* @param int $decimals The accuracy of the returned time.
*/
Defined in <ROOT>/system/Database/Query.php:207
⧉public setError(int $code, string $error): $this Stores the error description that happened for this query.
/**
* Stores the error description that happened for this query.
*
* @return $this
*/
Defined in <ROOT>/system/Database/Query.php:217
⧉public hasError(): bool Reports whether this statement created an error not.
/**
* Reports whether this statement created an error not.
*/
Defined in <ROOT>/system/Database/Query.php:228
⧉public getErrorCode(): int Returns the error code created while executing this statement.
/**
* Returns the error code created while executing this statement.
*/
Defined in <ROOT>/system/Database/Query.php:236
⧉public getErrorMessage(): string Returns the error message created while executing this statement.
/**
* Returns the error message created while executing this statement.
*/
Defined in <ROOT>/system/Database/Query.php:244
⧉public isWriteType(): bool Determines if the statement is a write-type query or not.
/**
* Determines if the statement is a write-type query or not.
*/
Defined in <ROOT>/system/Database/Query.php:252
⧉public swapPrefix(string $orig, string $swap): $this Swaps out one table prefix for a new one.
/**
* Swaps out one table prefix for a new one.
*
* @return $this
*/
Defined in <ROOT>/system/Database/Query.php:262
⧉public getOriginalQuery(): string Returns the original SQL that was passed into the system.
/**
* Returns the original SQL that was passed into the system.
*/
Defined in <ROOT>/system/Database/Query.php:279
⧉public debugToolbarDisplay(): string Returns string to display in debug toolbar
/**
* Returns string to display in debug toolbar
*/
Defined in <ROOT>/system/Database/Query.php:371
⧉public __toString(): string Return text representation of the query
/**
* Return text representation of the query
*/
Defined in <ROOT>/system/Database/Query.php:425
⧉protected compileBinds() Escapes and inserts any binds into the finalQueryString property.
/**
* Escapes and inserts any binds into the finalQueryString property.
*
* @see https://regex101.com/r/EUEhay/5
*/
Defined in <ROOT>/system/Database/Query.php:289
⧉protected matchNamedBinds(string $sql, array $binds): string Match bindings
/**
* Match bindings
*/
Defined in <ROOT>/system/Database/Query.php:317
⧉protected matchSimpleBinds(string $sql, array $binds, int $bindCount, int $ml): string Match bindings
/**
* Match bindings
*/
Defined in <ROOT>/system/Database/Query.php:341
⧉public connect(bool $persistent = false): false|mysqli Connect to the database.
/**
* Connect to the database.
*
* @return false|mysqli
*
* @throws DatabaseException
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:82
⧉public reconnect() Keep or establish the connection if no queries have been sent for a length of...
/**
* Keep or establish the connection if no queries have been sent for
* a length of time exceeding the server's idle timeout.
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:228
⧉public setDatabase(string $databaseName): bool Select a specific database table to use.
/**
* Select a specific database table to use.
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:245
⧉public getVersion(): string Returns a string containing the version of the database being used.
/**
* Returns a string containing the version of the database being used.
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:267
⧉public affectedRows(): int Returns the total number of rows affected by this query.
/**
* Returns the total number of rows affected by this query.
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:324
⧉public escapeLikeStringDirect($str): string|string[] Escape Like String Direct There are a few instances where MySQLi queries cann...
/**
* Escape Like String Direct
* There are a few instances where MySQLi queries cannot take the
* additional "ESCAPE x" parameter for specifying the escape character
* in "LIKE" strings, and this handles those directly with a backslash.
*
* @param string|string[] $str Input string
*
* @return string|string[]
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:351
⧉public error(): array Returns the last error code and message. Must return this format: ['code' => ...
/**
* Returns the last error code and message.
* Must return this format: ['code' => string|int, 'message' => string]
* intval(code) === 0 means "no error".
*
* @return array<string, int|string>
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:557
⧉public insertID(): int Insert ID
/**
* Insert ID
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:575
/**
* Saves our connection settings.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:345
⧉public initialize(): void Initializes the database connection/settings.
/**
* Initializes the database connection/settings.
*
* @return void
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:374
⧉public close() Close the database connection.
/**
* Close the database connection.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:441
⧉public persistentConnect(): false|object|resource Create a persistent database connection.
/**
* Create a persistent database connection.
*
* @return false|object|resource
* @phpstan-return false|TConnection
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:462
⧉public getConnection(?string $alias = null): false|object|resource Returns the actual connection object. If both a 'read' and 'write' connection...
/**
* Returns the actual connection object. If both a 'read' and 'write'
* connection has been specified, you can pass either term in to
* get that connection. If you pass either alias in and only a single
* connection is present, it must return the sole connection.
*
* @return false|object|resource
* @phpstan-return TConnection
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:476
⧉public getDatabase(): string Returns the name of the current database being used.
/**
* Returns the name of the current database being used.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:485
⧉public setPrefix(string $prefix = ''): string Set DB Prefix
/**
* Set DB Prefix
*
* Set's the DB Prefix to something new without needing to reconnect
*
* @param string $prefix The prefix
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:497
⧉public getPrefix(): string Returns the database prefix.
/**
* Returns the database prefix.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:505
⧉public getPlatform(): string The name of the platform in use (MySQLi, Postgre, SQLite3, OCI8, etc)
/**
* The name of the platform in use (MySQLi, Postgre, SQLite3, OCI8, etc)
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:513
⧉public setAliasedTables(array $aliases): $this Sets the Table Aliases to use. These are typically collected during use of th...
/**
* Sets the Table Aliases to use. These are typically
* collected during use of the Builder, and set here
* so queries are built correctly.
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:525
⧉public addTableAlias(string $table): $this Add a table alias to our list.
/**
* Add a table alias to our list.
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:537
⧉public query(string $sql, $binds = null, bool $setEscapeFlags = true, string $queryClass = ''): BaseResult|bool|Query BaseResult when “read” type query, bool when “write” type query, Query when prepared query Orchestrates a query against the database. Queries must use Database\Statemen...
/**
* Orchestrates a query against the database. Queries must use
* Database\Statement objects to store the query and build it.
* This method works with the cache.
*
* Should automatically handle different connections for read/write
* queries if needed.
*
* @param array|string|null $binds
*
* @return BaseResult|bool|Query BaseResult when “read” type query, bool when “write” type query, Query when prepared query
* @phpstan-return BaseResult<TConnection, TResult>|bool|Query
*
* @todo BC set $queryClass default as null in 4.1
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:569
⧉public simpleQuery(string $sql): false|object|resource Performs a basic query against the database. No binding or caching is perform...
/**
* Performs a basic query against the database. No binding or caching
* is performed, nor are transactions handled. Simply takes a raw
* query string and returns the database-specific result id.
*
* @return false|object|resource
* @phpstan-return false|TResult
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:686
⧉public transOff() Disable Transactions
/**
* Disable Transactions
*
* This permits transactions to be disabled at run-time.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:700
/**
* Enable/disable Transaction Strict Mode
*
* When strict mode is enabled, if you are running multiple groups of
* transactions, if one group fails all subsequent groups will be
* rolled back.
*
* If strict mode is disabled, each group is treated autonomously,
* meaning a failure of one group will not affect any others
*
* @param bool $mode = true
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:719
/**
* Start Transaction
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:729
⧉public transException(bool $transExcetion): $this If set to true, exceptions are thrown during transactions.
/**
* If set to true, exceptions are thrown during transactions.
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:743
/**
* Complete Transaction
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:753
⧉public transStatus(): bool Lets you retrieve the transaction flag to determine if it has failed
/**
* Lets you retrieve the transaction flag to determine if it has failed
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:779
⧉public transBegin(bool $testMode = false): bool Begin Transaction
/**
* Begin Transaction
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:787
⧉public transCommit(): bool Commit Transaction
/**
* Commit Transaction
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:821
/**
* Rollback Transaction
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:840
⧉public table($tableName): BaseBuilder Returns a non-shared new instance of the query builder for this connection.
/**
* Returns a non-shared new instance of the query builder for this connection.
*
* @param array|string $tableName
*
* @return BaseBuilder
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:880
⧉public newQuery(): CodeIgniter\Database\BaseBuilder Returns a new instance of the BaseBuilder class with a cleared FROM clause.
/**
* Returns a new instance of the BaseBuilder class with a cleared FROM clause.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:894
⧉public prepare(Closure $func, array $options = array()): BasePreparedQuery|null Creates a prepared statement with the database that can then be used to execu...
/**
* Creates a prepared statement with the database that can then
* be used to execute multiple statements against. Within the
* closure, you would build the query in any normal way, though
* the Query Builder is the expected manner.
*
* Example:
* $stmt = $db->prepare(function($db)
* {
* return $db->table('users')
* ->where('id', 1)
* ->get();
* })
*
* @return BasePreparedQuery|null
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:920
⧉public getLastQuery(): Query Returns the last query's statement object.
/**
* Returns the last query's statement object.
*
* @return Query
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:948
⧉public showLastQuery(): string Returns a string representation of the last query's statement object.
/**
* Returns a string representation of the last query's statement object.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:956
⧉public getConnectStart(): ?float Returns the time we started to connect to this database in seconds with micro...
/**
* Returns the time we started to connect to this database in
* seconds with microseconds.
*
* Used by the Debug Toolbar's timeline.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:967
⧉public getConnectDuration(int $decimals = 6): string Returns the number of seconds with microseconds that it took to connect to th...
/**
* Returns the number of seconds with microseconds that it took
* to connect to the database.
*
* Used by the Debug Toolbar's timeline.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:978
/**
* Protect Identifiers
*
* This function is used extensively by the Query Builder class, and by
* a couple functions in this class.
* It takes a column or table name (optionally with an alias) and inserts
* the table prefix onto it. Some logic is necessary in order to deal with
* column names that include the path. Consider a query like this:
*
* SELECT hostname.database.table.column AS c FROM hostname.database.table
*
* Or a query with aliasing:
*
* SELECT m.member_id, m.member_name FROM members AS m
*
* Since the column name can include up to four segments (host, DB, table, column)
* or also have an alias prefix, we need to do a bit of work to figure this out and
* insert the table prefix (if it exists) in the proper position, and escape only
* the correct identifiers.
*
* @param array|string $item
* @param bool $prefixSingle Prefix a table name with no segments?
* @param bool $protectIdentifiers Protect table or column names?
* @param bool $fieldExists Supplied $item contains a column name?
*
* @return array|string
* @phpstan-return ($item is array ? array : string)
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1011
⧉public escapeIdentifiers($item): array|string Escape the SQL Identifiers
/**
* Escape the SQL Identifiers
*
* This function escapes column and table names
*
* @param array|string $item
*
* @return array|string
* @phpstan-return ($item is array ? array : string)
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1171
⧉public prefixTable(string $table = ''): string Prepends a database prefix if one exists in configuration
/**
* Prepends a database prefix if one exists in configuration
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1231
/**
* Escape String
*
* @param string|string[] $str Input string
* @param bool $like Whether or not the string will be used in a LIKE condition
*
* @return string|string[]
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1286
⧉public escapeLikeString($str): string|string[] Escape LIKE String
/**
* Escape LIKE String
*
* Calls the individual driver for platform
* specific escaping for LIKE conditions
*
* @param string|string[] $str
*
* @return string|string[]
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1328
⧉public callFunction(string $functionName, $params): bool This function enables you to call PHP database functions that are not nativel...
/**
* This function enables you to call PHP database functions that are not natively included
* in CodeIgniter, in a platform independent manner.
*
* @param array ...$params
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1351
⧉public listTables(bool $constrainByPrefix = false): array|false Returns an array of table names
/**
* Returns an array of table names
*
* @return array|false
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1389
⧉public tableExists(string $tableName, bool $cached = true): bool Determine if a particular table exists
/**
* Determine if a particular table exists
*
* @param bool $cached Whether to use data cache
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1425
⧉public getFieldNames(string $table): array|false Fetch Field Names
/**
* Fetch Field Names
*
* @return array|false
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1466
⧉public fieldExists(string $fieldName, string $tableName): bool Determine if a particular field exists
/**
* Determine if a particular field exists
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1511
⧉public getFieldData(string $table): stdClass[] Returns an object with field data
/**
* Returns an object with field data
*
* @return stdClass[]
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1521
⧉public getIndexData(string $table): array Returns an object with key data
/**
* Returns an object with key data
*
* @return array
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1531
⧉public getForeignKeyData(string $table): array Returns an object with foreign key data
/**
* Returns an object with foreign key data
*
* @return array
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1541
/**
* Enables foreign key checks temporarily.
*
* @return bool
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1613
⧉public pretend(bool $pretend = true): $this Allows the engine to be set into a mode where queries are not actually execut...
/**
* Allows the engine to be set into a mode where queries are not
* actually executed, but they are still generated, timed, etc.
*
* This is primarily used by the prepared query functionality.
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1633
⧉public resetDataCache(): $this Empties our data cache. Especially helpful during testing.
/**
* Empties our data cache. Especially helpful during testing.
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1645
⧉public isWriteType($sql): bool Determines if the statement is a write-type query or not.
/**
* Determines if the statement is a write-type query or not.
*
* @param string $sql
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1657
⧉public __get(string $key): array|bool|float|int|object|resource|string|null Accessor for properties if they exist.
/**
* Accessor for properties if they exist.
*
* @return array|bool|float|int|object|resource|string|null
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1753
⧉public __isset(string $key): bool Checker for properties existence.
/**
* Checker for properties existence.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1765
⧉protected _close() Close the database connection.
/**
* Close the database connection.
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:237
⧉protected execute(string $sql): false|mysqli_result; Executes the query against the database.
/**
* Executes the query against the database.
*
* @return false|mysqli_result;
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:285
⧉protected prepQuery(string $sql): string Prep the query. If needed, each database adapter can prep the query string
/**
* Prep the query. If needed, each database adapter can prep the query string
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:310
/**
* Platform-dependant string escape
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:332
⧉protected _listTables(bool $prefixLimit = false, ?string $tableName = null): string Generates the SQL for listing tables in a platform-dependent manner. Uses esc...
/**
* Generates the SQL for listing tables in a platform-dependent manner.
* Uses escapeLikeStringDirect().
*
* @param string|null $tableName If $tableName is provided will return only this table if exists.
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:377
⧉protected _listColumns(string $table = ''): string Generates a platform-specific query string so that the column names can be fe...
/**
* Generates a platform-specific query string so that the column names can be fetched.
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:395
⧉protected _fieldData(string $table): array Returns an array of objects with field data
/**
* Returns an array of objects with field data
*
* @return stdClass[]
*
* @throws DatabaseException
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:407
⧉protected _indexData(string $table): array Returns an array of objects with index data
/**
* Returns an array of objects with index data
*
* @return stdClass[]
*
* @throws DatabaseException
* @throws LogicException
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:440
⧉protected _foreignKeyData(string $table): array Returns an array of objects with Foreign key data
/**
* Returns an array of objects with Foreign key data
*
* @return stdClass[]
*
* @throws DatabaseException
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:485
/**
* Rollback Transaction
*/
Defined in <ROOT>/system/Database/MySQLi/Connection.php:607
⧉protected getDriverFunctionPrefix(): string Get the prefix of the function to access the DB.
/**
* Get the prefix of the function to access the DB.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1373
⧉protected foreignKeyDataToObjects(array $data): array[ Converts array of arrays generated by _foreignKeyData() to array of objects
/**
* Converts array of arrays generated by _foreignKeyData() to array of objects
*
* @return array[
* {constraint_name} =>
* stdClass[
* 'constraint_name' => string,
* 'table_name' => string,
* 'column_name' => string[],
* 'foreign_table_name' => string,
* 'foreign_column_name' => string[],
* 'on_delete' => string,
* 'on_update' => string,
* 'match' => string
* ]
* ]
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in <ROOT>/system/Database/BaseConnection.php:1563
list => string (33) "CodeIgniter\Validation\Views\list"
single => string (35) "CodeIgniter\Validation\Views\single"
⧉public __construct() Will attempt to get environment variables with names that match the propertie...
/**
* Will attempt to get environment variables with names
* that match the properties of the child class.
*
* The "shortPrefix" is the lowercase-only config class name.
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in <ROOT>/system/Config/BaseConfig.php:60
/**
* Retrieve an environment-specific configuration setting
*
* @return string|null
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in <ROOT>/system/Config/BaseConfig.php:128
⧉protected registerProperties() Provides external libraries a simple way to register one or more options into...
/**
* Provides external libraries a simple way to register one or more
* options into a config file.
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in <ROOT>/system/Config/BaseConfig.php:174
⧉public shouldDiscover(string $alias): bool Should the application auto-discover the requested resource.
/**
* Should the application auto-discover the requested resource.
*/
Inherited from CodeIgniter\Modules\Modules
Defined in <ROOT>/system/Modules/Modules.php:45
⧉public __construct() Merge the built-in and developer-configured filters and plugins, with prefere...
/**
* Merge the built-in and developer-configured filters and plugins,
* with preference to the developer ones.
*/
Inherited from CodeIgniter\Config\View
Defined in <ROOT>/system/Config/View.php:108
/**
* Retrieve an environment-specific configuration setting
*
* @return string|null
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in <ROOT>/system/Config/BaseConfig.php:128
⧉protected registerProperties() Provides external libraries a simple way to register one or more options into...
/**
* Provides external libraries a simple way to register one or more
* options into a config file.
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in <ROOT>/system/Config/BaseConfig.php:174
⧉public shouldDiscover(string $alias): bool Should the application auto-discover the requested resource.
/**
* Should the application auto-discover the requested resource.
*/
Inherited from CodeIgniter\Modules\Modules
Defined in <ROOT>/system/Modules/Modules.php:45
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:150
⧉public setTable(string $table): $this Specify the table associated with a model
/**
* Specify the table associated with a model
*
* @param string $table Table
*
* @return $this
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:169
⧉public getIdValue($data): array|int|string|null Returns the id value for the data array or object
/**
* Returns the id value for the data array or object
*
* @param array|object $data Data
*
* @return array|int|string|null
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:538
⧉public chunk(int $size, Closure $userFunc) Loops over records in batches, allowing you to operate on them. Works with $t...
/**
* Loops over records in batches, allowing you to operate on them.
* Works with $this->builder to get the Compiled select to
* determine the rows to operate on.
* This method works only with dbCalls.
*
* @throws DataException
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:559
⧉public countAllResults(bool $reset = true, bool $test = false): int|string Override countAllResults to account for soft deleted accounts.
/**
* Override countAllResults to account for soft deleted accounts.
*
* @return int|string
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:593
⧉public builder(?string $table = null): BaseBuilder Provides a shared instance of the Query Builder.
/**
* Provides a shared instance of the Query Builder.
*
* @return BaseBuilder
*
* @throws ModelException
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:616
⧉public set($key, $value = '', ?bool $escape = null): $this Captures the builder's set() method so that we can validate the data here. Th...
/**
* Captures the builder's set() method so that we can validate the
* data here. This allows it to be used with any of the other
* builder methods and still get validated data, like replace.
*
* @param array|object|string $key Field name, or an array of field/value pairs
* @param bool|float|int|object|string|null $value Field value, if $key is a single field
* @param bool|null $escape Whether to escape values
*
* @return $this
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:663
⧉public __get(string $name): mixed Provides/instantiates the builder/db connection and model's table/primary key...
/**
* Provides/instantiates the builder/db connection and model's table/primary key names and return type.
*
* @param string $name Name
*
* @return mixed
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:797
⧉public __isset(string $name): bool Checks for the existence of properties across this model, builder, and db con...
/**
* Checks for the existence of properties across this model, builder, and db connection.
*
* @param string $name Name
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:815
⧉public __call(string $name, array $params): mixed Provides direct access to method in the builder (if available) and the databa...
/**
* Provides direct access to method in the builder (if available)
* and the database connection.
*
* @return mixed
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:830
⧉public find($id = null): array|object|null The resulting row of data, or null. Fetches the row of database.
/**
* Fetches the row of database.
*
* @param array|int|string|null $id One primary key or an array of primary keys
*
* @return array|object|null The resulting row of data, or null.
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:538
⧉public findColumn(string $columnName): array|null The resulting row of data, or null if no data found. Fetches the column of database.
/**
* Fetches the column of database.
*
* @param string $columnName Column Name
*
* @return array|null The resulting row of data, or null if no data found.
*
* @throws DataException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:582
⧉public findAll(int $limit0, int $offset0): array Fetches all results, while optionally limiting them.
/**
* Fetches all results, while optionally limiting them.
*
* @param int $limit Limit
* @param int $offset Offset
*
* @return array
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:601
⧉public first(): array|object|null Returns the first row of the result set.
/**
* Returns the first row of the result set.
*
* @return array|object|null
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:641
⧉public save($data): bool A convenience method that will attempt to determine whether the data should b...
/**
* A convenience method that will attempt to determine whether the
* data should be inserted or updated. Will work with either
* an array or object. When using with custom class objects,
* you must ensure that the class will provide access to the class
* variables, even if through a magic method.
*
* @param array|object $data Data
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:683
⧉public getInsertID(): int|string Returns last insert ID or 0.
/**
* Returns last insert ID or 0.
*
* @return int|string
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:718
⧉public insertBatch(?array $set = null, ?bool $escape = null, int $batchSize = 100, bool $testing = false): bool|int Number of rows inserted or FALSE on failure Compiles batch insert runs the queries, validating each row prior.
/**
* Compiles batch insert runs the queries, validating each row prior.
*
* @param array|null $set an associative array of insert values
* @param bool|null $escape Whether to escape values
* @param int $batchSize The size of the batch to run
* @param bool $testing True means only number of records is returned, false will execute the query
*
* @return bool|int Number of rows inserted or FALSE on failure
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:818
⧉public updateBatch(?array $set = null, ?string $index = null, int $batchSize = 100, bool $returnSQL = false): false|int|string[] Number of rows affected or FALSE on failure, SQL array when testMode Compiles an update and runs the query.
/**
* Compiles an update and runs the query.
*
* @param array|null $set An associative array of update values
* @param string|null $index The where key
* @param int $batchSize The size of the batch to run
* @param bool $returnSQL True means SQL is returned, false will execute the query
*
* @return false|int|string[] Number of rows affected or FALSE on failure, SQL array when testMode
*
* @throws DatabaseException
* @throws ReflectionException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:968
⧉public delete($id = null, bool $purge = false): BaseResult|bool Deletes a single record from the database where $id matches.
/**
* Deletes a single record from the database where $id matches.
*
* @param array|int|string|null $id The rows primary key(s)
* @param bool $purge Allows overriding the soft deletes setting.
*
* @return BaseResult|bool
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1042
⧉public purgeDeleted(): bool|string Returns a string if in test mode. Permanently deletes all rows that have been marked as deleted through soft de...
/**
* Permanently deletes all rows that have been marked as deleted
* through soft deletes (deleted = 1).
*
* @return bool|string Returns a string if in test mode.
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1083
⧉public withDeleted(bool $val = true): $this Sets $useSoftDeletes value so that we can temporarily override the soft delet...
/**
* Sets $useSoftDeletes value so that we can temporarily override
* the soft deletes settings. Can be used for all find* methods.
*
* @param bool $val Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1100
⧉public onlyDeleted(): $this Works with the find* methods to return only the rows that have been deleted.
/**
* Works with the find* methods to return only the rows that
* have been deleted.
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1113
⧉public replace(?array $data = null, bool $returnSQL = false): BaseResult|false|Query|string Compiles a replace and runs the query.
/**
* Compiles a replace and runs the query.
*
* @param array|null $data Data
* @param bool $returnSQL Set to true to return Query String
*
* @return BaseResult|false|Query|string
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1129
⧉public errors(bool $forceDB = false): array<string,string> Grabs the last error(s) that occurred. If data was validated, it will first c...
/**
* Grabs the last error(s) that occurred. If data was validated,
* it will first check for errors there, otherwise will try to
* grab the last error from the Database connection.
*
* The return array should be in the following format:
* ['source' => 'message']
*
* @param bool $forceDB Always grab the db error, not validation
*
* @return array<string,string>
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1155
⧉public paginate(?int $perPage = null, string $group = 'default', ?int $page = null, int $segment0): array|null Works with Pager to get the size and offset parameters. Expects a GET variabl...
/**
* Works with Pager to get the size and offset parameters.
* Expects a GET variable (?page=2) that specifies the page of results
* to display.
*
* @param int|null $perPage Items per page
* @param string $group Will be used by the pagination library to identify a unique pagination set.
* @param int|null $page Optional page number (useful when the page number is provided in different way)
* @param int $segment Optional URI segment number (if page number is provided by URI segment)
*
* @return array|null
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1177
⧉public setAllowedFields(array $allowedFields): $this It could be used when you have to change default or override current allowed ...
/**
* It could be used when you have to change default or override current allowed fields.
*
* @param array $allowedFields Array with names of fields
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1202
⧉public protect(bool $protect = true): $this Sets whether or not we should whitelist data set during updates or inserts ag...
/**
* Sets whether or not we should whitelist data set during
* updates or inserts against $this->availableFields.
*
* @param bool $protect Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1217
⧉public skipValidation(bool $skip = true): $this Set the value of the skipValidation flag.
/**
* Set the value of the skipValidation flag.
*
* @param bool $skip Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1340
⧉public setValidationMessages(array $validationMessages): $this Allows to set validation messages. It could be used when you have to change d...
/**
* Allows to set validation messages.
* It could be used when you have to change default or override current validate messages.
*
* @param array $validationMessages Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1355
⧉public setValidationMessage(string $field, array $fieldMessages): $this Allows to set field wise validation message. It could be used when you have t...
/**
* Allows to set field wise validation message.
* It could be used when you have to change default or override current validate messages.
*
* @param string $field Field Name
* @param array $fieldMessages Validation messages
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1371
⧉public setValidationRules(array $validationRules): $this Allows to set validation rules. It could be used when you have to change defa...
/**
* Allows to set validation rules.
* It could be used when you have to change default or override current validate rules.
*
* @param array $validationRules Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1386
⧉public setValidationRule(string $field, $fieldRules): $this Allows to set field wise validation rules. It could be used when you have to ...
/**
* Allows to set field wise validation rules.
* It could be used when you have to change default or override current validate rules.
*
* @param string $field Field Name
* @param array|string $fieldRules Validation rules
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1402
⧉public cleanRules(bool $choice = false): $this Should validation rules be removed before saving? Most handy when doing updates.
/**
* Should validation rules be removed before saving?
* Most handy when doing updates.
*
* @param bool $choice Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1417
⧉public validate($data): bool Validate the data against the validation rules (or the validation group) spec...
/**
* Validate the data against the validation rules (or the validation group)
* specified in the class property, $validationRules.
*
* @param array|object $data Data
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1430
⧉public getValidationRules(array $options = array()): array Returns the model's defined validation rules so that they can be used elsewhe...
/**
* Returns the model's defined validation rules so that they
* can be used elsewhere, if needed.
*
* @param array $options Options
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1462
⧉public getValidationMessages(): array Returns the model's validation messages, so they can be used elsewhere, if ne...
/**
* Returns the model's validation messages, so they
* can be used elsewhere, if needed.
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1485
⧉public allowCallbacks(bool $val = true): $this Sets $tempAllowCallbacks value so that we can temporarily override the settin...
/**
* Sets $tempAllowCallbacks value so that we can temporarily override
* the setting. Resets after the next method that uses triggers.
*
* @param bool $val value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1521
⧉public asArray(): $this Sets the return type of the results to be as an associative array.
/**
* Sets the return type of the results to be as an associative array.
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1573
⧉public asObject(string $class = 'object'): $this Sets the return type to be of the specified type of object. Defaults to a sim...
/**
* Sets the return type to be of the specified type of object.
* Defaults to a simple object, but can be any class that has
* class vars with the same name as the collection columns,
* or at least allows them to be created.
*
* @param string $class Class Name
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1590
/**
* Sets $allowEmptyInserts.
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1812
⧉protected doFind(bool $singleton, $id = null): array|object|null The resulting row of data, or null. Fetches the row of database from $this->table with a primary key matching $id...
/**
* Fetches the row of database from $this->table with a primary key
* matching $id.
* This method works only with dbCalls.
*
* @param bool $singleton Single or multiple results
* @param array|int|string|null $id One primary key or an array of primary keys
*
* @return array|object|null The resulting row of data, or null.
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:186
⧉protected doFindColumn(string $columnName): array|null The resulting row of data, or null if no data found. Fetches the column of database from $this->table. This method works only with...
/**
* Fetches the column of database from $this->table.
* This method works only with dbCalls.
*
* @param string $columnName Column Name
*
* @return array|null The resulting row of data, or null if no data found.
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:217
⧉protected doFindAll(int $limit0, int $offset0): array Works with the current Query Builder instance to return all results, while op...
/**
* Works with the current Query Builder instance to return
* all results, while optionally limiting them.
* This method works only with dbCalls.
*
* @param int $limit Limit
* @param int $offset Offset
*
* @return array
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:232
⧉protected doFirst(): array|object|null Returns the first row of the result set. Will take any previous Query Builder...
/**
* Returns the first row of the result set. Will take any previous
* Query Builder calls into account when determining the result set.
* This method works only with dbCalls.
*
* @return array|object|null
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:252
⧉protected doInsert(array $data): bool Inserts data into the current table. This method works only with dbCalls.
/**
* Inserts data into the current table.
* This method works only with dbCalls.
*
* @param array $data Data
*
* @return bool
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:279
⧉protected doInsertBatch(?array $set = null, ?bool $escape = null, int $batchSize = 100, bool $testing = false): bool|int Number of rows inserted or FALSE on failure Compiles batch insert strings and runs the queries, validating each row prior...
/**
* Compiles batch insert strings and runs the queries, validating each row prior.
* This method works only with dbCalls.
*
* @param array|null $set An associative array of insert values
* @param bool|null $escape Whether to escape values
* @param int $batchSize The size of the batch to run
* @param bool $testing True means only number of records is returned, false will execute the query
*
* @return bool|int Number of rows inserted or FALSE on failure
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:352
⧉protected doUpdate($id = null, $data = null): bool Updates a single record in $this->table. This method works only with dbCalls.
/**
* Updates a single record in $this->table.
* This method works only with dbCalls.
*
* @param array|int|string|null $id
* @param array|null $data
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:374
⧉protected doUpdateBatch(?array $set = null, ?string $index = null, int $batchSize = 100, bool $returnSQL = false): false|int|string[] Number of rows affected or FALSE on failure, SQL array when testMode Compiles an update string and runs the query This method works only with dbCa...
/**
* Compiles an update string and runs the query
* This method works only with dbCalls.
*
* @param array|null $set An associative array of update values
* @param string|null $index The where key
* @param int $batchSize The size of the batch to run
* @param bool $returnSQL True means SQL is returned, false will execute the query
*
* @return false|int|string[] Number of rows affected or FALSE on failure, SQL array when testMode
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:412
⧉protected doDelete($id = null, bool $purge = false): bool|string Deletes a single record from $this->table where $id matches the table's prima...
/**
* Deletes a single record from $this->table where $id matches
* the table's primaryKey
* This method works only with dbCalls.
*
* @param array|int|string|null $id The rows primary key(s)
* @param bool $purge Allows overriding the soft deletes setting.
*
* @return bool|string
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:429
⧉protected doPurgeDeleted(): bool|string Returns a string if in test mode. Permanently deletes all rows that have been marked as deleted through soft de...
/**
* Permanently deletes all rows that have been marked as deleted
* through soft deletes (deleted = 1)
* This method works only with dbCalls.
*
* @return bool|string Returns a string if in test mode.
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:466
⧉protected doOnlyDeleted() Works with the find* methods to return only the rows that have been deleted. ...
/**
* Works with the find* methods to return only the rows that
* have been deleted.
* This method works only with dbCalls.
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:478
⧉protected doReplace(?array $data = null, bool $returnSQL = false): BaseResult|false|Query|string Compiles a replace into string and runs the query This method works only with...
/**
* Compiles a replace into string and runs the query
* This method works only with dbCalls.
*
* @param array|null $data Data
* @param bool $returnSQL Set to true to return Query String
*
* @return BaseResult|false|Query|string
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:492
⧉protected doErrors(): array<string,string> Grabs the last error(s) that occurred from the Database connection. The retur...
/**
* Grabs the last error(s) that occurred from the Database connection.
* The return array should be in the following format:
* ['source' => 'message']
* This method works only with dbCalls.
*
* @return array<string,string>
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:505
⧉protected idValue($data): array|int|string|null Returns the id value for the data array or object
/**
* Returns the id value for the data array or object
*
* @param array|object $data Data
*
* @return array|int|string|null
*
* @deprecated Use getIdValue() instead. Will be removed in version 5.0.
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:526
⧉protected shouldUpdate($data): bool This method is called on save to determine if entry have to be updated If thi...
/**
* This method is called on save to determine if entry have to be updated
* If this method return false insert operation will be executed
*
* @param array|object $data Data
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:682
⧉protected objectToRawArray($data, bool $onlyChanged = true, bool $recursive = false): ?array Takes a class an returns an array of it's public and protected properties as ...
/**
* Takes a class an returns an array of it's public and protected
* properties as an array with raw values.
*
* @param object|string $data
* @param bool $recursive If true, inner entities will be casted as array as well
*
* @return array|null Array
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:770
⧉protected initialize() Initializes the instance with any additional steps. Optionally implemented by...
/**
* Initializes the instance with any additional steps.
* Optionally implemented by child classes.
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:342
⧉protected doProtectFields(array $data): array Ensures that only the fields that are allowed to be updated are in the data a...
/**
* Ensures that only the fields that are allowed to be updated
* are in the data array.
*
* Used by insert() and update() to protect against mass assignment
* vulnerabilities.
*
* @param array $data Data
*
* @throws DataException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1235
⧉protected setDate(?int $userData = null): int|string Sets the date or current date if null value is passed.
/**
* Sets the date or current date if null value is passed.
*
* @param int|null $userData An optional PHP timestamp to be converted.
*
* @return int|string
*
* @throws ModelException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1263
⧉protected intToDate(int $value): int|string A utility function to allow child models to use the type of date/time format ...
/**
* A utility function to allow child models to use the type of
* date/time format that they prefer. This is primarily used for
* setting created_at, updated_at and deleted_at values, but can be
* used by inheriting classes.
*
* The available time formats are:
* - 'int' - Stores the date as an integer timestamp
* - 'datetime' - Stores the data in the SQL datetime format
* - 'date' - Stores the date (only) in the SQL date format.
*
* @param int $value value
*
* @return int|string
*
* @throws ModelException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1287
⧉protected timeToDate(CodeIgniter\I18n\Time $value): int|string Converts Time value to string using $this->dateFormat.
/**
* Converts Time value to string using $this->dateFormat.
*
* The available time formats are:
* - 'int' - Stores the date as an integer timestamp
* - 'datetime' - Stores the data in the SQL datetime format
* - 'date' - Stores the date (only) in the SQL date format.
*
* @param Time $value value
*
* @return int|string
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1316
⧉protected cleanValidationRules(array $rules, ?array $data = null): array Removes any rules that apply to fields that have not been set currently so th...
/**
* Removes any rules that apply to fields that have not been set
* currently so that rules don't block updating when only updating
* a partial row.
*
* @param array $rules Array containing field name and rule
* @param array|null $data Data
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1498
⧉protected trigger(string $event, array $eventData): array A simple event trigger for Model Events that allows additional data manipulat...
/**
* A simple event trigger for Model Events that allows additional
* data manipulation within the model. Specifically intended for
* usage by child models this can be used to format data,
* save/load related classes, etc.
*
* It is the responsibility of the callback methods to return
* the data itself.
*
* Each $eventData array MUST have a 'data' key with the relevant
* data for callback methods (like an array of key/value pairs to insert
* or update, an array of results, etc.)
*
* If callbacks are not allowed then returns $eventData immediately.
*
* @param string $event Event
* @param array $eventData Event Data
*
* @return array
*
* @throws DataException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1550
⧉protected objectToArray($data, bool $onlyChanged = true, bool $recursive = false): array Takes a class and returns an array of its public and protected properties as ...
/**
* Takes a class and returns an array of its public and protected
* properties as an array suitable for use in creates and updates.
* This method uses objectToRawArray() internally and does conversion
* to string on all Time instances
*
* @param object|string $data Data
* @param bool $onlyChanged Only Changed Property
* @param bool $recursive If true, inner entities will be cast as array as well
*
* @return array Array
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1611
⧉protected transformDataToArray($data, string $type): array Transform data to array.
/**
* Transform data to array.
*
* @param array|object|null $data Data
* @param string $type Type of data (insert|update)
*
* @throws DataException
* @throws InvalidArgumentException
* @throws ReflectionException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1673
⧉protected fillPlaceholders(array $rules, array $data): array Replace any placeholders within the rules with the values that match the 'key...
/**
* Replace any placeholders within the rules with the values that
* match the 'key' of any properties being set. For example, if
* we had the following $data array:
*
* [ 'id' => 13 ]
*
* and the following rule:
*
* 'required|is_unique[users,email,id,{id}]'
*
* The value of {id} would be replaced with the actual id in the form data:
*
* 'required|is_unique[users,email,id,13]'
*
* @param array $rules Validation rules
* @param array $data Data
*
* @codeCoverageIgnore
*
* @deprecated use fillPlaceholders($rules, $data) from Validation instead
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1778
⧉private get_action_html_entity_decode($result)
Defined in <ROOT>/app/Models/Frontend_model.php:122
⇄⧉public static classToArray($data, $primaryKey = null, string $dateFormat = 'datetime', bool $onlyChanged = true): array Takes a class an returns an array of it's public and protected properties as ...
/**
* Takes a class an returns an array of it's public and protected
* properties as an array suitable for use in creates and updates.
*
* @param object|string $data
* @param string|null $primaryKey
*
* @throws ReflectionException
*
* @codeCoverageIgnore
*
* @deprecated since 4.1
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:875
/**
* Constructor.
*
* @param \Config\Logger $config
*
* @throws RuntimeException
*/
Defined in <ROOT>/system/Log/Logger.php:120
⧉public emergency($message, array $context = array()): bool System is unusable.
/**
* System is unusable.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:158
⧉public alert($message, array $context = array()): bool Action must be taken immediately.
/**
* Action must be taken immediately.
*
* Example: Entire website down, database unavailable, etc. This should
* trigger the SMS alerts and wake you up.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:171
⧉public error($message, array $context = array()): bool Runtime errors that do not require immediate action but should typically be l...
/**
* Runtime errors that do not require immediate action but should typically
* be logged and monitored.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:194
⧉public warning($message, array $context = array()): bool Exceptional occurrences that are not errors.
/**
* Exceptional occurrences that are not errors.
*
* Example: Use of deprecated APIs, poor use of an API, undesirable things
* that are not necessarily wrong.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:207
⧉public notice($message, array $context = array()): bool Normal but significant events.
/**
* Normal but significant events.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:217
/**
* Detailed debug information.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:239
⧉public log($level, $message, array $context = array()): bool Logs with an arbitrary level.
/**
* Logs with an arbitrary level.
*
* @param string $level
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:250
⧉public determineFile(): array Determines the file and line that the logging call was made from by analyzing...
/**
* Determines the file and line that the logging call
* was made from by analyzing the backtrace.
* Find the earliest stack frame that is part of our logging system.
*/
Defined in <ROOT>/system/Log/Logger.php:372
⧉protected interpolate($message, array $context = array()): string Replaces any placeholders in the message with variables from the context, as ...
/**
* Replaces any placeholders in the message with variables
* from the context, as well as a few special items like:
*
* {session_vars}
* {post_vars}
* {get_vars}
* {env}
* {env:foo}
* {file}
* {line}
*
* @param string $message
*
* @return string
*/
Defined in <ROOT>/system/Log/Logger.php:316
⧉protected cleanFileNames(string $file): string Cleans the paths of filenames by replacing APPPATH, SYSTEMPATH, FCPATH with t...
/**
* Cleans the paths of filenames by replacing APPPATH, SYSTEMPATH, FCPATH
* with the actual var. i.e.
*
* /var/www/site/app/Controllers/Home.php
* becomes:
* APPPATH/Controllers/Home.php
*
* @deprecated Use dedicated `clean_path()` function.
*/
Defined in <ROOT>/system/Log/Logger.php:422
/**
* Constructor
*
* @param App $config
* @param string|null $body
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:151
⧉public detectLocale($config) Handles setting up the locale, perhaps auto-detecting through content negotia...
/**
* Handles setting up the locale, perhaps auto-detecting through
* content negotiation.
*
* @param App $config
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:212
⧉public detectPath(string $protocol = ''): string Detects the relative path based on the URIProtocol Config setting.
/**
* Detects the relative path based on
* the URIProtocol Config setting.
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:239
⧉public negotiate(string $type, array $supported, bool $strictMatch = false): string Provides a convenient way to work with the Negotiate class for content negoti...
/**
* Provides a convenient way to work with the Negotiate class
* for content negotiation.
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:355
⧉public is(string $type): bool Checks this request type.
/**
* Checks this request type.
*
* @param string $type HTTP verb or 'json' or 'ajax'
* @phpstan-param string|'get'|'post'|'put'|'delete'|'head'|'patch'|'options'|'json'|'ajax' $type
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:384
⧉public isCLI(): bool Determines if this request was made from the command line (CLI).
/**
* Determines if this request was made from the command line (CLI).
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:408
⧉public isAJAX(): bool Test to see if a request contains the HTTP_X_REQUESTED_WITH header.
/**
* Test to see if a request contains the HTTP_X_REQUESTED_WITH header.
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:416
⧉public isSecure(): bool Attempts to detect if the current connection is secure through a few differen...
/**
* Attempts to detect if the current connection is secure through
* a few different methods.
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:426
⧉public setPath(string $path, ?Config\App $config = null): $this Sets the relative path and updates the URI object.
/**
* Sets the relative path and updates the URI object.
*
* Note: Since current_url() accesses the shared request
* instance, this can be used to change the "current URL"
* for testing.
*
* @param string $path URI path relative to baseURL
* @param App|null $config Optional alternate config to use
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:451
⧉public getPath(): string Returns the URI path relative to baseURL, running detection as necessary.
/**
* Returns the URI path relative to baseURL,
* running detection as necessary.
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:523
⧉public setLocale(string $locale): IncomingRequest Sets the locale string for this request.
/**
* Sets the locale string for this request.
*
* @return IncomingRequest
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:537
⧉public getLocale(): string Gets the current locale, with a fallback to the default locale if none is set.
/**
* Gets the current locale, with a fallback to the default
* locale if none is set.
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:555
⧉public getDefaultLocale(): string Returns the default locale as set in Config\App.php
/**
* Returns the default locale as set in Config\App.php
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:563
⧉public getVar($index = null, $filter = null, $flags = null): array|bool|float|int|stdClass|string|null Fetch an item from JSON input stream with fallback to $_REQUEST object. This ...
/**
* Fetch an item from JSON input stream with fallback to $_REQUEST object. This is the simplest way
* to grab data from the request object and can be used in lieu of the
* other get* methods in most cases.
*
* @param array|string|null $index
* @param int|null $filter Filter constant
* @param array|int|null $flags
*
* @return array|bool|float|int|stdClass|string|null
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:579
⧉public getJSON(bool $assoc = false, int $depth = 512, int $options0): array|bool|float|int|stdClass|null A convenience method that grabs the raw input stream and decodes the JSON int...
/**
* A convenience method that grabs the raw input stream and decodes
* the JSON into an array.
*
* If $assoc == true, then all objects in the response will be converted
* to associative arrays.
*
* @param bool $assoc Whether to return objects as associative arrays
* @param int $depth How many levels deep to decode
* @param int $options Bitmask of options
*
* @see http://php.net/manual/en/function.json-decode.php
*
* @return array|bool|float|int|stdClass|null
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:606
⧉public getJsonVar($index = null, bool $assoc = false, ?int $filter = null, $flags = null): array|bool|float|int|stdClass|string|null Get a specific variable from a JSON input stream
/**
* Get a specific variable from a JSON input stream
*
* @param array|string|null $index The variable that you want which can use dot syntax for getting specific values.
* @param bool $assoc If true, return the result as an associative array.
* @param int|null $filter Filter Constant
* @param array|int|null $flags Option
*
* @return array|bool|float|int|stdClass|string|null
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:621
⧉public getRawInput(): array A convenience method that grabs the raw input stream(send method in PUT, PATC...
/**
* A convenience method that grabs the raw input stream(send method in PUT, PATCH, DELETE) and decodes
* the String into an array.
*
* @return array
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:696
⧉public getRawInputVar($index = null, ?int $filter = null, $flags = null): array|bool|float|int|object|string|null Gets a specific variable from raw input stream (send method in PUT, PATCH, DE...
/**
* Gets a specific variable from raw input stream (send method in PUT, PATCH, DELETE).
*
* @param array|string|null $index The variable that you want which can use dot syntax for getting specific values.
* @param int|null $filter Filter Constant
* @param array|int|null $flags Option
*
* @return array|bool|float|int|object|string|null
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:712
⧉public getGet($index = null, $filter = null, $flags = null): array|bool|float|int|object|string|null Fetch an item from GET data.
/**
* Fetch an item from GET data.
*
* @param array|string|null $index Index for item to fetch from $_GET.
* @param int|null $filter A filter name to apply.
* @param array|int|null $flags
*
* @return array|bool|float|int|object|string|null
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:766
⧉public getPost($index = null, $filter = null, $flags = null): array|bool|float|int|object|string|null Fetch an item from POST.
/**
* Fetch an item from POST.
*
* @param array|string|null $index Index for item to fetch from $_POST.
* @param int|null $filter A filter name to apply
* @param array|int|null $flags
*
* @return array|bool|float|int|object|string|null
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:780
⧉public getPostGet($index = null, $filter = null, $flags = null): array|bool|float|int|object|string|null Fetch an item from POST data with fallback to GET.
/**
* Fetch an item from POST data with fallback to GET.
*
* @param array|string|null $index Index for item to fetch from $_POST or $_GET
* @param int|null $filter A filter name to apply
* @param array|int|null $flags
*
* @return array|bool|float|int|object|string|null
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:794
⧉public getGetPost($index = null, $filter = null, $flags = null): array|bool|float|int|object|string|null Fetch an item from GET data with fallback to POST.
/**
* Fetch an item from GET data with fallback to POST.
*
* @param array|string|null $index Index for item to be fetched from $_GET or $_POST
* @param int|null $filter A filter name to apply
* @param array|int|null $flags
*
* @return array|bool|float|int|object|string|null
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:816
⧉public getCookie($index = null, $filter = null, $flags = null): array|bool|float|int|object|string|null Fetch an item from the COOKIE array.
/**
* Fetch an item from the COOKIE array.
*
* @param array|string|null $index Index for item to be fetched from $_COOKIE
* @param int|null $filter A filter name to be applied
* @param array|int|null $flags
*
* @return array|bool|float|int|object|string|null
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:838
⧉public getUserAgent(): UserAgent Fetch the user agent string
/**
* Fetch the user agent string
*
* @return UserAgent
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:848
⧉public getOldInput(string $key): array|string|null Attempts to get old Input data that has been flashed to the session with redi...
/**
* Attempts to get old Input data that has been flashed to the session
* with redirect_with_input(). It first checks for the data in the old
* POST data, then the old GET data and finally check for dot arrays
*
* @return array|string|null
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:860
⧉public getFiles(): array Returns an array of all files that have been uploaded with this request. Each...
/**
* Returns an array of all files that have been uploaded with this
* request. Each file is represented by an UploadedFile instance.
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:904
⧉public getFileMultiple(string $fileID): array|null Verify if a file exist, by the name of the input field used to upload it, in ...
/**
* Verify if a file exist, by the name of the input field used to upload it, in the collection
* of uploaded files and if is have been uploaded with multiple option.
*
* @return array|null
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:919
⧉public getFile(string $fileID): UploadedFile|null Retrieves a single file by the name of the input field used to upload it.
/**
* Retrieves a single file by the name of the input field used
* to upload it.
*
* @return UploadedFile|null
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:934
⧉public getIPAddress(): string Gets the user's IP address.
/**
* Gets the user's IP address.
*
* @return string IP address if it can be detected.
* If the IP address is not a valid IP address,
* then will return '0.0.0.0'.
*/
Inherited from CodeIgniter\HTTP\Request
Defined in <ROOT>/system/HTTP/RequestTrait.php:51
⧉public isValidIP(?string $ip = null, ?string $which = null): bool Validate an IP address
/**
* Validate an IP address
*
* @param string $ip IP Address
* @param string $which IP protocol: 'ipv4' or 'ipv6'
*
* @deprecated Use Validation instead
*
* @codeCoverageIgnore
*/
Inherited from CodeIgniter\HTTP\Request
Defined in <ROOT>/system/HTTP/Request.php:66
⧉public getMethod(bool $upper = false): string Get the request method.
/**
* Get the request method.
*
* @param bool $upper Whether to return in upper or lower case.
*
* @deprecated The $upper functionality will be removed and this will revert to its PSR-7 equivalent
*
* @codeCoverageIgnore
*/
Inherited from CodeIgniter\HTTP\Request
Defined in <ROOT>/system/HTTP/Request.php:80
⧉public setMethod(string $method): $this Sets the request method. Used when spoofing the request.
/**
* Sets the request method. Used when spoofing the request.
*
* @return $this
*
* @deprecated Use withMethod() instead for immutability
*
* @codeCoverageIgnore
*/
Inherited from CodeIgniter\HTTP\Request
Defined in <ROOT>/system/HTTP/Request.php:94
⧉public withMethod($method): static Returns an instance with the specified method.
/**
* Returns an instance with the specified method.
*
* @param string $method
*
* @return static
*/
Inherited from CodeIgniter\HTTP\Request
Defined in <ROOT>/system/HTTP/Request.php:108
⧉public getUri(): URI Retrieves the URI instance.
/**
* Retrieves the URI instance.
*
* @return URI
*/
Inherited from CodeIgniter\HTTP\Request
Defined in <ROOT>/system/HTTP/Request.php:122
⧉public getServer($index = null, $filter = null, $flags = null): mixed Fetch an item from the $_SERVER array.
/**
* Fetch an item from the $_SERVER array.
*
* @param array|string|null $index Index for item to be fetched from $_SERVER
* @param int|null $filter A filter name to be applied
* @param array|int|null $flags
*
* @return mixed
*/
Inherited from CodeIgniter\HTTP\Request
Defined in <ROOT>/system/HTTP/RequestTrait.php:199
⧉public getEnv($index = null, $filter = null, $flags = null): mixed Fetch an item from the $_ENV array.
/**
* Fetch an item from the $_ENV array.
*
* @param array|string|null $index Index for item to be fetched from $_ENV
* @param int|null $filter A filter name to be applied
* @param array|int|null $flags
*
* @return mixed
*/
Inherited from CodeIgniter\HTTP\Request
Defined in <ROOT>/system/HTTP/RequestTrait.php:213
⧉public setGlobal(string $method, $value): $this Allows manually setting the value of PHP global, like $_GET, $_POST, etc.
/**
* Allows manually setting the value of PHP global, like $_GET, $_POST, etc.
*
* @param mixed $value
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Request
Defined in <ROOT>/system/HTTP/RequestTrait.php:225
⧉public fetchGlobal(string $method, $index = null, ?int $filter = null, $flags = null): array|bool|float|int|object|string|null Fetches one or more items from a global, like cookies, get, post, etc. Can op...
/**
* Fetches one or more items from a global, like cookies, get, post, etc.
* Can optionally filter the input when you retrieve it by passing in
* a filter.
*
* If $type is an array, it must conform to the input allowed by the
* filter_input_array method.
*
* http://php.net/manual/en/filter.filters.sanitize.php
*
* @param string $method Input filter constant
* @param array|string|null $index
* @param int|null $filter Filter constant
* @param array|int|null $flags Options
*
* @return array|bool|float|int|object|string|null
*/
Inherited from CodeIgniter\HTTP\Request
Defined in <ROOT>/system/HTTP/RequestTrait.php:249
⧉public withUri(CodeIgniter\HTTP\URI $uri, $preserveHost = false): static Returns an instance with the provided URI.
/**
* Returns an instance with the provided URI.
*
* @param URI $uri New request URI to use.
* @param bool $preserveHost Preserve the original state of the Host header.
*
* @return static
*/
Inherited from CodeIgniter\HTTP\OutgoingRequest
Defined in <ROOT>/system/HTTP/OutgoingRequest.php:125
⧉public getBody(): string|null Returns the Message's body.
/**
* Returns the Message's body.
*
* @return string|null
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/Message.php:52
⧉public setBody($data): self Sets the body of the current message.
/**
* Sets the body of the current message.
*
* @param string $data
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:52
⧉public appendBody($data): self Appends data to the body of the current message.
/**
* Appends data to the body of the current message.
*
* @param mixed $data
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:66
⧉public getHeaders(): array Returns an array containing all headers.
/**
* Returns an array containing all headers.
*
* @return array<string, Header> An array of the request headers
*
* @deprecated Use Message::headers() to make room for PSR-7
*
* @TODO Incompatible return value with PSR-7
*
* @codeCoverageIgnore
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/Message.php:68
⧉public populateHeaders(): void Populates the $headers array with any headers the server knows about.
/**
* Populates the $headers array with any headers the server knows about.
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:80
⧉public getHeader(string $name): array|Header|null Returns a single header object. If multiple headers with the same name exist,...
/**
* Returns a single header object. If multiple headers with the same
* name exist, then will return an array of header objects.
*
* @return array|Header|null
*
* @deprecated Use Message::header() to make room for PSR-7
*
* @TODO Incompatible return value with PSR-7
*
* @codeCoverageIgnore
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/Message.php:85
⧉public hasHeader(string $name): bool Determines whether a header exists.
/**
* Determines whether a header exists.
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/Message.php:93
⧉public headers(): array Returns an array containing all Headers.
/**
* Returns an array containing all Headers.
*
* @return array<string, Header> An array of the Header objects
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:107
⧉public getHeaderLine(string $name): string Retrieves a comma-separated string of the values for a single header.
/**
* Retrieves a comma-separated string of the values for a single header.
*
* This method returns all of the header values of the given
* case-insensitive header name as a string concatenated together using
* a comma.
*
* NOTE: Not all header values may be appropriately represented using
* comma concatenation. For such headers, use getHeader() instead
* and supply your own delimiter when concatenating.
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/Message.php:111
⧉public getProtocolVersion(): string Returns the HTTP Protocol Version.
/**
* Returns the HTTP Protocol Version.
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/Message.php:125
⧉public header($name): array|Header|null Returns a single Header object. If multiple headers with the same name exist,...
/**
* Returns a single Header object. If multiple headers with the same
* name exist, then will return an array of header objects.
*
* @param string $name
*
* @return array|Header|null
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:127
⧉public setHeader(string $name, $value): self Sets a header and it's value.
/**
* Sets a header and it's value.
*
* @param array|string|null $value
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:141
⧉public removeHeader(string $name): self Removes a header from the list of headers we track.
/**
* Removes a header from the list of headers we track.
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:166
⧉public appendHeader(string $name, ?string $value): self Adds an additional header value to any headers that accept multiple values (i...
/**
* Adds an additional header value to any headers that accept
* multiple values (i.e. are an array or implement ArrayAccess)
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:180
⧉public prependHeader(string $name, string $value): self Adds an additional header value to any headers that accept multiple values (i...
/**
* Adds an additional header value to any headers that accept
* multiple values (i.e. are an array or implement ArrayAccess)
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:197
⧉public setProtocolVersion(string $version): self Sets the HTTP protocol version.
/**
* Sets the HTTP protocol version.
*
* @return $this
*
* @throws HTTPException For invalid protocols
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:222
⧉protected detectURI(string $protocol, string $baseURL) Sets up our URI object based on the information we have. This is either provi...
/**
* Sets up our URI object based on the information we have. This is
* either provided by the user in the baseURL Config setting, or
* determined from the environment as needed.
*
* @deprecated $protocol and $baseURL are deprecated. No longer used.
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:230
⧉protected parseRequestURI(): string Will parse the REQUEST_URI and automatically detect the URI from it, fixing t...
/**
* Will parse the REQUEST_URI and automatically detect the URI from it,
* fixing the query string if necessary.
*
* @return string The URI it found.
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:269
/**
* Parse QUERY_STRING
*
* Will parse QUERY_STRING and automatically detect the URI from it.
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:327
⧉protected removeRelativeDirectory(string $uri): string Remove relative directory (../) and multi slashes (///)
/**
* Remove relative directory (../) and multi slashes (///)
*
* Do some final cleaning of the URI and return it, currently only used in static::_parse_request_uri()
*
* @deprecated Use URI::removeDotSegments() directly
*/
Defined in <ROOT>/system/HTTP/IncomingRequest.php:950
⧉protected populateGlobals(string $method) Saves a copy of the current state of one of several PHP globals so we can ret...
/**
* Saves a copy of the current state of one of several PHP globals
* so we can retrieve them later.
*/
Inherited from CodeIgniter\HTTP\Request
Defined in <ROOT>/system/HTTP/RequestTrait.php:337
⧉protected getHeaderName(string $name): string Takes a header name in any case, and returns the normal-case version of the h...
/**
* Takes a header name in any case, and returns the
* normal-case version of the header.
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:210
⧉private getPostMaxSize(): int
Defined in <ROOT>/system/HTTP/IncomingRequest.php:182
/**
* Constructor
*
* @param App $config
*
* @todo Recommend removing reliance on config injection
*/
Defined in <ROOT>/system/HTTP/Response.php:148
⧉public setStatusCode(int $code, string $reason = ''): $this Return an instance with the specified status code and, optionally, reason phr...
/**
* Return an instance with the specified status code and, optionally, reason phrase.
*
* If no reason phrase is specified, will default recommended reason phrase for
* the response's status code.
*
* @see http://tools.ietf.org/html/rfc7231#section-6
* @see http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
*
* @param int $code The 3-digit integer result code to set.
* @param string $reason The reason phrase to use with the
* provided status code; if none is provided, will
* default to the IANA name.
*
* @return $this
*
* @throws HTTPException For invalid status code arguments.
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:151
⧉public setDate(DateTime $date): $this Sets the date header
/**
* Sets the date header
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:179
⧉public setLink(CodeIgniter\Pager\PagerInterface $pager): $this Set the Link Header
/**
* Set the Link Header
*
* @see http://tools.ietf.org/html/rfc5988
*
* @return $this
*
* @todo Recommend moving to Pager
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:197
⧉public pretend(bool $pretend = true): $this Turns "pretend" mode on or off to aid in testing.
/**
* Turns "pretend" mode on or off to aid in testing.
*
* Note that this is not a part of the interface so
* should not be relied on outside of internal testing.
*
* @return $this
*
* @testTag only available to test code
*/
Defined in <ROOT>/system/HTTP/Response.php:199
⧉public getStatusCode(): int Gets the response status code.
/**
* Gets the response status code.
*
* The status code is a 3-digit integer result code of the server's attempt
* to understand and satisfy the request.
*
* @return int Status code.
*/
Defined in <ROOT>/system/HTTP/Response.php:214
⧉public setContentType(string $mime, string $charset = 'UTF-8'): $this Sets the Content Type header for this response with the mime type and, option...
/**
* Sets the Content Type header for this response with the mime type
* and, optionally, the charset.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:226
⧉public getReason(): string Gets the response response phrase associated with the status code.
/**
* Gets the response response phrase associated with the status code.
*
* @see http://tools.ietf.org/html/rfc7231#section-6
* @see http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
*
* @deprecated Use getReasonPhrase()
*
* @codeCoverageIgnore
*/
Defined in <ROOT>/system/HTTP/Response.php:233
⧉public setJSON($body, bool $unencoded = false): $this Converts the $body into JSON and sets the Content Type header.
/**
* Converts the $body into JSON and sets the Content Type header.
*
* @param array|string $body
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:246
⧉public getReasonPhrase(): string Reason phrase; must return an empty string if none present. Gets the response reason phrase associated with the status code.
/**
* Gets the response reason phrase associated with the status code.
*
* Because a reason phrase is not a required element in a response
* status line, the reason phrase value MAY be null. Implementations MAY
* choose to return the default RFC 7231 recommended reason phrase (or those
* listed in the IANA HTTP Status Code Registry) for the response's
* status code.
*
* @see http://tools.ietf.org/html/rfc7231#section-6
* @see http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
*
* @return string Reason phrase; must return an empty string if none present.
*/
Defined in <ROOT>/system/HTTP/Response.php:252
⧉public getJSON(): string|null Returns the current body, converted to JSON is it isn't already.
/**
* Returns the current body, converted to JSON is it isn't already.
*
* @return string|null
*
* @throws InvalidArgumentException If the body property is not array.
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:260
⧉public setXML($body): $this Converts $body into XML, and sets the correct Content-Type.
/**
* Converts $body into XML, and sets the correct Content-Type.
*
* @param array|string $body
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:278
⧉public getXML(): bool|string|null Retrieves the current body into XML and returns it.
/**
* Retrieves the current body into XML and returns it.
*
* @return bool|string|null
*
* @throws InvalidArgumentException If the body property is not array.
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:292
⧉public noCache(): $this Sets the appropriate headers to ensure this response is not cached by the bro...
/**
* Sets the appropriate headers to ensure this response
* is not cached by the browsers.
*
* @return $this
*
* @todo Recommend researching these directives, might need: 'private', 'no-transform', 'no-store', 'must-revalidate'
*
* @see DownloadResponse::noCache()
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:344
⧉public setCache(array $options = array()): $this A shortcut method that allows the developer to set all of the cache-control h...
/**
* A shortcut method that allows the developer to set all of the
* cache-control headers in one method call.
*
* The options array is used to provide the cache-control directives
* for the header. It might look something like:
*
* $options = [
* 'max-age' => 300,
* 's-maxage' => 900
* 'etag' => 'abcde',
* ];
*
* Typical options are:
* - etag
* - last-modified
* - max-age
* - s-maxage
* - private
* - public
* - must-revalidate
* - proxy-revalidate
* - no-transform
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:378
⧉public setLastModified($date): $this Sets the Last-Modified date header.
/**
* Sets the Last-Modified date header.
*
* $date can be either a string representation of the date or,
* preferably, an instance of DateTime.
*
* @param DateTime|string $date
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:415
⧉public send(): $this Sends the output to the browser.
/**
* Sends the output to the browser.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:436
⧉public sendHeaders(): $this Sends the headers of this HTTP response to the browser.
/**
* Sends the headers of this HTTP response to the browser.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:458
⧉public sendBody(): $this Sends the Body of the message to the browser.
/**
* Sends the Body of the message to the browser.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:487
⧉public redirect(string $uri, string $method = 'auto', ?int $code = null): $this Perform a redirect to a new URL, in two flavors: header or location.
/**
* Perform a redirect to a new URL, in two flavors: header or location.
*
* @param string $uri The URI to redirect to
* @param int|null $code The type of redirection, defaults to 302
*
* @return $this
*
* @throws HTTPException For invalid status code.
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:504
/**
* Set a cookie
*
* Accepts an arbitrary number of binds (up to 7) or an associative
* array in the first parameter containing all the values.
*
* @param array|Cookie|string $name Cookie name / array containing binds / Cookie object
* @param string $value Cookie value
* @param string $expire Cookie expiration time in seconds
* @param string $domain Cookie domain (e.g.: '.yourdomain.com')
* @param string $path Cookie path (default: '/')
* @param string $prefix Cookie name prefix ('': the default prefix)
* @param bool|null $secure Whether to only transfer cookies via SSL
* @param bool|null $httponly Whether only make the cookie accessible via HTTP (no javascript)
* @param string|null $samesite
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:567
⧉public getCookieStore(): CookieStore Returns the `CookieStore` instance.
/**
* Returns the `CookieStore` instance.
*
* @return CookieStore
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:626
⧉public hasCookie(string $name, ?string $value = null, string $prefix = ''): bool Checks to see if the Response has a specified cookie or not.
/**
* Checks to see if the Response has a specified cookie or not.
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:634
/**
* Returns the cookie
*
* @param string $prefix Cookie prefix.
* '': the default prefix
*
* @return Cookie|Cookie[]|null
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:649
⧉public deleteCookie(string $name = '', string $domain = '', string $path = '/', string $prefix = ''): $this Sets a cookie to be deleted when the response is sent.
/**
* Sets a cookie to be deleted when the response is sent.
*
* @return $this
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:671
⧉public getCookies(): Cookie[] Returns all cookies currently set.
/**
* Returns all cookies currently set.
*
* @return Cookie[]
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:714
⧉public download(string $filename = '', $data = '', bool $setMime = false): DownloadResponse|null Force a download.
/**
* Force a download.
*
* Generates the headers that force a download to happen. And
* sends the file to the browser.
*
* @param string $filename The name you want the downloaded file to be named
* or the path to the file to send
* @param string|null $data The data to be downloaded. Set null if the $filename is the file path
* @param bool $setMime Whether to try and send the actual MIME type
*
* @return DownloadResponse|null
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:788
Defined in <ROOT>/system/HTTP/ResponseTrait.php:812
⧉public getBody(): string|null Returns the Message's body.
/**
* Returns the Message's body.
*
* @return string|null
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/Message.php:52
⧉public setBody($data): self Sets the body of the current message.
/**
* Sets the body of the current message.
*
* @param string $data
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:52
⧉public appendBody($data): self Appends data to the body of the current message.
/**
* Appends data to the body of the current message.
*
* @param mixed $data
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:66
⧉public getHeaders(): array Returns an array containing all headers.
/**
* Returns an array containing all headers.
*
* @return array<string, Header> An array of the request headers
*
* @deprecated Use Message::headers() to make room for PSR-7
*
* @TODO Incompatible return value with PSR-7
*
* @codeCoverageIgnore
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/Message.php:68
⧉public populateHeaders(): void Populates the $headers array with any headers the server knows about.
/**
* Populates the $headers array with any headers the server knows about.
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:80
⧉public getHeader(string $name): array|Header|null Returns a single header object. If multiple headers with the same name exist,...
/**
* Returns a single header object. If multiple headers with the same
* name exist, then will return an array of header objects.
*
* @return array|Header|null
*
* @deprecated Use Message::header() to make room for PSR-7
*
* @TODO Incompatible return value with PSR-7
*
* @codeCoverageIgnore
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/Message.php:85
⧉public hasHeader(string $name): bool Determines whether a header exists.
/**
* Determines whether a header exists.
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/Message.php:93
⧉public headers(): array Returns an array containing all Headers.
/**
* Returns an array containing all Headers.
*
* @return array<string, Header> An array of the Header objects
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:107
⧉public getHeaderLine(string $name): string Retrieves a comma-separated string of the values for a single header.
/**
* Retrieves a comma-separated string of the values for a single header.
*
* This method returns all of the header values of the given
* case-insensitive header name as a string concatenated together using
* a comma.
*
* NOTE: Not all header values may be appropriately represented using
* comma concatenation. For such headers, use getHeader() instead
* and supply your own delimiter when concatenating.
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/Message.php:111
⧉public getProtocolVersion(): string Returns the HTTP Protocol Version.
/**
* Returns the HTTP Protocol Version.
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/Message.php:125
⧉public header($name): array|Header|null Returns a single Header object. If multiple headers with the same name exist,...
/**
* Returns a single Header object. If multiple headers with the same
* name exist, then will return an array of header objects.
*
* @param string $name
*
* @return array|Header|null
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:127
⧉public setHeader(string $name, $value): self Sets a header and it's value.
/**
* Sets a header and it's value.
*
* @param array|string|null $value
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:141
⧉public removeHeader(string $name): self Removes a header from the list of headers we track.
/**
* Removes a header from the list of headers we track.
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:166
⧉public appendHeader(string $name, ?string $value): self Adds an additional header value to any headers that accept multiple values (i...
/**
* Adds an additional header value to any headers that accept
* multiple values (i.e. are an array or implement ArrayAccess)
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:180
⧉public prependHeader(string $name, string $value): self Adds an additional header value to any headers that accept multiple values (i...
/**
* Adds an additional header value to any headers that accept
* multiple values (i.e. are an array or implement ArrayAccess)
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:197
⧉public setProtocolVersion(string $version): self Sets the HTTP protocol version.
/**
* Sets the HTTP protocol version.
*
* @return $this
*
* @throws HTTPException For invalid protocols
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:222
⧉protected formatBody($body, string $format): mixed Handles conversion of the data into the appropriate format, and sets the corr...
/**
* Handles conversion of the data into the appropriate format,
* and sets the correct Content-Type header for our response.
*
* @param array|string $body
* @param string $format Valid: json, xml
*
* @return mixed
*
* @throws InvalidArgumentException If the body property is not string or array.
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:314
⧉protected sendCookies() Actually sets the cookies.
/**
* Actually sets the cookies.
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:722
⧉protected getHeaderName(string $name): string Takes a header name in any case, and returns the normal-case version of the h...
/**
* Takes a header name in any case, and returns the
* normal-case version of the header.
*/
Inherited from CodeIgniter\HTTP\Message
Defined in <ROOT>/system/HTTP/MessageTrait.php:210
⧉private dispatchCookies(): void
Defined in <ROOT>/system/HTTP/ResponseTrait.php:731
⧉private doSetRawCookie(string $name, string $value, array $options): void Extracted call to `setrawcookie()` in order to run unit tests on it.
/**
* Extracted call to `setrawcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:760
⧉private doSetCookie(string $name, string $value, array $options): void Extracted call to `setcookie()` in order to run unit tests on it.
/**
* Extracted call to `setcookie()` in order to run unit tests on it.
*
* @codeCoverageIgnore
*/
Defined in <ROOT>/system/HTTP/ResponseTrait.php:770
/**
* Constructor.
*
* Extract configuration settings and save them here.
*/
Defined in <ROOT>/system/Session/Session.php:164
⧉public start(): $this|void Initialize the session container and starts up the session.
/**
* Initialize the session container and starts up the session.
*
* @return $this|void
*/
Defined in <ROOT>/system/Session/Session.php:218
⧉public stop() Does a full stop of the session:
/**
* Does a full stop of the session:
*
* - destroys the session
* - unsets the session id
* - destroys the session cookie
*/
Defined in <ROOT>/system/Session/Session.php:281
⧉public regenerate(bool $destroy = false) Regenerates the session ID.
/**
* Regenerates the session ID.
*
* @param bool $destroy Should old session data be destroyed?
*/
Defined in <ROOT>/system/Session/Session.php:420
⧉public destroy() Destroys the current session.
/**
* Destroys the current session.
*/
Defined in <ROOT>/system/Session/Session.php:451
⧉public set($data, $value = null) Sets user data into the session.
/**
* Sets user data into the session.
*
* If $data is a string, then it is interpreted as a session property
* key, and $value is expected to be non-null.
*
* If $data is an array, it is expected to be an array of key/value pairs
* to be set as session properties.
*
* @param array|string $data Property name or associative array of properties
* @param array|bool|float|int|object|string|null $value Property value if single key provided
*/
Defined in <ROOT>/system/Session/Session.php:472
⧉public get(?string $key = null): array|bool|float|int|object|string|null The property value(s) Get user data that has been set in the session.
/**
* Get user data that has been set in the session.
*
* If the property exists as "normal", returns it.
* Otherwise, returns an array of any temp or flash data values with the
* property key.
*
* Replaces the legacy method $session->userdata();
*
* @param string|null $key Identifier of the session property to retrieve
*
* @return array|bool|float|int|object|string|null The property value(s)
*/
Defined in <ROOT>/system/Session/Session.php:502
⧉public has(string $key): bool Returns whether an index exists in the session array.
/**
* Returns whether an index exists in the session array.
*
* @param string $key Identifier of the session property we are interested in.
*/
Defined in <ROOT>/system/Session/Session.php:535
⧉public push(string $key, array $data) Push new value onto session value that is array.
/**
* Push new value onto session value that is array.
*
* @param string $key Identifier of the session property we are interested in.
* @param array $data value to be pushed to existing session key.
*/
Defined in <ROOT>/system/Session/Session.php:546
⧉public remove($key) Remove one or more session properties.
/**
* Remove one or more session properties.
*
* If $key is an array, it is interpreted as an array of string property
* identifiers to remove. Otherwise, it is interpreted as the identifier
* of a specific session property to remove.
*
* @param array|string $key Identifier of the session property or properties to remove.
*/
Defined in <ROOT>/system/Session/Session.php:562
⧉public __set(string $key, $value) Magic method to set variables in the session by simply calling $session->foo ...
/**
* Magic method to set variables in the session by simply calling
* $session->foo = bar;
*
* @param string $key Identifier of the session property to set.
* @param array|string $value
*/
Defined in <ROOT>/system/Session/Session.php:582
⧉public __get(string $key): string|null Magic method to get session variables by simply calling $foo = $session->foo;
/**
* Magic method to get session variables by simply calling
* $foo = $session->foo;
*
* @param string $key Identifier of the session property to remove.
*
* @return string|null
*/
Defined in <ROOT>/system/Session/Session.php:595
⧉public __isset(string $key): bool Magic method to check for session variables. Different from has() in that it ...
/**
* Magic method to check for session variables.
* Different from has() in that it will validate 'session_id' as well.
* Mostly used by internal PHP functions, users should stick to has()
*
* @param string $key Identifier of the session property to remove.
*/
Defined in <ROOT>/system/Session/Session.php:617
⧉public setFlashdata($data, $value = null) Sets data into the session that will only last for a single request. Perfect ...
/**
* Sets data into the session that will only last for a single request.
* Perfect for use with single-use status update messages.
*
* If $data is an array, it is interpreted as an associative array of
* key/value pairs for flashdata properties.
* Otherwise, it is interpreted as the identifier of a specific
* flashdata property, with $value containing the property value.
*
* @param array|string $data Property identifier or associative array of properties
* @param array|bool|float|int|object|string|null $value Property value if $data is a scalar
*/
Defined in <ROOT>/system/Session/Session.php:634
⧉public getFlashdata(?string $key = null): array|null The requested property value, or an associative array of them Retrieve one or more items of flash data from the session.
/**
* Retrieve one or more items of flash data from the session.
*
* If the item key is null, return all flashdata.
*
* @param string $key Property identifier
*
* @return array|null The requested property value, or an associative array of them
*/
Defined in <ROOT>/system/Session/Session.php:649
⧉public keepFlashdata($key) Keeps a single piece of flash data alive for one more request.
/**
* Keeps a single piece of flash data alive for one more request.
*
* @param array|string $key Property identifier or array of them
*/
Defined in <ROOT>/system/Session/Session.php:674
⧉public markAsFlashdata($key): bool Mark a session property or properties as flashdata.
/**
* Mark a session property or properties as flashdata.
*
* @param array|string $key Property identifier or array of them
*
* @return bool False if any of the properties are not already set
*/
Defined in <ROOT>/system/Session/Session.php:686
⧉public unmarkFlashdata($key) Unmark data in the session as flashdata.
/**
* Unmark data in the session as flashdata.
*
* @param array|string $key Property identifier or array of them
*/
Defined in <ROOT>/system/Session/Session.php:716
⧉public getFlashKeys(): array Retrieve all of the keys for session data marked as flashdata.
/**
* Retrieve all of the keys for session data marked as flashdata.
*
* @return array The property names of all flashdata
*/
Defined in <ROOT>/system/Session/Session.php:742
⧉public setTempdata($data, $value = null, int $ttl = 300) Sets new data into the session, and marks it as temporary data with a set lif...
/**
* Sets new data into the session, and marks it as temporary data
* with a set lifespan.
*
* @param array|string $data Session data key or associative array of items
* @param array|bool|float|int|object|string|null $value Value to store
* @param int $ttl Time-to-live in seconds
*/
Defined in <ROOT>/system/Session/Session.php:767
⧉public getTempdata(?string $key = null): array|bool|float|int|object|string|null Session data value or null if not found. Returns either a single piece of tempdata, or all temp data currently in the ...
/**
* Returns either a single piece of tempdata, or all temp data currently
* in the session.
*
* @param string $key Session data key
*
* @return array|bool|float|int|object|string|null Session data value or null if not found.
*/
Defined in <ROOT>/system/Session/Session.php:781
⧉public removeTempdata(string $key) Removes a single piece of temporary data from the session.
/**
* Removes a single piece of temporary data from the session.
*
* @param string $key Session data key
*/
Defined in <ROOT>/system/Session/Session.php:806
⧉public markAsTempdata($key, int $ttl = 300): bool Mark one of more pieces of data as being temporary, meaning that it has a set...
/**
* Mark one of more pieces of data as being temporary, meaning that
* it has a set lifespan within the session.
*
* @param array|string $key Property identifier or array of them
* @param int $ttl Time to live, in seconds
*
* @return bool False if any of the properties were not set
*/
Defined in <ROOT>/system/Session/Session.php:821
⧉public unmarkTempdata($key) Unmarks temporary data in the session, effectively removing its lifespan and ...
/**
* Unmarks temporary data in the session, effectively removing its
* lifespan and allowing it to live as long as the session does.
*
* @param array|string $key Property identifier or array of them
*/
Defined in <ROOT>/system/Session/Session.php:866
⧉public getTempKeys(): array Retrieve the keys of all session data that have been marked as temporary data.
/**
* Retrieve the keys of all session data that have been marked as temporary data.
*/
Defined in <ROOT>/system/Session/Session.php:890
⧉protected configure() Configuration.
/**
* Configuration.
*
* Handle input binds and configuration defaults.
*/
Defined in <ROOT>/system/Session/Session.php:297
⧉protected configureSidLength() Configure session ID length
/**
* Configure session ID length
*
* To make life easier, we used to force SHA-1 and 4 bits per
* character on everyone. And of course, someone was unhappy.
*
* Then PHP 7.1 broke backwards-compatibility because ext/session
* is such a mess that nobody wants to touch it with a pole stick,
* and the one guy who does, nobody has the energy to argue with.
*
* So we were forced to make changes, and OF COURSE something was
* going to break and now we have this pile of shit. -- Narf
*/
Defined in <ROOT>/system/Session/Session.php:351
⧉protected initVars() Handle temporary variables
/**
* Handle temporary variables
*
* Clears old "flash" data, marks the new one for deletion and handles
* "temp" data deletion.
*/
Defined in <ROOT>/system/Session/Session.php:392
⧉protected setSaveHandler() Sets the driver as the session handler in PHP. Extracted for easier testing.
/**
* Sets the driver as the session handler in PHP.
* Extracted for easier testing.
*/
Defined in <ROOT>/system/Session/Session.php:911
⧉protected startSession() Starts the session. Extracted for testing reasons.
/**
* Starts the session.
* Extracted for testing reasons.
*/
Defined in <ROOT>/system/Session/Session.php:920
⧉protected setCookie() Takes care of setting the cookie on the client side.
/**
* Takes care of setting the cookie on the client side.
*
* @codeCoverageIgnore
*/
Defined in <ROOT>/system/Session/Session.php:936
⧉private removeOldSessionCookie(): void
Defined in <ROOT>/system/Session/Session.php:428
protected validator -> null
protected vendorId -> string (0) ""
⧉public __construct()
Defined in <ROOT>/app/Controllers/Frontend.php:12
⧉public index()
Defined in <ROOT>/app/Controllers/Frontend.php:22
⧉public index_new($id)
Defined in <ROOT>/app/Controllers/Frontend.php:29
⧉public entersiteag()
Defined in <ROOT>/app/Controllers/Frontend.php:69
⧉public ziele()
Defined in <ROOT>/app/Controllers/Frontend.php:76
⧉public vorges()
Defined in <ROOT>/app/Controllers/Frontend.php:83
⧉public unter()
Defined in <ROOT>/app/Controllers/Frontend.php:90
⧉public abtei()
Defined in <ROOT>/app/Controllers/Frontend.php:98
⧉public demo()
Defined in <ROOT>/app/Controllers/Frontend.php:108
⧉public daten()
Defined in <ROOT>/app/Controllers/Frontend.php:116
⧉public story()
Defined in <ROOT>/app/Controllers/Frontend.php:125
⧉public portfolio()
Defined in <ROOT>/app/Controllers/Frontend.php:134
⧉public uberbetrieblichemain()
Defined in <ROOT>/app/Controllers/Frontend.php:145
⧉public uberbetrieblicheuk()
Defined in <ROOT>/app/Controllers/Frontend.php:153
⧉public beruflicheschule()
Defined in <ROOT>/app/Controllers/Frontend.php:164
⧉public beruflicheschulebws()
Defined in <ROOT>/app/Controllers/Frontend.php:170
⧉public zusatzlichematerialien()
Defined in <ROOT>/app/Controllers/Frontend.php:178
⧉public ausbildungsbetrieb()
Defined in <ROOT>/app/Controllers/Frontend.php:187
⧉public zusatzlichesmaterial()
Defined in <ROOT>/app/Controllers/Frontend.php:198
⧉public zusatzmaterialberufsschule()
Defined in <ROOT>/app/Controllers/Frontend.php:207
⧉public qualifikationsverfahren()
Defined in <ROOT>/app/Controllers/Frontend.php:217
⧉public ausbildungsbetriebe()
Defined in <ROOT>/app/Controllers/Frontend.php:226
⧉public podcast()
Defined in <ROOT>/app/Controllers/Frontend.php:234
⧉public ausbildungsordnung()
Defined in <ROOT>/app/Controllers/Frontend.php:242
⧉public lernzielkontrollen()
Defined in <ROOT>/app/Controllers/Frontend.php:250
⧉public lernzielkontrollen_result($id)
Defined in <ROOT>/app/Controllers/Frontend.php:261
⧉public lernziel_detail($id)
Defined in <ROOT>/app/Controllers/Frontend.php:278
⧉public lernzielkontrollen_detail($id)
Defined in <ROOT>/app/Controllers/Frontend.php:285
⧉public lernzielkontrollen_test($id)
Defined in <ROOT>/app/Controllers/Frontend.php:293
⧉public get_sub($id)
Defined in <ROOT>/app/Controllers/Frontend.php:305
⧉public get_child($id)
Defined in <ROOT>/app/Controllers/Frontend.php:313
/**
* Constructor.
*
* @throws HTTPException
*/
Inherited from CodeIgniter\Controller
Defined in <ROOT>/system/Controller.php:74
⧉protected forceHTTPS(int $duration = 31536000) A convenience method to use when you need to ensure that a single method is r...
/**
* A convenience method to use when you need to ensure that a single
* method is reached only via HTTPS. If it isn't, then a redirect
* will happen back to this method and HSTS header will be sent
* to have modern browsers transform requests automatically.
*
* @param int $duration The number of seconds this link should be
* considered secure for. Only with HSTS header.
* Default value is 1 year.
*
* @throws HTTPException
*/
Inherited from CodeIgniter\Controller
Defined in <ROOT>/system/Controller.php:100
⧉protected cachePage(int $time) Provides a simple way to tie into the main CodeIgniter class and tell it how ...
/**
* Provides a simple way to tie into the main CodeIgniter class and
* tell it how long to cache the current page for.
*/
Inherited from CodeIgniter\Controller
Defined in <ROOT>/system/Controller.php:109
/**
* Handles "auto-loading" helper files.
*
* @deprecated Use `helper` function instead of using this method.
*
* @codeCoverageIgnore
*/
Inherited from CodeIgniter\Controller
Defined in <ROOT>/system/Controller.php:121
⧉protected validate($rules, array $messages = array()): bool A shortcut to performing validation on Request data.
/**
* A shortcut to performing validation on Request data.
*
* @param array|string $rules
* @param array $messages An array of custom error messages
*/
Inherited from CodeIgniter\Controller
Defined in <ROOT>/system/Controller.php:136
⧉protected validateData(array $data, $rules, array $messages = array(), ?string $dbGroup = null): bool A shortcut to performing validation on any input data.
/**
* A shortcut to performing validation on any input data.
*
* @param array $data The data to validate
* @param array|string $rules
* @param array $messages An array of custom error messages
* @param string|null $dbGroup The database group to use
*/
Inherited from CodeIgniter\Controller
Defined in <ROOT>/system/Controller.php:151
public date_time -> string (19) "2023-11-09 17:00:44"
public department_id -> string (2) "24"
⧉public description -> UTF-8 string (379) "Wir verpacken Güter, aber warum eigentlich? Die Verpackung dient einerseits ...
Wir verpacken Güter, aber warum eigentlich? Die Verpackung dient einerseits dem Schutz der Güter, andererseits übernimmt sie aber auch logistische und Informationsaufgaben. Diese Informationen tragen dazu bei, dass die Güter zur richtigen Zeit am richtigen Ort sind. Verpackungen unterliegen einem stetigen Wandel. Dabei gewinnt die Nachhaltigkeit mehr und mehr an Bedeutung.
public download_link -> string (0) ""
public hour -> string (11) "4 Lektionen"
public id -> string (2) "46"
public level -> string (1) "1"
public name -> string (41) "Modul 602 Versandbereite Pakete erstellen"
public print_link -> string (0) ""
public share_link -> string (0) ""
public skills -> string (2) "9,"
public status -> string (1) "0"
public submitted_by -> string (6) "hodler"
public tags -> string (3) "12,"
public title -> string (41) "Modul 602 Versandbereite Pakete erstellen"
public updated_at -> string (19) "2022-02-11 14:05:26"
public video -> string (36) "https://www.nanoo.tv/link/v/AWtvujqJ"
⧉public initialize(Config\Autoload $config, Config\Modules $modules): $this Reads in the configuration array (described above) and stores the valid parts...
/**
* Reads in the configuration array (described above) and stores
* the valid parts that we'll need.
*
* @return $this
*/
Defined in <ROOT>/system/Autoloader/Autoloader.php:96
⧉public register() Register the loader with the SPL autoloader stack.
/**
* Register the loader with the SPL autoloader stack.
*/
Defined in <ROOT>/system/Autoloader/Autoloader.php:152
⧉public unregister(): void Unregister autoloader.
/**
* Unregister autoloader.
*
* This method is for testing.
*/
Defined in <ROOT>/system/Autoloader/Autoloader.php:171
⧉public addNamespace($namespace, ?string $path = null): $this Registers namespaces with the autoloader.
/**
* Registers namespaces with the autoloader.
*
* @param array<string, array<int, string>|string>|string $namespace
* @phpstan-param array<string, list<string>|string>|string $namespace
*
* @return $this
*/
Defined in <ROOT>/system/Autoloader/Autoloader.php:185
⧉public getNamespace(?string $prefix = null): array Get namespaces with prefixes as keys and paths as values.
/**
* Get namespaces with prefixes as keys and paths as values.
*
* If a prefix param is set, returns only paths to the given prefix.
*
* @return array
*/
Defined in <ROOT>/system/Autoloader/Autoloader.php:215
⧉public removeNamespace(string $namespace): $this Removes a single namespace from the psr4 settings.
/**
* Removes a single namespace from the psr4 settings.
*
* @return $this
*/
Defined in <ROOT>/system/Autoloader/Autoloader.php:229
⧉public loadClassmap(string $class): false|string Load a class using available class mapping.
/**
* Load a class using available class mapping.
*
* @return false|string
*/
Defined in <ROOT>/system/Autoloader/Autoloader.php:243
⧉public loadClass(string $class): false|string The mapped file on success, or boolean false Loads the class file for a given class name.
/**
* Loads the class file for a given class name.
*
* @param string $class The fully qualified class name.
*
* @return false|string The mapped file on success, or boolean false
* on failure.
*/
Defined in <ROOT>/system/Autoloader/Autoloader.php:262
/**
* Check file path.
*
* Checks special characters that are illegal in filenames on certain
* operating systems and special characters requiring special escaping
* to manipulate at the command line. Replaces spaces and consecutive
* dashes with a single dash. Trim period, dash and underscore from beginning
* and end of filename.
*
* @return string The sanitized filename
*/
Defined in <ROOT>/system/Autoloader/Autoloader.php:331
⧉public loadHelpers(): void Loads helpers
/**
* Loads helpers
*/
Defined in <ROOT>/system/Autoloader/Autoloader.php:483
⧉protected loadInNamespace(string $class): false|string The mapped file name on success, or boolean false on fail Loads the class file for a given class name.
/**
* Loads the class file for a given class name.
*
* @param string $class The fully-qualified class name
*
* @return false|string The mapped file name on success, or boolean false on fail
*/
Defined in <ROOT>/system/Autoloader/Autoloader.php:277
⧉protected includeFile(string $file): false|string The filename on success, false if the file is not loaded A central way to include a file. Split out primarily for testing purposes.
/**
* A central way to include a file. Split out primarily for testing purposes.
*
* @return false|string The filename on success, false if the file is not loaded
*/
Defined in <ROOT>/system/Autoloader/Autoloader.php:307
⧉protected discoverComposerNamespaces() Locates autoload information from Composer, if available.
/**
* Locates autoload information from Composer, if available.
*
* @deprecated No longer used.
*/
Defined in <ROOT>/system/Autoloader/Autoloader.php:449
Defined in <ROOT>/system/Autoloader/FileLocator.php:27
⧉public locateFile(string $file, ?string $folder = null, string $ext = 'php'): false|string The path to the file, or false if not found. Attempts to locate a file by examining the name for a namespace and looking t...
/**
* Attempts to locate a file by examining the name for a namespace
* and looking through the PSR-4 namespaced files that we know about.
*
* @param string $file The namespaced file to locate
* @param string|null $folder The folder within the namespace that we should look for the file.
* @param string $ext The file extension the file should have.
*
* @return false|string The path to the file, or false if not found.
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:42
⧉public getClassname(string $file): string Examines a file and returns the fully qualified class name.
/**
* Examines a file and returns the fully qualified class name.
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:113
⧉public search(string $path, string $ext = 'php', bool $prioritizeApp = true): array Searches through all of the defined namespaces looking for a file. Returns an...
/**
* Searches through all of the defined namespaces looking for a file.
* Returns an array of all found locations for the defined file.
*
* Example:
*
* $locator->search('Config/Routes.php');
* // Assuming PSR4 namespaces include foo and bar, might return:
* [
* 'app/Modules/foo/Config/Routes.php',
* 'app/Modules/bar/Config/Routes.php',
* ]
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:166
⧉public findQualifiedNameFromPath(string $path): false|string The qualified name or false if the path is not found Find the qualified name of a file according to the namespace of the first mat...
/**
* Find the qualified name of a file according to
* the namespace of the first matched namespace path.
*
* @return false|string The qualified name or false if the path is not found
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:253
⧉public listFiles(string $path): array Scans the defined namespaces, returning a list of all files that are containe...
/**
* Scans the defined namespaces, returning a list of all files
* that are contained within the subpath specified by $path.
*
* @return string[] List of file paths
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:295
⧉public listNamespaceFiles(string $prefix, string $path): array Scans the provided namespace, returning a list of all files that are containe...
/**
* Scans the provided namespace, returning a list of all files
* that are contained within the sub path specified by $path.
*
* @return string[] List of file paths
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:328
⧉protected ensureExt(string $path, string $ext): string Ensures a extension is at the end of a filename
/**
* Ensures a extension is at the end of a filename
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:199
⧉protected getNamespaces(): array<int, array<string, string>> Return the namespace mappings we know about.
/**
* Return the namespace mappings we know about.
*
* @return array<int, array<string, string>>
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:217
⧉protected legacyLocate(string $file, ?string $folder = null): false|string The path to the file, or false if not found. Checks the app folder to see if the file can be found. Only for use with file...
/**
* Checks the app folder to see if the file can be found.
* Only for use with filenames that DO NOT include namespacing.
*
* @return false|string The path to the file, or false if not found.
*/
Defined in <ROOT>/system/Autoloader/FileLocator.php:362
/**
* Constructor
*/
Defined in <ROOT>/system/Log/Handlers/FileHandler.php:46
⧉public handle($level, $message): bool Handles logging the message. If the handler returns false, then execution of ...
/**
* Handles logging the message.
* If the handler returns false, then execution of handlers
* will stop. Any handlers that have not run, yet, will not
* be run.
*
* @param string $level
* @param string $message
*
* @throws Exception
*/
Defined in <ROOT>/system/Log/Handlers/FileHandler.php:69
⧉public canHandle(string $level): bool Checks whether the Handler will handle logging items of this log Level.
/**
* Checks whether the Handler will handle logging items of this
* log Level.
*/
Inherited from CodeIgniter\Log\Handlers\BaseHandler
Defined in <ROOT>/system/Log/Handlers/BaseHandler.php:45
⧉public setDateFormat(string $format): CodeIgniter\Log\Handlers\HandlerInterface Stores the date format to use while logging messages.
/**
* Stores the date format to use while logging messages.
*/
Inherited from CodeIgniter\Log\Handlers\BaseHandler
Defined in <ROOT>/system/Log/Handlers/BaseHandler.php:53
/**
* Constructor.
*
* @param \Config\Logger $config
*
* @throws RuntimeException
*/
Defined in <ROOT>/system/Log/Logger.php:120
⧉public emergency($message, array $context = array()): bool System is unusable.
/**
* System is unusable.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:158
⧉public alert($message, array $context = array()): bool Action must be taken immediately.
/**
* Action must be taken immediately.
*
* Example: Entire website down, database unavailable, etc. This should
* trigger the SMS alerts and wake you up.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:171
⧉public error($message, array $context = array()): bool Runtime errors that do not require immediate action but should typically be l...
/**
* Runtime errors that do not require immediate action but should typically
* be logged and monitored.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:194
⧉public warning($message, array $context = array()): bool Exceptional occurrences that are not errors.
/**
* Exceptional occurrences that are not errors.
*
* Example: Use of deprecated APIs, poor use of an API, undesirable things
* that are not necessarily wrong.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:207
⧉public notice($message, array $context = array()): bool Normal but significant events.
/**
* Normal but significant events.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:217
/**
* Detailed debug information.
*
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:239
⧉public log($level, $message, array $context = array()): bool Logs with an arbitrary level.
/**
* Logs with an arbitrary level.
*
* @param string $level
* @param string $message
*/
Defined in <ROOT>/system/Log/Logger.php:250
⧉public determineFile(): array Determines the file and line that the logging call was made from by analyzing...
/**
* Determines the file and line that the logging call
* was made from by analyzing the backtrace.
* Find the earliest stack frame that is part of our logging system.
*/
Defined in <ROOT>/system/Log/Logger.php:372
⧉protected interpolate($message, array $context = array()): string Replaces any placeholders in the message with variables from the context, as ...
/**
* Replaces any placeholders in the message with variables
* from the context, as well as a few special items like:
*
* {session_vars}
* {post_vars}
* {get_vars}
* {env}
* {env:foo}
* {file}
* {line}
*
* @param string $message
*
* @return string
*/
Defined in <ROOT>/system/Log/Logger.php:316
⧉protected cleanFileNames(string $file): string Cleans the paths of filenames by replacing APPPATH, SYSTEMPATH, FCPATH with t...
/**
* Cleans the paths of filenames by replacing APPPATH, SYSTEMPATH, FCPATH
* with the actual var. i.e.
*
* /var/www/site/app/Controllers/Home.php
* becomes:
* APPPATH/Controllers/Home.php
*
* @deprecated Use dedicated `clean_path()` function.
*/
Defined in <ROOT>/system/Log/Logger.php:422
⧉public render(string $view, ?array $options = null, ?bool $saveData = null): string Builds the output based upon a file name and any data that has already been set.
/**
* Builds the output based upon a file name and any
* data that has already been set.
*
* Valid $options:
* - cache Number of seconds to cache for
* - cache_name Name to use for cache
*
* @param string $view File name of the view source
* @param array|null $options Reserved for 3rd-party uses since
* it might be needed to pass additional info
* to other template engines.
* @param bool|null $saveData If true, saves data for subsequent calls,
* if false, cleans the data after displaying,
* if null, uses the config setting.
*/
Defined in <ROOT>/system/View/View.php:166
⧉public renderString(string $view, ?array $options = null, ?bool $saveData = null): string Builds the output based upon a string and any data that has already been set....
/**
* Builds the output based upon a string and any
* data that has already been set.
* Cache does not apply, because there is no "key".
*
* @param string $view The view contents
* @param array|null $options Reserved for 3rd-party uses since
* it might be needed to pass additional info
* to other template engines.
* @param bool|null $saveData If true, saves data for subsequent calls,
* if false, cleans the data after displaying,
* if null, uses the config setting.
*/
Defined in <ROOT>/system/View/View.php:277
⧉public excerpt(string $string, int $length = 20): string Extract first bit of a long string and add ellipsis
/**
* Extract first bit of a long string and add ellipsis
*/
Defined in <ROOT>/system/View/View.php:300
⧉public setData(array $data = array(), ?string $context = null): CodeIgniter\View\RendererInterface Sets several pieces of view data at once.
/**
* Sets several pieces of view data at once.
*
* @param string|null $context The context to escape it for: html, css, js, url
* If null, no escaping will happen
* @phpstan-param null|'html'|'js'|'css'|'url'|'attr'|'raw' $context
*/
Defined in <ROOT>/system/View/View.php:312
⧉public setVar(string $name, $value = null, ?string $context = null): CodeIgniter\View\RendererInterface Sets a single piece of view data.
/**
* Sets a single piece of view data.
*
* @param mixed $value
* @param string|null $context The context to escape it for: html, css, js, url
* If null, no escaping will happen
* @phpstan-param null|'html'|'js'|'css'|'url'|'attr'|'raw' $context
*/
Defined in <ROOT>/system/View/View.php:332
⧉public resetData(): CodeIgniter\View\RendererInterface Removes all of the view data from the system.
/**
* Removes all of the view data from the system.
*/
Defined in <ROOT>/system/View/View.php:347
⧉public getData(): array Returns the current data that will be displayed in the view.
/**
* Returns the current data that will be displayed in the view.
*/
Defined in <ROOT>/system/View/View.php:357
⧉public extend(string $layout) Specifies that the current view should extend an existing layout.
/**
* Specifies that the current view should extend an existing layout.
*/
Defined in <ROOT>/system/View/View.php:365
⧉public section(string $name) Starts holds content for a section within the layout.
/**
* Starts holds content for a section within the layout.
*
* @param string $name Section name
*/
Defined in <ROOT>/system/View/View.php:375
⧉public endSection() Captures the last section
/**
* Captures the last section
*
* @throws RuntimeException
*/
Defined in <ROOT>/system/View/View.php:389
⧉public renderSection(string $sectionName) Renders a section's contents.
/**
* Renders a section's contents.
*/
Defined in <ROOT>/system/View/View.php:410
⧉public include(string $view, ?array $options = null, $saveData = true): string Used within layout views to include additional views.
/**
* Used within layout views to include additional views.
*
* @param bool $saveData
*/
Defined in <ROOT>/system/View/View.php:429
⧉public getPerformanceData(): array Returns the performance data that might have been collected during the execut...
/**
* Returns the performance data that might have been collected
* during the execution. Used primarily in the Debug Toolbar.
*/
Defined in <ROOT>/system/View/View.php:438
⧉protected decorateOutput(string $html): string Runs the generated output through any declared view decorators.
/**
* Runs the generated output through any declared
* view decorators.
*/
Defined in <ROOT>/system/View/ViewDecoratorTrait.php:22
⧉protected logPerformance(float $start, float $end, string $view) Logs performance data for rendering a view.
/**
* Logs performance data for rendering a view.
*/
Defined in <ROOT>/system/View/View.php:446
/**
* Runs the validation process, returning true/false determining whether
* validation was successful or not.
*
* @param array|null $data The array of data to validate.
* @param string|null $group The predefined group of rules to apply.
* @param string|null $dbGroup The database group to use.
*/
Defined in <ROOT>/system/Validation/Validation.php:110
⧉public check($value, string $rule, array $errors = array()): bool Runs the validation process, returning true or false determining whether vali...
/**
* Runs the validation process, returning true or false
* determining whether validation was successful or not.
*
* @param array|bool|float|int|object|string|null $value
* @param string[] $errors
*/
Defined in <ROOT>/system/Validation/Validation.php:184
⧉public withRequest(CodeIgniter\HTTP\RequestInterface $request): CodeIgniter\Validation\ValidationInterface Takes a Request object and grabs the input data to use from its array values.
/**
* Takes a Request object and grabs the input data to use from its
* array values.
*/
Defined in <ROOT>/system/Validation/Validation.php:392
⧉public setRule(string $field, ?string $label, $rules, array $errors = array()): $this Sets an individual rule and custom error messages for a single field.
/**
* Sets an individual rule and custom error messages for a single field.
*
* The custom error message should be just the messages that apply to
* this field, like so:
*
* [
* 'rule' => 'message',
* 'rule' => 'message',
* ]
*
* @param array|string $rules
*
* @return $this
*
* @throws TypeError
*/
Defined in <ROOT>/system/Validation/Validation.php:429
⧉public setRules(array $rules, array $errors = array()): CodeIgniter\Validation\ValidationInterface Stores the rules that should be used to validate the items. Rules should be a...
/**
* Stores the rules that should be used to validate the items.
* Rules should be an array formatted like:
*
* [
* 'field' => 'rule1|rule2'
* ]
*
* The $errors array should be formatted like:
* [
* 'field' => [
* 'rule' => 'message',
* 'rule' => 'message
* ],
* ]
*
* @param array $errors // An array of custom error messages
*/
Defined in <ROOT>/system/Validation/Validation.php:469
⧉public getRules(): array Returns all of the rules currently defined.
/**
* Returns all of the rules currently defined.
*/
Defined in <ROOT>/system/Validation/Validation.php:496
⧉public hasRule(string $field): bool Checks to see if the rule for key $field has been set or not.
/**
* Checks to see if the rule for key $field has been set or not.
*/
Defined in <ROOT>/system/Validation/Validation.php:504
⧉public getRuleGroup(string $group): array Get rule group.
/**
* Get rule group.
*
* @param string $group Group.
*
* @return string[] Rule group.
*
* @throws ValidationException If group not found.
*/
Defined in <ROOT>/system/Validation/Validation.php:518
⧉public setRuleGroup(string $group) Set rule group.
/**
* Set rule group.
*
* @param string $group Group.
*
* @throws ValidationException If group not found.
*/
Defined in <ROOT>/system/Validation/Validation.php:538
⧉public listErrors(string $template = 'list'): string Returns the rendered HTML of the errors as defined in $template.
/**
* Returns the rendered HTML of the errors as defined in $template.
*
* You can also use validation_list_errors() in Form helper.
*/
Defined in <ROOT>/system/Validation/Validation.php:554
⧉public showError(string $field, string $template = 'single'): string Displays a single error in formatted HTML as defined in the $template view.
/**
* Displays a single error in formatted HTML as defined in the $template view.
*
* You can also use validation_show_error() in Form helper.
*/
Defined in <ROOT>/system/Validation/Validation.php:570
⧉public loadRuleGroup(?string $group = null): array Loads custom rule groups (if set) into the current rules.
/**
* Loads custom rule groups (if set) into the current rules.
*
* Rules can be pre-defined in Config\Validation and can
* be any name, but must all still be an array of the
* same format used with setRules(). Additionally, check
* for {group}_errors for an array of custom error messages.
*
* @return array
*
* @throws ValidationException
*/
Defined in <ROOT>/system/Validation/Validation.php:612
⧉public hasError(string $field): bool Checks to see if an error exists for the given field.
/**
* Checks to see if an error exists for the given field.
*/
Defined in <ROOT>/system/Validation/Validation.php:692
⧉public getError(?string $field = null): string Returns the error(s) for a specified $field (or empty string if not set).
/**
* Returns the error(s) for a specified $field (or empty string if not
* set).
*/
Defined in <ROOT>/system/Validation/Validation.php:703
⧉public getErrors(): array Returns the array of errors that were encountered during a run() call. The ar...
/**
* Returns the array of errors that were encountered during
* a run() call. The array should be in the following format:
*
* [
* 'field1' => 'error message',
* 'field2' => 'error message',
* ]
*
* @return array<string, string>
*
* @codeCoverageIgnore
*/
Defined in <ROOT>/system/Validation/Validation.php:730
⧉public setError(string $field, string $error): CodeIgniter\Validation\ValidationInterface Sets the error for a specific field. Used by custom validation methods.
/**
* Sets the error for a specific field. Used by custom validation methods.
*/
Defined in <ROOT>/system/Validation/Validation.php:738
⧉public reset(): CodeIgniter\Validation\ValidationInterface Resets the class to a blank slate. Should be called whenever you need to proc...
/**
* Resets the class to a blank slate. Should be called whenever
* you need to process more than one array.
*/
Defined in <ROOT>/system/Validation/Validation.php:827
⧉protected processRules(string $field, ?string $label, $value, $rules = null, ?array $data = null, ?string $originalField = null): bool Runs all of $rules against $field, until one fails, or all of them have been ...
/**
* Runs all of $rules against $field, until one fails, or
* all of them have been processed. If one fails, it adds
* the error to $this->errors and moves on to the next,
* so that we can collect all of the first errors.
*
* @param array|string $value
* @param array|null $rules
* @param array|null $data The array of data to validate, with `DBGroup`.
* @param string|null $originalField The original asterisk field name like "foo.*.bar".
*/
Defined in <ROOT>/system/Validation/Validation.php:202
⧉protected loadRuleSets() Loads all of the rulesets classes that have been defined in the Config\Valida...
/**
* Loads all of the rulesets classes that have been defined in the
* Config\Validation and stores them locally so we can use them.
*/
Defined in <ROOT>/system/Validation/Validation.php:589
⧉protected fillPlaceholders(array $rules, array $data): array Replace any placeholders within the rules with the values that match the 'key...
/**
* Replace any placeholders within the rules with the values that
* match the 'key' of any properties being set. For example, if
* we had the following $data array:
*
* [ 'id' => 13 ]
*
* and the following rule:
*
* 'required|is_unique[users,email,id,{id}]'
*
* The value of {id} would be replaced with the actual id in the form data:
*
* 'required|is_unique[users,email,id,13]'
*/
Defined in <ROOT>/system/Validation/Validation.php:654
/**
* Attempts to find the appropriate error message
*
* @param string|null $value The value that caused the validation to fail.
*/
Defined in <ROOT>/system/Validation/Validation.php:750
⧉protected splitRules(string $rules): array Split rules string by pipe operator.
/**
* Split rules string by pipe operator.
*/
Defined in <ROOT>/system/Validation/Validation.php:785
⧉private isClosure($rule): bool
/**
* @param Closure|string $rule
*/
Defined in <ROOT>/system/Validation/Validation.php:357
⧉private isStringList(array $array): bool Is the array a string list `list<string>`?
/**
* Is the array a string list `list<string>`?
*/
Defined in <ROOT>/system/Validation/Validation.php:365
protected validationMessages -> array (0)
protected validationRules -> array (0)
⧉private builderMethodsNotAvailable -> array (3)
0 => string (17) "getCompiledInsert"
1 => string (17) "getCompiledSelect"
2 => string (17) "getCompiledUpdate"
private tempPrimaryKeyValue -> null
⇄⧉public get_custom_query($query = '')
$value->get_custom_query($query = '')
Defined in <ROOT>/app/Models/Frontend_model.php:6
⇄⧉public get_custom_code($query = '')
$value->get_custom_code($query = '')
Defined in <ROOT>/app/Models/Frontend_model.php:15
⇄⧉public get_records($table = '', $where = '')
$value->get_records($table = '', $where = '')
Defined in <ROOT>/app/Models/Frontend_model.php:24
new \App\Models\Frontend_model(?CodeIgniter\Database\ConnectionInterface $db = null, ?CodeIgniter\Validation\ValidationInterface $validation = null)
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:150
⇄⧉public setTable(string $table): $this Specify the table associated with a model
$value->setTable(string $table)
/**
* Specify the table associated with a model
*
* @param string $table Table
*
* @return $this
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:169
⇄⧉public getIdValue($data): array|int|string|null Returns the id value for the data array or object
$value->getIdValue($data)
/**
* Returns the id value for the data array or object
*
* @param array|object $data Data
*
* @return array|int|string|null
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:538
⇄⧉public chunk(int $size, Closure $userFunc) Loops over records in batches, allowing you to operate on them. Works with $t...
$value->chunk(int $size, Closure $userFunc)
/**
* Loops over records in batches, allowing you to operate on them.
* Works with $this->builder to get the Compiled select to
* determine the rows to operate on.
* This method works only with dbCalls.
*
* @throws DataException
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:559
⇄⧉public countAllResults(bool $reset = true, bool $test = false): int|string Override countAllResults to account for soft deleted accounts.
/**
* Override countAllResults to account for soft deleted accounts.
*
* @return int|string
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:593
⇄⧉public builder(?string $table = null): BaseBuilder Provides a shared instance of the Query Builder.
$value->builder(?string $table = null)
/**
* Provides a shared instance of the Query Builder.
*
* @return BaseBuilder
*
* @throws ModelException
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:616
⇄⧉public set($key, $value = '', ?bool $escape = null): $this Captures the builder's set() method so that we can validate the data here. Th...
/**
* Captures the builder's set() method so that we can validate the
* data here. This allows it to be used with any of the other
* builder methods and still get validated data, like replace.
*
* @param array|object|string $key Field name, or an array of field/value pairs
* @param bool|float|int|object|string|null $value Field value, if $key is a single field
* @param bool|null $escape Whether to escape values
*
* @return $this
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:663
⧉public __get(string $name): mixed Provides/instantiates the builder/db connection and model's table/primary key...
/**
* Provides/instantiates the builder/db connection and model's table/primary key names and return type.
*
* @param string $name Name
*
* @return mixed
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:797
⧉public __isset(string $name): bool Checks for the existence of properties across this model, builder, and db con...
/**
* Checks for the existence of properties across this model, builder, and db connection.
*
* @param string $name Name
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:815
⧉public __call(string $name, array $params): mixed Provides direct access to method in the builder (if available) and the databa...
/**
* Provides direct access to method in the builder (if available)
* and the database connection.
*
* @return mixed
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:830
⇄⧉public find($id = null): array|object|null The resulting row of data, or null. Fetches the row of database.
$value->find($id = null)
/**
* Fetches the row of database.
*
* @param array|int|string|null $id One primary key or an array of primary keys
*
* @return array|object|null The resulting row of data, or null.
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:538
⇄⧉public findColumn(string $columnName): array|null The resulting row of data, or null if no data found. Fetches the column of database.
$value->findColumn(string $columnName)
/**
* Fetches the column of database.
*
* @param string $columnName Column Name
*
* @return array|null The resulting row of data, or null if no data found.
*
* @throws DataException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:582
⇄⧉public findAll(int $limit0, int $offset0): array Fetches all results, while optionally limiting them.
$value->findAll(int $limit0, int $offset0)
/**
* Fetches all results, while optionally limiting them.
*
* @param int $limit Limit
* @param int $offset Offset
*
* @return array
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:601
⇄⧉public first(): array|object|null Returns the first row of the result set.
$value->first()
/**
* Returns the first row of the result set.
*
* @return array|object|null
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:641
⇄⧉public save($data): bool A convenience method that will attempt to determine whether the data should b...
$value->save($data)
/**
* A convenience method that will attempt to determine whether the
* data should be inserted or updated. Will work with either
* an array or object. When using with custom class objects,
* you must ensure that the class will provide access to the class
* variables, even if through a magic method.
*
* @param array|object $data Data
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:683
⇄⧉public getInsertID(): int|string Returns last insert ID or 0.
$value->getInsertID()
/**
* Returns last insert ID or 0.
*
* @return int|string
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:718
⇄⧉public insertBatch(?array $set = null, ?bool $escape = null, int $batchSize = 100, bool $testing = false): bool|int Number of rows inserted or FALSE on failure Compiles batch insert runs the queries, validating each row prior.
/**
* Compiles batch insert runs the queries, validating each row prior.
*
* @param array|null $set an associative array of insert values
* @param bool|null $escape Whether to escape values
* @param int $batchSize The size of the batch to run
* @param bool $testing True means only number of records is returned, false will execute the query
*
* @return bool|int Number of rows inserted or FALSE on failure
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:818
⇄⧉public updateBatch(?array $set = null, ?string $index = null, int $batchSize = 100, bool $returnSQL = false): false|int|string[] Number of rows affected or FALSE on failure, SQL array when testMode Compiles an update and runs the query.
/**
* Compiles an update and runs the query.
*
* @param array|null $set An associative array of update values
* @param string|null $index The where key
* @param int $batchSize The size of the batch to run
* @param bool $returnSQL True means SQL is returned, false will execute the query
*
* @return false|int|string[] Number of rows affected or FALSE on failure, SQL array when testMode
*
* @throws DatabaseException
* @throws ReflectionException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:968
⇄⧉public delete($id = null, bool $purge = false): BaseResult|bool Deletes a single record from the database where $id matches.
$value->delete($id = null, bool $purge = false)
/**
* Deletes a single record from the database where $id matches.
*
* @param array|int|string|null $id The rows primary key(s)
* @param bool $purge Allows overriding the soft deletes setting.
*
* @return BaseResult|bool
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1042
⇄⧉public purgeDeleted(): bool|string Returns a string if in test mode. Permanently deletes all rows that have been marked as deleted through soft de...
$value->purgeDeleted()
/**
* Permanently deletes all rows that have been marked as deleted
* through soft deletes (deleted = 1).
*
* @return bool|string Returns a string if in test mode.
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1083
⇄⧉public withDeleted(bool $val = true): $this Sets $useSoftDeletes value so that we can temporarily override the soft delet...
$value->withDeleted(bool $val = true)
/**
* Sets $useSoftDeletes value so that we can temporarily override
* the soft deletes settings. Can be used for all find* methods.
*
* @param bool $val Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1100
⇄⧉public onlyDeleted(): $this Works with the find* methods to return only the rows that have been deleted.
$value->onlyDeleted()
/**
* Works with the find* methods to return only the rows that
* have been deleted.
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1113
⇄⧉public replace(?array $data = null, bool $returnSQL = false): BaseResult|false|Query|string Compiles a replace and runs the query.
/**
* Compiles a replace and runs the query.
*
* @param array|null $data Data
* @param bool $returnSQL Set to true to return Query String
*
* @return BaseResult|false|Query|string
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1129
⇄⧉public errors(bool $forceDB = false): array<string,string> Grabs the last error(s) that occurred. If data was validated, it will first c...
$value->errors(bool $forceDB = false)
/**
* Grabs the last error(s) that occurred. If data was validated,
* it will first check for errors there, otherwise will try to
* grab the last error from the Database connection.
*
* The return array should be in the following format:
* ['source' => 'message']
*
* @param bool $forceDB Always grab the db error, not validation
*
* @return array<string,string>
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1155
⇄⧉public paginate(?int $perPage = null, string $group = 'default', ?int $page = null, int $segment0): array|null Works with Pager to get the size and offset parameters. Expects a GET variabl...
/**
* Works with Pager to get the size and offset parameters.
* Expects a GET variable (?page=2) that specifies the page of results
* to display.
*
* @param int|null $perPage Items per page
* @param string $group Will be used by the pagination library to identify a unique pagination set.
* @param int|null $page Optional page number (useful when the page number is provided in different way)
* @param int $segment Optional URI segment number (if page number is provided by URI segment)
*
* @return array|null
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1177
⇄⧉public setAllowedFields(array $allowedFields): $this It could be used when you have to change default or override current allowed ...
$value->setAllowedFields(array $allowedFields)
/**
* It could be used when you have to change default or override current allowed fields.
*
* @param array $allowedFields Array with names of fields
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1202
⇄⧉public protect(bool $protect = true): $this Sets whether or not we should whitelist data set during updates or inserts ag...
$value->protect(bool $protect = true)
/**
* Sets whether or not we should whitelist data set during
* updates or inserts against $this->availableFields.
*
* @param bool $protect Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1217
⇄⧉public skipValidation(bool $skip = true): $this Set the value of the skipValidation flag.
$value->skipValidation(bool $skip = true)
/**
* Set the value of the skipValidation flag.
*
* @param bool $skip Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1340
⇄⧉public setValidationMessages(array $validationMessages): $this Allows to set validation messages. It could be used when you have to change d...
/**
* Allows to set validation messages.
* It could be used when you have to change default or override current validate messages.
*
* @param array $validationMessages Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1355
⇄⧉public setValidationMessage(string $field, array $fieldMessages): $this Allows to set field wise validation message. It could be used when you have t...
/**
* Allows to set field wise validation message.
* It could be used when you have to change default or override current validate messages.
*
* @param string $field Field Name
* @param array $fieldMessages Validation messages
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1371
⇄⧉public setValidationRules(array $validationRules): $this Allows to set validation rules. It could be used when you have to change defa...
/**
* Allows to set validation rules.
* It could be used when you have to change default or override current validate rules.
*
* @param array $validationRules Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1386
⇄⧉public setValidationRule(string $field, $fieldRules): $this Allows to set field wise validation rules. It could be used when you have to ...
/**
* Allows to set field wise validation rules.
* It could be used when you have to change default or override current validate rules.
*
* @param string $field Field Name
* @param array|string $fieldRules Validation rules
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1402
⇄⧉public cleanRules(bool $choice = false): $this Should validation rules be removed before saving? Most handy when doing updates.
$value->cleanRules(bool $choice = false)
/**
* Should validation rules be removed before saving?
* Most handy when doing updates.
*
* @param bool $choice Value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1417
⇄⧉public validate($data): bool Validate the data against the validation rules (or the validation group) spec...
$value->validate($data)
/**
* Validate the data against the validation rules (or the validation group)
* specified in the class property, $validationRules.
*
* @param array|object $data Data
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1430
⇄⧉public getValidationRules(array $options = array()): array Returns the model's defined validation rules so that they can be used elsewhe...
/**
* Returns the model's defined validation rules so that they
* can be used elsewhere, if needed.
*
* @param array $options Options
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1462
⇄⧉public getValidationMessages(): array Returns the model's validation messages, so they can be used elsewhere, if ne...
$value->getValidationMessages()
/**
* Returns the model's validation messages, so they
* can be used elsewhere, if needed.
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1485
⇄⧉public allowCallbacks(bool $val = true): $this Sets $tempAllowCallbacks value so that we can temporarily override the settin...
$value->allowCallbacks(bool $val = true)
/**
* Sets $tempAllowCallbacks value so that we can temporarily override
* the setting. Resets after the next method that uses triggers.
*
* @param bool $val value
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1521
⇄⧉public asArray(): $this Sets the return type of the results to be as an associative array.
$value->asArray()
/**
* Sets the return type of the results to be as an associative array.
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1573
⇄⧉public asObject(string $class = 'object'): $this Sets the return type to be of the specified type of object. Defaults to a sim...
$value->asObject(string $class = 'object')
/**
* Sets the return type to be of the specified type of object.
* Defaults to a simple object, but can be any class that has
* class vars with the same name as the collection columns,
* or at least allows them to be created.
*
* @param string $class Class Name
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1590
/**
* Sets $allowEmptyInserts.
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1812
⧉protected doFind(bool $singleton, $id = null): array|object|null The resulting row of data, or null. Fetches the row of database from $this->table with a primary key matching $id...
/**
* Fetches the row of database from $this->table with a primary key
* matching $id.
* This method works only with dbCalls.
*
* @param bool $singleton Single or multiple results
* @param array|int|string|null $id One primary key or an array of primary keys
*
* @return array|object|null The resulting row of data, or null.
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:186
⧉protected doFindColumn(string $columnName): array|null The resulting row of data, or null if no data found. Fetches the column of database from $this->table. This method works only with...
/**
* Fetches the column of database from $this->table.
* This method works only with dbCalls.
*
* @param string $columnName Column Name
*
* @return array|null The resulting row of data, or null if no data found.
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:217
⧉protected doFindAll(int $limit0, int $offset0): array Works with the current Query Builder instance to return all results, while op...
/**
* Works with the current Query Builder instance to return
* all results, while optionally limiting them.
* This method works only with dbCalls.
*
* @param int $limit Limit
* @param int $offset Offset
*
* @return array
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:232
⧉protected doFirst(): array|object|null Returns the first row of the result set. Will take any previous Query Builder...
/**
* Returns the first row of the result set. Will take any previous
* Query Builder calls into account when determining the result set.
* This method works only with dbCalls.
*
* @return array|object|null
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:252
⧉protected doInsert(array $data): bool Inserts data into the current table. This method works only with dbCalls.
/**
* Inserts data into the current table.
* This method works only with dbCalls.
*
* @param array $data Data
*
* @return bool
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:279
⧉protected doInsertBatch(?array $set = null, ?bool $escape = null, int $batchSize = 100, bool $testing = false): bool|int Number of rows inserted or FALSE on failure Compiles batch insert strings and runs the queries, validating each row prior...
/**
* Compiles batch insert strings and runs the queries, validating each row prior.
* This method works only with dbCalls.
*
* @param array|null $set An associative array of insert values
* @param bool|null $escape Whether to escape values
* @param int $batchSize The size of the batch to run
* @param bool $testing True means only number of records is returned, false will execute the query
*
* @return bool|int Number of rows inserted or FALSE on failure
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:352
⧉protected doUpdate($id = null, $data = null): bool Updates a single record in $this->table. This method works only with dbCalls.
/**
* Updates a single record in $this->table.
* This method works only with dbCalls.
*
* @param array|int|string|null $id
* @param array|null $data
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:374
⧉protected doUpdateBatch(?array $set = null, ?string $index = null, int $batchSize = 100, bool $returnSQL = false): false|int|string[] Number of rows affected or FALSE on failure, SQL array when testMode Compiles an update string and runs the query This method works only with dbCa...
/**
* Compiles an update string and runs the query
* This method works only with dbCalls.
*
* @param array|null $set An associative array of update values
* @param string|null $index The where key
* @param int $batchSize The size of the batch to run
* @param bool $returnSQL True means SQL is returned, false will execute the query
*
* @return false|int|string[] Number of rows affected or FALSE on failure, SQL array when testMode
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:412
⧉protected doDelete($id = null, bool $purge = false): bool|string Deletes a single record from $this->table where $id matches the table's prima...
/**
* Deletes a single record from $this->table where $id matches
* the table's primaryKey
* This method works only with dbCalls.
*
* @param array|int|string|null $id The rows primary key(s)
* @param bool $purge Allows overriding the soft deletes setting.
*
* @return bool|string
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:429
⧉protected doPurgeDeleted(): bool|string Returns a string if in test mode. Permanently deletes all rows that have been marked as deleted through soft de...
/**
* Permanently deletes all rows that have been marked as deleted
* through soft deletes (deleted = 1)
* This method works only with dbCalls.
*
* @return bool|string Returns a string if in test mode.
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:466
⧉protected doOnlyDeleted() Works with the find* methods to return only the rows that have been deleted. ...
/**
* Works with the find* methods to return only the rows that
* have been deleted.
* This method works only with dbCalls.
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:478
⧉protected doReplace(?array $data = null, bool $returnSQL = false): BaseResult|false|Query|string Compiles a replace into string and runs the query This method works only with...
/**
* Compiles a replace into string and runs the query
* This method works only with dbCalls.
*
* @param array|null $data Data
* @param bool $returnSQL Set to true to return Query String
*
* @return BaseResult|false|Query|string
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:492
⧉protected doErrors(): array<string,string> Grabs the last error(s) that occurred from the Database connection. The retur...
/**
* Grabs the last error(s) that occurred from the Database connection.
* The return array should be in the following format:
* ['source' => 'message']
* This method works only with dbCalls.
*
* @return array<string,string>
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:505
⧉protected idValue($data): array|int|string|null Returns the id value for the data array or object
/**
* Returns the id value for the data array or object
*
* @param array|object $data Data
*
* @return array|int|string|null
*
* @deprecated Use getIdValue() instead. Will be removed in version 5.0.
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:526
⧉protected shouldUpdate($data): bool This method is called on save to determine if entry have to be updated If thi...
/**
* This method is called on save to determine if entry have to be updated
* If this method return false insert operation will be executed
*
* @param array|object $data Data
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:682
⧉protected objectToRawArray($data, bool $onlyChanged = true, bool $recursive = false): ?array Takes a class an returns an array of it's public and protected properties as ...
/**
* Takes a class an returns an array of it's public and protected
* properties as an array with raw values.
*
* @param object|string $data
* @param bool $recursive If true, inner entities will be casted as array as well
*
* @return array|null Array
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:770
⧉protected initialize() Initializes the instance with any additional steps. Optionally implemented by...
/**
* Initializes the instance with any additional steps.
* Optionally implemented by child classes.
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:342
⧉protected doProtectFields(array $data): array Ensures that only the fields that are allowed to be updated are in the data a...
/**
* Ensures that only the fields that are allowed to be updated
* are in the data array.
*
* Used by insert() and update() to protect against mass assignment
* vulnerabilities.
*
* @param array $data Data
*
* @throws DataException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1235
⧉protected setDate(?int $userData = null): int|string Sets the date or current date if null value is passed.
/**
* Sets the date or current date if null value is passed.
*
* @param int|null $userData An optional PHP timestamp to be converted.
*
* @return int|string
*
* @throws ModelException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1263
⧉protected intToDate(int $value): int|string A utility function to allow child models to use the type of date/time format ...
/**
* A utility function to allow child models to use the type of
* date/time format that they prefer. This is primarily used for
* setting created_at, updated_at and deleted_at values, but can be
* used by inheriting classes.
*
* The available time formats are:
* - 'int' - Stores the date as an integer timestamp
* - 'datetime' - Stores the data in the SQL datetime format
* - 'date' - Stores the date (only) in the SQL date format.
*
* @param int $value value
*
* @return int|string
*
* @throws ModelException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1287
⧉protected timeToDate(CodeIgniter\I18n\Time $value): int|string Converts Time value to string using $this->dateFormat.
/**
* Converts Time value to string using $this->dateFormat.
*
* The available time formats are:
* - 'int' - Stores the date as an integer timestamp
* - 'datetime' - Stores the data in the SQL datetime format
* - 'date' - Stores the date (only) in the SQL date format.
*
* @param Time $value value
*
* @return int|string
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1316
⧉protected cleanValidationRules(array $rules, ?array $data = null): array Removes any rules that apply to fields that have not been set currently so th...
/**
* Removes any rules that apply to fields that have not been set
* currently so that rules don't block updating when only updating
* a partial row.
*
* @param array $rules Array containing field name and rule
* @param array|null $data Data
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1498
⧉protected trigger(string $event, array $eventData): array A simple event trigger for Model Events that allows additional data manipulat...
/**
* A simple event trigger for Model Events that allows additional
* data manipulation within the model. Specifically intended for
* usage by child models this can be used to format data,
* save/load related classes, etc.
*
* It is the responsibility of the callback methods to return
* the data itself.
*
* Each $eventData array MUST have a 'data' key with the relevant
* data for callback methods (like an array of key/value pairs to insert
* or update, an array of results, etc.)
*
* If callbacks are not allowed then returns $eventData immediately.
*
* @param string $event Event
* @param array $eventData Event Data
*
* @return array
*
* @throws DataException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1550
⧉protected objectToArray($data, bool $onlyChanged = true, bool $recursive = false): array Takes a class and returns an array of its public and protected properties as ...
/**
* Takes a class and returns an array of its public and protected
* properties as an array suitable for use in creates and updates.
* This method uses objectToRawArray() internally and does conversion
* to string on all Time instances
*
* @param object|string $data Data
* @param bool $onlyChanged Only Changed Property
* @param bool $recursive If true, inner entities will be cast as array as well
*
* @return array Array
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1611
⧉protected transformDataToArray($data, string $type): array Transform data to array.
/**
* Transform data to array.
*
* @param array|object|null $data Data
* @param string $type Type of data (insert|update)
*
* @throws DataException
* @throws InvalidArgumentException
* @throws ReflectionException
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1673
⧉protected fillPlaceholders(array $rules, array $data): array Replace any placeholders within the rules with the values that match the 'key...
/**
* Replace any placeholders within the rules with the values that
* match the 'key' of any properties being set. For example, if
* we had the following $data array:
*
* [ 'id' => 13 ]
*
* and the following rule:
*
* 'required|is_unique[users,email,id,{id}]'
*
* The value of {id} would be replaced with the actual id in the form data:
*
* 'required|is_unique[users,email,id,13]'
*
* @param array $rules Validation rules
* @param array $data Data
*
* @codeCoverageIgnore
*
* @deprecated use fillPlaceholders($rules, $data) from Validation instead
*/
Inherited from CodeIgniter\BaseModel
Defined in <ROOT>/system/BaseModel.php:1778
⧉private get_action_html_entity_decode($result)
Defined in <ROOT>/app/Models/Frontend_model.php:122
⇄⧉public static classToArray($data, $primaryKey = null, string $dateFormat = 'datetime', bool $onlyChanged = true): array Takes a class an returns an array of it's public and protected properties as ...
/**
* Takes a class an returns an array of it's public and protected
* properties as an array suitable for use in creates and updates.
*
* @param object|string $data
* @param string|null $primaryKey
*
* @throws ReflectionException
*
* @codeCoverageIgnore
*
* @deprecated since 4.1
*/
Inherited from CodeIgniter\Model
Defined in <ROOT>/system/Model.php:875
⇄⧉public description -> UTF-8 string (379) "Wir verpacken Güter, aber warum eigentlich? Die Verpackung dient einerseits ...
$value->description
Wir verpacken Güter, aber warum eigentlich? Die Verpackung dient einerseits dem Schutz der Güter, andererseits übernimmt sie aber auch logistische und Informationsaufgaben. Diese Informationen tragen dazu bei, dass die Güter zur richtigen Zeit am richtigen Ort sind. Verpackungen unterliegen einem stetigen Wandel. Dabei gewinnt die Nachhaltigkeit mehr und mehr an Bedeutung.
⇄public download_link -> string (0) ""
$value->download_link
⇄public hour -> string (11) "4 Lektionen"
$value->hour
⇄public id -> string (2) "46"
$value->id
⇄public level -> string (1) "1"
$value->level
⇄public name -> string (41) "Modul 602 Versandbereite Pakete erstellen"
$value->name
⇄public print_link -> string (0) ""
$value->print_link
⇄public share_link -> string (0) ""
$value->share_link
⇄public skills -> string (2) "9,"
$value->skills
⇄public status -> string (1) "0"
$value->status
⇄public submitted_by -> string (6) "hodler"
$value->submitted_by
⇄public tags -> string (3) "12,"
$value->tags
⇄public title -> string (41) "Modul 602 Versandbereite Pakete erstellen"
