您的意見對我們極其重要，請向我們分享任何關於我們的網站、您的住宿體驗，或對我們公司的任何意見。Your feedback is extremely important to us. Please share with us any advice about our website, your accommodation experience, or any of our company.
⇄⧉public __construct() Will attempt to get environment variables with names that match the propertie...
new \Config\Project()
/**
* 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 .../Config/BaseConfig.php:60
/**
* Retrieve an environment-specific configuration setting
*
* @return string|null
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in .../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 .../Config/BaseConfig.php:174
⧉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 .../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 .../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 .../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 .../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 .../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 .../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 .../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 .../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 .../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 .../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 .../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 .../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 .../Database/Query.php:279
⧉public debugToolbarDisplay(): string Returns string to display in debug toolbar
/**
* Returns string to display in debug toolbar
*/
Defined in .../Database/Query.php:371
⧉public __toString(): string Return text representation of the query
/**
* Return text representation of the query
*/
Defined in .../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 .../Database/Query.php:289
⧉protected matchNamedBinds(string $sql, array $binds): string Match bindings
/**
* Match bindings
*/
Defined in .../Database/Query.php:317
⧉protected matchSimpleBinds(string $sql, array $binds, int $bindCount, int $ml): string Match bindings
/**
* Match bindings
*/
Defined in .../Database/Query.php:341
⧉public connect(bool $persistent = false): mixed Connect to the database.
/**
* Connect to the database.
*
* @throws DatabaseException
*
* @return mixed
*/
Defined in .../Database/MySQLi/Connection.php:79
⧉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 .../Database/MySQLi/Connection.php:225
⧉public setDatabase(string $databaseName): bool Select a specific database table to use.
/**
* Select a specific database table to use.
*/
Defined in .../Database/MySQLi/Connection.php:242
⧉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 .../Database/MySQLi/Connection.php:264
⧉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 .../Database/MySQLi/Connection.php:321
⧉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 .../Database/MySQLi/Connection.php:348
⧉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 .../Database/MySQLi/Connection.php:545
⧉public insertID(): int Insert ID
/**
* Insert ID
*/
Defined in .../Database/MySQLi/Connection.php:563
/**
* Saves our connection settings.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:335
⧉public initialize(): mixed Initializes the database connection/settings.
/**
* Initializes the database connection/settings.
*
* @throws DatabaseException
*
* @return mixed
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:362
⧉public close() Close the database connection.
/**
* Close the database connection.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:436
⧉public persistentConnect(): mixed Create a persistent database connection.
/**
* Create a persistent database connection.
*
* @return mixed
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:456
⧉public getConnection(?string $alias = null): mixed 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 mixed
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:477
⧉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 .../Database/BaseConnection.php:493
⧉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 .../Database/BaseConnection.php:505
⧉public getPrefix(): string Returns the database prefix.
/**
* Returns the database prefix.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:513
⧉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 .../Database/BaseConnection.php:521
⧉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 .../Database/BaseConnection.php:538
⧉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 .../Database/BaseConnection.php:550
⧉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 mixed ...$binds
*
* @return BaseResult|bool|Query BaseResult when “read” type query, bool when “write” type query, Query when prepared query
*
* @todo BC set $queryClass default as null in 4.1
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:580
⧉public simpleQuery(string $sql): mixed 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 mixed
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:672
⧉public transOff() Disable Transactions
/**
* Disable Transactions
*
* This permits transactions to be disabled at run-time.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:686
/**
* 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 .../Database/BaseConnection.php:705
/**
* Complete Transaction
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:727
⧉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 .../Database/BaseConnection.php:753
⧉public transBegin(bool $testMode = false): bool Begin Transaction
/**
* Begin Transaction
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:761
⧉public transCommit(): bool Commit Transaction
/**
* Commit Transaction
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:795
/**
* Rollback Transaction
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:814
⧉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
*
* @throws DatabaseException
*
* @return BaseBuilder
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:854
⧉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 .../Database/BaseConnection.php:868
⧉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 .../Database/BaseConnection.php:889
⧉public getLastQuery(): mixed Returns the last query's statement object.
/**
* Returns the last query's statement object.
*
* @return mixed
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:917
⧉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 .../Database/BaseConnection.php:925
⧉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 .../Database/BaseConnection.php:936
⧉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 .../Database/BaseConnection.php:947
/**
* 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 .../Database/BaseConnection.php:980
⧉public escapeIdentifiers($item): mixed Escape the SQL Identifiers
/**
* Escape the SQL Identifiers
*
* This function escapes column and table names
*
* @param mixed $item
*
* @return mixed
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:1126
⧉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 .../Database/BaseConnection.php:1184
⧉public escape($str): mixed "Smart" Escape String
/**
* "Smart" Escape String
*
* Escapes data based on type.
* Sets boolean and null types
*
* @param mixed $str
*
* @return mixed
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:1208
/**
* 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 .../Database/BaseConnection.php:1233
⧉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 .../Database/BaseConnection.php:1275
⧉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 .../Database/BaseConnection.php:1298
⧉public listTables(bool $constrainByPrefix = false): array|bool Returns an array of table names
/**
* Returns an array of table names
*
* @throws DatabaseException
*
* @return array|bool
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:1336
⧉public tableExists(string $tableName): bool Determine if a particular table exists
/**
* Determine if a particular table exists
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:1384
⧉public getFieldNames(string $table): array|false Fetch Field Names
/**
* Fetch Field Names
*
* @throws DatabaseException
*
* @return array|false
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:1396
⧉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 .../Database/BaseConnection.php:1441
⧉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 .../Database/BaseConnection.php:1451
⧉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 .../Database/BaseConnection.php:1461
⧉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 .../Database/BaseConnection.php:1471
/**
* Enables foreign key checks temporarily.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:1489
⧉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 .../Database/BaseConnection.php:1504
⧉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 .../Database/BaseConnection.php:1516
⧉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 .../Database/BaseConnection.php:1528
⧉public __get(string $key): mixed Accessor for properties if they exist.
/**
* Accessor for properties if they exist.
*
* @return mixed
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:1590
⧉public __isset(string $key): bool Checker for properties existence.
/**
* Checker for properties existence.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:1602
⧉protected _close() Close the database connection.
/**
* Close the database connection.
*/
Defined in .../Database/MySQLi/Connection.php:234
⧉protected execute(string $sql): mixed Executes the query against the database.
/**
* Executes the query against the database.
*
* @return mixed
*/
Defined in .../Database/MySQLi/Connection.php:282
⧉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 .../Database/MySQLi/Connection.php:307
/**
* Platform-dependant string escape
*/
Defined in .../Database/MySQLi/Connection.php:329
⧉protected _listTables(bool $prefixLimit = false): 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().
*/
Defined in .../Database/MySQLi/Connection.php:372
⧉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 .../Database/MySQLi/Connection.php:386
⧉protected _fieldData(string $table): array Returns an array of objects with field data
/**
* Returns an array of objects with field data
*
* @throws DatabaseException
*
* @return stdClass[]
*/
Defined in .../Database/MySQLi/Connection.php:398
⧉protected _indexData(string $table): array Returns an array of objects with index data
/**
* Returns an array of objects with index data
*
* @throws DatabaseException
* @throws LogicException
*
* @return stdClass[]
*/
Defined in .../Database/MySQLi/Connection.php:431
⧉protected _foreignKeyData(string $table): array Returns an array of objects with Foreign key data
/**
* Returns an array of objects with Foreign key data
*
* @throws DatabaseException
*
* @return stdClass[]
*/
Defined in .../Database/MySQLi/Connection.php:476
/**
* Rollback Transaction
*/
Defined in .../Database/MySQLi/Connection.php:595
⧉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 .../Database/BaseConnection.php:1320
/**
* Constructor
*
* @param array|string $tableName tablename or tablenames with or without aliases
*
* Examples of $tableName: `mytable`, `jobs j`, `jobs j, users u`, `['jobs j','users u']`
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:280
⧉public db(): CodeIgniter\Database\ConnectionInterface Returns the current database connection
/**
* Returns the current database connection
*
* @return BaseConnection|ConnectionInterface
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:314
⧉public testMode(bool $mode = true): $this Sets a test mode status.
/**
* Sets a test mode status.
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:324
⧉public getTable(): string Gets the name of the primary table.
/**
* Gets the name of the primary table.
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:334
⧉public getBinds(): array Returns an array of bind values and their named parameters for binding in the...
/**
* Returns an array of bind values and their
* named parameters for binding in the Query object later.
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:343
⧉public ignore(bool $ignore = true): $this Ignore
/**
* Ignore
*
* Set ignore Flag for next insert,
* update or delete query.
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:356
⧉public select($select = '*', ?bool $escape = null): $this Generates the SELECT portion of the query
/**
* Generates the SELECT portion of the query
*
* @param array|RawSql|string $select
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:370
⧉public selectMax(string $select = '', string $alias = ''): $this Generates a SELECT MAX(field) portion of a query
/**
* Generates a SELECT MAX(field) portion of a query
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:416
⧉public selectMin(string $select = '', string $alias = ''): $this Generates a SELECT MIN(field) portion of a query
/**
* Generates a SELECT MIN(field) portion of a query
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:426
⧉public selectAvg(string $select = '', string $alias = ''): $this Generates a SELECT AVG(field) portion of a query
/**
* Generates a SELECT AVG(field) portion of a query
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:436
⧉public selectSum(string $select = '', string $alias = ''): $this Generates a SELECT SUM(field) portion of a query
/**
* Generates a SELECT SUM(field) portion of a query
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:446
⧉public selectCount(string $select = '', string $alias = ''): $this Generates a SELECT COUNT(field) portion of a query
/**
* Generates a SELECT COUNT(field) portion of a query
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:456
⧉public selectSubquery(CodeIgniter\Database\BaseBuilder $subquery, string $as): self Adds a subquery to the selection
/**
* Adds a subquery to the selection
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:464
⧉public distinct(bool $val = true): $this Sets a flag which tells the query string compiler to add DISTINCT
/**
* Sets a flag which tells the query string compiler to add DISTINCT
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:531
⧉public from($from, bool $overwrite = false): self Generates the FROM portion of the query
/**
* Generates the FROM portion of the query
*
* @param array|string $from
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:545
/**
* @param BaseBuilder $from Expected subquery
* @param string $alias Subquery alias
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:576
⧉public join(string $table, $cond, string $type = '', ?bool $escape = null): $this Generates the JOIN portion of the query
/**
* Generates the JOIN portion of the query
*
* @param RawSql|string $cond
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:593
⧉public where($key, $value = null, ?bool $escape = null): $this Generates the WHERE portion of the query. Separates multiple calls with 'AND'.
/**
* Generates the WHERE portion of the query.
* Separates multiple calls with 'AND'.
*
* @param array|RawSql|string $key
* @param mixed $value
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:672
⧉public orWhere($key, $value = null, ?bool $escape = null): $this OR WHERE
/**
* OR WHERE
*
* Generates the WHERE portion of the query.
* Separates multiple calls with 'OR'.
*
* @param array|RawSql|string $key
* @param mixed $value
* @param bool $escape
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:689
⧉public whereIn(?string $key = null, $values = null, ?bool $escape = null): $this Generates a WHERE field IN('item', 'item') SQL query, joined with 'AND' if ap...
/**
* Generates a WHERE field IN('item', 'item') SQL query,
* joined with 'AND' if appropriate.
*
* @param array|BaseBuilder|Closure|string $values The values searched on, or anonymous function with subquery
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:787
⧉public orWhereIn(?string $key = null, $values = null, ?bool $escape = null): $this Generates a WHERE field IN('item', 'item') SQL query, joined with 'OR' if app...
/**
* Generates a WHERE field IN('item', 'item') SQL query,
* joined with 'OR' if appropriate.
*
* @param array|BaseBuilder|Closure|string $values The values searched on, or anonymous function with subquery
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:800
⧉public whereNotIn(?string $key = null, $values = null, ?bool $escape = null): $this Generates a WHERE field NOT IN('item', 'item') SQL query, joined with 'AND' i...
/**
* Generates a WHERE field NOT IN('item', 'item') SQL query,
* joined with 'AND' if appropriate.
*
* @param array|BaseBuilder|Closure|string $values The values searched on, or anonymous function with subquery
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:813
⧉public orWhereNotIn(?string $key = null, $values = null, ?bool $escape = null): $this Generates a WHERE field NOT IN('item', 'item') SQL query, joined with 'OR' if...
/**
* Generates a WHERE field NOT IN('item', 'item') SQL query,
* joined with 'OR' if appropriate.
*
* @param array|BaseBuilder|Closure|string $values The values searched on, or anonymous function with subquery
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:826
⧉public havingIn(?string $key = null, $values = null, ?bool $escape = null): $this Generates a HAVING field IN('item', 'item') SQL query, joined with 'AND' if a...
/**
* Generates a HAVING field IN('item', 'item') SQL query,
* joined with 'AND' if appropriate.
*
* @param array|BaseBuilder|Closure|string $values The values searched on, or anonymous function with subquery
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:839
⧉public orHavingIn(?string $key = null, $values = null, ?bool $escape = null): $this Generates a HAVING field IN('item', 'item') SQL query, joined with 'OR' if ap...
/**
* Generates a HAVING field IN('item', 'item') SQL query,
* joined with 'OR' if appropriate.
*
* @param array|BaseBuilder|Closure|string $values The values searched on, or anonymous function with subquery
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:852
⧉public havingNotIn(?string $key = null, $values = null, ?bool $escape = null): $this Generates a HAVING field NOT IN('item', 'item') SQL query, joined with 'AND' ...
/**
* Generates a HAVING field NOT IN('item', 'item') SQL query,
* joined with 'AND' if appropriate.
*
* @param array|BaseBuilder|Closure|string $values The values searched on, or anonymous function with subquery
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:865
⧉public orHavingNotIn(?string $key = null, $values = null, ?bool $escape = null): $this Generates a HAVING field NOT IN('item', 'item') SQL query, joined with 'OR' i...
/**
* Generates a HAVING field NOT IN('item', 'item') SQL query,
* joined with 'OR' if appropriate.
*
* @param array|BaseBuilder|Closure|string $values The values searched on, or anonymous function with subquery
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:878
⧉public like($field, string $match = '', string $side = 'both', ?bool $escape = null, bool $insensitiveSearch = false): $this Generates a %LIKE% portion of the query. Separates multiple calls with 'AND'.
/**
* Generates a %LIKE% portion of the query.
* Separates multiple calls with 'AND'.
*
* @param array|RawSql|string $field
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:954
⧉public notLike($field, string $match = '', string $side = 'both', ?bool $escape = null, bool $insensitiveSearch = false): $this Generates a NOT LIKE portion of the query. Separates multiple calls with 'AND'.
/**
* Generates a NOT LIKE portion of the query.
* Separates multiple calls with 'AND'.
*
* @param array|RawSql|string $field
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:967
⧉public orLike($field, string $match = '', string $side = 'both', ?bool $escape = null, bool $insensitiveSearch = false): $this Generates a %LIKE% portion of the query. Separates multiple calls with 'OR'.
/**
* Generates a %LIKE% portion of the query.
* Separates multiple calls with 'OR'.
*
* @param array|RawSql|string $field
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:980
⧉public orNotLike($field, string $match = '', string $side = 'both', ?bool $escape = null, bool $insensitiveSearch = false): $this Generates a NOT LIKE portion of the query. Separates multiple calls with 'OR'.
/**
* Generates a NOT LIKE portion of the query.
* Separates multiple calls with 'OR'.
*
* @param array|RawSql|string $field
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:993
⧉public havingLike($field, string $match = '', string $side = 'both', ?bool $escape = null, bool $insensitiveSearch = false): $this Generates a %LIKE% portion of the query. Separates multiple calls with 'AND'.
/**
* Generates a %LIKE% portion of the query.
* Separates multiple calls with 'AND'.
*
* @param array|RawSql|string $field
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1006
⧉public notHavingLike($field, string $match = '', string $side = 'both', ?bool $escape = null, bool $insensitiveSearch = false): $this Generates a NOT LIKE portion of the query. Separates multiple calls with 'AND'.
/**
* Generates a NOT LIKE portion of the query.
* Separates multiple calls with 'AND'.
*
* @param array|RawSql|string $field
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1019
⧉public orHavingLike($field, string $match = '', string $side = 'both', ?bool $escape = null, bool $insensitiveSearch = false): $this Generates a %LIKE% portion of the query. Separates multiple calls with 'OR'.
/**
* Generates a %LIKE% portion of the query.
* Separates multiple calls with 'OR'.
*
* @param array|RawSql|string $field
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1032
⧉public orNotHavingLike($field, string $match = '', string $side = 'both', ?bool $escape = null, bool $insensitiveSearch = false): $this Generates a NOT LIKE portion of the query. Separates multiple calls with 'OR'.
/**
* Generates a NOT LIKE portion of the query.
* Separates multiple calls with 'OR'.
*
* @param array|RawSql|string $field
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1045
⧉public union($union): $this Add UNION statement
/**
* Add UNION statement
*
* @param BaseBuilder|Closure $union
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1155
⧉public unionAll($union): $this Add UNION ALL statement
/**
* Add UNION ALL statement
*
* @param BaseBuilder|Closure $union
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1167
⧉public groupStart(): $this Starts a query group.
/**
* Starts a query group.
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1195
⧉public orGroupStart(): $this Starts a query group, but ORs the group
/**
* Starts a query group, but ORs the group
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1205
⧉public notGroupStart(): $this Starts a query group, but NOTs the group
/**
* Starts a query group, but NOTs the group
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1215
⧉public orNotGroupStart(): $this Starts a query group, but OR NOTs the group
/**
* Starts a query group, but OR NOTs the group
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1225
⧉public groupEnd(): $this Ends a query group
/**
* Ends a query group
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1235
⧉public havingGroupStart(): $this Starts a query group for HAVING clause.
/**
* Starts a query group for HAVING clause.
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1245
⧉public orHavingGroupStart(): $this Starts a query group for HAVING clause, but ORs the group.
/**
* Starts a query group for HAVING clause, but ORs the group.
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1255
⧉public notHavingGroupStart(): $this Starts a query group for HAVING clause, but NOTs the group.
/**
* Starts a query group for HAVING clause, but NOTs the group.
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1265
⧉public orNotHavingGroupStart(): $this Starts a query group for HAVING clause, but OR NOTs the group.
/**
* Starts a query group for HAVING clause, but OR NOTs the group.
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1275
⧉public havingGroupEnd(): $this Ends a query group for HAVING clause.
/**
* Ends a query group for HAVING clause.
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1285
⧉public groupBy($by, ?bool $escape = null): $this
/**
* @param array|string $by
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1351
/**
* @param string $direction ASC, DESC or RANDOM
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1408
/**
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1460
⧉public offset(int $offset): $this Sets the OFFSET value
/**
* Sets the OFFSET value
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1478
⧉public set($key, $value = '', ?bool $escape = null): $this Allows key/value pairs to be set for insert(), update() or replace().
/**
* Allows key/value pairs to be set for insert(), update() or replace().
*
* @param array|object|string $key Field name, or an array of field/value pairs
* @param mixed $value Field value, if $key is a single field
* @param bool|null $escape Whether to escape values
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1504
⧉public getSetData(bool $clean = false): array Returns the previously set() data, alternatively resetting it if needed.
/**
* Returns the previously set() data, alternatively resetting it if needed.
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1530
⧉public getCompiledSelect(bool $reset = true): string Compiles a SELECT query string and returns the sql.
/**
* Compiles a SELECT query string and returns the sql.
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1544
⧉public get(?int $limit = null, int $offset0, bool $reset = true): false|ResultInterface Compiles the select statement based on the other functions called and runs th...
/**
* Compiles the select statement based on the other functions called
* and runs the query
*
* @return false|ResultInterface
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1577
⧉public countAll(bool $reset = true): int|string Generates a platform-specific query string that counts all records in the par...
/**
* Generates a platform-specific query string that counts all records in
* the particular table
*
* @return int|string
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1603
⧉public countAllResults(bool $reset = true): int|string Generates a platform-specific query string that counts all records returned b...
/**
* Generates a platform-specific query string that counts all records
* returned by an Query Builder query.
*
* @return int|string
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1635
⧉public getCompiledQBWhere(): array Compiles the set conditions and returns the sql statement
/**
* Compiles the set conditions and returns the sql statement
*
* @return array
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1694
⧉public getWhere($where = null, ?int $limit = null, ?int $offset0, bool $reset = true): ResultInterface Allows the where clause, limit and offset to be added directly
/**
* Allows the where clause, limit and offset to be added directly
*
* @param array|string $where
*
* @return ResultInterface
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1706
⧉public insertBatch(?array $set = null, ?bool $escape = null, int $batchSize = 100): false|int|string[] Number of rows inserted or FALSE on failure, SQL array when testMode Compiles batch insert strings and runs the queries
/**
* Compiles batch insert strings and runs the queries
*
* @throws DatabaseException
*
* @return false|int|string[] Number of rows inserted or FALSE on failure, SQL array when testMode
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1737
⧉public setInsertBatch($key, string $value = '', ?bool $escape = null): $this|null Allows key/value pairs to be set for batch inserts
/**
* Allows key/value pairs to be set for batch inserts
*
* @param mixed $key
*
* @return $this|null
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1810
⧉public getCompiledInsert(bool $reset = true): bool|string Compiles an insert query and returns the sql
/**
* Compiles an insert query and returns the sql
*
* @throws DatabaseException
*
* @return bool|string
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1859
⧉public insert(?array $set = null, ?bool $escape = null): bool|Query Compiles an insert string and runs the query
/**
* Compiles an insert string and runs the query
*
* @throws DatabaseException
*
* @return bool|Query
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1885
⧉public replace(?array $set = null): BaseResult|false|Query|string Compiles an replace into string and runs the query
/**
* Compiles an replace into string and runs the query
*
* @throws DatabaseException
*
* @return BaseResult|false|Query|string
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1950
⧉public getCompiledUpdate(bool $reset = true): bool|string Compiles an update query and returns the sql
/**
* Compiles an update query and returns the sql
*
* @return bool|string
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1997
⧉public update(?array $set = null, $where = null, ?int $limit = null): bool Compiles an update string and runs the query.
/**
* Compiles an update string and runs the query.
*
* @param mixed $where
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2019
⧉public updateBatch(?array $set = null, ?string $index = null, int $batchSize = 100): false|int|string[] Number of rows affected or FALSE on failure, SQL array when testMode Compiles an update string and runs the query
/**
* Compiles an update string and runs the query
*
* @throws DatabaseException
*
* @return false|int|string[] Number of rows affected or FALSE on failure, SQL array when testMode
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2105
⧉public setUpdateBatch($key, string $index = '', ?bool $escape = null): $this|null Allows key/value pairs to be set for batch updating
/**
* Allows key/value pairs to be set for batch updating
*
* @param array|object $key
*
* @throws DatabaseException
*
* @return $this|null
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2216
⧉public emptyTable(): bool|string TRUE on success, FALSE on failure, string on testMode Compiles a delete string and runs "DELETE FROM table"
/**
* Compiles a delete string and runs "DELETE FROM table"
*
* @return bool|string TRUE on success, FALSE on failure, string on testMode
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2256
⧉public truncate(): bool|string TRUE on success, FALSE on failure, string on testMode Compiles a truncate string and runs the query If the database does not suppor...
/**
* Compiles a truncate string and runs the query
* If the database does not support the truncate() command
* This function maps to "DELETE FROM table"
*
* @return bool|string TRUE on success, FALSE on failure, string on testMode
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2278
⧉public getCompiledDelete(bool $reset = true): string Compiles a delete query string and returns the sql
/**
* Compiles a delete query string and returns the sql
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2307
⧉public delete($where = '', ?int $limit = null, bool $resetData = true): bool|string Compiles a delete string and runs the query
/**
* Compiles a delete string and runs the query
*
* @param mixed $where
*
* @throws DatabaseException
*
* @return bool|string
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2324
⧉public increment(string $column, int $value = 1): bool Increments a numeric column by the specified value.
/**
* Increments a numeric column by the specified value.
*
* @return bool
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2366
⧉public decrement(string $column, int $value = 1): bool Decrements a numeric column by the specified value.
/**
* Decrements a numeric column by the specified value.
*
* @return bool
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2380
⧉public resetQuery(): $this Publicly-visible method to reset the QB values.
/**
* Publicly-visible method to reset the QB values.
*
* @return $this
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2731
⧉protected _fromTables(): string FROM tables
/**
* FROM tables
*
* Groups tables in FROM clauses if needed, so there is no confusion
* about operator precedence.
*
* Note: This is only used (and overridden) by MySQL.
*/
Defined in .../Database/MySQLi/Builder.php:48
/**
* Generates a platform-specific LIMIT clause.
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1490
⧉protected compileFinalQuery(string $sql): string Returns a finalized, compiled query string with the bindings inserted and pre...
/**
* Returns a finalized, compiled query string with the bindings
* inserted and prefixes swapped out.
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1559
⧉protected _insertBatch(string $table, array $keys, array $values): string Generates a platform-specific insert string from the supplied data.
/**
* Generates a platform-specific insert string from the supplied data.
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1798
⧉protected validateInsert(): bool This method is used by both insert() and getCompiledInsert() to validate that...
/**
* This method is used by both insert() and getCompiledInsert() to
* validate that the there data is actually being set and that table
* has been chosen to be inserted into.
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1922
⧉protected _insert(string $table, array $keys, array $unescapedKeys): string Generates a platform-specific insert string from the supplied data
/**
* Generates a platform-specific insert string from the supplied data
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1938
⧉protected _replace(string $table, array $keys, array $values): string Generates a platform-specific replace string from the supplied data
/**
* Generates a platform-specific replace string from the supplied data
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:1976
⧉protected _update(string $table, array $values): string Generates a platform-specific update string from the supplied data
/**
* Generates a platform-specific update string from the supplied data
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2064
⧉protected validateUpdate(): bool This method is used by both update() and getCompiledUpdate() to validate that...
/**
* This method is used by both update() and getCompiledUpdate() to
* validate that data is actually being set and that a table has been
* chosen to be update.
*
* @throws DatabaseException
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2085
⧉protected _updateBatch(string $table, array $values, string $index): string Generates a platform-specific batch update string from the supplied data
/**
* Generates a platform-specific batch update string from the supplied data
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2179
⧉protected _truncate(string $table): string Generates a platform-specific truncate string from the supplied data
/**
* Generates a platform-specific truncate string from the supplied data
*
* If the database does not support the truncate() command,
* then this method maps to 'DELETE FROM table'
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2299
⧉protected _delete(string $table): string Generates a platform-specific delete string from the supplied data
/**
* Generates a platform-specific delete string from the supplied data
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2392
⧉protected trackAliases($table): string|void Used to track SQL statements written with aliased tables.
/**
* Used to track SQL statements written with aliased tables.
*
* @param array|string $table The table to inspect
*
* @return string|void
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2404
⧉protected compileSelect($selectOverride = false): string Compile the SELECT statement
/**
* Compile the SELECT statement
*
* Generates a query string based on which functions were used.
* Should not be called directly.
*
* @param mixed $selectOverride
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2441
⧉protected compileIgnore(string $statement): string Checks if the ignore option is supported by the Database Driver for the speci...
/**
* Checks if the ignore option is supported by
* the Database Driver for the specific statement.
*
* @return string
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2491
⧉protected compileWhereHaving(string $qbKey): string Escapes identifiers in WHERE and HAVING statements at execution time.
/**
* Escapes identifiers in WHERE and HAVING statements at execution time.
*
* Required so that aliases are tracked properly, regardless of whether
* where(), orWhere(), having(), orHaving are called prior to from(),
* join() and prefixTable is added only if needed.
*
* @param string $qbKey 'QBWhere' or 'QBHaving'
*
* @return string SQL statement
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2511
⧉protected compileGroupBy(): string Escapes identifiers in GROUP BY statements at execution time.
/**
* Escapes identifiers in GROUP BY statements at execution time.
*
* Required so that aliases are tracked properly, regardless of whether
* groupBy() is called prior to from(), join() and prefixTable is added
* only if needed.
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2589
⧉protected compileOrderBy(): string Escapes identifiers in ORDER BY statements at execution time.
/**
* Escapes identifiers in ORDER BY statements at execution time.
*
* Required so that aliases are tracked properly, regardless of whether
* orderBy() is called prior to from(), join() and prefixTable is added
* only if needed.
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2616
⧉protected unionInjection(string $sql): string
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2637
⧉protected objectToArray($object): array Takes an object as input and converts the class variables to array key/vals
/**
* Takes an object as input and converts the class variables to array key/vals
*
* @param object $object
*
* @return array
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2655
⧉protected batchObjectToArray($object): array Takes an object as input and converts the class variables to array key/vals
/**
* Takes an object as input and converts the class variables to array key/vals
*
* @param object $object
*
* @return array
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2680
⧉protected isLiteral(string $str): bool Determines if a string represents a literal value or a field name
/**
* Determines if a string represents a literal value or a field name
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2707
⧉protected resetRun(array $qbResetItems) Resets the query builder values. Called by the get() function
/**
* Resets the query builder values. Called by the get() function
*
* @param array $qbResetItems An array of fields to reset
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2744
⧉protected resetSelect() Resets the query builder values. Called by the get() function
/**
* Resets the query builder values. Called by the get() function
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2754
⧉protected resetWrite() Resets the query builder "write" values.
/**
* Resets the query builder "write" values.
*
* Called by the insert() update() insertBatch() updateBatch() and delete() functions
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2785
⧉protected hasOperator(string $str): bool Tests whether the string has an SQL operator
/**
* Tests whether the string has an SQL operator
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2801
/**
* Returns the SQL string operator
*
* @return mixed
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2814
⧉protected setBind(string $key, $value = null, bool $escape = true): string Stores a bind value after ensuring that it's unique. While it might be nicer ...
/**
* Stores a bind value after ensuring that it's unique.
* While it might be nicer to have named keys for our binds array
* with PHP 7+ we get a huge memory/performance gain with indexed
* arrays instead, so lets take advantage of that here.
*
* @param mixed $value
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2851
⧉protected cleanClone(): $this Returns a clone of a Base Builder with reset query builder values.
/**
* Returns a clone of a Base Builder with reset query builder values.
*
* @return $this
*
* @deprecated
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2883
⧉protected isSubquery($value): bool
/**
* @param mixed $value
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2891
/**
* @param BaseBuilder|Closure $builder
* @param bool $wrapped Wrap the subquery in brackets
* @param string $alias Subquery alias
*/
Inherited from CodeIgniter\Database\BaseBuilder
Defined in .../Database/BaseBuilder.php:2901
⧉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 .../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 .../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 .../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 .../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 .../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 .../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 .../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 .../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 .../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 .../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 .../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 .../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 .../Database/Query.php:279
⧉public debugToolbarDisplay(): string Returns string to display in debug toolbar
/**
* Returns string to display in debug toolbar
*/
Defined in .../Database/Query.php:371
⧉public __toString(): string Return text representation of the query
/**
* Return text representation of the query
*/
Defined in .../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 .../Database/Query.php:289
⧉protected matchNamedBinds(string $sql, array $binds): string Match bindings
/**
* Match bindings
*/
Defined in .../Database/Query.php:317
⧉protected matchSimpleBinds(string $sql, array $binds, int $bindCount, int $ml): string Match bindings
/**
* Match bindings
*/
Defined in .../Database/Query.php:341
⧉public connect(bool $persistent = false): mixed Connect to the database.
/**
* Connect to the database.
*
* @throws DatabaseException
*
* @return mixed
*/
Defined in .../Database/MySQLi/Connection.php:79
⧉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 .../Database/MySQLi/Connection.php:225
⧉public setDatabase(string $databaseName): bool Select a specific database table to use.
/**
* Select a specific database table to use.
*/
Defined in .../Database/MySQLi/Connection.php:242
⧉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 .../Database/MySQLi/Connection.php:264
⧉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 .../Database/MySQLi/Connection.php:321
⧉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 .../Database/MySQLi/Connection.php:348
⧉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 .../Database/MySQLi/Connection.php:545
⧉public insertID(): int Insert ID
/**
* Insert ID
*/
Defined in .../Database/MySQLi/Connection.php:563
/**
* Saves our connection settings.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:335
⧉public initialize(): mixed Initializes the database connection/settings.
/**
* Initializes the database connection/settings.
*
* @throws DatabaseException
*
* @return mixed
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:362
⧉public close() Close the database connection.
/**
* Close the database connection.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:436
⧉public persistentConnect(): mixed Create a persistent database connection.
/**
* Create a persistent database connection.
*
* @return mixed
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:456
⧉public getConnection(?string $alias = null): mixed 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 mixed
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:477
⧉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 .../Database/BaseConnection.php:493
⧉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 .../Database/BaseConnection.php:505
⧉public getPrefix(): string Returns the database prefix.
/**
* Returns the database prefix.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:513
⧉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 .../Database/BaseConnection.php:521
⧉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 .../Database/BaseConnection.php:538
⧉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 .../Database/BaseConnection.php:550
⧉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 mixed ...$binds
*
* @return BaseResult|bool|Query BaseResult when “read” type query, bool when “write” type query, Query when prepared query
*
* @todo BC set $queryClass default as null in 4.1
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:580
⧉public simpleQuery(string $sql): mixed 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 mixed
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:672
⧉public transOff() Disable Transactions
/**
* Disable Transactions
*
* This permits transactions to be disabled at run-time.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:686
/**
* 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 .../Database/BaseConnection.php:705
/**
* Complete Transaction
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:727
⧉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 .../Database/BaseConnection.php:753
⧉public transBegin(bool $testMode = false): bool Begin Transaction
/**
* Begin Transaction
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:761
⧉public transCommit(): bool Commit Transaction
/**
* Commit Transaction
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:795
/**
* Rollback Transaction
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:814
⧉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
*
* @throws DatabaseException
*
* @return BaseBuilder
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:854
⧉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 .../Database/BaseConnection.php:868
⧉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 .../Database/BaseConnection.php:889
⧉public getLastQuery(): mixed Returns the last query's statement object.
/**
* Returns the last query's statement object.
*
* @return mixed
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:917
⧉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 .../Database/BaseConnection.php:925
⧉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 .../Database/BaseConnection.php:936
⧉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 .../Database/BaseConnection.php:947
/**
* 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 .../Database/BaseConnection.php:980
⧉public escapeIdentifiers($item): mixed Escape the SQL Identifiers
/**
* Escape the SQL Identifiers
*
* This function escapes column and table names
*
* @param mixed $item
*
* @return mixed
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:1126
⧉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 .../Database/BaseConnection.php:1184
⧉public escape($str): mixed "Smart" Escape String
/**
* "Smart" Escape String
*
* Escapes data based on type.
* Sets boolean and null types
*
* @param mixed $str
*
* @return mixed
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:1208
/**
* 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 .../Database/BaseConnection.php:1233
⧉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 .../Database/BaseConnection.php:1275
⧉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 .../Database/BaseConnection.php:1298
⧉public listTables(bool $constrainByPrefix = false): array|bool Returns an array of table names
/**
* Returns an array of table names
*
* @throws DatabaseException
*
* @return array|bool
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:1336
⧉public tableExists(string $tableName): bool Determine if a particular table exists
/**
* Determine if a particular table exists
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:1384
⧉public getFieldNames(string $table): array|false Fetch Field Names
/**
* Fetch Field Names
*
* @throws DatabaseException
*
* @return array|false
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:1396
⧉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 .../Database/BaseConnection.php:1441
⧉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 .../Database/BaseConnection.php:1451
⧉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 .../Database/BaseConnection.php:1461
⧉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 .../Database/BaseConnection.php:1471
/**
* Enables foreign key checks temporarily.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:1489
⧉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 .../Database/BaseConnection.php:1504
⧉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 .../Database/BaseConnection.php:1516
⧉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 .../Database/BaseConnection.php:1528
⧉public __get(string $key): mixed Accessor for properties if they exist.
/**
* Accessor for properties if they exist.
*
* @return mixed
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:1590
⧉public __isset(string $key): bool Checker for properties existence.
/**
* Checker for properties existence.
*/
Inherited from CodeIgniter\Database\BaseConnection
Defined in .../Database/BaseConnection.php:1602
⧉protected _close() Close the database connection.
/**
* Close the database connection.
*/
Defined in .../Database/MySQLi/Connection.php:234
⧉protected execute(string $sql): mixed Executes the query against the database.
/**
* Executes the query against the database.
*
* @return mixed
*/
Defined in .../Database/MySQLi/Connection.php:282
⧉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 .../Database/MySQLi/Connection.php:307
/**
* Platform-dependant string escape
*/
Defined in .../Database/MySQLi/Connection.php:329
⧉protected _listTables(bool $prefixLimit = false): 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().
*/
Defined in .../Database/MySQLi/Connection.php:372
⧉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 .../Database/MySQLi/Connection.php:386
⧉protected _fieldData(string $table): array Returns an array of objects with field data
/**
* Returns an array of objects with field data
*
* @throws DatabaseException
*
* @return stdClass[]
*/
Defined in .../Database/MySQLi/Connection.php:398
⧉protected _indexData(string $table): array Returns an array of objects with index data
/**
* Returns an array of objects with index data
*
* @throws DatabaseException
* @throws LogicException
*
* @return stdClass[]
*/
Defined in .../Database/MySQLi/Connection.php:431
⧉protected _foreignKeyData(string $table): array Returns an array of objects with Foreign key data
/**
* Returns an array of objects with Foreign key data
*
* @throws DatabaseException
*
* @return stdClass[]
*/
Defined in .../Database/MySQLi/Connection.php:476
/**
* Rollback Transaction
*/
Defined in .../Database/MySQLi/Connection.php:595
⧉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 .../Database/BaseConnection.php:1320
⧉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 .../Config/View.php:108
/**
* Retrieve an environment-specific configuration setting
*
* @return string|null
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in .../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 .../Config/BaseConfig.php:174
⧉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 .../Autoloader/Autoloader.php:83
⧉public register() Register the loader with the SPL autoloader stack.
/**
* Register the loader with the SPL autoloader stack.
*/
Defined in .../Autoloader/Autoloader.php:134
⧉public addNamespace($namespace, ?string $path = null): $this Registers namespaces with the autoloader.
/**
* Registers namespaces with the autoloader.
*
* @param array|string $namespace
*
* @return $this
*/
Defined in .../Autoloader/Autoloader.php:157
⧉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 .../Autoloader/Autoloader.php:187
⧉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 .../Autoloader/Autoloader.php:201
⧉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 .../Autoloader/Autoloader.php:215
⧉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 .../Autoloader/Autoloader.php:234
⧉public sanitizeFilename(string $filename): string Sanitizes a filename, replacing spaces with dashes.
/**
* Sanitizes a filename, replacing spaces with dashes.
*
* Removes 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 .../Autoloader/Autoloader.php:303
⧉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 .../Autoloader/Autoloader.php:249
⧉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 .../Autoloader/Autoloader.php:279
⧉protected discoverComposerNamespaces() Locates autoload information from Composer, if available.
/**
* Locates autoload information from Composer, if available.
*
* @deprecated No longer used.
*/
Defined in .../Autoloader/Autoloader.php:346
⧉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 .../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 .../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 .../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 .../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 .../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 .../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 .../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 .../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 .../Autoloader/FileLocator.php:362
/**
* Constructor.
*
* @param \Config\Logger $config
*
* @throws RuntimeException
*/
Defined in .../Log/Logger.php:119
⧉public emergency($message, array $context = array()): bool System is unusable.
/**
* System is unusable.
*
* @param string $message
*/
Defined in .../Log/Logger.php:157
⧉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 .../Log/Logger.php:170
⧉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 .../Log/Logger.php:193
⧉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 .../Log/Logger.php:206
⧉public notice($message, array $context = array()): bool Normal but significant events.
/**
* Normal but significant events.
*
* @param string $message
*/
Defined in .../Log/Logger.php:216
/**
* Detailed debug information.
*
* @param string $message
*/
Defined in .../Log/Logger.php:238
⧉public log($level, $message, array $context = array()): bool Logs with an arbitrary level.
/**
* Logs with an arbitrary level.
*
* @param mixed $level
* @param string $message
*/
Defined in .../Log/Logger.php:249
⧉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 .../Log/Logger.php:377
⧉protected interpolate($message, array $context = array()): mixed 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 mixed $message
*
* @return mixed
*/
Defined in .../Log/Logger.php:319
⧉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 .../Log/Logger.php:427
⧉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 .../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 .../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 .../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 $context The context to escape it for: html, css, js, url
* If null, no escaping will happen
*/
Defined in .../View/View.php:311
⧉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
*/
Defined in .../View/View.php:330
⧉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 .../View/View.php:345
⧉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 .../View/View.php:355
⧉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 .../View/View.php:363
⧉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 .../View/View.php:373
⧉public endSection() Captures the last section
/**
* Captures the last section
*
* @throws RuntimeException
*/
Defined in .../View/View.php:387
⧉public renderSection(string $sectionName) Renders a section's contents.
/**
* Renders a section's contents.
*/
Defined in .../View/View.php:408
⧉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 .../View/View.php:427
⧉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 .../View/View.php:436
⧉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 .../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 .../View/View.php:444
/**
* 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 .../Validation/Validation.php:109
⧉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 mixed $value
* @param string[] $errors
*/
Defined in .../Validation/Validation.php:187
⧉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 .../Validation/Validation.php:348
⧉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
*
* @throws TypeError
*
* @return $this
*/
Defined in .../Validation/Validation.php:385
⧉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 .../Validation/Validation.php:425
⧉public getRules(): array Returns all of the rules currently defined.
/**
* Returns all of the rules currently defined.
*/
Defined in .../Validation/Validation.php:452
⧉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 .../Validation/Validation.php:460
⧉public getRuleGroup(string $group): array Get rule group.
/**
* Get rule group.
*
* @param string $group Group.
*
* @throws InvalidArgumentException If group not found.
*
* @return string[] Rule group.
*/
Defined in .../Validation/Validation.php:474
⧉public setRuleGroup(string $group) Set rule group.
/**
* Set rule group.
*
* @param string $group Group.
*
* @throws InvalidArgumentException If group not found.
*/
Defined in .../Validation/Validation.php:494
⧉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.
*/
Defined in .../Validation/Validation.php:508
⧉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.
*/
Defined in .../Validation/Validation.php:522
⧉public loadRuleGroup(?string $group = null): array|ValidationException|null 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|ValidationException|null
*/
Defined in .../Validation/Validation.php:562
⧉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 .../Validation/Validation.php:642
⧉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 .../Validation/Validation.php:653
⧉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 .../Validation/Validation.php:680
⧉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 .../Validation/Validation.php:695
⧉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 .../Validation/Validation.php:776
⧉protected processRules(string $field, ?string $label, $value, $rules = null, ?array $data = 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 $data
*/
Defined in .../Validation/Validation.php:204
⧉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 .../Validation/Validation.php:541
⧉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 .../Validation/Validation.php:604
/**
* Attempts to find the appropriate error message
*
* @param string|null $value The value that caused the validation to fail.
*/
Defined in .../Validation/Validation.php:707
⧉protected splitRules(string $rules): array Split rules string by pipe operator.
/**
* Split rules string by pipe operator.
*/
Defined in .../Validation/Validation.php:734
protected validationMessages -> array (0)
protected validationRules -> array (0)
protected _pagination -> null
⧉private builderMethodsNotAvailable -> array (3)
0 => string (17) "getCompiledInsert"
1 => string (17) "getCompiledSelect"
2 => string (17) "getCompiledUpdate"
⇄⧉public all(): array 管理者最新消息列表
$value->roomModel->all()
/**
* 管理者最新消息列表
* @param string $category
* @return array
*/
Defined in .../app/Models/Room.php:33
⇄⧉public types()
$value->roomModel->types()
Defined in .../app/Models/Room.php:37
⇄⧉public setAlias(string $alias): $this 設定table alias name
$value->roomModel->setAlias(string $alias)
/**
* 設定table alias name
*
* @since version 1.1.2
*
* @param string $alias
* @return $this
*/
Inherited from App\Libraries\BaseApp\Model
Defined in .../app/Libraries/BaseApp/Model.php:62
/**
* 設定分頁資訊,與findLimit共用
* 當呼叫與findLimit時,有設定分頁資訊，會依照設定內容自動分頁
*
* @since version 1.0.0
*
* @param int $page 頁碼
* @param type $perPage 一頁幾筆
* @return $this
*/
Inherited from App\Libraries\BaseApp\Model
Defined in .../app/Libraries/BaseApp/Model.php:77
⇄⧉public getPagination(): array 取得分頁結果 並清除分頁設定
$value->roomModel->getPagination()
/**
* 取得分頁結果 並清除分頁設定
*
* @since version 1.0.0
*
* @return array
*/
Inherited from App\Libraries\BaseApp\Model
Defined in .../app/Libraries/BaseApp/Model.php:95
new \App\Models\Room(?CodeIgniter\Database\ConnectionInterface $db = null, ?CodeIgniter\Validation\ValidationInterface $validation = null)
Inherited from CodeIgniter\Model
Defined in .../Model.php:131
⇄⧉public setTable(string $table): $this Specify the table associated with a model
$value->roomModel->setTable(string $table)
/**
* Specify the table associated with a model
*
* @param string $table Table
*
* @return $this
*/
Inherited from CodeIgniter\Model
Defined in .../Model.php:150
⇄⧉public getIdValue($data): array|int|string|null Returns the id value for the data array or object
$value->roomModel->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 .../Model.php:483
⇄⧉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 methods works only with dbCalls
*
* @throws DataException
*/
Inherited from CodeIgniter\Model
Defined in .../Model.php:504
⇄⧉public countAllResults(bool $reset = true, bool $test = false): mixed Override countAllResults to account for soft deleted accounts.
/**
* Override countAllResults to account for soft deleted accounts.
*
* @return mixed
*/
Inherited from CodeIgniter\Model
Defined in .../Model.php:538
⇄⧉public builder(?string $table = null): BaseBuilder Provides a shared instance of the Query Builder.
$value->roomModel->builder(?string $table = null)
/**
* Provides a shared instance of the Query Builder.
*
* @throws ModelException
*
* @return BaseBuilder
*/
Inherited from CodeIgniter\Model
Defined in .../Model.php:561
⇄⧉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 mixed $key Field name, or an array of field/value pairs
* @param mixed $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 .../Model.php:608
⇄⧉public insert($data = null, bool $returnID = true): BaseResult|false|int|object|string Inserts data into the database. If an object is provided, it will attempt to ...
/**
* Inserts data into the database. If an object is provided,
* it will attempt to convert it to an array.
*
* @param array|object|null $data
* @param bool $returnID Whether insert ID should be returned or not.
*
* @throws ReflectionException
*
* @return BaseResult|false|int|object|string
*/
Inherited from CodeIgniter\Model
Defined in .../Model.php:653
⇄⧉public update($id = null, $data = null): bool Updates a single record in the database. If an object is provided, it will at...
/**
* Updates a single record in the database. If an object is provided,
* it will attempt to convert it into an array.
*
* @param array|int|string|null $id
* @param array|object|null $data
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\Model
Defined in .../Model.php:679
⧉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 .../Model.php:729
⧉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 .../Model.php:747
⧉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 .../Model.php:762
⇄⧉public find($id = null): array|object|null The resulting row of data, or null. Fetches the row of database
$value->roomModel->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 .../BaseModel.php:504
⇄⧉public findColumn(string $columnName): array|null The resulting row of data, or null if no data found. Fetches the column of database
$value->roomModel->findColumn(string $columnName)
/**
* Fetches the column of database
*
* @param string $columnName Column Name
*
* @throws DataException
*
* @return array|null The resulting row of data, or null if no data found.
*/
Inherited from CodeIgniter\BaseModel
Defined in .../BaseModel.php:548
⇄⧉public findAll(int $limit0, int $offset0): array Fetches all results, while optionally limiting them.
$value->roomModel->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 .../BaseModel.php:567
⇄⧉public first(): array|object|null Returns the first row of the result set.
$value->roomModel->first()
/**
* Returns the first row of the result set.
*
* @return array|object|null
*/
Inherited from CodeIgniter\BaseModel
Defined in .../BaseModel.php:607
⇄⧉public save($data): bool A convenience method that will attempt to determine whether the data should b...
$value->roomModel->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 .../BaseModel.php:649
⇄⧉public getInsertID(): int|string Returns last insert ID or 0.
$value->roomModel->getInsertID()
/**
* Returns last insert ID or 0.
*
* @return int|string
*/
Inherited from CodeIgniter\BaseModel
Defined in .../BaseModel.php:684
⇄⧉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
*
* @throws ReflectionException
*
* @return bool|int Number of rows inserted or FALSE on failure
*/
Inherited from CodeIgniter\BaseModel
Defined in .../BaseModel.php:774
⇄⧉public updateBatch(?array $set = null, ?string $index = null, int $batchSize = 100, bool $returnSQL = false): mixed Number of rows affected or FALSE on failure 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
*
* @throws DatabaseException
* @throws ReflectionException
*
* @return mixed Number of rows affected or FALSE on failure
*/
Inherited from CodeIgniter\BaseModel
Defined in .../BaseModel.php:890
⇄⧉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.
*
* @throws DatabaseException
*
* @return BaseResult|bool
*/
Inherited from CodeIgniter\BaseModel
Defined in .../BaseModel.php:944
⇄⧉public purgeDeleted(): mixed Permanently deletes all rows that have been marked as deleted through soft de...
$value->roomModel->purgeDeleted()
/**
* Permanently deletes all rows that have been marked as deleted
* through soft deletes (deleted = 1)
*
* @return mixed
*/
Inherited from CodeIgniter\BaseModel
Defined in .../BaseModel.php:981
⇄⧉public withDeleted(bool $val = true): $this Sets $useSoftDeletes value so that we can temporarily override the soft delet...
$value->roomModel->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 .../BaseModel.php:998
⇄⧉public onlyDeleted(): $this Works with the find* methods to return only the rows that have been deleted.
$value->roomModel->onlyDeleted()
/**
* Works with the find* methods to return only the rows that
* have been deleted.
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in .../BaseModel.php:1011
⇄⧉public replace(?array $data = null, bool $returnSQL = false): mixed 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 mixed
*/
Inherited from CodeIgniter\BaseModel
Defined in .../BaseModel.php:1027
⇄⧉public errors(bool $forceDB = false): array<string,string> Grabs the last error(s) that occurred. If data was validated, it will first c...
$value->roomModel->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 .../BaseModel.php:1052
⇄⧉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 .../BaseModel.php:1074
⇄⧉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 .../BaseModel.php:1098
⇄⧉public protect(bool $protect = true): $this Sets whether or not we should whitelist data set during updates or inserts ag...
$value->roomModel->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 .../BaseModel.php:1113
⇄⧉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 .../BaseModel.php:1236
⇄⧉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 .../BaseModel.php:1251
⇄⧉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 .../BaseModel.php:1267
⇄⧉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 .../BaseModel.php:1282
⇄⧉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 .../BaseModel.php:1298
⇄⧉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 .../BaseModel.php:1313
⇄⧉public validate($data): bool Validate the data against the validation rules (or the validation group) spec...
$value->roomModel->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 .../BaseModel.php:1326
⇄⧉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 .../BaseModel.php:1358
⇄⧉public getValidationMessages(): array Returns the model's define validation messages so they can be used elsewhere,...
$value->roomModel->getValidationMessages()
/**
* Returns the model's define validation messages so they
* can be used elsewhere, if needed.
*/
Inherited from CodeIgniter\BaseModel
Defined in .../BaseModel.php:1381
⇄⧉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 .../BaseModel.php:1417
⇄⧉public asArray(): $this Sets the return type of the results to be as an associative array.
$value->roomModel->asArray()
/**
* Sets the return type of the results to be as an associative array.
*
* @return $this
*/
Inherited from CodeIgniter\BaseModel
Defined in .../BaseModel.php:1469
⇄⧉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 .../BaseModel.php:1486
⧉protected setApiStatus($code, $msg) 定義apiCode and apiMsg
/**
* 定義apiCode and apiMsg
* @param type $code
* @param type $msg
*/
Inherited from App\Libraries\BaseApp\Model
Defined in .../app/Libraries/BaseApp/Model.php:367
⧉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 methods works only with dbCalls
* This methods 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 .../Model.php:167
⧉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 methods works only with...
/**
* Fetches the column of database from $this->table
* This methods 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 .../Model.php:199
⧉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 methods works only with dbCalls
*
* @param int $limit Limit
* @param int $offset Offset
*
* @return array
*/
Inherited from CodeIgniter\Model
Defined in .../Model.php:214
⧉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 methods works only with dbCalls
*
* @return array|object|null
*/
Inherited from CodeIgniter\Model
Defined in .../Model.php:234
⧉protected doInsert(array $data): bool|Query Inserts data into the current table. This methods works only with dbCalls
/**
* Inserts data into the current table.
* This methods works only with dbCalls
*
* @param array $data Data
*
* @return bool|Query
*/
Inherited from CodeIgniter\Model
Defined in .../Model.php:261
⧉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 methods 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 .../Model.php:300
⧉protected doUpdate($id = null, $data = null): bool Updates a single record in $this->table. This methods works only with dbCalls
/**
* Updates a single record in $this->table.
* This methods works only with dbCalls
*
* @param array|int|string|null $id
* @param array|null $data
*/
Inherited from CodeIgniter\Model
Defined in .../Model.php:322
⧉protected doUpdateBatch(?array $set = null, ?string $index = null, int $batchSize = 100, bool $returnSQL = false): mixed Number of rows affected or FALSE on failure Compiles an update string and runs the query This methods works only with dbC...
/**
* Compiles an update string and runs the query
* This methods 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
*
* @throws DatabaseException
*
* @return mixed Number of rows affected or FALSE on failure
*/
Inherited from CodeIgniter\Model
Defined in .../Model.php:354
⧉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 methods works only with dbCalls
*
* @param array|int|string|null $id The rows primary key(s)
* @param bool $purge Allows overriding the soft deletes setting.
*
* @throws DatabaseException
*
* @return bool|string
*/
Inherited from CodeIgniter\Model
Defined in .../Model.php:371
⧉protected doPurgeDeleted(): bool|mixed 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 methods works only with dbCalls
*
* @return bool|mixed
*/
Inherited from CodeIgniter\Model
Defined in .../Model.php:411
⧉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 methods works only with dbCalls
*/
Inherited from CodeIgniter\Model
Defined in .../Model.php:423
⧉protected doReplace(?array $data = null, bool $returnSQL = false): mixed Compiles a replace into string and runs the query This methods works only wit...
/**
* Compiles a replace into string and runs the query
* This methods works only with dbCalls
*
* @param array|null $data Data
* @param bool $returnSQL Set to true to return Query String
*
* @return mixed
*/
Inherited from CodeIgniter\Model
Defined in .../Model.php:437
⧉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 methods works only with dbCalls
*
* @return array<string,string>
*/
Inherited from CodeIgniter\Model
Defined in .../Model.php:450
⧉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 .../Model.php:471
⧉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 .../Model.php:627
⧉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
*
* @throws ReflectionException
*
* @return array|null Array
*/
Inherited from CodeIgniter\Model
Defined in .../Model.php:707
⧉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 .../BaseModel.php:308
⧉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 .../BaseModel.php:1131
⧉protected setDate(?int $userData = null): mixed 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.
*
* @throws ModelException
*
* @return mixed
*/
Inherited from CodeIgniter\BaseModel
Defined in .../BaseModel.php:1159
⧉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
*
* @throws ModelException
*
* @return int|string
*/
Inherited from CodeIgniter\BaseModel
Defined in .../BaseModel.php:1183
⧉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 .../BaseModel.php:1212
⧉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 .../BaseModel.php:1394
⧉protected trigger(string $event, array $eventData): mixed 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
*
* @throws DataException
*
* @return mixed
*/
Inherited from CodeIgniter\BaseModel
Defined in .../BaseModel.php:1446
⧉protected objectToArray($data, bool $onlyChanged = true, bool $recursive = false): array Takes a class and returns an array of it's public and protected properties as...
/**
* Takes a class and returns an array of it's 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 casted as array as well
*
* @throws ReflectionException
*
* @return array Array
*/
Inherited from CodeIgniter\BaseModel
Defined in .../BaseModel.php:1507
⧉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 .../BaseModel.php:1569
⧉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 .../BaseModel.php:1670
⧉private listQuery(): $this 篩選分類,取得封面照片
/**
* 篩選分類,取得封面照片
* @return $this
*/
Defined in .../app/Models/Room.php:21
⇄⧉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 .../Model.php:807
/**
* Constructor.
*
* @param \Config\Logger $config
*
* @throws RuntimeException
*/
Defined in .../Log/Logger.php:119
⧉public emergency($message, array $context = array()): bool System is unusable.
/**
* System is unusable.
*
* @param string $message
*/
Defined in .../Log/Logger.php:157
⧉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 .../Log/Logger.php:170
⧉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 .../Log/Logger.php:193
⧉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 .../Log/Logger.php:206
⧉public notice($message, array $context = array()): bool Normal but significant events.
/**
* Normal but significant events.
*
* @param string $message
*/
Defined in .../Log/Logger.php:216
/**
* Detailed debug information.
*
* @param string $message
*/
Defined in .../Log/Logger.php:238
⧉public log($level, $message, array $context = array()): bool Logs with an arbitrary level.
/**
* Logs with an arbitrary level.
*
* @param mixed $level
* @param string $message
*/
Defined in .../Log/Logger.php:249
⧉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 .../Log/Logger.php:377
⧉protected interpolate($message, array $context = array()): mixed 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 mixed $message
*
* @return mixed
*/
Defined in .../Log/Logger.php:319
⧉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 .../Log/Logger.php:427
/**
* Retrieve an environment-specific configuration setting
*
* @return string|null
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in .../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 .../Config/BaseConfig.php:174
/**
* Constructor.
*
* @param string $uri
*
* @throws InvalidArgumentException
*/
Defined in .../HTTP/URI.php:232
⧉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 .../HTTP/URI.php:245
⧉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 .../HTTP/URI.php:258
⧉public setURI(?string $uri = null): URI Sets and overwrites any current URI information.
/**
* Sets and overwrites any current URI information.
*
* @return URI
*/
Defined in .../HTTP/URI.php:270
⧉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 .../HTTP/URI.php:304
⧉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 .../HTTP/URI.php:328
⧉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 .../HTTP/URI.php:371
⧉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 .../HTTP/URI.php:388
⧉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 .../HTTP/URI.php:407
⧉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 .../HTTP/URI.php:427
⧉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 .../HTTP/URI.php:458
⧉public getQuery(array $options = array()): string Retrieve the query string
/**
* Retrieve the query string
*/
Defined in .../HTTP/URI.php:466
⧉public getFragment(): string Retrieve a URI fragment
/**
* Retrieve a URI fragment
*/
Defined in .../HTTP/URI.php:500
⧉public getSegments(): array Returns the segments of the path as an array.
/**
* Returns the segments of the path as an array.
*/
Defined in .../HTTP/URI.php:508
⧉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 .../HTTP/URI.php:522
⧉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 .../HTTP/URI.php:543
⧉public getTotalSegments(): int Returns the total number of segments.
/**
* Returns the total number of segments.
*/
Defined in .../HTTP/URI.php:566
⧉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 .../HTTP/URI.php:579
⧉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 .../HTTP/URI.php:634
⧉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 .../HTTP/URI.php:662
⧉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 .../HTTP/URI.php:680
⧉public setHost(string $str): $this Sets the host name to use.
/**
* Sets the host name to use.
*
* @return $this
*/
Defined in .../HTTP/URI.php:693
⧉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 .../HTTP/URI.php:707
⧉public setPath(string $path): $this Sets the path portion of the URI.
/**
* Sets the path portion of the URI.
*
* @return $this
*/
Defined in .../HTTP/URI.php:731
⧉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 .../HTTP/URI.php:747
⧉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 .../HTTP/URI.php:764
⧉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 .../HTTP/URI.php:794
⧉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 .../HTTP/URI.php:808
⧉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 .../HTTP/URI.php:822
⧉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 .../HTTP/URI.php:839
⧉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 .../HTTP/URI.php:863
⧉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 .../HTTP/URI.php:959
⧉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 .../HTTP/URI.php:875
⧉protected applyParts(array $parts) Saves our parts from a parse_url call.
/**
* Saves our parts from a parse_url call.
*/
Defined in .../HTTP/URI.php:907
⧉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 .../HTTP/URI.php:1015
⧉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 .../HTTP/URI.php:1037
⧉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 .../HTTP/URI.php:602
⇄⧉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.
/**
* 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 .../HTTP/URI.php:182
⧉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|string|null $value
*/
Defined in .../HTTP/Header.php:41
⧉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 .../HTTP/Header.php:50
⧉public getValue(): array|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|string
*/
Defined in .../HTTP/Header.php:61
⧉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 .../HTTP/Header.php:71
⧉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|string|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:85
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:100
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:125
⧉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 .../HTTP/Header.php:149
⧉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 .../HTTP/Header.php:178
⧉Accept-Encoding => CodeIgniter\HTTP\Header (2)
Properties (2)
Available methods (9)
protected name -> string (15) "Accept-Encoding"
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|string|null $value
*/
Defined in .../HTTP/Header.php:41
⧉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 .../HTTP/Header.php:50
⧉public getValue(): array|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|string
*/
Defined in .../HTTP/Header.php:61
⧉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 .../HTTP/Header.php:71
⧉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|string|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:85
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:100
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:125
⧉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 .../HTTP/Header.php:149
⧉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 .../HTTP/Header.php:178
⧉Host => CodeIgniter\HTTP\Header (2)
Properties (2)
Available methods (9)
protected name -> string (4) "Host"
protected value -> string (18) "yunestatehotel.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|string|null $value
*/
Defined in .../HTTP/Header.php:41
⧉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 .../HTTP/Header.php:50
⧉public getValue(): array|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|string
*/
Defined in .../HTTP/Header.php:61
⧉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 .../HTTP/Header.php:71
⧉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|string|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:85
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:100
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:125
⧉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 .../HTTP/Header.php:149
⧉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 .../HTTP/Header.php:178
⧉Pragma => CodeIgniter\HTTP\Header (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|string|null $value
*/
Defined in .../HTTP/Header.php:41
⧉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 .../HTTP/Header.php:50
⧉public getValue(): array|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|string
*/
Defined in .../HTTP/Header.php:61
⧉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 .../HTTP/Header.php:71
⧉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|string|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:85
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:100
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:125
⧉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 .../HTTP/Header.php:149
⧉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 .../HTTP/Header.php:178
⧉User-Agent => CodeIgniter\HTTP\Header (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|string|null $value
*/
Defined in .../HTTP/Header.php:41
⧉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 .../HTTP/Header.php:50
⧉public getValue(): array|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|string
*/
Defined in .../HTTP/Header.php:61
⧉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 .../HTTP/Header.php:71
⧉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|string|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:85
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:100
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:125
⧉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 .../HTTP/Header.php:149
⧉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 .../HTTP/Header.php:178
⧉Cache-Control => CodeIgniter\HTTP\Header (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|string|null $value
*/
Defined in .../HTTP/Header.php:41
⧉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 .../HTTP/Header.php:50
⧉public getValue(): array|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|string
*/
Defined in .../HTTP/Header.php:61
⧉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 .../HTTP/Header.php:71
⧉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|string|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:85
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:100
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:125
⧉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 .../HTTP/Header.php:149
⧉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 .../HTTP/Header.php:178
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|string|null $value
*/
Defined in .../HTTP/Header.php:41
⧉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 .../HTTP/Header.php:50
⧉public getValue(): array|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|string
*/
Defined in .../HTTP/Header.php:61
⧉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 .../HTTP/Header.php:71
⧉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|string|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:85
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:100
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:125
⧉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 .../HTTP/Header.php:149
⧉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 .../HTTP/Header.php:178
⧉Sec-Fetch-Site => CodeIgniter\HTTP\Header (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|string|null $value
*/
Defined in .../HTTP/Header.php:41
⧉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 .../HTTP/Header.php:50
⧉public getValue(): array|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|string
*/
Defined in .../HTTP/Header.php:61
⧉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 .../HTTP/Header.php:71
⧉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|string|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:85
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:100
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:125
⧉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 .../HTTP/Header.php:149
⧉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 .../HTTP/Header.php:178
⧉Sec-Fetch-Mode => CodeIgniter\HTTP\Header (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|string|null $value
*/
Defined in .../HTTP/Header.php:41
⧉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 .../HTTP/Header.php:50
⧉public getValue(): array|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|string
*/
Defined in .../HTTP/Header.php:61
⧉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 .../HTTP/Header.php:71
⧉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|string|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:85
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:100
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:125
⧉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 .../HTTP/Header.php:149
⧉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 .../HTTP/Header.php:178
⧉Sec-Fetch-User => CodeIgniter\HTTP\Header (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|string|null $value
*/
Defined in .../HTTP/Header.php:41
⧉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 .../HTTP/Header.php:50
⧉public getValue(): array|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|string
*/
Defined in .../HTTP/Header.php:61
⧉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 .../HTTP/Header.php:71
⧉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|string|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:85
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:100
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:125
⧉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 .../HTTP/Header.php:149
⧉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 .../HTTP/Header.php:178
⧉Sec-Fetch-Dest => CodeIgniter\HTTP\Header (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|string|null $value
*/
Defined in .../HTTP/Header.php:41
⧉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 .../HTTP/Header.php:50
⧉public getValue(): array|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|string
*/
Defined in .../HTTP/Header.php:61
⧉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 .../HTTP/Header.php:71
⧉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|string|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:85
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:100
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:125
⧉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 .../HTTP/Header.php:149
⧉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 .../HTTP/Header.php:178
⧉Sec-Ch-Ua => CodeIgniter\HTTP\Header (2)
Properties (2)
Available methods (9)
protected name -> string (9) "Sec-Ch-Ua"
protected value -> string (66) ""Chromium";v="130", "HeadlessChrome";v="130", "Not?A_Brand";v="99""
⧉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|string|null $value
*/
Defined in .../HTTP/Header.php:41
⧉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 .../HTTP/Header.php:50
⧉public getValue(): array|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|string
*/
Defined in .../HTTP/Header.php:61
⧉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 .../HTTP/Header.php:71
⧉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|string|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:85
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:100
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:125
⧉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 .../HTTP/Header.php:149
⧉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 .../HTTP/Header.php:178
⧉Sec-Ch-Ua-Mobile => CodeIgniter\HTTP\Header (2)
Properties (2)
Available methods (9)
protected name -> string (16) "Sec-Ch-Ua-Mobile"
protected value -> string (2) "?0"
⧉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|string|null $value
*/
Defined in .../HTTP/Header.php:41
⧉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 .../HTTP/Header.php:50
⧉public getValue(): array|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|string
*/
Defined in .../HTTP/Header.php:61
⧉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 .../HTTP/Header.php:71
⧉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|string|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:85
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:100
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:125
⧉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 .../HTTP/Header.php:149
⧉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 .../HTTP/Header.php:178
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|string|null $value
*/
Defined in .../HTTP/Header.php:41
⧉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 .../HTTP/Header.php:50
⧉public getValue(): array|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|string
*/
Defined in .../HTTP/Header.php:61
⧉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 .../HTTP/Header.php:71
⧉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|string|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:85
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:100
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:125
⧉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 .../HTTP/Header.php:149
⧉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 .../HTTP/Header.php:178
⧉Priority => CodeIgniter\HTTP\Header (2)
Properties (2)
Available methods (9)
protected name -> string (8) "Priority"
protected value -> string (6) "u=0, i"
⧉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|string|null $value
*/
Defined in .../HTTP/Header.php:41
⧉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 .../HTTP/Header.php:50
⧉public getValue(): array|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|string
*/
Defined in .../HTTP/Header.php:61
⧉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 .../HTTP/Header.php:71
⧉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|string|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:85
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:100
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:125
⧉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 .../HTTP/Header.php:149
⧉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 .../HTTP/Header.php:178
⧉X-Https => CodeIgniter\HTTP\Header (2)
Properties (2)
Available methods (9)
protected name -> string (7) "X-Https"
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|string|null $value
*/
Defined in .../HTTP/Header.php:41
⧉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 .../HTTP/Header.php:50
⧉public getValue(): array|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|string
*/
Defined in .../HTTP/Header.php:61
⧉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 .../HTTP/Header.php:71
⧉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|string|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:85
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:100
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:125
⧉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 .../HTTP/Header.php:149
⧉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 .../HTTP/Header.php:178
⧉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 .../Config/BaseConfig.php:60
/**
* Retrieve an environment-specific configuration setting
*
* @return string|null
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in .../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 .../Config/BaseConfig.php:174
/**
* Constructor
*
* @param App $config
* @param URI $uri
* @param string|null $body
* @param UserAgent $userAgent
*/
Defined in .../HTTP/IncomingRequest.php:150
⧉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 .../HTTP/IncomingRequest.php:180
⧉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 .../HTTP/IncomingRequest.php:209
⧉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 .../HTTP/IncomingRequest.php:322
⧉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 .../HTTP/IncomingRequest.php:348
⧉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 .../HTTP/IncomingRequest.php:356
⧉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 .../HTTP/IncomingRequest.php:365
⧉public setPath(string $path, ?Config\App $config = null): $this Sets the relative path and updates the URI object. Note: Since current_url() ...
/**
* 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 SCRIPT_NAME
* @param App $config Optional alternate config to use
*
* @return $this
*/
Defined in .../HTTP/IncomingRequest.php:389
⧉public getPath(): string Returns the path relative to SCRIPT_NAME, running detection as necessary.
/**
* Returns the path relative to SCRIPT_NAME,
* running detection as necessary.
*/
Defined in .../HTTP/IncomingRequest.php:427
⧉public setLocale(string $locale): IncomingRequest Sets the locale string for this request.
/**
* Sets the locale string for this request.
*
* @return IncomingRequest
*/
Defined in .../HTTP/IncomingRequest.php:441
⧉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 .../HTTP/IncomingRequest.php:459
⧉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 .../HTTP/IncomingRequest.php:467
⧉public getVar($index = null, $filter = null, $flags = null): mixed 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 mixed $flags
*
* @return mixed
*/
Defined in .../HTTP/IncomingRequest.php:483
⧉public getJSON(bool $assoc = false, int $depth = 512, int $options0): mixed 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 mixed
*/
Defined in .../HTTP/IncomingRequest.php:521
⧉public getJsonVar(string $index, bool $assoc = false, ?int $filter = null, $flags = null): mixed Get a specific variable from a JSON input stream
/**
* Get a specific variable from a JSON input stream
*
* @param string $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 mixed
*/
Defined in .../HTTP/IncomingRequest.php:536
⧉public getRawInput(): mixed 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 mixed
*/
Defined in .../HTTP/IncomingRequest.php:570
⧉public getGet($index = null, $filter = null, $flags = null): mixed 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 mixed|null $flags
*
* @return mixed
*/
Defined in .../HTTP/IncomingRequest.php:586
⧉public getPost($index = null, $filter = null, $flags = null): mixed 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 mixed $flags
*
* @return mixed
*/
Defined in .../HTTP/IncomingRequest.php:600
⧉public getPostGet($index = null, $filter = null, $flags = null): mixed 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 mixed $flags
*
* @return mixed
*/
Defined in .../HTTP/IncomingRequest.php:614
⧉public getGetPost($index = null, $filter = null, $flags = null): mixed 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 mixed $flags
*
* @return mixed
*/
Defined in .../HTTP/IncomingRequest.php:631
⧉public getCookie($index = null, $filter = null, $flags = null): mixed 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 mixed $flags
*
* @return mixed
*/
Defined in .../HTTP/IncomingRequest.php:648
⧉public getUserAgent(): UserAgent Fetch the user agent string
/**
* Fetch the user agent string
*
* @return UserAgent
*/
Defined in .../HTTP/IncomingRequest.php:658
⧉public getOldInput(string $key): mixed 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 mixed
*/
Defined in .../HTTP/IncomingRequest.php:670
⧉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 .../HTTP/IncomingRequest.php:714
⧉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 .../HTTP/IncomingRequest.php:729
⧉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 .../HTTP/IncomingRequest.php:744
⧉public getIPAddress(): string Gets the user's IP address.
/**
* Gets the user's IP address.
*
* @return string IP address
*/
Inherited from CodeIgniter\HTTP\Request
Defined in .../HTTP/RequestTrait.php:48
⧉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 .../HTTP/Request.php:79
⧉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 .../HTTP/Request.php:93
⧉public setMethod(string $method): Request Sets the request method. Used when spoofing the request.
/**
* Sets the request method. Used when spoofing the request.
*
* @return Request
*
* @deprecated Use withMethod() instead for immutability
*
* @codeCoverageIgnore
*/
Inherited from CodeIgniter\HTTP\Request
Defined in .../HTTP/Request.php:107
⧉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 .../HTTP/Request.php:121
⧉public getUri(): URI Retrieves the URI instance.
/**
* Retrieves the URI instance.
*
* @return URI
*/
Inherited from CodeIgniter\HTTP\Request
Defined in .../HTTP/Request.php:135
⧉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 null $flags
*
* @return mixed
*/
Inherited from CodeIgniter\HTTP\Request
Defined in .../HTTP/RequestTrait.php:167
⧉public getEnv($index = null, $filter = null, $flags = null): mixed Fetch an item from the $_ENV array.
/**
* Fetch an item from the $_ENV array.
*
* @param null $index Index for item to be fetched from $_ENV
* @param null $filter A filter name to be applied
* @param null $flags
*
* @return mixed
*/
Inherited from CodeIgniter\HTTP\Request
Defined in .../HTTP/RequestTrait.php:181
⧉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 .../HTTP/RequestTrait.php:193
⧉public fetchGlobal(string $method, $index = null, ?int $filter = null, $flags = null): mixed 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 mixed
*/
Inherited from CodeIgniter\HTTP\Request
Defined in .../HTTP/RequestTrait.php:217
⧉public getBody(): mixed Returns the Message's body.
/**
* Returns the Message's body.
*
* @return mixed
*/
Inherited from CodeIgniter\HTTP\Message
Defined in .../HTTP/Message.php:51
⧉public setBody($data): self Sets the body of the current message.
/**
* Sets the body of the current message.
*
* @param mixed $data
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in .../HTTP/MessageTrait.php:52
⧉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
*
* @codeCoverageIgnore
*/
Inherited from CodeIgniter\HTTP\Message
Defined in .../HTTP/Message.php:65
⧉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 .../HTTP/MessageTrait.php:66
⧉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
*
* @codeCoverageIgnore
*/
Inherited from CodeIgniter\HTTP\Message
Defined in .../HTTP/Message.php:80
⧉public populateHeaders(): void Populates the $headers array with any headers the getServer knows about.
/**
* Populates the $headers array with any headers the getServer knows about.
*/
Inherited from CodeIgniter\HTTP\Message
Defined in .../HTTP/MessageTrait.php:80
⧉public hasHeader(string $name): bool Determines whether a header exists.
/**
* Determines whether a header exists.
*/
Inherited from CodeIgniter\HTTP\Message
Defined in .../HTTP/Message.php:88
⧉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 .../HTTP/Message.php:106
⧉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 .../HTTP/MessageTrait.php:107
⧉public getProtocolVersion(): string Returns the HTTP Protocol Version.
/**
* Returns the HTTP Protocol Version.
*/
Inherited from CodeIgniter\HTTP\Message
Defined in .../HTTP/Message.php:120
⧉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 .../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 .../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 .../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 .../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 .../HTTP/MessageTrait.php:197
⧉public setProtocolVersion(string $version): self Sets the HTTP protocol version.
/**
* Sets the HTTP protocol version.
*
* @throws HTTPException For invalid protocols
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in .../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.
*/
Defined in .../HTTP/IncomingRequest.php:196
⧉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 .../HTTP/IncomingRequest.php:239
/**
* Parse QUERY_STRING
*
* Will parse QUERY_STRING and automatically detect the URI from it.
*/
Defined in .../HTTP/IncomingRequest.php:294
⧉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 .../HTTP/IncomingRequest.php:760
⧉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 .../HTTP/RequestTrait.php:305
⧉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 .../HTTP/MessageTrait.php:210
/**
* Constructor.
*
* Stores our default values from the Config file.
*/
Defined in .../HTTP/ContentSecurityPolicy.php:242
⧉public enabled(): bool Whether Content Security Policy is being enforced.
/**
* Whether Content Security Policy is being enforced.
*/
Defined in .../HTTP/ContentSecurityPolicy.php:265
⧉public getStyleNonce(): string Get the nonce for the style tag.
/**
* Get the nonce for the style tag.
*/
Defined in .../HTTP/ContentSecurityPolicy.php:273
⧉public getScriptNonce(): string Get the nonce for the script tag.
/**
* Get the nonce for the script tag.
*/
Defined in .../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 .../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 .../HTTP/ContentSecurityPolicy.php:320
⧉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 .../HTTP/ContentSecurityPolicy.php:338
⧉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 .../HTTP/ContentSecurityPolicy.php:359
⧉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 .../HTTP/ContentSecurityPolicy.php:379
⧉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 .../HTTP/ContentSecurityPolicy.php:399
⧉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 .../HTTP/ContentSecurityPolicy.php:418
⧉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 .../HTTP/ContentSecurityPolicy.php:435
⧉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 .../HTTP/ContentSecurityPolicy.php:452
⧉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 .../HTTP/ContentSecurityPolicy.php:469
⧉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 .../HTTP/ContentSecurityPolicy.php:486
⧉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 .../HTTP/ContentSecurityPolicy.php:503
⧉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 .../HTTP/ContentSecurityPolicy.php:520
⧉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 .../HTTP/ContentSecurityPolicy.php:537
⧉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 .../HTTP/ContentSecurityPolicy.php:554
⧉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 .../HTTP/ContentSecurityPolicy.php:569
⧉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 .../HTTP/ContentSecurityPolicy.php:586
⧉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 .../HTTP/ContentSecurityPolicy.php:603
⧉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 .../HTTP/ContentSecurityPolicy.php:620
⧉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 .../HTTP/ContentSecurityPolicy.php:633
⧉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 .../HTTP/ContentSecurityPolicy.php:645
⧉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 .../HTTP/ContentSecurityPolicy.php:666
⧉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 .../HTTP/ContentSecurityPolicy.php:692
⧉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 .../HTTP/ContentSecurityPolicy.php:776
/**
* @param Cookie[] $cookies
*
* @throws CookieException
*/
Defined in .../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 .../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 .../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 .../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 .../Cookie/CookieStore.php:142
⧉public dispatch(): void Dispatches all cookies in store.
/**
* Dispatches all cookies in store.
*
* @deprecated Response should dispatch cookies.
*/
Defined in .../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 .../Cookie/CookieStore.php:186
⧉public clear(): void Clears the cookie collection.
/**
* Clears the cookie collection.
*/
Defined in .../Cookie/CookieStore.php:194
⧉public count(): int Gets the Cookie count in this collection.
/**
* Gets the Cookie count in this collection.
*/
Defined in .../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 .../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 .../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 .../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 .../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
*
* @throws CookieException
*
* @return static
*/
Defined in .../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 (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|string|null $value
*/
Defined in .../HTTP/Header.php:41
⧉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 .../HTTP/Header.php:50
⧉public getValue(): array|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|string
*/
Defined in .../HTTP/Header.php:61
⧉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 .../HTTP/Header.php:71
⧉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|string|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:85
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:100
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:125
⧉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 .../HTTP/Header.php:149
⧉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 .../HTTP/Header.php:178
⧉Content-Type => CodeIgniter\HTTP\Header (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|string|null $value
*/
Defined in .../HTTP/Header.php:41
⧉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 .../HTTP/Header.php:50
⧉public getValue(): array|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|string
*/
Defined in .../HTTP/Header.php:61
⧉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 .../HTTP/Header.php:71
⧉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|string|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:85
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:100
⧉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|null $value
*
* @return $this
*/
Defined in .../HTTP/Header.php:125
⧉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 .../HTTP/Header.php:149
⧉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 .../HTTP/Header.php:178
protected pretend -> boolean false
protected protocolVersion -> string (3) "2.0"
protected reason -> string (2) "OK"
protected statusCode -> integer 200
⧉protected validProtocolVersions -> array (3)
0 => string (3) "1.0"
1 => string (3) "1.1"
2 => string (3) "2.0"
⧉public __construct($config) Constructor
/**
* Constructor
*
* @param App $config
*
* @todo Recommend removing reliance on config injection
*/
Defined in .../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.
*
* @throws HTTPException For invalid status code arguments.
*
* @return $this
*/
Defined in .../HTTP/ResponseTrait.php:149
⧉public setDate(DateTime $date): Response Sets the date header
/**
* Sets the date header
*
* @return Response
*/
Defined in .../HTTP/ResponseTrait.php:177
⧉public setLink(CodeIgniter\Pager\PagerInterface $pager): Response Set the Link Header
/**
* Set the Link Header
*
* @see http://tools.ietf.org/html/rfc5988
*
* @return Response
*
* @todo Recommend moving to Pager
*/
Defined in .../HTTP/ResponseTrait.php:195
⧉public pretend(bool $pretend = true): $this Turns "pretend" mode on or off to aid in testing. Note that this is not a par...
/**
* 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
*/
Defined in .../HTTP/Response.php:196
⧉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 getServer's attempt
* to understand and satisfy the request.
*
* @return int Status code.
*/
Defined in .../HTTP/Response.php:211
⧉public setContentType(string $mime, string $charset = 'UTF-8'): Response 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 Response
*/
Defined in .../HTTP/ResponseTrait.php:224
⧉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 .../HTTP/Response.php:229
⧉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 .../HTTP/ResponseTrait.php:244
⧉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 .../HTTP/Response.php:248
⧉public getJSON(): mixed|string Returns the current body, converted to JSON is it isn't already.
/**
* Returns the current body, converted to JSON is it isn't already.
*
* @throws InvalidArgumentException If the body property is not array.
*
* @return mixed|string
*/
Defined in .../HTTP/ResponseTrait.php:258
⧉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 .../HTTP/ResponseTrait.php:276
⧉public getXML(): mixed|string Retrieves the current body into XML and returns it.
/**
* Retrieves the current body into XML and returns it.
*
* @throws InvalidArgumentException If the body property is not array.
*
* @return mixed|string
*/
Defined in .../HTTP/ResponseTrait.php:290
⧉public noCache(): Response 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 Response
*
* @todo Recommend researching these directives, might need: 'private', 'no-transform', 'no-store', 'must-revalidate'
*
* @see DownloadResponse::noCache()
*/
Defined in .../HTTP/ResponseTrait.php:342
⧉public setCache(array $options = array()): Response 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 Response
*/
Defined in .../HTTP/ResponseTrait.php:376
⧉public setLastModified($date): Response 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 Response
*/
Defined in .../HTTP/ResponseTrait.php:413
⧉public send(): Response Sends the output to the browser.
/**
* Sends the output to the browser.
*
* @return Response
*/
Defined in .../HTTP/ResponseTrait.php:434
⧉public sendHeaders(): Response Sends the headers of this HTTP response to the browser.
/**
* Sends the headers of this HTTP response to the browser.
*
* @return Response
*/
Defined in .../HTTP/ResponseTrait.php:456
⧉public sendBody(): Response Sends the Body of the message to the browser.
/**
* Sends the Body of the message to the browser.
*
* @return Response
*/
Defined in .../HTTP/ResponseTrait.php:485
⧉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 $code The type of redirection, defaults to 302
*
* @throws HTTPException For invalid status code.
*
* @return $this
*/
Defined in .../HTTP/ResponseTrait.php:502
/**
* 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
* @param bool $secure Whether to only transfer cookies via SSL
* @param bool $httponly Whether only make the cookie accessible via HTTP (no javascript)
* @param string|null $samesite
*
* @return $this
*/
Defined in .../HTTP/ResponseTrait.php:553
⧉public getCookieStore(): CookieStore Returns the `CookieStore` instance.
/**
* Returns the `CookieStore` instance.
*
* @return CookieStore
*/
Defined in .../HTTP/ResponseTrait.php:603
⧉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 .../HTTP/ResponseTrait.php:611
/**
* Returns the cookie
*
* @return Cookie|Cookie[]|null
*/
Defined in .../HTTP/ResponseTrait.php:623
⧉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 .../HTTP/ResponseTrait.php:645
⧉public getCookies(): Cookie[] Returns all cookies currently set.
/**
* Returns all cookies currently set.
*
* @return Cookie[]
*/
Defined in .../HTTP/ResponseTrait.php:687
⧉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 path to the file to send
* @param string|null $data The data to be downloaded
* @param bool $setMime Whether to try and send the actual MIME type
*
* @return DownloadResponse|null
*/
Defined in .../HTTP/ResponseTrait.php:760
⧉public getBody(): mixed Returns the Message's body.
/**
* Returns the Message's body.
*
* @return mixed
*/
Inherited from CodeIgniter\HTTP\Message
Defined in .../HTTP/Message.php:51
⧉public setBody($data): self Sets the body of the current message.
/**
* Sets the body of the current message.
*
* @param mixed $data
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in .../HTTP/MessageTrait.php:52
⧉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
*
* @codeCoverageIgnore
*/
Inherited from CodeIgniter\HTTP\Message
Defined in .../HTTP/Message.php:65
⧉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 .../HTTP/MessageTrait.php:66
⧉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
*
* @codeCoverageIgnore
*/
Inherited from CodeIgniter\HTTP\Message
Defined in .../HTTP/Message.php:80
⧉public populateHeaders(): void Populates the $headers array with any headers the getServer knows about.
/**
* Populates the $headers array with any headers the getServer knows about.
*/
Inherited from CodeIgniter\HTTP\Message
Defined in .../HTTP/MessageTrait.php:80
⧉public hasHeader(string $name): bool Determines whether a header exists.
/**
* Determines whether a header exists.
*/
Inherited from CodeIgniter\HTTP\Message
Defined in .../HTTP/Message.php:88
⧉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 .../HTTP/Message.php:106
⧉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 .../HTTP/MessageTrait.php:107
⧉public getProtocolVersion(): string Returns the HTTP Protocol Version.
/**
* Returns the HTTP Protocol Version.
*/
Inherited from CodeIgniter\HTTP\Message
Defined in .../HTTP/Message.php:120
⧉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 .../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 .../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 .../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 .../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 .../HTTP/MessageTrait.php:197
⧉public setProtocolVersion(string $version): self Sets the HTTP protocol version.
/**
* Sets the HTTP protocol version.
*
* @throws HTTPException For invalid protocols
*
* @return $this
*/
Inherited from CodeIgniter\HTTP\Message
Defined in .../HTTP/MessageTrait.php:222
⧉protected formatBody($body, string $format): mixed Handles conversion of the of the data into the appropriate format, and sets t...
/**
* Handles conversion of the 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
*
* @throws InvalidArgumentException If the body property is not string or array.
*
* @return mixed
*/
Defined in .../HTTP/ResponseTrait.php:312
⧉protected sendCookies() Actually sets the cookies.
/**
* Actually sets the cookies.
*/
Defined in .../HTTP/ResponseTrait.php:695
⧉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 .../HTTP/MessageTrait.php:210
⧉private dispatchCookies(): void
Defined in .../HTTP/ResponseTrait.php:704
⧉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 .../HTTP/ResponseTrait.php:733
⧉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 .../HTTP/ResponseTrait.php:743
/**
* 同CI內建的redirect 但轉址後直接結束
*
* @since version 1.0.0
*
* @param string $uri
*/
Inherited from App\Libraries\BaseApp\Controller
Defined in .../app/Libraries/BaseApp/Controller.php:185
⧉protected encode(string $val): string 字串加密
/**
* 字串加密
*
* @since version 1.0.0
*
* @param string $val
* @return string
*/
Inherited from App\Libraries\BaseApp\Controller
Defined in .../app/Libraries/BaseApp/Controller.php:198
⧉protected decode(string $val): string 字串解密
/**
* 字串解密
*
* @param string $val
* @return string
*/
Inherited from App\Libraries\BaseApp\Controller
Defined in .../app/Libraries/BaseApp/Controller.php:213
⧉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 .../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 .../Controller.php:109
/**
* Handles "auto-loading" helper files.
*
* @deprecated Use `helper` function instead of using this method.
*
* @codeCoverageIgnore
*/
Inherited from CodeIgniter\Controller
Defined in .../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 .../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 .../Controller.php:151
