Напишем компонент для отслеживания и управления актуальностью записей типов контента

+10
1.08K
Напишем компонент для отслеживания и управления актуальностью записей типов контента

Недавно мы написали поле для пометки неактуальных записей. Сегодня усложним задачу и сделаем из этого поля компонент.

Что будем делать

  1. Создадим компонент, перенесем в него наши экшены.
  2. Немного доработаем само поле, чтобы можно было делать актуальным без редактирования записи.
  3. Добавим админку и форму опций.
  4. Будем автоматически помечать записи, как неактуальные, через определенный промежуток времени, если автор не подтвержит акутальность.
  5. Отправим автору письмо с просьбой подтеврдить актуальность за пару дней до того, как сделаем запись неактуальной.

Начем с создания компонента. Если нам не нужна админка, то можно просто создать папку, в которой добавить файл модели и/или фронтенда и папку actions, куда переместим наши экшены. Приступим. Создадим в папке system/controllers новую папку changestatus, внутри этой папки добавим файл frontend.php. В нем объявим класс changestatus, наследуемый от cmsFrontend:

  1. <?php class changestatus extends cmsFrontend {
  2.  
  3. }

Здесь же создадим файл model.php c таким содержимым:

  1. <?php class modelChangestatus extends cmsModel {
  2.  
  3. }

В этой же папке создаем еще одну папку — actions. В нее перемещаем файлы changestatus_off.php и changestatus_off_continue.php из папки system/controllers/content/actions. Но давайте переименуем эти файлы: changestatus_off.php переименуем в off_start.php, а changestatus_off_continue.php в off_end.php.

Теперь внесем небольшие исправления в этих файлах. В файле off_start.php заменим 

  1. <?php class actionContentChangestatusOff extends cmsAction {

на

  1. <?php class actionChangestatusOffStart extends cmsAction {

А в файле off_end.php заменим

  1. <?php class actionContentChangestatusOffContinue extends cmsAction {

на

  1. <?php class actionChangestatusOffEnd extends cmsAction {

Так как теперь наши экшены в другом компоненте, то $this->model не будет работать, если так мы обращаемся модели другого компонента. У нас есть такое в обоих экшенах:

  1. $ctype = $this->model->getContentType($ctype_id);

Метод getContentType() — это метод компонента content. Поэтому здесь мы $this->model заменим на $this->model_content.

  1. $ctype = $this->model_content->getContentType($ctype_id);

Еще у нас в обоих экшенах много повторяющегося кода. Чуть позже мы его перенесем в модель. Но сначала давайте внесем изменения в js-файл, ведь там идет обращение к файлам по старым адресам. Открываем файл templates/default/js/field-changestatus.js и меняем в нем

  1. $.post('/content/changestatus_off/' + ctype_id + '/' + item_id + '/' + field_id).done(function(response) {

на 

  1. $.post('/changestatus/off_start/' + ctype_id + '/' + item_id + '/' + field_id).done(function(response) {

и

  1. $.post('/content/changestatus_off_continue/' + ctype_id + '/' + item_id + '/' + field_id + '/' + reason).done(function(response) {

на 

  1. $.post('/changestatus/off_end/' + ctype_id + '/' + item_id + '/' + field_id + '/' + reason).done(function(response) {

Чтобы убедиться, что всё работает, не забываем очистить кэш или изменить значение абстрактного счетчика в настройках сайта во вкладке Интерфейс.

Теперь давайте перенесем повторяющийся код из экшенов в модель. Открываем файлы off_start.php и off_end.php и смотрим, что у нас повторяется. А повторяется достаточно много:

  1. if ((int)$ctype_id <= 0 || (int)$item_id <= 0 || (int)$field_id <= 0) {
  2.  
  3. $result['action'] = 'error';
  4.  
  5. $result['text'] = 'Ай-я-яй, как не стыдно?';
  6.  
  7. echo json_encode($result);
  8.  
  9. $this->halt();
  10.  
  11. }
  12.  
  13. $ctype = $this->model_content->getContentType($ctype_id);
  14.  
  15. if (!$ctype) {
  16.  
  17. $result['action'] = 'error';
  18.  
  19. $result['text'] = 'Плохо, очень плохо!';
  20.  
  21. echo json_encode($result);
  22.  
  23. $this->halt();
  24.  
  25. }
  26.  
  27. $ctype_name = $ctype['name'];
  28.  
  29. $field = $this->model->getItemById('con_'.$ctype_name.'_fields', $field_id);
  30.  
  31. if (!$field || $field['type'] != 'changestatus') {
  32.  
  33. $result['action'] = 'error';
  34.  
  35. $result['text'] = 'А ну, марш в угол!';
  36.  
  37. echo json_encode($result);
  38.  
  39. $this->halt();
  40.  
  41. }
  42.  
  43. $field_name = $field['name'];
  44.  
  45. $item = $this->model->getItemById('con_'.$ctype_name, $item_id);
  46.  
  47. if (!$item) {
  48.  
  49. $result['action'] = 'error';
  50.  
  51. $result['text'] = 'Ну всё, приплыли...';
  52.  
  53. echo json_encode($result);
  54.  
  55. $this->halt();
  56.  
  57. }
  58.  
  59. $result = [];
  60.  
  61. $user = cmsUser::getInstance();
  62.  
  63. if (!$user->is_admin && $user->id != $item['user_id']) {
  64.  
  65. $result['action'] = 'error';
  66.  
  67. $result['text'] = 'Вам запрещено это делать!';
  68.  
  69. if (!$user->is_logged) {
  70.  
  71. $result['text'] = 'Вы вышли из аккаунта!';
  72.  
  73. }
  74.  
  75. echo json_encode($result);
  76.  
  77. $this->halt();
  78.  
  79. }

Сейчас мы сделаем это код немного чище, а также добавим метод в модель, где перед действием будут выполняться все проверки.

Открываем файл model.php и добавляем метод check():

  1. <?php class modelChangestatus extends cmsModel {
  2.  
  3. public function check() {
  4.  
  5. }
  6.  
  7. }

В этот метод мы передадим параметры, которые нужно проверить. В файл off_start.php приходят id типа контента, записи и поля. В файл off_end.php еще и id причины. Вот все эти 4 значения мы передадим в метод check():

  1. <?php class modelChangestatus extends cmsModel {
  2.  
  3. public function check($ctype_id, $item_id, $field_id, $reason_id = null) {
  4.  
  5. }
  6.  
  7. }

Так как id причины у нас есть не всегда, то по-умолчанию пусть будет null.

Приступим к проверкам:

  1. <?php class modelChangestatus extends cmsModel {
  2.  
  3. public function check($ctype_id, $item_id, $field_id, $reason_id = null) {
  4.  
  5. $result = []; // $result - это массив
  6.  
  7. $result['action'] = 'error'; // По-умолчанию ошибка
  8.  
  9. // Id типа контента, записи и поля должны быть числами
  10. $err1 = is_numeric($ctype_id) && is_numeric($item_id) && is_numeric($field_id);
  11.  
  12. // Если пришел id причины, то он должен быть числом или иксом
  13. $err2 = $reason_id ? is_numeric($reason_id) || $reason_id == 'x' : true;
  14.  
  15. // Если хотя бы одно из условий выше не выполняется
  16. if (!$err1 || !$err2) {
  17.  
  18. $result['text'] = 'Ай-я-яй, как не стыдно?'; // Такой будет текст ошибки
  19. return $result; // Возвращаемся в экшен
  20.  
  21. }
  22.  
  23. $user = cmsUser::getInstance();
  24.  
  25. // Если пользователь не авторизован, нет смысла продолжать
  26. if (!$user->is_logged) {
  27.  
  28. $result['text'] = 'Вы вышли из аккаунта!';
  29. return $result;
  30.  
  31. }
  32.  
  33. $model_content = cmsCore::getModel('content'); // Модель контента
  34. $ctype = $model_content->getContentType($ctype_id); // Получаем тип контента по id
  35.  
  36. if (!$ctype) { // Если нет такого типа контента
  37.  
  38. $result['text'] = 'Плохо, очень плохо!';
  39. return $result;
  40.  
  41. }
  42.  
  43. // Получаем поле
  44. $field = $model_content->getContentField($ctype['name'], $field_id);
  45.  
  46. // Если нет поля или его тип не changestatus
  47. if (!$field || $field['type'] != 'changestatus') {
  48.  
  49. $result['text'] = 'А ну, марш в угол!';
  50. return $result;
  51.  
  52. }
  53.  
  54. // Получаем запись
  55. $item = $model_content->getContentItem($ctype['name'], $item_id);
  56.  
  57. // Если нет записи
  58. if (!$item) {
  59.  
  60. $result['text'] = 'Ну всё, приплыли...';
  61. return $result;
  62.  
  63. }
  64.  
  65. // Если пользователь не админ или не автора
  66. if (!$user->is_admin && $user->id != $item['user_id']) {
  67.  
  68. $result['text'] = 'Вам запрещено это делать!';
  69. return $result;
  70.  
  71. }
  72.  
  73. // Если всё нормально, то возвращаем ok
  74. // и данные, которые получали в процессе проверок:
  75. // тип контента, запись и поле
  76. return [
  77. 'action' => 'ok',
  78. 'ctype' => $ctype,
  79. 'item' => $item,
  80. 'field' => $field
  81. ];
  82.  
  83. }
  84.  
  85. }

Теперь изменим экшены. Начнем с off_start.php:

  1. <?php class actionChangestatusOffStart extends cmsAction {
  2.  
  3. public function run($ctype_id, $item_id, $field_id) {
  4.  
  5. $result = []; // $result - это массив
  6. $result['action'] = 'error'; // По-умолчанию ошибка
  7.  
  8. // Отправляем данные в метод check()
  9. $check = $this->model->check($ctype_id, $item_id, $field_id);
  10.  
  11. // Если вернулась ошибка при проверке
  12. if ($check['action'] == 'error') {
  13.  
  14. // Возвращаем скрипту текстовое сообщение, соответствующее ошибке
  15. $result['text'] = $check['text'];
  16. return $this->cms_template->renderJSON($result);
  17.  
  18. }
  19.  
  20. // Если проверка пройдена, то меняем ошибку на ok
  21. $result['action'] = 'ok';
  22.  
  23. // Опции поля
  24. $field_options = $check['field']['options'];
  25.  
  26. // Если в опциях указаны причины, то делаем из них массив
  27. $reasons = $field_options['reason'] ? string_explode_list($field_options['reason']) : '';
  28.  
  29. $reasons_list = [];
  30.  
  31. // Если у есть причины, то перебераем их и создаем новый массив.
  32. // Так как значение с нулевым ключом - это первое значение списка,
  33. // то оставим икс в качестве метки, что причина не указана
  34. if ($reasons) {
  35.  
  36. foreach ($reasons as $key => $reason) {
  37.  
  38. $reasons_list[] = '<option value="'.$key.'">'.$reason.'</option>';
  39.  
  40. }
  41.  
  42. }
  43.  
  44. // Такой текст будет в модальном окне по-умолчанию
  45. $result_text = '<p class="changestatus_text">Материал будет помечен, как неактуальный. Вы уверены, что хотите продолжить?</p>';
  46.  
  47. // Если есть причины и пользователь не админ
  48. if ($reasons_list && !$this->cms_user->is_admin) {
  49.  
  50. // Делаем из массива с причинами выпадающий список
  51. $list = '<select>'.implode($reasons_list).'</select>';
  52.  
  53. // Меняем текст в модальном окне и к нему добавляем список причин
  54. $result_text = '<p class="changestatus_text">Укажите, пожалуйста, причину, по которой материал больше неактуален.</p>'.$list;
  55.  
  56. }
  57.  
  58. // Заголовоки из настроек типа контента.
  59. // В стрших версиях InstantCMS не было склонений по падежам.
  60. // Но нам нужен родительный падеж. Поэтому мы будем использовать заголовок two (два):
  61. // "Изменение статуса объявления/новости/поста"
  62. $ctype_labels = $this->model->yamlToArray($check['ctype']['labels']);
  63.  
  64. // Заголовок в модальном окне
  65. $label = '<p class="changestatus_label">Изменение статуса '.$ctype_labels['two'].'</p> <h3>&laquo;'.$check['item']['title'].'&raquo;</h3>';
  66.  
  67. // Кнопка для продолжения
  68. $btn_continue = '<div class="changestatus_btn changestatus_continue" onclick="statusOffContinue(\''.$ctype_id.'\', '.$item_id.', \''.$field_id.'\')">Продолжить</div>';
  69.  
  70. // Кнопка отмены
  71. $btn_cancel = '<div class="changestatus_btn changestatus_cancel" onclick="statusCancel(\''.$ctype_id.'\', '.$item_id.', \''.$field_id.'\')">Отменить</div>';
  72.  
  73. // Собираем кнопки вместе
  74. $buttons = '<div class="changestatus_btns">'.$btn_continue.$btn_cancel.'</div>';
  75.  
  76. // Результат: заголовок, текст, кнопки
  77. $result['text'] = '<div class="changestatus_modal changestatus_modal_'.$ctype_id.'_'.$item_id.'_'.$field_id.'"><div class="changestatus_modal_body">'.$label.$result_text.$buttons.'</div></div>';
  78.  
  79. return $this->cms_template->renderJSON($result);
  80.  
  81. }
  82.  
  83. }

Теперь изменим содержимое файла off_end.php:

  1. <?php class actionChangestatusOffEnd extends cmsAction {
  2.  
  3. public function run($ctype_id, $item_id, $field_id, $reason_id) {
  4.  
  5. $result = [];
  6. $result['action'] = 'error';
  7.  
  8. // Точно так же проходим проверку, но теперь передаем еще и id причины
  9. $check = $this->model->check($ctype_id, $item_id, $field_id, $reason_id);
  10.  
  11. if ($check['action'] == 'error') {
  12.  
  13. $result['text'] = $check['text'];
  14.  
  15. return $this->cms_template->renderJSON($result);
  16.  
  17. }
  18.  
  19. $result['action'] = 'ok';
  20.  
  21. $field_options = $check['field']['options'];
  22.  
  23. $result['text'] = '<div class="changestatus_off_text changestatus_not_reason">'.($field_options['not_actual'] ? $field_options['not_actual'] : 'Неактуально').'</div>';
  24.  
  25. // По-умолчанию причина не указана
  26. $reason = 'Причина не указана';
  27.  
  28. // Если id не является иксом
  29. if ($reason_id != 'x') {
  30.  
  31. //Если причины в опциях есть, то делаем из них массив
  32. $reasons = $field_options['reason'] ? string_explode_list($field_options['reason']) : '';
  33.  
  34. // Если в списке причин есть причина с id, который был передан в этот экшен
  35. if (!empty($reasons[$reason_id])) {
  36.  
  37. // то получаем причину
  38. $reason = $reasons[$reason_id];
  39.  
  40. }
  41.  
  42. }
  43.  
  44. // Если это делает админ
  45. if ($this->cms_user->is_admin) {
  46.  
  47. // то причина будет такая
  48. $reason = 'Статус изменен решением администрации сайта';
  49.  
  50. }
  51.  
  52. // Получаем имя таблицы в БД
  53. $table_name = $this->model_content->getContentTypeTableName($check['ctype']['name']);
  54.  
  55. // Обновляем поле в записи
  56. $this->model->update($table_name, $item_id, [
  57. $check['field']['name'] => $reason
  58. ]);
  59.  
  60. return $this->cms_template->renderJSON($result);
  61.  
  62. }
  63.  
  64. }

Перенесем обновление поля в модель. Открываем model.php и добавляем метод updField():

  1. public function updField($ctype_name, $item_id, $field_name, $reason) {
  2.  
  3. $this->update('con_'.$ctype_name, $item_id, [
  4. $field_name => $reason
  5. ]);
  6.  
  7. return true;
  8.  
  9. }

А в off_end.php вместо

  1. $table_name = $this->model_content->getContentTypeTableName($check['ctype']['name']);
  2.  
  3. $this->model->update($table_name, $item_id, [
  4. $check['field']['name'] => $reason
  5. ]);

напишем это:

  1. $this->model->updField($check['ctype']['name'], $item_id, $check['field']['name'], $reason);

Первый пункт выполнили, переходим ко второму. Сейчас, чтобы восстановить запись, нужно открыть форму редактирования и сохранить. Мы это так и оставим, но также добавим кнопку для неактуальной записи, при нажатии на которую он будет восстановлена.

Открываем файл поля system/fields/changestatus.php. Ярлык с надписью «Неактуально» у нас выводится в этой строке:

  1. return '<div class="changestatus_off_text" title="'.$value.'">'.($this->options['not_actual'] ? $this->options['not_actual'] : 'Неактуально').'</div>';

Добавим рядом с этим ярлыком кнопку для восстановления, которую будут видеть только админы и автор.

Перед этой строкой пишем:

  1. $restore_btn = '<div class="changestatus_btn changestatus_restore changestatus_restore_'.$cl.'" onclick="statusRestore('.$data.')">Восстановить</div>';

Можно добавить опцию с текстом для восстановления:

  1. new fieldString('btn_restore', [
  2. 'title' => 'Текст кнопки восстановления',
  3. 'default' => 'Восстановить'
  4. ])

Теперь наши опции выглядят так:

  1. public function getOptions(){
  2.  
  3. return [
  4. new fieldString('btn_off', [
  5. 'title' => 'Текст кнопки отключения',
  6. 'default' => 'Неактуально'
  7. ]),
  8. new fieldString('btn_restore', [
  9. 'title' => 'Текст кнопки восстановления',
  10. 'default' => 'Восстановить'
  11. ]),
  12. new fieldText('reason', [
  13. 'title' => 'Причины',
  14. 'hint' => 'Оставьте поле пустым, если указывать причину не нужно. По одной причине в каждой строке, например:<br><b>Продал на этом сайте<br>Продал на другом сайте<br>Передумал продавать</b>'
  15. ]),
  16. new fieldString('not_actual', [
  17. 'title' => 'Текст, если запись неактуальная',
  18. 'default' => 'Не актуально'
  19. ])
  20. ];
  21.  
  22. }

И вот так выглядит форма опций в админке:

Изображение

Добавим код, который выведет текст на кнопке:

  1. $restore_btn_text = $this->options['btn_restore'] ? $this->options['btn_restore'] : 'Восстановить';

И изменим код, выводящий эту кнопку, где вместо текста «Восстановить», вставим переменную $restore_btn_text:

  1. $restore_btn = '<div class="changestatus_btn changestatus_restore changestatus_restore_'.$cl.'" onclick="statusRestore('.$data.')">'.$restore_btn_text.'</div>';

Но в таком виде кнопка будет выводиться всем, а надо ее показывать только автору или админам. Изменим немного:

  1. $restore_btn = '';
  2.  
  3. if ($user->is_admin || $user->id == $this->item['user_id']) {
  4.  
  5. $restore_btn_text = $this->options['btn_restore'] ? $this->options['btn_restore'] : 'Восстановить';
  6.  
  7. $restore_btn = '<div class="changestatus_btn changestatus_restore changestatus_restore_'.$cl.'" onclick="statusRestore('.$data.')">'.$restore_btn_text.'</div>';
  8.  
  9. }

Ну и теперь нужно эту кнопку вывести где-нибудь. Добавим ее после ярлыка «Неактуально»:

  1. return '<div class="changestatus_off_text changestatus_off_text_'.$cl.'" title="'.$value.'">'.($this->options['not_actual'] ? $this->options['not_actual'] : 'Неактуально').'</div>'.$restore_btn;

Сделаем кнопку с классом changestatus_restore такой же, как и changestatus_off в файле templates/default/css/field-changestatus.css:

  1. .changestatus_off,
  2. .changestatus_restore{
  3. background: #d00000;
  4. }
  5.  
  6. .changestatus_off:hover,
  7. .changestatus_restore:hover{
  8. background: #e50000;
  9. }
  10.  
  11. И добавим кнопкам и ярлыкам отступы:
  12.  
  13. .changestatus_btn,
  14. .changestatus_off_text{
  15. margin:0 5px 5px 0;
  16. }

Получается вот так:

Изображение

Теперь нам нужно написать функцию statusRestore(). Открываем файл templates/default/js/field-changestatus.js и добавляем эту функцию:

  1. function statusRestore(ctype_id, item_id, field_id) {
  2.  
  3. /* Отправляем данные в экшен restore */
  4. $.post('/changestatus/restore/' + ctype_id + '/' + item_id + '/' + field_id).done(function(response) {
  5.  
  6. result = $.parseJSON(response);
  7.  
  8. /* Если получаем ошибку */
  9. if (result.action === 'error') {
  10.  
  11. /* Удаляем у кнопки атрибут onclick и добавляем класс ошибки, выводим текст ошибки */
  12. $('.changestatus_btn_' + ctype_id + '_' + item_id + '_' + field_id).removeAttr('onclick').addClass('error_btn').html(result.text);
  13.  
  14. } else { /* Если всё хорошо */
  15.  
  16. /* Удаляем метку, что запись неактуальная */
  17. $('.changestatus_off_text_' + ctype_id + '_' + item_id + '_' + field_id).remove();
  18.  
  19. /* Меняем у кнопки текст и событие */
  20. $('.changestatus_btn_' + ctype_id + '_' + item_id + '_' + field_id).attr('onclick', 'statusOff(' + ctype_id + ',' + item_id + ',' + field_id + ')').text(result.text);
  21.  
  22. }
  23.  
  24. });
  25.  
  26. }

Так как у нас теперь в поле участвует не одна кнопка, а две (будут еще), то теперь надо было бы класс у кнопок сделать другой, одинаковый. В файле поля system/fields/changestatus.php меняем

  1. $btn_off = '<div class="changestatus_btn changestatus_off changestatus_off_'.$cl.'" onclick="statusOff('.$data.')">'.$off_text.'</div>';

на

  1. $btn_off = '<div class="changestatus_btn changestatus_off changestatus_btn_'.$cl.'" onclick="statusOff('.$data.')">'.$off_text.'</div>';

Недавний наш код

  1. $restore_btn = '<div class="changestatus_btn changestatus_restore changestatus_restore_'.$cl.'" onclick="statusRestore('.$data.')">'.$restore_btn_text.'</div>';

меняем на 

  1. $restore_btn = '<div class="changestatus_btn changestatus_restore changestatus_btn_'.$cl.'" onclick="statusRestore('.$data.')">'.$restore_btn_text.'</div>';

В js-файле в двух местах (в функции statusOff() и statusOffContinue())

  1. $('.changestatus_off_' + ctype_id + '_' + item_id + '_' + field_id).removeAttr('onclick').addClass('error_btn').html(result.text);

меняем на

  1. $('.changestatus_btn_' + ctype_id + '_' + item_id + '_' + field_id).removeAttr('onclick').addClass('error_btn').html(result.text);

Теперь создадим новый экшен restore.php в папке system/controllers/changestatus/actions:

  1. <?php class actionChangestatusRestore extends cmsAction {
  2.  
  3. public function run($ctype_id, $item_id, $field_id) {
  4.  
  5. $result = [];
  6. $result['action'] = 'error';
  7.  
  8. $check = $this->model->check($ctype_id, $item_id, $field_id);
  9.  
  10. if ($check['action'] == 'error') {
  11.  
  12. $result['text'] = $check['text'];
  13. return $this->cms_template->renderJSON($result);
  14.  
  15. }
  16.  
  17. $result['action'] = 'ok';
  18.  
  19. $field_options = $check['field']['options'];
  20.  
  21. $result['text'] = $field_options['btn_off'] ? $field_options['btn_off'] : 'Больше неактуально?';;
  22.  
  23. // Мы опять обращаемся к методу updField, но вместо причины передаем метку "actual"
  24. $this->model->updField($check['ctype']['name'], $item_id, $check['field']['name'], 'actual');
  25.  
  26. return $this->cms_template->renderJSON($result);
  27.  
  28. }
  29.  
  30. }

Работает это так:

Изображение

Давайте добавим кнопку восстановления не только при загрузке страницы, но и после того, как мы сделали запись неактуальной, чтобы вместе с ярлыком появлялась и кнопка. Для этого в экшене off_end.php изменим этот код:

  1. $result['text'] = '<div class="changestatus_off_text changestatus_not_reason">'.($field_options['not_actual'] ? $field_options['not_actual'] : 'Неактуально').'</div>';

на этот:

  1. $cl = $ctype_id.'_'.$item_id.'_'.$field_id;
  2.  
  3. $data = $ctype_id.', '.$item_id.', '.$field_id;
  4.  
  5. $restore_btn = '';
  6.  
  7. if ($this->cms_user->is_admin || $this->cms_user->id == $check['item']['user_id']) {
  8.  
  9. $restore_btn_text = $field_options['btn_restore'] ? $field_options['btn_restore'] : 'Восстановить';
  10.  
  11. $restore_btn = '<div class="changestatus_btn changestatus_restore changestatus_btn_'.$cl.'" onclick="statusRestore('.$data.')">'.$restore_btn_text.'</div>';
  12.  
  13. }
  14.  
  15. $result['text'] = '<div class="changestatus_off_text changestatus_off_text_'.$cl.' changestatus_not_reason">'.($field_options['not_actual'] ? $field_options['not_actual'] : 'Неактуально').'</div>'.$restore_btn;

Принцип точно такой, как и в файле поля.

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

  1. function statusOffContinue(ctype_id, item_id, field_id) {
  2.  
  3. var reasons = $('.changestatus_modal_' + ctype_id + '_' + item_id + '_' + field_id + ' select');
  4.  
  5. if (reasons.length) {
  6.  
  7. var reason = reasons.val();
  8.  
  9. } else {
  10.  
  11. var reason = 'x';
  12.  
  13. }
  14.  
  15. $.post('/changestatus/off_end/' + ctype_id + '/' + item_id + '/' + field_id + '/' + reason).done(function(response) {
  16.  
  17. result = $.parseJSON(response);
  18.  
  19. statusCancel(ctype_id, item_id, field_id);
  20.  
  21. if (result.action === 'error') {
  22.  
  23. $('.changestatus_btn_' + ctype_id + '_' + item_id + '_' + field_id).removeAttr('onclick').addClass('error_btn').html(result.text);
  24.  
  25. } else {
  26.  
  27. $('.changestatus_btn_' + ctype_id + '_' + item_id + '_' + field_id).removeAttr('onclick').replaceWith(result.text);
  28.  
  29. }
  30.  
  31. });
  32.  
  33. }

Вот так теперь всё работает:

Изображение

Ну вот теперь можно начать что-то делать. Да, вы не ошиблись)) Мы еще даже не начинали, а всего лишь исправили то, что было. 

Давайте создадим админку компонента и форму опций. Но сначала придумаем, какие опции нам нужны и для чего. Представим ситуацию, когда пользователь на сайте добавляет запись в каком-то типе контента. Для примера возьмем тип контента «Справочник организаций». Так вот, пользователь добавил компанию, всё классно. Проходит 2-3 месяца, а компания уже переехала в другое место или сменила номер телефона. Или вообще закрылась. А что, если мы предложим пользователю подтвердить актуальность через какое-то время? Если он проигнорирует, то сделаем компанию неактуальной. Конечно, если у вас огромный справочник, который вы где-то спарсили, то вам вряд ли это нужно. Но если пользователь сам добавлялся, то, возможно, ему будет не сложно зайти на сайт и нажать на кнопку, чтобы его компания продолжала публиковаться. В крайнем случае, админ может сам всё перепроверить и подтвердить. Вот такие мысли. Давайте начнем это делать.

Чтобы у компонента была админка, нужно о нем сделать запись в БД. Вот ее мы сейчас и добавим. Открываем phpMyAdmin, переходим в нужную базу, находим и открываем таблицу cms_controllers. В ней мы увидим список установленных компонентов. Нажимаем возле любого из них на ссылку «Копировать»:

Изображение

Откроется форма, в которой мы удаляем лишние данные и добавляем свои, как на скриншоте:

Изображение

Нажимаем на кнопку «Вперед» и на этом пока всё. Теперь в админке у нас появился наш компонент:

Изображение

Но при переходе в его настройки мы получим примерно такую ошибку:

Изображение

Давайте добавим настройки. Сначала в папке system/controllers/changestatus создадим файл backend.php с таким содержимым:

  1. <?php class backendChangestatus extends cmsBackend {
  2.  
  3. public $useDefaultOptionsAction = true;
  4. protected $useOptions = true;
  5.  
  6. public function actionIndex(){
  7.  
  8. $this->redirectToAction('options');
  9.  
  10. }
  11.  
  12. }

Здесь мы написали, что главной страницей в админке компонента у нас будут опции. Давайте создадим форму опций. В папке system/controllers/changestatus создаем папку backend, внутри которой создаем папку forms, а в ней создаем файл form_options.php с таким содержимым:

  1. <?php class formChangestatusOptions extends cmsForm{
  2.  
  3. public function init(){
  4.  
  5. return [
  6.  
  7. 'basic' => [
  8.  
  9. 'title' => '',
  10. 'type' => 'fieldset',
  11. 'childs' => [
  12.  
  13. new fieldCheckbox('option', [
  14. 'title' => 'Опция'
  15. ])
  16.  
  17. ]
  18.  
  19. ]
  20.  
  21. ];
  22.  
  23. }
  24.  
  25. }

Здесь мы добавили одну единственную опцию — это поле флаг. Проверим, что у нас получилось: переходим в настройки компонента в админке и видим нашу форму:

Изображение

Чтобы опции работали, как надо, добавим пару строк в файле frontend.php:

  1. public $useDefaultOptionsAction = true;
  2. protected $useOptions = true;

Возвращаемся к файлу опций. Давайте напишем нормальную форму. Наша форма должна быть динамическая, ведь типы контента могут появляться или удаляться, а для каждого типа контента у нас будут свои настройки. Заменим содержимое файла form_options.php на это:

  1. <?php class formChangestatusOptions extends cmsForm{
  2.  
  3. public function init(){
  4.  
  5. // Получаем модель контента
  6. $model_content = cmsCore::getModel('content');
  7.  
  8. // Получаем типы контента
  9. $ctypes = $model_content->getContentTypes();
  10.  
  11. // Пустой массив опций
  12. $options = [];
  13.  
  14. // Если нет типов контента
  15. // Хотя так не бывает, но пусть будет, мало ли
  16. if (!$ctypes) {
  17.  
  18. // Возвращаем пустой массив
  19. return $options;
  20.  
  21. }
  22.  
  23. // Перебираем типы контента.
  24. // Каждое поле пишем отдельно с добавлением в ключ элемента массива опций имени типа контента.
  25. foreach ($ctypes as $ctype) {
  26.  
  27. $options[$ctype['name']] = new fieldCheckbox($ctype['name'], [
  28. 'title' => $ctype['title']
  29. ]);
  30.  
  31. $options[$ctype['name'].'_exclude_groups'] =new fieldListmultiple($ctype['name'].'_exclude_groups', [
  32. 'title' => 'Группы пользователей, записи которых всегда акутальные',
  33. 'generator' => function() use ($model_content){
  34.  
  35. $groups = $model_content->get('users_groups');
  36.  
  37. $list = [];
  38.  
  39. if (!$groups) {
  40.  
  41. return $list;
  42.  
  43. }
  44.  
  45. foreach ($groups as $group) {
  46.  
  47. $list[$group['id']] = $group['title'];
  48.  
  49. }
  50.  
  51. return $list;
  52. },
  53. 'visible_depend' => [$ctype['name'] => ['show' => ['1']]]
  54. ]);
  55.  
  56. $options[$ctype['name'].'_days'] = new fieldNumber($ctype['name'].'_days', [
  57. 'title' => 'Интервал между подтверждениями уникальности',
  58. 'units' => 'дней',
  59. 'default' => 90,
  60. 'visible_depend' => [$ctype['name'] => ['show' => ['1']]],
  61. 'options' => ['is_abs' => true, 'is_ceil' => true, 'save_zero' => true],
  62. 'hint' => '0 - отключить'
  63. ]);
  64.  
  65. $options[$ctype['name'].'_notify'] = new fieldNumber($ctype['name'].'_notify', [
  66. 'title' => 'За сколько дней уведомлять автора до даты окончания актуальности',
  67. 'units' => 'дней',
  68. 'default' => 3,
  69. 'visible_depend' => [$ctype['name'] => ['show' => ['1']]],
  70. 'options' => ['is_abs' => true, 'is_ceil' => true, 'save_zero' => true],
  71. 'hint' => '0 - не уведомлять'
  72. ]);
  73.  
  74. $options[$ctype['name'].'_notify_html'] = new fieldHtml($ctype['name'].'_notify_html', [
  75. 'title' => 'Шаблон письма-предупреждения, что запись будет помечена как неактуальная',
  76. 'default' => '<p>Здравствуйте, {nickname}.</p>
  77. <p>Проверьте, пожалуйста, и подтвердите актуальность данных вашей записи <a href="{href}">"{title}"</a>, иначе она будет помечена, как неактуальная, {date} в {time}.</p>',
  78. 'options' => ['editor' => 'ace', 'editor_options' => ['mode' => 'ace/mode/javascript']],
  79. 'visible_depend' => [$ctype['name'] => ['show' => ['1']]],
  80. 'hint' => 'Можно использовать специальные выражения {nickname}, {title}, {href}, {date}, {time}'
  81. ]);
  82.  
  83. $options[$ctype['name'].'_end_notify'] = new fieldCheckbox($ctype['name'].'_end_notify', [
  84. 'title' => 'Уведомлять автора, когда запись стала неактуальной',
  85. 'default' => 1,
  86. 'visible_depend' => [$ctype['name'] => ['show' => ['1']]]
  87. ]);
  88.  
  89. $options[$ctype['name'].'_end_notify_html'] = new fieldHtml($ctype['name'].'_end_notify_html', [
  90. 'title' => 'Шаблон письма-уведомления, что запись стала неактуальной',
  91. 'default' => '<p>Здравствуйте, {nickname}.</p>
  92. <p>Ваша запись "{title}" помечена, как неактуальная. Подтвердить актуальность записи вы можете <a href="{href}">по ссылке</a>.</p>',
  93. 'options' => ['editor' => 'ace', 'editor_options' => ['mode' => 'ace/mode/javascript']],
  94. 'visible_depend' => [$ctype['name'] => ['show' => ['1']]],
  95. 'hint' => 'Можно использовать специальные выражения {nickname}, {title}, {href}'
  96. ]);
  97.  
  98. }
  99.  
  100. // Выводим нашу форму
  101. return [
  102.  
  103. 'basic' => array(
  104.  
  105. 'title' => 'Настройка типов контента',
  106. 'type' => 'fieldset',
  107. 'childs' => $options
  108. )
  109.  
  110. ];
  111. }
  112.  
  113. }

Вот такая получается форма:

Изображение

Теперь эти опции нужно где-то применить, чтобы что-то как-то сработало. Создадим в БД таблицу, где будем хранить наши данные о всех записях, а добавляться данные туда будут сразу же после добавления или обновления записей выбранных типов контента или при нажатии на кнопки.

Таблица будет состоять из следующих полей:

  • id;
  • ctype_name — имя типа контента;
  • item_id — id записи;
  • date_end — дата, когда запись станет неактуальной;
  • is_notify — если мы отправили уведомление, что запись станет неактуальной, то запишем сюда что-нибудь, чтобы больше не отправлять;
  • is_actual — единица в этом поле говорит о том, что запись акутальная.

Итого 6 полей. Давайте создавать таблицу. Открываем phpMyAdmin, переходим в нашу БД, внизу есть такой блок:

Изображение

Пишем здесь название нашей новой таблицы cms_changestatus (вместо cms_ напишите нужный префикс) и выбираем 7 полей:

Изображение

Нажимаем кнопку «Вперед». Откроется таблица, которую нужно заполнить вот так:

Изображение

Нажимаем сохранить. Ну а теперь давайте начнем что-то в нее писать. Каждый раз при добавлении записи в выбранном в опциях компонента типа контента, нужно записать строку со значениями. Если запись редактируется, то нужно проверить, есть ли строка, соответствующая этой записи. Если удаляем, то нужно удалить строку. Если удаляем в корзину, то нужно снять метку is_actual. Если восстанавливается, то снова поставить метку. И т.д. Это всё должно делаться автоматически, поэтому сейчас начнем писать хуки.

В папке system/controllers/changestatus создаем папку hooks. В ней будем создавать файлы. Начнем с добавления записи. Создаем файл content_after_add_approve.php с таким содержимым:

  1. <?php class onChangestatusContentAfterAddApprove extends cmsAction {
  2.  
  3. public function run($data){
  4.  
  5. // Если тип контента не включен в опциях
  6. // или если пользователь в исключенной группе - ничего не делаем
  7. if (empty($this->options[$data['ctype_name']]) || $this->cms_user->isInGroups($this->options[$data['ctype_name'].'_exclude_groups'])) {
  8.  
  9. return $data;
  10.  
  11. }
  12.  
  13. // Если интервал равен нулю, тоже ничего не делаем
  14. if ($this->options[$data['ctype_name'].'_days'] == 0) {
  15.  
  16. return $data;
  17.  
  18. }
  19.  
  20. // Прибавляем к текущей дате нужное количество дней с помощью метода dateEnd()
  21. $date_end = $this->dateEnd(date('Y-m-d H:i:s'), $this->options[$data['ctype_name'].'_days']);
  22.  
  23. // Записываем данные в таблицу
  24. $this->model->insertItem($data['ctype_name'], $data['item']['id'], $date_end);
  25.  
  26. return $data;
  27.  
  28. }
  29.  
  30. }

Здесь мы выполнили два обращения к методам модели. Но их еще нет. Добавим. Открываем файл model.php и добавляем метод dateEnd():

  1. public function dateEnd($date, $days) {
  2.  
  3. // Прибавляем к дате количество дней из опций
  4. $date_time = new DateTime($date);
  5. $date_time->modify('+'.$days.' day');
  6. $date_end = $date_time->format('Y-m-d H:i:s');
  7.  
  8. // Возвращаем дату окончания
  9. return $date_end;
  10.  
  11. }

И метод insertItem():

  1. public function insertItem($ctype_name, $item_id, $date_end) {
  2.  
  3. $this->insert('changestatus',[
  4. 'ctype_name' => $ctype_name,
  5. 'item_id' => $item_id,
  6. 'date_end' => $date_end,
  7. 'is_actual' => 1
  8. ]);
  9.  
  10. return true;
  11.  
  12. }

При записи в БД мы не указываем id, так как он добавится сам, и is_notify, т. к. мы установили значение по-умолчанию 0 — уведомление не отправлено, ведь это новая запись.

Этот хук готов. Еще, согласно документации, раньше хуки нужно было прописывать в файл манифеста, но если версия InstantCMS выше 2.7.2, то этого делать не нужно. Но после создания хука, чтобы он работал, нужно обновить события в БД в разделе Компоненты -> Управление событиями.

Напишем еще один хук, который будет срабатывать после редактирования записи. Создаем в папке hooks файл content_after_update_approve.php с таким содержимым:

  1. <?php class onChangestatusContentAfterUpdateApprove extends cmsAction {
  2.  
  3. public function run($data){
  4.  
  5. // Проверяем, есть ли в таблице changestatus строка с этой записью типа контента
  6. $item = $this->model->filterEqual('ctype_name', $data['ctype_name'])->getItemByField('changestatus', 'item_id', $data['item']['id']);
  7.  
  8. // Получаем автора записи
  9. $author = $this->model_users->getUser($data['item']['user_id']);
  10.  
  11. // Получаем группы автора
  12. $author_groups = $author['groups'];
  13.  
  14. // Объявляем переменную $exclude - это массив
  15. $exclude = [];
  16.  
  17. // Перебираем массив с группами
  18. foreach ($author_groups as $author_group) {
  19.  
  20. // Если группы нет в массиве исключенных групп
  21. if (!in_array($author_group, (array) $this->options[$data['ctype_name'].'_exclude_groups'])) {
  22.  
  23. // Пропускаем
  24. continue;
  25.  
  26. }
  27.  
  28. // или записываем в массив $exclude
  29. $exclude[] = $author_group;
  30.  
  31. }
  32.  
  33. // Если тип контента не выбран в опциях, интервал равен нулю или в массиве $exclude что-то есть
  34. if (empty($this->options[$data['ctype_name']]) || $this->options[$data['ctype_name'].'_days'] == 0 || $exclude) {
  35.  
  36. // Если есть строка в таблице changestatus
  37. if ($item) {
  38.  
  39. // Удаляем эту строку
  40. $this->model->delete('changestatus', $item['id']);
  41.  
  42. // Обновляем поля типа changestatus
  43. $this->model->updFields($data['ctype_name'], $item['id'], 'actual');
  44.  
  45. }
  46.  
  47. return $data;
  48.  
  49. }
  50.  
  51. // Обращаемся к методу dateEnd() для получения даты окончания
  52. $date_end = $this->model->dateEnd($this->options[$data['ctype_name'].'_days']);
  53.  
  54. // Если нет строки в таблице changestatus
  55. if (!$item) {
  56.  
  57. // Создаем строку
  58. $this->model->insertItem($data['ctype_name'], $data['item']['id'], $date_end);
  59.  
  60. return $data;
  61.  
  62. }
  63.  
  64. // Если есть строка, то обновляем ее
  65. // Записываем в нее новую дату, указываем, что запись актуальная и уведомление не отправлено
  66. $this->model->updateItem($item['id'], $date_end, 1, 0);
  67.  
  68. // Обновляем поля типа changestatus
  69. $this->model->updFields($data['ctype_name'], $item['id'], 'actual');
  70.  
  71. return $data;
  72.  
  73. }
  74.  
  75. }

Давайте проверку, находится ли автор в исключенной группе, перенесем в модель. Нам это пригодится еще в некоторых местах. Добавляем в файле модели метод authorGroups():

  1. public function authorGroups($data) {
  2.  
  3. $author = $this->model_users->getUser($data['item']['user_id']);
  4.  
  5. $exclude = [];
  6.  
  7. foreach ($author['groups'] as $author_group) {
  8.  
  9. if (!in_array($author_group, (array) $this->options[$data['ctype_name'].'_exclude_groups'])) {
  10.  
  11. continue;
  12.  
  13. }
  14.  
  15. $exclude[] = $author_group;
  16.  
  17. }
  18.  
  19. return $exclude;
  20.  
  21. }

А в хуке этот код

  1. // Получаем автора записи
  2. $author = $this->model_users->getUser($data['item']['user_id']);
  3.  
  4. // Получаем группы автора
  5. $author_groups = $author['groups'];
  6.  
  7. // Объявляем переменную $exclude - это массив
  8. $exclude = [];
  9.  
  10. // Перебираем массив с группами
  11. foreach ($author_groups as $author_group) {
  12.  
  13. // Если группы нет в массиве исключенных групп
  14. if (!in_array($author_group, (array) $this->options[$data['ctype_name'].'_exclude_groups'])) {
  15.  
  16. // Пропускаем
  17. continue;
  18.  
  19. }
  20.  
  21. // или записываем в массив $exclude
  22. $exclude[] = $author_group;
  23.  
  24. }

заменим на такую строчку:

  1. $exclude = $this->model->authorGroups($data);

Еще здесь мы обращаемся к новому методу в модели, которого еще нет — updateItem(). Добавим его в модель:

  1. public function updateItem($id, $date_end, $is_actual, $is_notify) {
  2.  
  3. // Обновляем запись в таблице changestatus
  4. // Записываем новую дату, указываем, что запись актуальная и что уведомление не отправлено
  5. $this->update('changestatus', $id, [
  6. 'date_end' => $date_end,
  7. 'is_actual' => $is_actual,
  8. 'is_notify' => $is_notify
  9. ]);
  10.  
  11. return true;
  12.  
  13. }

Может появиться вопрос, почему мы не обновляем само поле, делая запись актуальной. Метод store() поля при сохранении делает запись актуальной. А зачем нам делать два раза одно и то же? 

Добавление и редактирование добавили, осталось совсем немного — удаление, удаление в корзину и восстановление из корзины. Давайте напишем хук, срабатывающий после удаления записи. В папке hooks добавляем файл content_after_delete.php с таким содержимым:

  1. <?php class onChangestatusContentAfterDelete extends cmsAction {
  2.  
  3. public function run($data) {
  4.  
  5. $item = $this->model->filterEqual('ctype_name', $data['ctype_name'])->getItemByField('changestatus', 'item_id', $data['item']['id']);
  6.  
  7. if ($item) {
  8.  
  9. $this->model->delete('changestatus', $item['id']);
  10.  
  11. }
  12.  
  13. return $data;
  14.  
  15. }
  16.  
  17. }

Здесь всё просто — получили запись в таблице changestatus. Если она есть, то удалили. Не забываем обновлять события при добавления хуков в разделе Компоненты -> Управление событиями.

Теперь напишем хук, срабатывающий после удаления записи в корзину. Он будет называться content_after_trash_put.php, а содержимое файла будет почти такое же, как и в предыдущем, отличаться будет только название класса:

  1. <?php class onChangestatusContentAfterTrashPut extends cmsAction {
  2.  
  3. public function run($data) {
  4.  
  5. $item = $this->model->filterEqual('ctype_name', $data['ctype_name'])->getItemByField('changestatus', 'item_id', $data['item']['id']);
  6.  
  7. if ($item) {
  8.  
  9. $this->model->delete('changestatus', $item['id']);
  10.  
  11. }
  12.  
  13. return $data;
  14.  
  15. }
  16.  
  17. }

И осталось написать последний хук, срабатывающий после восстановления записи из корзины. Название файла content_after_restore.php, а содержимое такое же, как и в хуке, срабатывающем после обновления записи, только класс другой и кое-что еще:

  1. <?php class onChangestatusContentAfterRestore extends cmsAction {
  2.  
  3. public function run($data){
  4.  
  5. $item = $this->model->filterEqual('ctype_name', $data['ctype_name'])->getItemByField('changestatus', 'item_id', $data['item']['id']);
  6.  
  7. $exclude = $this->model->authorGroups($data);
  8.  
  9. if (empty($this->options[$data['ctype_name']]) || $this->options[$data['ctype_name'].'_days'] == 0 || $exclude) {
  10.  
  11. if ($item) {
  12.  
  13. $this->model->delete('changestatus', $item['id']);
  14.  
  15. }
  16.  
  17. return $data;
  18.  
  19. }
  20.  
  21. $date_end = $this->model->dateEnd($this->options[$data['ctype_name'].'_days']);
  22.  
  23. if (!$item) {
  24.  
  25. $this->model->insertItem($data['ctype_name'], $data['item']['id'], $date_end);
  26.  
  27. return $data;
  28.  
  29. }
  30.  
  31. $this->model->updateItem($item['id'], $date_end, 1, 0);
  32.  
  33. return $data;
  34.  
  35. }
  36.  
  37. }

Обновляем события в админке. Теперь у нас автоматически будет происходить запись в БД строк обо всех записях типа контента, когда мы их создаем, редактируем или удаляем. Но это еще не всё. 

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

А еще нам надо будет добавить одну кнопку в поле, чтобы автор или админ могли подтвердить актуальность до окончания срока. А также в экшены, делающие записи неактуальными или актуальными, добавить запись, обновление и удаление строк в таблице changestatus, чтобы всё это было единым целым.

Но сначала все-таки напишем задание для планировщика. Для этого в папке hooks создаем файл cron_changestatus.php с таким сожержимым:

  1. <?php class onChangestatusCronChangestatus extends cmsAction {
  2.  
  3. public $disallow_event_db_register = true;
  4.  
  5. public function run(){
  6.  
  7. return true;
  8.  
  9. }
  10.  
  11. }

Здесь пока ничего не происходит. Давайте подумает, что же все-таки должно происходить? Мы должны загрузить строки из таблицы changestatus, срок которых подходит к концу, чтобы выслать уведомления авторам. Если срок уже вышел, то сделать запись неактуальной и снова отправить уведомление автору. Приступим:

  1. <?php class onChangestatusCronChangestatus extends cmsAction {
  2.  
  3. // Этот хук выполняется по крону, нам его не нужно записывать в БД
  4. public $disallow_event_db_register = true;
  5.  
  6. public function run(){
  7.  
  8. // Массив с типами контента
  9. $ctypes_arr = $this->model_content->getContentTypes();
  10.  
  11. // Массив с интервалами, сюда мы запишем значения, за сколько предупреждать авторов
  12. $intervals = [];
  13.  
  14. // Перебираем типы контента
  15. foreach ($ctypes_arr as $ctype) {
  16.  
  17. // Если опции для типа контента не существует,
  18. // например, если мы создали тип контента после сохранения опций
  19. if (!isset($this->options[$ctype['name']])) {
  20.  
  21. // Пропускаем
  22. continue;
  23.  
  24. }
  25.  
  26. // Добавляем занчения массива, где
  27. // ключ - имя типа контента,
  28. // значение - за сколько дней предупредить автора
  29. $intervals[$ctype['name']] = $this->options[$ctype['name'].'_notify'];
  30.  
  31. }
  32.  
  33. // Берем из полученного массива максимальное значение
  34. $interval = max($intervals);
  35.  
  36. // Прибавляем к текущей дате количество дней из переменной $interval
  37. $date_plus = date('Y-m-d H:i:s', strtotime('+'.$interval.' days'));
  38.  
  39. // Получаем записи в таблице changestatus,
  40. // дата окончания которых наступит через $interval дней или уже наступила.
  41. // Системного фильтра такого нет, напишем свой dateApproach.
  42. // Также выбираем, чтобы у записей было заполнено поле date_end и is_actual чтобы содержало единицу
  43. $items = $this->model->dateApproach('date_end', $interval, $date_plus)->get('changestatus');
  44.  
  45. // Если нет подходящих строк
  46. if (!$items) {
  47.  
  48. // Завершаем работу
  49. return true;
  50.  
  51. }
  52.  
  53. // Перебираем строки
  54. foreach ($items as $item) {
  55.  
  56. // Получаем запись типа контента.
  57. // Она должна быть опубликована, одобрена и не удалена в корзину
  58. $c_item = $this->model_content->filterEqual('is_pub', 1)->filterEqual('is_approved', 1)->filterIsNull('is_deleted', 1)->getContentItem($item['ctype_name'], $item['item_id']);
  59.  
  60. // Если запись не нашли
  61. if (!$c_item) {
  62.  
  63. // Удаляем эту строку
  64. $this->model->delete('changestatus', $item['id']);
  65.  
  66. // и переходим к следующей
  67. continue;
  68.  
  69. }
  70.  
  71. // Массив, который передадим в метод authorGroups()
  72. // для проверки, не исключены ли группы, к которым
  73. // принадлежит автор
  74. $data = [
  75. 'item' => ['user_id' => $c_item['user_id']],
  76. 'ctype_name' => $item['ctype_name']
  77. ];
  78.  
  79. // Проверяем группы автора
  80. $exclude = $this->model->authorGroups($data);
  81.  
  82. // Если автор в группе, каторая исключена
  83. // или отслеживаниеи типа контена не включено
  84. // или интервал, в течение которого запись считается актуальной, равно нулю
  85. if ($exclude || $this->options[$ctype['name']] || $this->options[$ctype['name'].'_days]' == 0) {
  86.  
  87. // Удаляем строку
  88. $this->model->delete('changestatus', $item['id']);
  89.  
  90. // и переходим к следующей
  91. continue;
  92.  
  93. }
  94.  
  95. // Если дата окончания меньше или равна текущей дате
  96. if (strtotime($item['date_end']) <= date('U')) {
  97.  
  98. // Если включено уведомление после того, как запсиь стала неактуальной
  99. if ($this->options[$ctype['name'].'_end_notify']) {
  100.  
  101. // Отправляем письмо автору методом sendEmail()
  102. // Его мы добавим в модель
  103. $this->model->sendEmail($item['ctype_name'], $c_item, $this->options[$ctype['name'].'_end_notify_html'], $item['date_end']);
  104.  
  105. }
  106.  
  107. // Обновляем все поля типа changestatus в записи типа контента
  108. // Метод updFields() добавим в модель
  109. $this->model->updFields($item['ctype_name'], $c_item['id'], 'Актуальность не подтверждена автором записи');
  110.  
  111. // Обновляем строку в БД
  112. $this->model->updateItem($item['id'], null, 0, 1);
  113.  
  114. // Переходим к следующей строке
  115. continue;
  116.  
  117. }
  118.  
  119. $c_interval = $intervals[$item['ctype_name']];
  120.  
  121. // Если разница даты окончания и текущей
  122. // больше значения, за сколько дней предупреждать автора, умноженного на количество секунд в сутках
  123. // или предупреждения отключены (равно 0)
  124. // или предупреждение уже было отправлено
  125. if (strtotime($item['date_end']) - date('U') > $c_interval * 86400 || $c_interval == 0 || $item['is_notify'] == 1) {
  126.  
  127. // переходим к следующей строке
  128. continue;
  129.  
  130. }
  131.  
  132. // Отправляем предупреждение
  133. $this->model->sendEmail($item['ctype_name'], $c_item, $this->options[$ctype['name'].'_notify_html'], $item['date_end']);
  134.  
  135. // В строку пишем, что предупреждение отправлено
  136. $this->model->updateItem($item['id'], $item['date_end'], 1, 1);
  137.  
  138. }
  139.  
  140. return true;
  141.  
  142. }
  143.  
  144. }

Вот такое получилось задание. Но чтобы оно выполнялось по расписанию, нужно его добавить в планировщике. Переходим по пути Панель управления -> Настройки -> Планировщик, нажимаем «Добавить задание», заполняем поля (компонент — changestatus, хук — changestatus) и сохраняем.

Изображение

Давайте теперь добавим 3 метода в модель, о которых говорилось в комментариях в коде хука:

  1. public function dateApproach($field, $days){
  2.  
  3. // Переводим дни в минуты
  4. $minutes = $days * 1440;
  5.  
  6. // Используем функцию TIMESTAMPDIFF
  7. // Смысл такой: отнимаем от даты из поля текущую дату
  8. // и разница должна быть меньше или равна количеству минут
  9. $this->filter("TIMESTAMPDIFF(MINUTE, NOW(), {$field}) <= $minutes");
  10.  
  11. return $this;
  12.  
  13. }
  14.  
  15. public function updFields($ctype_name, $item_id, $reason) {
  16.  
  17. // Модель контента
  18. $model_content = cmsCore::getModel('content');
  19.  
  20. // Поля типа контента типа changestatus
  21. $fields = $model_content->filterEqual('type', 'changestatus')->getContentFields($ctype_name);
  22.  
  23. // Если нет подходящих полей
  24. if (!$fields) {
  25.  
  26. // возвращаемся
  27. return true;
  28.  
  29. }
  30.  
  31. // Перебираем поля
  32. foreach ($fields as $field) {
  33.  
  34. // Обновляем каждое поле
  35. $this->updField($ctype_name, $item_id, $field['name'], $reason);
  36.  
  37. }
  38.  
  39. return true;
  40.  
  41. }
  42.  
  43. public function sendEmail($ctype_name, $item, $body, $date){
  44.  
  45. // Модель пользователей
  46. $users_model = cmsCore::getModel('users');
  47.  
  48. // Автор записи
  49. $user = $users_model->getUser($item['user_id']);
  50.  
  51. $config = cmsConfig::getInstance();
  52.  
  53. // Тело письма из опций с заменой выражений в фигурных скобках на значения
  54. $body = str_replace([
  55. '{nickname}',
  56. '{title}',
  57. '{href}',
  58. '{date}',
  59. '{time}'
  60. ],[
  61. $user['nickname'],
  62. $item['title'],
  63. $config->host.href_to($ctype_name, $item['slug'].'.html'),
  64. date('d.m.Y', strtotime($date)),
  65. date('H:i', strtotime($date))
  66. ], $body);
  67.  
  68. // В конец тела письма добавляем такую вставку
  69. $body .= '<br>--<br>C уважением, '.$config->sitename.'<br><small>Письмо отправлено автоматически, пожалуйста, не отвечайте на него.</small>';
  70.  
  71. // Создаем объект cmsMailer
  72. $mailer = new cmsMailer();
  73.  
  74. // Кому - email автора
  75. $mailer->addTo($user['email']);
  76. // От кого - от сайта - email и имя отправителя
  77. $mailer->setFrom($config->mail_from, $config->mail_from_name);
  78. // Тема письма
  79. $mailer->setSubject('Подтвердите актуальность страницы "'.$item['title'].'"');
  80. // Тело письма
  81. $mailer->setBodyHTML($body);
  82. //Отправляем
  83. $mailer->send();
  84. // Очищаем
  85. $mailer->clearTo();
  86.  
  87. return true;
  88.  
  89. }

Ну и осталось совсем немного — добавить запись и обновление строк в таблице changestatus при нажатии на кнопки. У нас всего 2 кнопки — одна кнопка внутри модального окна с подтверждением, вторая для восстановления записи. Когда это сделаем, напишем еще одну кнопку, позволяющую подтвердить актуальность, пока запись еще актуальная, но это чуть позже.

Если мы делаем запись неактуальной, нам надо в таблице changestatus, если есть строка этой записи, удалить дату окончания и пометить, что запись неактуальная. Но сначала давайте сделаем кое-что еще — если у нас зачем-то добавлено несколько полей, то мы их все сделаем неакутальными, чтобы не было конфликтов. Работать будем в файле system/controllers/changestatus/actions/off_end.php. Заменим строку

  1. $this->model->updField($check['ctype']['name'], $item_id, $check['field']['name'], $reason);

на это:

  1. $this->model->updFields($check['ctype']['name'], $item_id, $reason);

Теперь добавим обновление строки в таблице changestatus. Сразу после этой строки пишем:

  1. // Получаем строку
  2. $item = $this->model->filterEqual('ctype_name', $check['ctype']['name'])->getItemByField('changestatus', 'item_id', $item_id);
  3.  
  4. // Если не нашли
  5. if (!$item) {
  6.  
  7. // То и не надо
  8. return $this->cms_template->renderJSON($result);
  9.  
  10. }
  11.  
  12. $data = [
  13. 'item' => ['user_id' => $check['item']['user_id']],
  14. 'ctype_name' => $check['ctype']['name']
  15. ];
  16.  
  17. $exclude = $this->model->authorGroups($data);
  18.  
  19. // Если тип контента не отслеживается или пользователь в исключенной группе
  20. if (!$this->options[$check['ctype']['name']] || $this->options[$check['ctype']['name'].'_days'] == 0 || $exclude) {
  21.  
  22. // Удаляем строку
  23. $this->model->delete('changestatus', $item['id']);
  24.  
  25. return $this->cms_template->renderJSON($result);
  26.  
  27. }
  28.  
  29. // Обновляем строку
  30. $this->model->updateItem($item['id'], null, 0, 0);

Давайте некоторые куски кода перенесем в модель. Например, вот этот:

  1. $c_item = $this->model_content->filterEqual('is_pub', 1)->filterEqual('is_approved', 1)->filterIsNull('is_deleted', 1)->getContentItem($item['ctype_name'], $item['item_id']);

Создадим для него отдельный метод в модели:

  1. public function cItem($ctype_name, $item_id) {
  2.  
  3. $model_content = cmsCore::getModel('content');
  4.  
  5. $item = $model_content->filterEqual('is_pub', 1)->filterEqual('is_approved', 1)->filterIsNull('is_deleted', 1)->getContentItem($ctype_name, $item_id);
  6.  
  7. return $item;
  8.  
  9. }

Теперь в файле cron_changestatus.php найдем 

  1. $c_item = $this->model_content->filterEqual('is_pub', 1)->filterEqual('is_approved', 1)->filterIsNull('is_deleted', 1)->getContentItem($item['ctype_name'], $item['item_id']);

и заменим на

  1. $c_item = $this->model->cItem($item['ctype_name'], $item['item_id'])

У нас повторяется вот это:

  1. $data = [
  2. 'item' => ['user_id' => $c_item['user_id']],
  3. 'ctype_name' => $item['ctype_name']
  4. ];
  5.  
  6. $exclude = $this->model->authorGroups($data);

В модели добавим метод:

  1. public function dataExclude($user_id, $ctype_name) {
  2.  
  3. $data = [
  4. 'item' => ['user_id' => $user_id],
  5. 'ctype_name' => $ctype_name
  6. ];
  7.  
  8. return $this->authorGroups($data);
  9.  
  10. }

В cron_changestatus.php заменим приведенный выше код на

  1. $exclude = $this->model->dataExclude($c_item['user_id'], $item['ctype_name']);

А в off_end.php похожий код

  1. $data = [
  2. 'item' => ['user_id' => $c_item['user_id']],
  3. 'ctype_name' => $check['ctype']['name']
  4. ];
  5.  
  6. $exclude = $this->model->authorGroups($data);

Заменим на 

  1. $exclude = $this->model->dataExclude($c_item['user_id'], $check['ctype']['name']);

Теперь будем работать в файле system/controllers/changestatus/actions/restore.php. Это восстановление. Нам нужно при восстановлении проверить, есть ли запись. Если есть, то обновить ее, а если нет, то создать. И это при условии, что для типа контента включено отслеживание и что автор не в исключенной группе.

Здесь точно так же найдем такую строку:

  1. $this->model->updField($check['ctype']['name'], $item_id, $check['field']['name'], 'actual');

и заменим на 

  1. $this->model->updFields($check['ctype']['name'], $item_id, 'actual');

Теперь сразу после нее пишем код:

  1. $item = $this->model->filterEqual('ctype_name', $check['ctype']['name'])->getItemByField('changestatus', 'item_id', $item_id);
  2.  
  3. $exclude = $this->model->dataExclude($check['item']['user_id'], $check['ctype']['name']);
  4.  
  5. $date_end = $this->model->dateEnd($this->options[$check['ctype']['name'].'_days']);
  6.  
  7. // Если для типа контента не включено отслеживание
  8. // или если период актуальности равен нулю
  9. // или если автор в исключенной группе
  10. if (!$this->options[$check['ctype']['name']] || $this->options[$check['ctype']['name'].'_days'] == 0 || $exclude) {
  11.  
  12. // Если есть строка
  13. if ($item) {
  14.  
  15. // то удалим
  16. $this->model->delete('changestatus', $item['id']);
  17.  
  18. }
  19.  
  20. // Вот и всё, закрыли вопрос
  21. return $this->cms_template->renderJSON($result);
  22.  
  23. }
  24.  
  25. // Если есть строка
  26. if ($item) {
  27.  
  28. // обновляем
  29. $this->model->updateItem($item['id'], $date_end, 0, 0);
  30.  
  31. // или
  32. } else {
  33.  
  34. // создаем
  35. $this->model->insertItem($check['ctype']['name'], $item_id, $date_end);
  36.  
  37. }

Вот как-то так. Ну и осталось добавить последнее — кнопку подтверждения актуальности, если запись еще актуальная. Во-первых, проверим, нужно ли подтверждать актуальность. Если тип контента не включен или автор в исключенной группе, то эта кнопка не нужна. Во-вторых, выведем эту кнопку только при приближении времени перевода в неактуальные. Думаю, половина срока актуальности будет нормально. А что будет делать кнопка? Ровно то же самое, что и кнопка восстановления.

Работать будем в файле system/fields/changestatus.php. Находим там этот код:

  1. if ($value == 'actual') {
  2.  
  3. if ($user->is_admin || $user->id == $this->item['user_id']) {
  4.  
  5. $off_text = $this->options['btn_off'] ? $this->options['btn_off'] : 'Больше неактуально?';
  6.  
  7. $btn_off = '<div class="changestatus_btn changestatus_off changestatus_btn_'.$cl.'" onclick="statusOff('.$data.')">'.$off_text.'</div>';
  8.  
  9. return $btn_off;
  10.  
  11. }
  12.  
  13. return '';
  14.  
  15. }

Во-первых, давайте его немного изменим:

  1. if ($value == 'actual') {
  2.  
  3. if (!$user->is_admin && $user->id != $this->item['user_id']) {
  4.  
  5. return '';
  6.  
  7. }
  8.  
  9. $off_text = $this->options['btn_off'] ? $this->options['btn_off'] : 'Больше неактуально?';
  10.  
  11. $btn_off = '<div class="changestatus_btn changestatus_off changestatus_btn_'.$cl.'" onclick="statusOff('.$data.')">'.$off_text.'</div>';
  12.  
  13. return $btn_off;
  14.  
  15. }

Теперь здесь же перед $off_text = ... добавим такой код:

  1. // Кнопки досрочного подтверждения нет
  2. $btn_confirm = '';
  3.  
  4. // Контроллер
  5. $controller = cmsCore::getController('changestatus');
  6.  
  7. // Модель
  8. $model = cmsCore::getModel('changestatus');
  9.  
  10. // Проверяем, нет ли автора в исключенных группах
  11. $exclude = $model->dataExclude($this->item['user_id'], $this->item['ctype']['name']);
  12.  
  13. // Если включено отслеживание типа контента
  14. if (!empty($controller->options[$this->item['ctype']['name']])) {
  15.  
  16. // Если период актуальности больше нуля
  17. // и автор не в исключенной группе
  18. if ($controller->options[$this->item['ctype']['name'].'_days'] > 0 && !$exclude) {
  19.  
  20. // Получаем запись в таблице changestatus
  21. $item = $model->filterEqual('ctype_name', $this->item['ctype']['name'])->getItemByField('changestatus', 'item_id', $this->item['id']);
  22.  
  23. // Текст кнопки
  24. $btn_confirm_text = $this->options['btn_confirm'] ? $this->options['btn_confirm'] : 'Подтвердить актуальность';
  25.  
  26. // Сама кнопка
  27. $btn_confirm = '<div class="changestatus_btn changestatus_confirm changestatus_btn_'.$cl.'" onclick="statusRestore('.$data.', \'confirm\')">'.$btn_confirm_text.'</div>';
  28.  
  29. // Если есть запись, но разница в днях между временем окончания и текущим временем
  30. // больше половины периода актуальности
  31. if ($item && (strtotime($item['date_end']) - date('U')) / 86400 > $controller->options[$this->item['ctype']['name'].'_days'] / 2) {
  32.  
  33. // то кнопка не нужна
  34. $btn_confirm = '';
  35.  
  36. }
  37.  
  38. }
  39.  
  40. }

Теперь давайте изменим немного весь метод parse(), а то получилось слишком много вложенных условий:

  1. public function parse($value){
  2.  
  3. if (empty($this->item['id'])) {
  4.  
  5. return '';
  6.  
  7. }
  8.  
  9. $user = cmsUser::getInstance();
  10.  
  11. $cl = $this->ctype_id.'_'.$this->item['id'].'_'.$this->field_id;
  12.  
  13. $data = $this->ctype_id.', '.$this->item['id'].', '.$this->field_id;
  14.  
  15. if ($value != 'actual' || $user->is_admin || $user->id == $this->item['user_id']) {
  16.  
  17. cmsTemplate::getInstance()->addCSS('templates/default/css/field-changestatus.css');
  18.  
  19. cmsTemplate::getInstance()->addJS('templates/default/js/field-changestatus.js');
  20.  
  21. }
  22.  
  23. if ($value != 'actual') {
  24.  
  25. $restore_btn = '';
  26.  
  27. if ($user->is_admin || $user->id == $this->item['user_id']) {
  28.  
  29. $restore_btn_text = $this->options['btn_restore'] ? $this->options['btn_restore'] : 'Восстановить';
  30.  
  31. $restore_btn = '<div class="changestatus_btn changestatus_restore changestatus_btn_'.$cl.'" onclick="statusRestore('.$data.')">'.$restore_btn_text.'</div>';
  32.  
  33. }
  34.  
  35. return '<div class="changestatus_off_text changestatus_off_text_'.$cl.'" title="'.$value.'">'.($this->options['not_actual'] ? $this->options['not_actual'] : 'Неактуально').'</div>'.$restore_btn;
  36.  
  37. }
  38.  
  39. if (!$user->is_admin && $user->id != $this->item['user_id']) {
  40.  
  41. return '';
  42.  
  43. }
  44.  
  45. $btn_confirm = '';
  46.  
  47. $controller = cmsCore::getController('changestatus');
  48.  
  49. $model = cmsCore::getModel('changestatus');
  50.  
  51. $exclude = $model->dataExclude($this->item['user_id'], $this->item['ctype']['name']);
  52.  
  53. if (!empty($controller->options[$this->item['ctype']['name']])) {
  54.  
  55. if ($controller->options[$this->item['ctype']['name'].'_days'] > 0 && !$exclude) {
  56.  
  57. $item = $model->filterEqual('ctype_name', $this->item['ctype']['name'])->getItemByField('changestatus', 'item_id', $this->item['id']);
  58.  
  59. $btn_confirm_text = $this->options['btn_confirm'] ? $this->options['btn_confirm'] : 'Подтвердить актуальность';
  60.  
  61. $btn_confirm = '<div class="changestatus_btn changestatus_confirm changestatus_btn_'.$cl.'" onclick="statusRestore('.$data.', \'confirm\')">'.$btn_confirm_text.'</div>';
  62.  
  63. if ($item && (strtotime($item['date_end']) - date('U')) / 86400 > $controller->options[$this->item['ctype']['name'].'_days'] / 2) {
  64.  
  65. $btn_confirm = '';
  66.  
  67. }
  68.  
  69. }
  70.  
  71. }
  72.  
  73. $off_text = $this->options['btn_off'] ? $this->options['btn_off'] : 'Больше неактуально?';
  74.  
  75. $btn_off = '<div class="changestatus_btn changestatus_off changestatus_btn_'.$cl.'" onclick="statusOff('.$data.')">'.$off_text.'</div>';
  76.  
  77. return $btn_off.$btn_confirm;
  78.  
  79. }

Еще у нас появилась новая опция — текст кнопки досрочного подтверждения актуальности. Добавим ее:

  1. new fieldString('btn_confirm', [
  2. 'title' => 'Текст кнопки подтверждения актуальности',
  3. 'default' => 'Подтвердить актуальность'
  4. ])

Ну и добавим немного стилей. Сделаем эту кнопку другого цвета:

  1. .changestatus_confirm{
  2. background:#ff9900;
  3. }
  4. .changestatus_confirm:hover{
  5. background:#ff5300;
  6. }

И немного подправим функцию statusRestore() в js-файле:

  1. /* Добавили еще один параметр, по-умолчанию пустой */
  2. function statusRestore(ctype_id, item_id, field_id, type = null) {
  3.  
  4. $.post('/changestatus/restore/' + ctype_id + '/' + item_id + '/' + field_id).done(function(response) {
  5.  
  6. result = $.parseJSON(response);
  7.  
  8. if (result.action === 'error') {
  9.  
  10. $('.changestatus_btn_' + ctype_id + '_' + item_id + '_' + field_id).removeAttr('onclick').addClass('error_btn').html(result.text);
  11.  
  12. } else {
  13.  
  14. $('.changestatus_off_text_' + ctype_id + '_' + item_id + '_' + field_id).remove();
  15.  
  16. /* Если тип confirm, то удаляем кнопку после выполнения */
  17. if (type === 'confirm') {
  18.  
  19. $('.changestatus_confirm.changestatus_btn_' + ctype_id + '_' + item_id + '_' + field_id).remove();
  20.  
  21. } else {
  22.  
  23. $('.changestatus_btn_' + ctype_id + '_' + item_id + '_' + field_id).removeClass('error_btn').attr('onclick', 'statusOff(' + ctype_id + ',' + item_id + ',' + field_id + ')').text(result.text);
  24.  
  25. }
  26.  
  27. }
  28.  
  29. });
  30.  
  31. }

Там же добавим еще одну строку в функцию statusOffContinue(). Находим строку

  1. $('.changestatus_btn_' + ctype_id + '_' + item_id + '_' + field_id).removeAttr('onclick').replaceWith(result.text);

И перед ней добавляем

  1. $('.changestatus_confirm.changestatus_btn_' + ctype_id + '_' + item_id + '_' + field_id).remove();

Вот вроде бы и всё.

Изображение

Осталось упаковать это всё дело в установщик. Так как это уже не поле, а компонент, то кроме файлов нам еще нужно при установке сделать запрос в БД, чтобы добавить нужные таблицы и строки.

Но сначала соберем в кучу файлы.

Создаем папку с именем changestatus, в ней создаем в ней папки и копируем в них файлы. Структура файлов и папок должна быть такая:

package
--system
----controllers
------changestatus
--------actions
----------off_end.php
----------off_start.php
----------restore.php
--------backend
----------forms
------------form_options.php
--------hooks
----------content_after_add_approve.php
----------content_after_update_approve.php
----------content_after_trash_put.php
----------content_after_restore.php
----------content_after_delete.php
----------cron_changestatus.php
--------backend.php
--------frontend.php
--------model.php
----fields
------changestatus.php
--templates
----default
------assets
--------fields
----------changestatus.tpl.php
------css
--------field-changestatus.css
------js
--------field-changestatus.js
manifest.ru.ini
install.php
install.sql

В файл install.php пишем:

  1. <?php function install_package() {
  2.  
  3. return true;
  4.  
  5. }

В install.sql пишем:

  1. INSERT INTO `cms_controllers` (`title`, `name`, `is_enabled`, `author`, `url`, `version`, `is_backend`)
  2. SELECT 'Смена статуса записей', 'changestatus', 1, 'Нифигассе о-го-гошеньки', 'https://nifigasse.ru', '', 1
  3. FROM DUAL
  4. WHERE NOT EXISTS(
  5. SELECT 1 FROM `cms_controllers` WHERE `name` = 'changestatus'
  6. )
  7. LIMIT 1;
  8.  
  9. UPDATE`cms_controllers` SET `version` = '1.0.0' WHERE `name`= 'changestatus';
  10.  
  11. INSERT INTO `cms_scheduler_tasks` (`title`, `controller`, `hook`, `period`, `date_last_run`, `is_active`, `is_new`)
  12. SELECT 'Смена статуса записей', 'changestatus', 'changestatus', 30, CURRENT_TIMESTAMP(), 1, 0
  13. FROM DUAL
  14. WHERE NOT EXISTS(
  15. SELECT 1 FROM `cms_scheduler_tasks` WHERE `controller` = 'changestatus' AND `hook` = 'changestatus'
  16. )
  17. LIMIT 1;
  18.  
  19. CREATE TABLE IF NOT EXISTS `cms_changestatus` (
  20. `id` INT(11) NOT NULL AUTO_INCREMENT,
  21. `ctype_name` VARCHAR(128) NOT NULL,
  22. `item_id` INT(11) NOT NULL,
  23. `date_end` TIMESTAMP NULL DEFAULT NULL,
  24. `is_notify` INT(1) NOT NULL DEFAULT 0,
  25. `is_actual` INT(1) NOT NULL DEFAULT 0,
  26. PRIMARY KEY (`id`)
  27. ) ENGINE=InnoDB DEFAULT CHARSET=utf8;

В файл manifest.ru.ini пишем:

  1. [info]
  2. title = "Смена статуса записей"
  3.  
  4. [version]
  5. major = "2"
  6. minor = "0"
  7. build = "0"
  8. date = "20220811"
  9.  
  10. [depends]
  11. core = "2.12.2"
  12.  
  13. [author]
  14. name = "Нифигиссе о-го-го-шеньки"
  15. url = "https://nifigasse.ru"
  16.  
  17. [description]
  18. text[] = "Компонент отслеживания актуальности записей типов контента."
  19. text[] = ""
  20. text[] = "Распространяется бесплатно. Поддержка не оказывается."

Теперь выделяем все файлы и папки и добавляем их в архив zip.

Готово.

Я не тестировал компонент, но по идее должно работать. Все ошибки или неточности можно исправлять прямо здесь в комментариях. Ну а кому лень это всё читать, можете просто скачать компонент в каталоге дополнений:

Ну и конечно буду рад любой конструктивной критике и замечаниям.

Спасибо за внимание))

+1
Vlad Vlad 1 год назад #

Спасибо! Реально, интересный и пошаговый мануал получился.
Читая такие блоги, можно потихоньку научится кодить.🧠


0
Happy Happy 1 год назад #

Спасибо 

+3
Loadырь Loadырь 1 год назад #

Я не тестировал компонент, но по идее должно работать.

Зачёт!!! 👍.

Прошлый раз удержался от комментария кода, в этот раз тоже промолчу. Скажу немного про MVC:

1. Модель. Файл модели используется для работы с базой данных — получение (запись, удаление, обновление и т.п.) данных и представление их в нужном виде. Логику по проверкам и прочие методы, не используемые в файле модели, лучше выносить в controller (файл frontend или backend). У вас это public function check($ctype_id, $item_id, $field_id, $reason_id = null) и public function dataExclude($user_id, $ctype_name).

Для работы с датами и временем в базе данных есть такие методы. Отсюда и ниже можно использовать их

2. Вид. Такие конструкции желательно выносить в файл шаблона

  1. $reasons_list = [];
  2.  
  3. if ($reasons) {
  4.  
  5. foreach ($reasons as $key => $reason) {
  6.  
  7. $reasons_list[] = '<option value="'.$key.'">'.$reason.'</option>';
  8.  
  9. }
  10.  
  11. }
  12.  
  13. $result_text = '<p class="changestatus_text">Материал будет помечен, как неактуальный. Вы уверены, что хотите продолжить?</p>';
  14.  
  15. $user = cmsUser::getInstance();
  16.  
  17. if ($reasons_list && !$user->is_admin) {
  18.  
  19. $list = '<select>'.implode($reasons_list).'</select>';
  20.  
  21. $result_text = '<p class="changestatus_text">Укажите, пожалуйста, причину, по которой материал больше неактуален.</p>'.$list;
  22.  
  23. }

Или хотя бы использовать стандартные функции шаблона github.com/instantsoft/icms2/blob/master/system/libs/template.helper.php#L333 Так ваши кнопки, селекторы и прочее сразу будут нужного цвета и размера для выбранного шаблона на сайте у пользователей данного компонента.

3. Контроллер. Для отправки писем «счастья» есть нормальные методы и им тоже не место в файле модели github.com/instantsoft/icms2/blob/master/system/controllers/comments/frontend.php#L204

0
&$!#% &$!#% 1 год назад #

удержался от комментария кода

А вот это зря))

Для работы с датами и временем в базе данных есть такие методы

Там нет нужного, поэтому пришлось делать так. Кстати, за основу я как раз-таки взял filterTimestampYounger() и немного изменил.

Да, согласен, я не знаю всех методов. Я это и не скрываю. Но ничего страшного в этом не вижу. Иногда использование системных методов вызывает ошибки на старых версиях движка, потому что тогда их еще не было. Честное слово, не все обновляются)) Но вот с опытом начинаю больше использовать системных всё-таки.

Ну а модель-контроллер — изучу подробнее этот вопрос, спасибо. И за весь коммент в целом тоже спасибо.

+1
Fuze Fuze 1 год назад #

Тоже удержался от комментирования, но Loadырь написал основное :) Писать слишком много, могу только голосом онлайн объяснить что-либо.

Добавлю лишь вот это, рекомендую погуглить с примерами в контексте php.

я не знаю всех методов

Так файлы открыть и посмотреть что мешает?)

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

99% методов filter* живут с первой версии  движка.

+1
IamB IamB 1 год назад #

Скажу немного про MVC:

Раз уж зашла об этом речь, то основная идея заключается в том, чтобы разделить задачи. И вынести однородные задачи в отдельный слой, а не валить все в кучу. Будет это MVC или что-то еще модное не суть важно.

Логику по проверкам и прочие методы, не используемые в файле модели, лучше выносить в controller 

Напишите это на каком-нибудь форуме PHP-программистов и вас обольют помоями, ибо это не свойственные контроллерам действия. Уже давненько и вполне обоснованно «толстые» контроллеры подвергаются обструкции, но не здесь.

+2
&$!#% &$!#% 1 год назад #

В общем, загуглил, почитал, что за зверь такой MVC. Ну и из того, что я увидел, делаю вывод, что у меня всё правильно в этом плане. Вкратце — в модели выполняются все процессы, включая проверки, запросы и т.д., контроллер — это только посредник между моделью и представлением. Но может в инстанте своя концепция? Спорить не буду.

Про фильтр. Нужного фильтра в системе НЕТ, поэтому пришлось писать свой, но опять же за основу взят системный.

Код можно было бы сделать легче и читабельнее, согласен. Хоть все и воздержались от комментирования кода, но я и сам это вижу.

На досуге перепишу немного.

+1
IamB IamB 1 год назад #

Но может в инстанте своя концепция? 

Да, здесь принято все писать в контроллер. А для того чтобы контроллеры были не такими большими по объему, можно экшены выносить в отдельные классы расширяя cmsAction. Но тут исторически так уже сложилось и споры на тему: как правильно, деструктивны. Но это не значит, что в своем компоненте вы не можете все сделать «правильно».

+1
Evg Evg 1 год назад #

В сети есть места, где «евангилисты» устраивают битвы по поводу своего понимания различных вещей: MVC, толщины контроллеров, моделей, количество слоёв в луковице и т.д. Есть те, кто категорично выступает против ООП, другие против ещё чего-то. Занятно читать такие вещи, где действительно есть фанаты, которые «прям уписывают» по разным вещам. Да, кстати, они все убедительны и все правы! Серьезно. 
ИМХО, достаточно смотреть на принятую, уже существующую манеру внутри продукта. Это и будет, опять же ИМХО, самым «правильным» подходом.

+2
Fuze Fuze 1 год назад #

ИМХО, достаточно смотреть на принятую, уже существующую манеру внутри продукта. Это и будет, опять же ИМХО, самым «правильным» подходом.

Именно. Опять же не забывая про базовые, не зависящие от языка, принципы программирования.

0
IamB IamB 1 год назад #

ИМХО, достаточно смотреть на принятую, уже существующую манеру внутри продукта. Это и будет, опять же ИМХО, самым «правильным» подходом.

Да это так, но это в случае, когда манера продукта соответствует вашему пониманию «как надо» или вам по барабану. И именно поэтому у меня есть сомнения, что программисты потянуться косяками, какой бы  мощной ни была раскрутка.

+1
&$!#% &$!#% 1 год назад #

Так я и не спорю. Всего-лишь хочу понять. Многое понял, многое ещё нет. Да и не претендую я, чтобы мои разработки оказались в коробке. Fuze не даст соврать, я сам попросил его исключить меня из группы «Разработчики». Ни на что не претендую и не спорю, просто вникаю. Ну а как правильно — когда-то Fuze на форуме сам и говорил, что если работает, значит правильно))

А ещё иногда, чтобы получить обратную связь, нужно написать какую-нибудь провокационную хрень. Ну не могу я онлайн голосом поговорить, нет возможности))

+2
Loadырь Loadырь 1 год назад #

Да, всё нормально. Сам часто пользуюсь этим мемасиком

Изображение

Можно писать всю логику и в модели. Просто здесь принято это делать немного иначе. 

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

Да, движок развивается и что-то новое появляется. Поэтому разработчики пишут, что дополнение будет работать начиная с некоторой версии. У меня самого есть компоненты, которые полноценно будут работать только в следующем релизе. Но использование стандартных методов поможет избежать ошибок в будущих версиях. Например может обновиться либа по работе с почтой или выйдет новая крутая либа и заменит старую совсем. Тогда ваш код по отправке писем перестанет работать. А при использовании штатных методов всё будет работать, так как при обновлении либы обновятся и методы работы с ней. От того и процесс обновления движка сайта со сторонними дополнениями будет не таким «ужасающим».

И конечно, если не нашли методы в движке, как в случае с фильтром, то придется писать свои, это факт. Но когда есть в движке и не используется, то тогда это выглядит примерно так

Изображение
+1
Fuze Fuze 1 год назад #

Ну и из того, что я увидел, делаю вывод, что у меня всё правильно в этом плане.

Методам типа «check» (реализации внутри) не место в модели. Модель не должна работать ни с cmsTemplate ни даже с cmsUser и cmsCore. Читаем про SOLID

И да, понятие модели в InstantCMS несколько иное docs.instantcms.ru/dev/models/overview

0
Vlad Vlad 1 год назад #

Добрый вечер. Спасибо за компонент.
В новом шаблоне туллтипы можно вызывать немного по другому.
Так в файле system/fields/changestatus.php можно добавить на 68 строчке
атрибуты data-toggle=«tooltip» data-placement=«top», тогда туллтипы будут системные. Сейчас они «ломают» другие туллтипы со страници.

  1. return '<div class="changestatus_off_text changestatus_off_text_' . $cl . '" title="' . $value . '" data-toggle="tooltip" data-placement="top">' . ($this->options[ 'not_actual' ] ? $this->options[ 'not_actual' ] : 'Неактуально') . '</div>' . $restore_btn;
  2.  

Немного подправить css (и js наверно… я в js не шарю😔)

+1
&$!#% &$!#% 1 год назад #

Посмотрите пост, где я рассказывал, как писал поле (пока ещё не компонент). Там в конце где-то я добавлял скрипт для тултипа. Если есть конфликт, то просто удалите этот кусок скрипта.

0
Def Def 1 год назад #

Странно, у меня почему-то не дает модальное окно с выбором варианта перевода записи в неактуальное. Компонент установлен, события обновлены.

0
Def Def 1 год назад #

Возможно ли еще сделать зависимость поля «Вывода в ТОП» с этим полем? Т.е если статус «неактивен», то и кнопку «Продвинуть» не показывать? Или показывать, но при клике сначала уведомлять о том, что необходимо сменить статус записи. 

Или в идеале вообще в этом поле дать возможность выбирать поля для скрытия, если статус данного поля «Неактивен». Позволит скрывать например поле с ценой или оплатой, чтобы не вводить посетителя в заблуждение. 

Вообще зависимости полей друг от друга в системе пока сильно не хватает.

0
Def Def 1 год назад #

в остальном с точки зрения функциональности все очень хорошо визуально.

0
Def Def 1 год назад #

Еще пробовал настроить зависимость полей через системный вариант заполненности поля, но почему-то поле UP JUMP основа показывается если значение поля «Статус изменен решением администрации сайта»

Изображение

0
&$!#% &$!#% 1 год назад #

Читайте внимательно: «Зависимость показа поля в форме».

+2
&$!#% &$!#% 1 год назад #

Нужно добавить одну опцию и два хука.

Изображение

Изображение

0
Def Def 1 год назад #

Круть-круть!)

0
&$!#% &$!#% 1 год назад #
0
Def Def 1 год назад #

очень круто! Спасибо, то что доктор прописал) Как вы на отдыхе это делаете)

+1
&$!#% &$!#% 1 год назад #

Я не совсем на отдыхе)) А на второй вечер мне стало копец как скучно, пришлось за ноутом домой съездить.

0
Def Def 1 год назад #

еще такой вопрос — а можно еще добавить настройку — показывать поля, если статус записи «не актуальная»?)

0
&$!#% &$!#% 1 год назад #

Можно, конечно. Добавляйте.

0
Def Def 1 год назад #

спасибо) я думаю что лучше в чужую разработку лишний раз не лазить, чтобы не поломать что-то) Я лучше донатом помогать буду:)

0
&$!#% &$!#% 1 год назад #

Жмете на кнопку и ничего происходит?

0
Def Def 1 год назад #

происходит, но без выбора варианта причины.

Изображение

0
&$!#% &$!#% 1 год назад #

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

0
Def Def 1 год назад #

а, сори, протупил

Def Def 1 год назад #
Комментарий удален

Еще от автора

Складчина на платные дополнения. Дубль 2
Понимаю, что я всем уже надоел со своими акциями/складчинами. Последняя попытка, простите.
Напишем поле для смены автора записи прямо из списка или из записи
Поле, с помощью которого админ сможет менять автора записи ТК прямо из списка записей или из самой записи.
Google Indexing, v. 1.1.1
Добавлен собственный API для автоматического добавления ссылок в очередь при публикации новых материалов на других ваших сайтах. И другое по мелочи.
Используя этот сайт, вы соглашаетесь с тем, что мы используем файлы cookie.