Joomla! Documentation™

Joomla! 

3.x

Joomla! 

2.5

Примечание о версии

Это руководство разделено на две независимые части:

• Вставка, обновление и удаление данных из базы данных.
• Выборка данных из одной или нескольких таблиц и извлечение их в различных формах

В этом разделе документации рассматривается вставка, обновление и удаление данных из таблицы базы данных. Чтобы увидеть другую частьнажмите здесь

Введение

Joomla предоставляет сложный уровень абстракции базы данных, чтобы упростить использование для сторонних разработчиков. Новые версии API платформы Joomla предоставляют дополнительные функциональные возможности, которые дополнительно расширяют уровень базы данных, и включают в себя такие функции, как коннекторы для большего разнообразия серверов баз данных и цепочку запросов, чтобы улучшить читаемость кода соединения и упростить кодирование SQL.

Joomla может использовать различные типы систем баз данных SQL и работать в различных средах с разными префиксами таблиц. В дополнение к этим функциям класс автоматически создает соединение с базой данных. Помимо создания объекта вам нужны всего две строки кода, чтобы получить результат из базы данных в различных форматах. Использование уровня базы данных Joomla обеспечивает максимальную совместимость и гибкость для вашего расширения.

Запрос

Запросы к базе данных Joomla изменились с тех пор, как была введена новая платформа Joomla Framework, теперь «цепочка запросов» является рекомендуемым методом для создания запросов к базе данных (хотя строковые запросы все еще поддерживаются).

Цепочка запросов относится к методу, соединяющему несколько методов, один за другим, каждый метод возвращает объект, который может поддерживать следующий метод, улучшая читабельность и упрощая код.

Чтобы получить новый экземпляр класса JDatabaseQuery, мы используем метод getQuery JDatabaseDriver:

$db = JFactory::getDbo();

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

JDatabaseDriver :: getQuery принимает необязательный аргумент $ new, который может иметь значение true или false (по умолчанию используется значение false).

Чтобы запросить наш источник данных, мы можем вызвать несколько методов JDatabaseQuery; эти методы инкапсулируют язык запросов источника данных (в большинстве случаев SQL), скрывая специфический синтаксис запроса от разработчика и увеличивая переносимость исходного кода разработчика.

Некоторые из наиболее часто используемых методов включают в себя; include; select, from, join, where and order. Существуют также такие методы, как вставка, insert, update and delete для изменения записей в хранилище данных. Объединяя эти и другие вызовы методов, вы можете создать практически любой запрос к вашему хранилищу данных без ущерба для переносимости кода.

Вставка записи

С использованием SQL

Класс JDatabaseQuery предоставляет несколько методов для построения запросов на вставку, наиболее распространенными из которых являются:

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

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

// Insert columns.
$columns = array('user_id', 'profile_key', 'profile_value', 'ordering');

// Insert values.
$values = array(1001, $db->quote('custom.message'), $db->quote('Inserting a record using insert()'), 1);

// Prepare the insert query.
$query
    ->insert($db->quoteName('#__user_profiles'))
    ->columns($db->quoteName($columns))
    ->values(implode(',', $values));

// Set the query using our newly populated query object and execute it.
$db->setQuery($query);
$db->execute();

(Here the quoteName() function adds appropriate quotes around the table and column names to avoid conflicts with any database reserved word, now or in the future.) To get the ID of the row that you just inserted, you can use the 'insertid' method, for example.

// Get the row that was just inserted
$new_row_id = $db->insertid();

How to store empty value as NULL

If your default value of a column is NULL, you should not add that column name in the array. Let the database system store NULL as the default value. If the default value of a column is not NULL and it is allowed to store NULL values, you should specify that in the code. See how to do it in the following example.

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

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

/** First Case [NULL as default value] **/
// The column 'profile_value' has NULL as default value. So, we will not add it to the array. The database engine will store NULL as value for column 'profile_value'.
// $columns = array('user_id', 'profile_key', 'profile_value', 'ordering');
$columns = array('user_id', 'profile_key', 'ordering');

// Insert values.
$values = array(1001, $db->quote('custom.message'), 1);

/** Second Case [string as default value and you can also store NULL value] **/
// The column 'profile_value' has empty string '' as default value but we can also store NULL value. So, we have to add the column name and NULL value to $columns and $values.
$columns = array('user_id', 'profile_key', 'profile_value', 'ordering');

// Insert values.
$values = array(1001, $db->quote('custom.message'), $db->quote('NULL'), 1);

С использованием как объекта

Класс JDatabaseDriver также предоставляет удобный метод для сохранения объекта непосредственно в базе данных, что позволяет нам добавлять запись в таблицу без записи одной строки SQL.

// Create and populate an object.
$profile = new stdClass();
$profile->user_id = 1001;
$profile->profile_key='custom.message';
$profile->profile_value='Inserting a record using insertObject()';
$profile->ordering=1;

// Insert the object into the user profile table.
$result = JFactory::getDbo()->insertObject('#__user_profiles', $profile);

Обратите внимание, что нам не нужно экранировать имя таблицы; метод insertObject делает это за нас.

Метод insertObject выдаст ошибку, если возникнет проблема с вставкой записи в таблицу базы данных.

Если вы предоставляете уникальное значение первичного ключа (как в примере выше), настоятельно рекомендуется перед попыткой вставки выбрать из таблицы значение этого столбца.

Если вы просто вставляете следующую строку в вашу таблицу (т. Е. База данных генерирует значение первичного ключа), вы можете указать имя столбца первичного ключа в качестве третьего параметра метода insertObject (), и метод обновит объект с помощью вновь сгенерированного значения первичного ключа.

Например, с учетом следующего утверждения:

$result = $dbconnect->insertObject('#__my_table', $object, 'primary_key');

после выполнения $object->primary_key будет обновлено значением первичного ключа вновь вставленной строки.

ПОДСКАЗКА: Установите $object->primary_key в null или 0 (ноль) перед вставкой.

How to store empty value as NULL when insert an object

If your default value of a column is NULL, you should not add that column name to the object. Let the database system store NULL as the default value. If the default value of a column is not NULL and it is allowed to store NULL values, you should specify that in the code. See how to do it in the following example.

// Create and populate an object.
$profile = new stdClass();
$profile->user_id = 1001;
$profile->profile_key='custom.message';
$profile->ordering=1;

/** First Case [NULL as default value] **/
// The column 'profile_value' has NULL as default value. So, we will not add it to the object. The database engine will store NULL as value for column 'profile_value'.
// $profile->profile_value='Inserting a record using insertObject()';

/** Second Case [string as default value and you can also store NULL value] **/
// The column 'profile_value' has empty string '' as default value but we can also store NULL value. So, we have to add the column name and NULL value as its value.
$profile->profile_value = $db->quote('NULL');

// Insert the object into the user profile table.
$result = JFactory::getDbo()->insertObject('#__user_profiles', $profile);

Обновление записи

С использованием SQL

Класс JDatabaseQuery также предоставляет методы для создания запросов на обновление, в частности update и set. Мы также повторно используем другой метод, который мы использовали при создании операторов выбора, метод where.

$db = JFactory::getDbo();

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

// Fields to update.
$fields = array(
    $db->quoteName('profile_value') . ' = ' . $db->quote('Updating custom message for user 1001.'),
    $db->quoteName('ordering') . ' = 2',

    // If you would like to store NULL value, you should specify that.
    $db->quoteName('avatar') . ' = NULL',
);

// Conditions for which records should be updated.
$conditions = array(
    $db->quoteName('user_id') . ' = 42', 
    $db->quoteName('profile_key') . ' = ' . $db->quote('custom.message')
);

$query->update($db->quoteName('#__user_profiles'))->set($fields)->where($conditions);

$db->setQuery($query);

$result = $db->execute();

С использованием как объекта

Как и insertObject, класс JDatabaseDriver предоставляет удобный метод для обновления объекта.

Ниже мы обновим нашу пользовательскую таблицу новыми значениями, используя существующий первичный ключ id:

$updateNulls = true;

// Create an object for the record we are going to update.
$object = new stdClass();

// Must be a valid primary key value.
$object->id = 1;
$object->title = 'My Custom Record';
$object->description = 'A custom record being updated in the database.';

// If you would like to store NULL value, you should specify that.
$object->short_description = null;

// Update their details in the users table using id as the primary key.
// You should provide forth parameter with value TRUE, if you would like to store the NULL values.
$result = JFactory::getDbo()->updateObject('#__custom_table', $object, 'id', $updateNulls);

Как и insertObject, updateObject позаботится об экранировании имен таблиц для нас.

Метод updateObject выдаст ошибку, если возникнет проблема с обновлением записи в таблице базы данных.

Мы должны убедиться, что запись уже существует, прежде чем пытаться обновить ее, поэтому мы, можем, добавить какую-то проверку записи перед выполнением метода updateObject.

Удаление записи

Наконец, есть также метод удаления для удаления записей из базы данных.

$db = JFactory::getDbo();

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

// delete all custom keys for user 1001.
$conditions = array(
    $db->quoteName('user_id') . ' = 1001', 
    $db->quoteName('profile_key') . ' = ' . $db->quote('custom.%')
);

$query->delete($db->quoteName('#__user_profiles'));
$query->where($conditions);

$db->setQuery($query);

$result = $db->execute();

Sample Module Code

Below is the code for a simple Joomla module which you can install and run to demonstrate use of the JDatabase functionality for updating records in the database, and which you can adapt to experiment with some of the concepts described above. If you are unsure about development and installing a Joomla module then following the tutorial at Creating a simple module will help. Important note: In any Joomla extensions which you develop that you should avoid accessing the core Joomla tables directly like this and should instead use the Joomla APIs if at all possible, because the database structures may change without warning. In a folder mod_db_update create the following 2 files:

mod_db_update.xml

<?xml version="1.0" encoding="utf-8"?>
<extension type="module" version="3.1" client="site" method="upgrade">
    <name>Database update demo</name>
    <version>1.0.1</version>
    <description>Code demonstrating use of Joomla Database class to perform SQL UPDATE statements</description>
    <files>
        <filename module="mod_db_update">mod_db_update.php</filename>
    </files>
</extension>

mod_db_update.php

<?php
defined('_JEXEC') or die('Restricted Access');

use Joomla\CMS\Factory;

$db = Factory::getDbo();

$me = Factory::getUser();

if ($me->id == 0)
{
	echo "Not logged on!";
}
else
{
	$email = $me->email; 
	// change the case of the email address
	$email_uppercase = strtoupper($email);
	if ($email == $email_uppercase)
	{
		$new_email = strtolower($email);
	}
	else
	{
		$new_email = $email_uppercase;
	}
	
	$query = $db->getQuery(true);

	$fields = array($db->quoteName('email') . " = '{$new_email}'");

	$conditions = array($db->quoteName('id') . ' = ' . $me->id); 

	$query->update($db->quoteName('#__users'))->set($fields)->where($conditions);

	echo $db->replacePrefix((string) $query);
	
	$db->setQuery($query);

	if ($result = $db->execute())
	{
		echo "Email case successfully changed!";
	}
}

The code above updates the email address field in the users record of the currently logged-on user, toggling between upper case and lower case in successive reloads of the web page. The method Factory::getUser() returns the user object of the currently logged-on user, or if not logged on, then a blank user object, whose id field is set to zero. The $db->replacePrefix((string) $query) expression returns the actual SQL statement, and outputting this can be useful in debugging.

Zip up the mod_db_update directory to create mod_db_update.zip.

Within your Joomla administrator go to Install Extensions and via the Upload Package File tab upload this zip file to install this sample log module.

Make this module visible by editing it (click on it within the Modules page) then:

1. making its status Published
2. selecting a position on the page for it to be shown
3. on the menu assignment tab specify the pages it should appear on

When you visit a site web page then you should see the module in your selected position, and it should output the SQL UPDATE statement and affirm that it has updated the record successfully. To confirm that it has updated the record correctly go into phpmyadmin and view the users table within the Joomla database. The updates aren't visible via the admin Users functionality on the back end, as Joomla displays in lower case all the email addresses in the records.