Расширения для пользователей

Целевая аудитория¶

Эта статья предназначена для разработчиков, которые хотят добавить дополнительные данные своим пользователям MODX и функциональные возможности для связанных классов.

Хотя это возможно с помощью менее интегрированного подхода путем простого добавления таблицы базы данных, которая включает отношение внешнего ключа, к исходной таблице пользователей MODX, описанный здесь подход предназначен для более тщательной интеграции с помощью расширения базового класса modUser.

Приведенные здесь шаги носят технический характер и основаны на базовой платформе MODX xPDO. Вы должны быть знакомы с объектами и методами xPDO (например, getObject), прежде чем пытаться использовать это руководство.

Смотрите также¶

• Обратный инжиниринг классов xPDO из существующей таблицы базы данных
• Дополнительные примеры файлов схемы XML xPDO
• Генерация кода модели

Общее представление¶

Расширяя уровень аутентификации MODX Revolution, мы можем создавать очень сложные и разнообразные пользовательские подсистемы, например, для социальных сетей, систем управления пользователями или других приложений, которые еще не концептуализированы. Эта способность расширять класс modUser является лишь одним примером того, как расширять базовый класс - аналогичный подход может быть использован для расширения любого базового класса MODX.

Цель¶

Расширение modUser предназначено для тех ситуаций, когда необходимо расширить или улучшить аутентификацию пользователя или взаимодействие с пользователем, например, для упрощения пользовательской аутентификации.

Правила¶

Расширение modUser не означает, что мы добавляем что-либо в таблицу modx_users в базе данных. Вместо этого мы будем добавлять отдельную связанную таблицу, привязанную к исходной таблице через внешний ключ. Ни в коем случае расширенное приложение не должно пытаться полностью заменить класс modUser. Мы используем класс modUser в качестве нашей основы. Единственный признак того, что пользователь был расширен, будет найден путем изменения class_key с «modUser» на расширенное имя класса.

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

MODX Revolution уже работает с пользователями и, вероятно, не нуждается в особой помощи. Хотя мы можем использовать ваше расширение для наших данных, не пишите «раздутый» код, который просто повторяет код, уже предоставленный в классе modUser. Другими словами, используйте ресурсы Revolution для ваших расширенных пользователей, но не создавайте код для замены modUser.

Наконец, ознакомьтесь с modUser, прежде чем начинать программировать. Вы можете предположить, что некоторые методы не являются взаимно-однозначными, например, атрибуты, которые можно назначать для контекста, ресурса и т.д. Обычно для доступа к методам modUser используются указания modUser.

Шаги к расширению modUser¶

1.) Создайте схему и сгенерируйте модель¶

Первое, что нам нужно сделать, это создать расширенную пользовательскую схему, которая расширяет modUser. Обратите внимание, что нет никакого агрегатного отношения вверх от вашего "основного" класса, который расширяет modUser

Простой пример¶

Самый простой пример, который мы можем себе представить, - это желание добавить один дополнительный атрибут к пользовательским данным. В базе данных это будет означать, что у нас есть отдельная таблица с 2 столбцами: одна для отношения внешнего ключа обратно к таблице modx_users и другой столбец, содержащий наш новый «дополнительный» атрибут, например, facebook_url:

<?xml version="1.0" encoding="UTF-8"?>
<model package="extendeduser" baseClass="xPDOObject" platform="mysql" defaultEngine="MyISAM" tablePrefix="ext_">
       <!-- расширяем класс modUser -->
       <object class="extUser" extends="modUser">
               <composite alias="Data" local="id" class="Userdata" foreign="userdata_id" cardinality="one" owner="local" />
       </object>
       <object class="Userdata" table="data" extends="xPDOSimpleObject">
               <field key="userdata_id" dbtype="int" precision="11" phptype="integer" null="false" attributes="unsigned"/>
               <field key="facebook_url" dbtype="varchar" precision="100" phptype="string" null="true" />
               <index alias="userdata_id" name="userdata_id" primary="false" unique="true" type="BTREE">
                   <column key="userdata_id" length="" collation="A" null="false" />
               </index>
               <aggregate alias="extUser" local="userdata_id" foreign="id" cardinality="one" owner="foreign" />
       </object>
</model>

Обратите внимание, что расширение класса modUser происходит в пределах одного этого объекта. Также обратите внимание, что мы указываем префикс для нашей вспомогательной таблицы в узле модели: ext_

Более сложный пример¶

Обратите внимание, что бит index="unique" устарел - объявление индекса должно попадать в свой собственный узел, как в примере выше.

<?xml version="1.0" encoding="UTF-8"?>
<model package="extendeduser" baseClass="xPDOObject" platform="mysql" defaultEngine="MyISAM" tablePrefix="ext_">
   <!-- наследуем класс пользователя MODX и расширяем его -->
   <object class="extUser" extends="modUser">
       <composite alias="Phones" local="id" foreign="user" cardinality="many" owner="local" />
       <composite alias="Table2" local="id" foreign="user" cardinality="many" owner="local" />
   </object>
   <!-- добавляем номера телефона пользователя -->
   <object table="phone_numbers" extends="xPDOSimpleObject">
       <field key="user" dbtype="int" phptype="integer" null="false" default="0" index="index" />
       <field key="areacode" dbtype="varchar" precision="3" phptype="string" null="false" default="" />
       <field key="number" dbtype="varchar" precision="7" phptype="string" null="false" default="" />
       <aggregate alias="extUser" local="user" foreign="id" cardinality="one" owner="foreign" />
   </object>
   <!-- расширяем пользователя -->
   <object table="table2" extends="xPDOSimpleObject">
       <field key="user" dbtype="int" phptype="integer" null="false" default="0" index="index" />
       <field key="myspaceurl" dbtype="varchar" precision="255" phptype="string" null="false" />
       <aggregate alias="extUser" local="user" foreign="id" cardinality="one" owner="foreign" />
   </object>
</model>

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

2.) Отредактируйте файл extuser.class.php¶

Чтобы получить доступ к расширенному классу, мы должны сообщить modUser, что данный пользователь был расширен. Таблица modx_users в базе данных содержит поле специально для этой цели: class_key. Значением по умолчанию в этом поле является modUser. Когда пользователи добавляются на ваш сайт с использованием вашего расширения, нам нужно «принудительно» ввести имя «основного» класса в схеме, а именно extUser в нашем примере.

Отредактируйте файл extuser.class.php, созданный при создании модели. Конкретный файл находится в верхней части дерева модели (вы должны увидеть каталог mysql) в этой же папке. Отредактируйте файл, чтобы он выглядел следующим образом:

<?php
/**
* @package extendeduser
* @subpackage user.mysql
*/
class extUser extends modUser {
   function __construct(xPDO & $xpdo) {
       parent::__construct($xpdo);
       $this->set('class_key','extUser');
   }
}
?>

3.) Создайте (или отредактируйте) extension_packages в Системных настройках¶

Перейдите к системным настройкам в системном меню менеджера и найдите extension_packages.

Если ключ уже существует, добавьте в массив json

,{"extendeduser":{"path":"[[++core_path]]components/extendeduser/model/"}}

Если ключ не существует¶

• Создайте новый системный параметр с названием extension_packages
• Ключ extension_packages
• Тип поля: Текстовое поле
• Значение:

[{"extendeduser":{"path":"[[++core_path]]components/extendeduser/model/"}}]

4.) Заключительный шаг: Создайте класс для доступа и использования вашего расширенного класса¶

Основная причина расширения базового класса заключается в том, чтобы вы могли легче взаимодействовать со своими расширенными данными. Таким образом, в какой-то момент в сниппете, плагине или пользовательских страницах менеджера (CMP, Custom Manager Page) вы будете работать с новыми данными.

Простой пример¶

Вот как вы можете взаимодействовать со своими расширенными данными в сниппете:

$modx->addPackage('extendeduser', MODX_CORE_PATH . 'components/extendeduser/model/', 'ext_');
$user = $modx->getObject('extUser', 123); // где 123 - это идентификатор (ID) пользователя
$data = $user->getOne('Data'); // используйте псевдоним из схемы
// toArray распечатает все дополнительные данные, например, facebook_url
return print_r($data->toArray(), true);

Более сложный пример¶

<?php
/**
*  File        sample.class.php (требует MODX Revolution 2.x)
* Created on    Август 18, 2010
* Project        shawn_wilkerson
* @package     extendedUser
* @version    1.0
* @category    Расширение пользователя
* @author        W. Shawn Wilkerson
* @link        http://www.shawnWilkerson.com
* @copyright  Авторское право (c) 2010, W. Shawn Wilkerson.  Все права защищены.
* @license      GPL
*
*/
if (!class_exists('Sampleclass')) {
   class Sampleclass
   {
       function __construct(modX & $modx, array $config= array ()) {
           /* Импортируем modx по ссылке */
           $this->modx= & $modx;
           /* Создадим среду */
           $this->extPath= $modx->getOption('core_path',null, MODX_CORE_PATH).'components/extendeduser/';
           $this->modx->addPackage('extendeduser', $this->extPath .'model/', 'ut_');
           $this->_config= array_merge(array (
               'userID' => $this->modx->user->get('id'),
           ), $config);
           /* Определим пользователя */
           $this->userObj = $this->setUser($this->_config['userID']);
           $this->userID = $this->userObj->get('id');
       }
       function __destruct() {
           unset ($this->extPath, $this->userObj, $this->userID, $this->_config);
       }
       /**
        * Возвращает объект с типом Phone.
        */
       public function getPhoneObj() {
           $this->userObj->getOne('Phones');
           return $this->userObj->Phones;
       }
       /**
        * Возвращает экземпляр объекта modUser, по умолчанию - текущий пользователь.
        * @param $userID
        */
       public function getUserObj($userID) {
           return $this->modx->getObject('modUser', $userID);
       }
       /**
        * Устанавливает пользователя.
        * @param int $userID
        */
       public function setUser($userID){
           return $this->getUserObj($userID);
       }
   }
}

5.) Доступ к классу¶

В нашем примере мы будем обращаться к нашему расширенному пользователю по всему сайту, поэтому мы загружаем его как сервис, как показано в следующем примере:

<?php
$x = $modx->getService('extendeduser','Sampleclass',$modx->getOption('core_path',null, MODX_CORE_PATH).'components/extendeduser/',$scriptProperties);
if (!($x instanceof Extendeduser)) {
   $modx->log(modX::LOG_LEVEL_ERROR,'[Extendeduser] Could not load Extendeduser class.');
   $modx->event->output(true);
}
return;

Стоит отметить¶

1. Любой ранее существующий пользователь по-прежнему будет иметь modUser в качестве class_key и, следовательно, не будет расширяться или создавать пользовательские объекты типа extUser, если вы не измените его.
2. Дважды проверьте файл modx.mysql.schema.xml, чтобы убедиться, что вы не используете классы или псевдонимы, которые он уже использует, поскольку ваш файл заменит modUser по умолчанию, запрещающий вам доступ к таким элементам, как атрибуты пользователя (с псевдонимом Profile)
3. У extUser не будет таблицы, созданной в базе данных, но прикрепленные отношения будут
4. Таблица(ы) расширенных классов должна(ы) находиться в той же базе данных, что и обычная таблица modx_users
5. Признаки ошибки в шаге 3 (путь extension_packages):
   1. Любой пользователь с class_key extUser вернет ошибку при входе в систему: «Пользователь не может быть найден ...». Если это администратор, обратитесь напрямую к вашей базе данных, верните ключ_класса в modUser, войдите в систему правильно, а затем измените путь на правильное представление пути.
   2. Прикрепленные к классу сниппеты будут работать с перебоями или вообще не работать
6. Чтобы посчитать свои данные (т.е. сколько телефонных номеров у этого человека), используйте любой вариант ниже (можно добавить любые критерии):

    $this->modx->getCount('extPhones', array('user' => $this->userID));
    $this->modx->getCount('extPhones');

Вполне возможно иметь несколько активных расширенных систем ModUser одновременно. Было бы даже возможно расширить rpx расширение Джейсона Коварда в гибридную систему, используя преимущества обеих систем. Также вполне возможно иметь несколько расширенных приложений modUser, работающих автономно. Это может быть сделано, следуя подобному процессу для каждого из ваших расширений, изменяя только поле «class_key», чтобы отразить расширенный класс, принадлежащий каждому соответствующему пользователю.

Предлагаемые дополнительные соображения¶

Файлы моделей можно редактировать с помощью методов и описаний. Взгляните на большую часть моделей MODX/xPDO, и вы увидите, как широко это сделано.

Этот процесс может быть автоматизирован и записан при входе пользователя. Для краткости лучше всего показать вам работу splittingred на github, где он предоставляет реальное приложение:

Плагины:

• http://github.com/splittingred/modActiveDirectory/blob/master/core/components/activedirectory/elements/plugins/plugin.activedirectory.php

События:

• http://github.com/splittingred/modActiveDirectory/blob/master/core/components/activedirectory/elements/events/onauthentication.php
• http://github.com/splittingred/modActiveDirectory/blob/master/core/components/activedirectory/elements/events/onusernotfound.php

Доступны расширенные классы modUser¶

modActiveDirectory - это приложение, которое обеспечивает взаимодействие с контроллером домена Microsoft

Расширение rpx позволяет людям войти через Facebook и другие социальные сети

Изменение class_key¶

Всякий раз, когда вы изменяете ключ class_key для встроенного объекта MODX, вы должны знать, как меняется поведение. Ключ class_key влияет на то, какие агрегаты и композиты доступны объекту. Например, если у пользователя есть class_key «extUser», вы все равно можете получить объект, используя родительский класс:

// Оба примера работают, когда у пользователя установлен class_key в "extUser":
$User = $modx->getObject('modUser', 123);
$User = $modx->getObject('extUser', 123);

Тем не менее, агрегаты или составные отношения зависят от сохраненного значения class_key.

$Data = $modx->newObject('Userdata');
$Data->set('facebook_url',$url); // и т.д.
$User->addOne($Data);
$User->save(); // это не сохранит связанные даннные, если class_key не имеет определенных отношений!
$User->set('class_key', 'extUser');
$User->save(); // теперь мы можем установить связанные данные
$User->addOne($Data);
$User->save(); // а теперь мы можем сохранить связанные данные