Selecting data using JDatabase/es

Joomla! 

3.x

Joomla! 

2.5

Nota de la Versión

Este tutorial se divide en dos partes independientes:

• Insertar, actualizar y eliminar datos de la base de datos.
• Seleccionar datos de una o más tablas y recuperarlos en una variedad de formas diferentes.

Esta sección de la documentación se ve la selección de datos de una tabla de base de datos y como recuperarlos en una variedad de formatos. Para ver la otra parte has clic aquí

Introducción

Joomla! ofrece una sofisticada capa de abstracción de la base de datos para simplificar su uso por parte de los desarrolladores de terceras partes. Las nuevas versiones de la Plataforma API de Joomla! proporciona funcionalidades adicionales que extiende la capa de base de datos; que incluye características tales como conectores para una mayor variedad de servidores de base de datos y la consulta encadenada. para mejorar la legibilidad del código de conexión y simplificar el código SQL.

Joomla puede utilizar diferentes tipos de sistemas de base de datos SQL y ejecutar una variedad de entornos con diferentes prefijos de las tablas. Además de estas funciones, la clase crea automáticamente la conexión a base de datos. Además de crear una instancia del objeto, necesitas sólo dos líneas de código para obtener un resultado de la base de datos, en una variedad de formatos. El uso de la capa de base de datos de Joomla! asegura una máxima compatibilidad y flexibilidad para tu extensión.

La Consulta

Las consultas a las base de datos de Joomla! a cambiado con la introducción de Joomla! 1.6. La forma recomendada de la construcción de consultas de base de datos es a través de la consulta "encadenada" (aunque la cadena de consultas aún son compatibles).

Consulta encadenada se refiere a un método de conexión de un número de métodos, uno tras otro, con cada método devolviendo un objeto que puede soportar el método siguiente, se mejora la legibilidad y la simplificación de código.

Para obtener una nueva instancia de la clase JDatabaseQuery utilizamos el método getQuery de JDatabaseDriver  :

$db = JFactory::getDbo();

$query = $db->getQuery(true);

JDatabaseDriver::getQuery toma un argumento opcional, $new, que puede ser true o false (el valor predeterminado es false).

La consulta a nuestra base de datos puede llamar a un número de métodos JDatabaseQuery; estos métodos encapsulan el lenguaje de consulta de la fuente de datos (en la mayoría de los casos SQL), ocultando la sintaxis específica de la consulta al desarrollador y aumentando la portabilidad de los código fuente del desarrollador.

Algunos de los métodos utilizados con más frecuencia incluyen: select, from, join, where y order. También hay métodos tales como insert, update y delete para la modificación de registros en la base de datos. Por el encadenamiento de estos y otros métodos de llamada, puedes crear casi cualquier consulta sobre tu base de datos sin comprometer la portabilidad del código..

Seleccionar Registros de una Sola Tabla

A continuación hay un ejemplo de creación de una consulta de base de datos utilizando la clase JDatabaseQuery. Con el uso de los métodos select, from, where y order, se pueden crear consultas, flexibles, fácilmente legibles y portables:

// Get a db connection.
$db = JFactory::getDbo();

// Create a new query object.
$query = $db->getQuery(true);

// Select all records from the user profile table where key begins with "custom.".
// Order it by the ordering field.
$query->select($db->quoteName(array('user_id', 'profile_key', 'profile_value', 'ordering')));
$query->from($db->quoteName('#__user_profiles'));
$query->where($db->quoteName('profile_key') . ' LIKE '. $db->quote('\'custom.%\''));
$query->order('ordering ASC');

// Reset the query using our newly populated query object.
$db->setQuery($query);

// Load the results as a list of stdClass objects (see later for more options on retrieving data).
$results = $db->loadObjectList();

La consulta también puede ser encadenada para simplificar aún más:

$query
    ->select($db->quoteName(array('user_id', 'profile_key', 'profile_value', 'ordering')))
    ->from($db->quoteName('#__user_profiles'))
    ->where($db->quoteName('profile_key') . ' LIKE '. $db->quote('\'custom.%\''))
    ->order('ordering ASC');

El encadenamiento puede ser útil cuando las consultas se convierten en más y más complejas.

La agrupación se puede lograr muy simplemente. La siguiente consulta sería para contar el número de artículos en cada categoría.

$query
    ->select( array('catid', 'COUNT(*)') )
    ->from($db->quoteName('#__content'))
    ->group($db->quoteName('catid'));

Un límite se puede ajustar a una consulta con "setLimit". Por ejemplo, en la siguiente consulta, se devolverían hasta 10 registros.

$query
    ->select($db->quoteName(array('user_id', 'profile_key', 'profile_value', 'ordering')))
    ->from($db->quoteName('#__user_profiles'))
    ->setLimit('10');

Seleccionar Registros de Varias Tablas

Using the JDatabaseQuery's join methods, we can select records from multiple related tables. The generic "join" method takes two arguments; the join "type" (inner, outer, left, right) and the join condition. In the following example you will notice that we can use all of the keywords we would normally use if we were writing a native SQL query, including the AS keyword for aliasing tables and the ON keyword for creating relationships between tables. Also note that the table alias is used in all methods which reference table columns (I.e. select, where, order).

// Get a db connection.
$db = JFactory::getDbo();

// Create a new query object.
$query = $db->getQuery(true);

// Select all articles for users who have a username which starts with 'a'.
// Order it by the created date.
// Note by putting 'a' as a second parameter will generate `#__content` AS `a`
$query
    ->select($db->quoteName(array('a.*', 'b.username', 'b.name')))
    ->from($db->quoteName('#__content', 'a'))
    ->join('INNER', $db->quoteName('#__users', 'b') . ' ON (' . $db->quoteName('a.created_by') . ' = ' . $db->quoteName('b.id') . ')')
    ->where($db->quoteName('b.username') . ' LIKE \'a%\'')
    ->order($db->quoteName('a.created') . ' DESC');

// Reset the query using our newly populated query object.
$db->setQuery($query);

// Load the results as a list of stdClass objects (see later for more options on retrieving data).
$results = $db->loadObjectList();

El método join anterior nos permite consultar las tablas user y content, la recuperación de los artículos con detalles del autor. También hay métodos de conveniencia para las uniones:

• innerJoin()
• leftJoin()
• rightJoin()
• outerJoin()

Podemos utilizar varias combinaciones consultar a través de más de dos tablas:

$query
    ->select($db->quoteName(array('a.*', 'b.username', 'b.name', 'c.*', 'd.*')))
    ->from($db->quoteName('#__content', 'a'))
    ->join('INNER', $db->quoteName('#__users', 'b') . ' ON (' . $db->quoteName('a.created_by') . ' = ' . $db->quoteName('b.id') . ')')
    ->join('LEFT', $db->quoteName('#__user_profiles', 'c') . ' ON (' . $db->quoteName('b.id') . ' = ' . $db->quoteName('c.user_id') . ')')
    ->join('RIGHT', $db->quoteName('#__categories', 'd') . ' ON (' . $db->quoteName('a.catid') . ' = ' . $db->quoteName('d.id') . ')')
    ->where($db->quoteName('b.username') . ' LIKE \'a%\'')
    ->order($db->quoteName('a.created') . ' DESC');

Observa cómo el encadenamiento hace que el código fuente sea mucho más legible para estas consultas más largas.

En algunos casos, también tendrás que utilizar la cláusula AS, a la hora de seleccionar los elementos para evitar conflictos entre los nombres de las columnas. En este caso, de selección múltiple, las declaraciones pueden ser encadenadas en conjunción con el segundo parámetro de $db->quoteName.

$query
    ->select($db->quoteName('a.*'))
    ->select($db->quoteName('b.username', 'username'))
    ->select($db->quoteName('b.name', 'name'))
    ->from($db->quoteName('#__content', 'a'))
    ->join('INNER', $db->quoteName('#__users', 'b') . ' ON (' . $db->quoteName('a.created_by') . ' = ' . $db->quoteName('b.id') . ')')
    ->where($db->quoteName('b.username') . ' LIKE \'a%\'')
    ->order($db->quoteName('a.created') . ' DESC');

Un segundo array también puede ser utilizado como el segundo parámetro de la instrucción select para rellenar los valores de la cláusula AS. Recuerda incluir nulls en el segundo array que correspondan a las columnas en el primer array y para los que no deseas utilizar la cláusula AS:

$query
    ->select($db->quoteName(array('a.*', 'b.username', 'b.name'), array('', 'username', 'name'))
    ->from($db->quoteName('#__content', 'a'))
    ->join('INNER', $db->quoteName('#__users', 'b') . ' ON (' . $db->quoteName('a.created_by') . ' = ' . $db->quoteName('b.id') . ')')
    ->where($db->quoteName('b.username') . ' LIKE \'a%\'')
    ->order($db->quoteName('a.created') . ' DESC');

Resultados de la Consulta

La clase database contiene muchos métodos para trabajar con el conjunto de resultados de al consulta.

Resultado de Valor Único

loadResult()

Se utiliza loadResult() cuando se espera un solo valor como resultado de la consulta de base de datos.

id	nombre	correo electrónico	nombre de usuario
1	John Smith	johnsmith@domain.example	johnsmith
2	Magda Hellman	magda_h@domain.example	magdah
3	Yvonne de Gaulle	ydg@domain.example	ydegaulle

Esto es a menudo el resultado de una consulta 'count' para obtener un número de registros:

$db = JFactory::getDbo();
$query = $db->getQuery(true);
$query->select('COUNT(*)');
$query->from($db->quoteName('#__my_table'));
$query->where($db->quoteName('name')." = ".$db->quote($value));

// Reset the query using our newly populated query object.
$db->setQuery($query);
$count = $db->loadResult();

or where you are just looking for a single field from a single row of the table (or possibly a single field from the first row returned).

$db = JFactory::getDbo();
$query = $db->getQuery(true);
$query->select('field_name');
$query->from($db->quoteName('#__my_table'));
$query->where($db->quoteName('some_name')." = ".$db->quote($some_value));

$db->setQuery($query);
$result = $db->loadResult();

Resultado de una Sola Fila

Cada una de estas funciones devuelve el resultados de un único registro de la base de datos, aunque puede haber varios registros que cumplan los criterios que se hayan establecido. Para obtener más registros de lo que necesitas llamar a la función nuevamente.

id	nombre	correo electrónico	nombre de usuario
1	John Smith	johnsmith@domain.example	johnsmith
2	Magda Hellman	magda_h@domain.example	magdah
3	Yvonne de Gaulle	ydg@domain.example	ydegaulle

loadRow()

loadRow() devuelve un array indexado a partir de un único registro de la tabla:

. . .
$db->setQuery($query);
$row = $db->loadRow();
print_r($row);

se tendrá:

Array ( [0] => 1 [1] => John Smith [2] => johnsmith@domain.example [3] => johnsmith ) 

Puedes acceder a los valores individuales mediante el uso de:

$row['index'] // e.g. $row['2']

Notas:

1. Los índices del array son numéricos a partir de cero.
2. Si bien puedes repetir la llamada para obtener más filas, una de las funciones que devuelve varias filas puede ser más útil.

loadAssoc()

loadAssoc() devuelve un array asociativo a partir de un único registro de la tabla:

. . .
$db->setQuery($query);
$row = $db->loadAssoc();
print_r($row);

se tendrá:

Array ( [id] => 1, [name] => John Smith, [email] => johnsmith@domain.example, [username] => johnsmith )

Puedes acceder a los valores individuales mediante el uso de:

$row['name'] // e.g. $row['name']

1. Si bien puedes repetir la llamada para obtener más filas, una de las funciones que devuelve varias filas puede ser más útil.

loadObject()

loadObject devuelve un objeto PHP a partir de un único registro de la tabla:

. . .
$db->setQuery($query);
$result = $db->loadObject();
print_r($result);

se tendrá:

stdClass Object ( [id] => 1, [name] => John Smith, [email] => johnsmith@domain.example, [username] => johnsmith )

Puedes acceder a los valores individuales mediante el uso de:

$result->index // e.g. $result->email

Notas:

1. Si bien puedes repetir la llamada para obtener más filas, una de las funciones que devuelve varias filas puede ser más útil.

Resultado de una Sola Columna

Cada una de estas funciones devolverá resultados de una sola columna de la base de datos.

id	nombre	correo electrónico	nombre de usuario
1	John Smith	johnsmith@domain.example	johnsmith
2	Magda Hellman	magda_h@domain.example	magdah
3	Yvonne de Gaulle	ydg@domain.example	ydegaulle

loadColumn()

loadColumn() devuelve un array indexado a partir de una única columna de la tabla:

$query->select('name'));
      ->from . . .";
. . .
$db->setQuery($query);
$column= $db->loadColumn();
print_r($column);

se tendrá:

Array ( [0] => John Smith [1] => Magda Hellman [2] => Yvonne de Gaulle )

Puedes acceder a los valores individuales mediante el uso de:

$column['index'] // e.g. $column['2']

Notas:

1. Los índices del array son numéricos a partir de cero.
2. loadColumn() es equivalente a loadColumn(0).

loadColumn($index)

loadColumn($index) devuelve un array indexado a partir de una única columna de la tabla:

$query->select(array('name', 'email', 'username'));
      ->from . . .";
. . .
$db->setQuery($query);
$column= $db->loadColumn(1);
print_r($column);

se tendrá:

Array ( [0] => johnsmith@domain.example, [1] => magda_h@domain.example, [2] => ydg@domain.example )

Puedes acceder a los valores individuales mediante el uso de:

$column['index'] // e.g. $column['2']

loadColumn($index) permite iterar a través de una serie de columnas en los resultados

. . .
$db->setQuery($query);
for ( $i = 0; $i <= 2; $i++ ) {
  $column= $db->loadColumn($i);
  print_r($column);
}

se tendrá:

Array ( [0] => John Smith [1] => Magda Hellman [2] => Yvonne de Gaulle )
Array ( [0] => johnsmith@domain.example [1] => magda_h@domain.example [2] => ydg@domain.example )
Array ( [0] => johnsmith [1] => magdah [2] => ydegaulle )

Notas:

1. Los índices del array son numéricos a partir de cero.

Resultados de filas Múltiples

Cada una de estas funciones devolverá resultados de varios registros de la base de datos.

id	nombre	correo electrónico	nombre de usuario
1	John Smith	johnsmith@domain.example	johnsmith
2	Magda Hellman	magda_h@domain.example	magdah
3	Yvonne de Gaulle	ydg@domain.example	ydegaulle

loadRowList()

loadRowList() devuelve un array indexado de arrays indexados con los registros de la tabla de devueltos por la consulta:

. . .
$db->setQuery($query);
$row = $db->loadRowList();
print_r($row);

va a dar (con saltos de línea añadido para mayor claridad):

Array ( 
[0] => Array ( [0] => 1 [1] => John Smith [2] => johnsmith@domain.example [3] => johnsmith ) 
[1] => Array ( [0] => 2 [1] => Magda Hellman [2] => magda_h@domain.example [3] => magdah ) 
[2] => Array ( [0] => 3 [1] => Yvonne de Gaulle [2] => ydg@domain.example [3] => ydegaulle ) 
)

Puedes acceder a las filas individuales mediante el uso de:

$row['index'] // e.g. $row['2']

y puedes acceder a los valores individuales mediante el uso de:

$row['index']['index'] // e.g. $row['2']['3']

Notas:

1. Los índices del array son numéricos a partir de cero.

loadAssocList()

loadAssocList() devuelve un array indexado de arrays asociativo con los registros de la tabla de devueltos por la consulta:

. . .
$db->setQuery($query);
$row = $db->loadAssocList();
print_r($row);

va a dar (con saltos de línea añadido para mayor claridad):

Array ( 
[0] => Array ( [id] => 1 [name] => John Smith [email] => johnsmith@domain.example [username] => johnsmith ) 
[1] => Array ( [id] => 2 [name] => Magda Hellman [email] => magda_h@domain.example [username] => magdah ) 
[2] => Array ( [id] => 3 [name] => Yvonne de Gaulle [email] => ydg@domain.example [username] => ydegaulle ) 
) 

Puedes acceder a las filas individuales mediante el uso de:

$row['index'] // e.g. $row['2']

y puedes acceder a los valores individuales mediante el uso de:

$row['index']['column_name'] // e.g. $row['2']['email']

loadAssocList($clave)

loadAssocList('clave') devuelve un array asociativo - indexado por 'clave' - de array asociativos a partir de los registros de la tabla devueltos por la consulta:

. . .
$db->setQuery($query);
$row = $db->loadAssocList('username');
print_r($row);

va a dar (con saltos de línea añadido para mayor claridad):

Array ( 
[johnsmith] => Array ( [id] => 1 [name] => John Smith [email] => johnsmith@domain.example [username] => johnsmith ) 
[magdah] => Array ( [id] => 2 [name] => Magda Hellman [email] => magda_h@domain.example [username] => magdah ) 
[ydegaulle] => Array ( [id] => 3 [name] => Yvonne de Gaulle [email] => ydg@domain.example [username] => ydegaulle ) 
)

Puedes acceder a las filas individuales mediante el uso de:

$row['key_value'] // e.g. $row['johnsmith']

y puedes acceder a los valores individuales mediante el uso de:

$row['key_value']['column_name'] // e.g. $row['johnsmith']['email']

Nota: La 'clave' debe ser un nombre de columna válido de la tabla; no tiene que ser un Índice o una Clave Principal. Pero si no tiene un valor único no puede ser capaz de recuperar los resultados de forma fiable.

loadAssocList($clave, $columna)

loadAssocList('clave', 'columna') devuelve un array asociativo, indexado por 'clave', de los valores de la columna llamada 'columna' devueltos por la consulta:

. . .
$db->setQuery($query);
$row = $db->loadAssocList('id', 'username');
print_r($row);

va a dar (con saltos de línea añadido para mayor claridad):

Array ( 
[1] => John Smith 
[2] => Magda Hellman 
[3] => Yvonne de Gaulle
)

Nota: La 'clave' debe ser un nombre de columna válido de la tabla; no tiene que ser un Índice o una Clave Principal. Pero si no tiene un valor único no puede ser capaz de recuperar los resultados de forma fiable.

loadObjectList()

loadObjectList() devuelve un array indexado de objetos PHP a partir de los registros de la tabla devueltos por la consulta:

. . .
$db->setQuery($query);
$row = $db->loadObjectList();
print_r($row);

va a dar (con saltos de línea añadido para mayor claridad):

Array ( 
[0] => stdClass Object ( [id] => 1 [name] => John Smith 
    [email] => johnsmith@domain.example [username] => johnsmith ) 
[1] => stdClass Object ( [id] => 2 [name] => Magda Hellman 
    [email] => magda_h@domain.example [username] => magdah ) 
[2] => stdClass Object ( [id] => 3 [name] => Yvonne de Gaulle 
    [email] => ydg@domain.example [username] => ydegaulle ) 
)

Puedes acceder a las filas individuales mediante el uso de:

$row['index'] // e.g. $row['2']

and you can access the individual values by using:

$row['index']->name // e.g. $row['2']->email

loadObjectList('key')

loadObjectList($key) returns an associated array - indexed on 'key' - of objects from the table records returned by the query:

. . .
$db->setQuery($query);
$row = $db->loadObjectList('username');
print_r($row);

will give (with line breaks added for clarity):

Array ( 
[johnsmith] => stdClass Object ( [id] => 1 [name] => John Smith 
    [email] => johnsmith@domain.example [username] => johnsmith ) 
[magdah] => stdClass Object ( [id] => 2 [name] => Magda Hellman 
    [email] => magda_h@domain.example [username] => magdah ) 
[ydegaulle] => stdClass Object ( [id] => 3 [name] => Yvonne de Gaulle 
    [email] => ydg@domain.example [username] => ydegaulle ) 
)

You can access the individual rows by using:

$row['key_value'] // e.g. $row['johnsmith']

and you can access the individual values by using:

$row['key_value']->column_name // e.g. $row['johnsmith']->email

Note: Key must be a valid column name from the table; it does not have to be an Index or a Primary Key. But if it does not have a unique value you may not be able to retrieve results reliably.

Miscellaneous Result Set Methods

getNumRows()

getNumRows() will return the number of result rows found by the last query and waiting to be read. To get a result from getNumRows() you have to run it after the query and before you have retrieved any results.

. . .
$db->setQuery($query);
$db->execute();
$num_rows = $db->getNumRows();
print_r($num_rows);
$result = $db->loadRowList();

will return

3

Note: if you run getNumRows() after loadRowList() - or any other retrieval method - you may get a PHP Warning:

Warning: mysql_num_rows(): 80 is not a valid MySQL result resource 
in libraries\joomla\database\database\mysql.php on line 344