PHPXRef 0.7.1 : YOURLS : Detail view of YDB.php

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

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

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)

since: 1.7.3
return: void

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

since: 1.7.3
return: void

get_emulate_state() X-Ref

Get emulate status

since: 1.7.3
return: bool

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

since: 1.7.3
return: void

dead_or_error(\Exception $exception) X-Ref

Die with an error message

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

start_profiler() X-Ref

Start a Message Logger

since: 1.7.3
return: void

set_html_context($context) X-Ref

return: void
param: string $context

get_html_context() X-Ref

return: string

set_option($name, $value) X-Ref

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

has_option($name) X-Ref

return: bool
param: string $name

get_option($name) X-Ref

return: string
param: string $name

delete_option($name) X-Ref

return: void
param: string $name

set_infos($keyword, $infos) X-Ref

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

has_infos($keyword) X-Ref

return: bool
param: string $keyword

get_infos($keyword) X-Ref

return: array
param: string $keyword

delete_infos($keyword) X-Ref

return: void
param: string $keyword

update_infos_if_exists($keyword, $infos) X-Ref

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

get_plugins() X-Ref

return: array

set_plugins(array $plugins) X-Ref

return: void
param: array $plugins

add_plugin($plugin) X-Ref

return: void
param: string $plugin plugin filename

remove_plugin($plugin) X-Ref

return: void
param: string $plugin plugin filename

get_plugin_pages() X-Ref

return: array

set_plugin_pages(array $pages) X-Ref

return: void
param: array $pages

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

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

remove_plugin_page( $slug ) X-Ref

return: void
param: string $slug

get_num_queries() X-Ref

Return count of SQL queries performed

since: 1.7.3
return: int

get_queries() X-Ref

Return SQL queries performed

since: 1.7.3
return: array

set_installed($bool) X-Ref

Set YOURLS installed state

since: 1.7.3
return: void
param: bool $bool

is_installed() X-Ref

Get YOURLS installed state

since: 1.7.3
return: bool

mysql_version() X-Ref

Return MySQL version

since: 1.7.3
return: string

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

Fetch the number of affected rows

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

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

Fetch all rows

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

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

Fetch all rows as associative arrays

since: 1.10.4
return: array 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.

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

Fetch a single column from all rows

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

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

Fetch rows grouped by the first column

since: 1.10.4
return: array Rows grouped by the first column value
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.

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

Fetch a single row as an object

since: 1.10.4
return: object|false Object representing the row, or false if no rows found
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.

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

Fetch all rows as objects

since: 1.10.4
return: array 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.

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

Fetch a single row as an array

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

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

Fetch key-value pairs

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

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

Fetch a single value

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

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.

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

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

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

since: 1.10.4
return: mixed The cached result if available, otherwise the fresh query result
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

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);
});

since: 1.10.4
return: mixed
param: callable $callback

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