PHPXRef 0.7.1 : YOURLS : Detail view of YDB.php

__construct($dsn, $user, $pass, $options) X-Ref

param: string $dsn     The data source name
param: string $user    The username
param: string $pass    The password
param: array  $options Driver-specific options
since: 1.7.3

init() X-Ref

Init everything needed

Everything we need to set up is done here in init(), not in the constructor, so even
when the connection fails (e.g. config error or DB dead), the constructor has worked,
and we have a $ydb object properly instantiated (and for instance yourls_die() can
correctly die, even if using $ydb methods)

return: void
since: 1.7.3

set_emulate_state() X-Ref

Check if we emulate prepare statements, and set bool flag accordingly

Check if current driver can PDO::getAttribute(PDO::ATTR_EMULATE_PREPARES)
Some combinations of PHP/MySQL don't support this function. See
https://travis-ci.org/YOURLS/YOURLS/jobs/271423782#L481

return: void
since: 1.7.3

get_emulate_state() X-Ref

Get emulate status

return: bool
since: 1.7.3

connect_to_DB() X-Ref

Initiate real connection to DB server

This is to check that the server is running and/or the config is OK

return: void
since: 1.7.3

dead_or_error(\Exception $exception) X-Ref

Die with an error message

param: \Exception $exception
return: void
since: 1.7.3

start_profiler() X-Ref

Start a Message Logger

return: void
since: 1.7.3

set_html_context($context) X-Ref

param: string $context
return: void

get_html_context() X-Ref

return: string

set_option($name, $value) X-Ref

param: string $name
param: mixed $value
return: void

has_option($name) X-Ref

param: string $name
return: bool

get_option($name) X-Ref

param: string $name
return: string

delete_option($name) X-Ref

param: string $name
return: void

set_infos($keyword, $infos) X-Ref

param: string $keyword
param: mixed $infos
return: void

has_infos($keyword) X-Ref

param: string $keyword
return: bool

get_infos($keyword) X-Ref

param: string $keyword
return: array

delete_infos($keyword) X-Ref

param: string $keyword
return: void

update_infos_if_exists($keyword, $infos) X-Ref

param: string $keyword
param: mixed $infos
return: void

get_plugins() X-Ref

return: array

set_plugins(array $plugins) X-Ref

param: array $plugins
return: void

add_plugin($plugin) X-Ref

param: string $plugin plugin filename
return: void

remove_plugin($plugin) X-Ref

param: string $plugin plugin filename
return: void

get_plugin_pages() X-Ref

return: array

set_plugin_pages(array $pages) X-Ref

param: array $pages
return: void

add_plugin_page( $slug, $title, $function ) X-Ref

param: string $slug
param: string $title
param: callable $function
return: void

remove_plugin_page( $slug ) X-Ref

param: string $slug
return: void

get_num_queries() X-Ref

Return count of SQL queries performed

return: int
since: 1.7.3

get_queries() X-Ref

Return SQL queries performed

return: array
since: 1.7.3

set_installed($bool) X-Ref

Set YOURLS installed state

param: bool $bool
return: void
since: 1.7.3

is_installed() X-Ref

Get YOURLS installed state

return: bool
since: 1.7.3

mysql_version() X-Ref

Return MySQL version

return: string
since: 1.7.3

fetchAffected(string $statement, array $values = []) X-Ref

Fetch the number of affected rows

param: string $statement SQL statement to execute
param: array $values Optional. Values to bind to the statement. Default empty array.
return: int Number of affected rows
since: 1.10.4

fetchAll(string $statement, array $values = []) X-Ref

Fetch all rows

param: string $statement SQL statement to execute
param: array $values Optional. Values to bind to the statement. Default empty array.
return: array All rows returned by the query
since: 1.10.4

fetchAssoc(string $statement, array $values = []) X-Ref

Fetch all rows as associative arrays

param: string $statement SQL statement to execute
param: array $values Optional. Values to bind to the statement. Default empty array.
return: array All rows as associative arrays
since: 1.10.4

fetchCol(string $statement, array $values = []) X-Ref

Fetch a single column from all rows

param: string $statement SQL statement to execute
param: array $values Optional. Values to bind to the statement. Default empty array.
return: array First column values from all rows
since: 1.10.4

fetchGroup(string $statement, array $values = [], int $style = PDO::FETCH_COLUMN) X-Ref

Fetch rows grouped by the first column

param: string $statement SQL statement to execute
param: array $values Optional. Values to bind to the statement. Default empty array.
param: int $style Optional. PDO fetch style constant. Default PDO::FETCH_COLUMN.
return: array Rows grouped by the first column value
since: 1.10.4

fetchObject(string $statement, array $values = [], string $class = 'stdClass', array $args = []) X-Ref

Fetch a single row as an object

param: string $statement SQL statement to execute
param: array  $values    Optional. Values to bind to the statement. Default empty array.
param: string $class     Optional. Class name for the returned object. Default 'stdClass'.
param: array  $args      Optional. Constructor arguments for the class. Default empty array.
return: object|false Object representing the row, or false if no rows found
since: 1.10.4

fetchObjects(string $statement, array $values = [], string $class = 'stdClass', array $args = []) X-Ref

Fetch all rows as objects

param: string $statement SQL statement to execute
param: array  $values    Optional. Values to bind to the statement. Default empty array.
param: string $class     Optional. Class name for the returned objects. Default 'stdClass'.
param: array  $args      Optional. Constructor arguments for the class. Default empty array.
return: array All rows as objects
since: 1.10.4

fetchOne(string $statement, array $values = []) X-Ref

Fetch a single row as an array

param: string $statement SQL statement to execute
param: array $values Optional. Values to bind to the statement. Default empty array.
return: array|false Associative array representing the row, or false if no rows found
since: 1.10.4

fetchPairs(string $statement, array $values = []) X-Ref

Fetch key-value pairs

param: string $statement SQL statement to execute
param: array $values Optional. Values to bind to the statement. Default empty array.
return: array Associative array of key-value pairs
since: 1.10.4

fetchValue(string $statement, array $values = []) X-Ref

Fetch a single value

param: string $statement SQL statement to execute
param: array $values Optional. Values to bind to the statement. Default empty array.
return: mixed Single value from the query result
since: 1.10.4

perform(string $statement, array $values = []) X-Ref

Performs a query with bound values and returns the resulting PDOStatement
You most likely should not use this method directly. Use the fetch_* methods instead.

param: string $statement The SQL statement to perform.
param: array $values Values to bind to the query
return: PDOStatement
since: 1.10.4

fetch_wrapper(string $method, ...$args) X-Ref

Wrapper for all fetch methods, allowing plugins to intercept and modify query results.

param: string $method The parent fetch method name to call (e.g., 'fetchAll', 'fetchValue')
param: mixed ...$args Variable number of arguments to pass to the parent method
return: mixed The cached result if available, otherwise the fresh query result
since: 1.10.4

without_filters(callable $callback) X-Ref

Execute a callback with filters temporarily disabled

This method allows bypassing the plugin filter system for the duration of the callback execution. Useful to
prevent infinite loops when a filter needs to call the original method without re-triggering itself.

Example usage:
$ydb = yourls_get_db('write-get_from_cache');
$result = $ydb->withoutFilters(function($db) use ($method, $args) {
return $db->fetch_wrapper($method, ...$args);
});

param: callable $callback
return: mixed
since: 1.10.4

File Size:	618 lines (18 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of YOURLS

/includes/Database/ -> YDB.php (summary)

Defines 1 class