modx-pro / docs Goto Github PK

Компонент позволяет создавать Яндекс Карту и размещать на ней список объектов (1 объект = 1 ресурс). Можно вывести одиночный объект на карте по id ресурса.

Для добавления карты к ресурсу нужно всего лишь создать TV с типом "YandexMaps" (появится после установки компонента).

Чтобы указать местоположение объекта нужно просто кликнуть на том месте на карте в "дополнительных полях" ресурса.

Так выглядит TV поле в админке

Так выглядит карта со множеством объектов во фронтенде

Параметры сниппета YandexMaps

Инструкция

1. Установите компонент.
2. Добавьте TV поле (например: "coords"), у которого на вкладке "Параметры ввода" укажите тип: "yandexMaps":
   
3. Укажите это поле для шаблонов, которые будут присвоены ресурсам-объектам на карте.
4. Добавьте ресурс, у которого укажите шаблон, о котором говорилось выше. На вкладке "Дополнительные поля" кликните на том месте карты, на котором находится нужный объект. При необходимости воспользуйтесь поиском места на карте.
5. Примерное дерево, для которого указан вызов сниппета в примерах 4 и 5 (внизу):
   

Примеры

Пример 1 (вывод одиночного объекта используя свою иконку)

[[!yandexMaps?
    &id=`[[*id]]`
    &tvCoords=`coords`
    &markerIcon=`/images/cafe_marker_icon.png`
    &fieldForBalloonContent=`description`
    &fieldForHint=`pagetitle`
    &showMoreLink=`true`
]]

Пример 2 (вывод одиночного объекта используя preset - "DotIcon")

[[!yandexMaps?
    &id=`[[*id]]`
    &tvCoords=`coords`
    &markerPreset=`islands#violetDotIcon`
    &fieldForBalloonContent=`introtext`
    &fieldForHint=`menutitle`
]]

Пример 3 (вывод одиночного объекта используя preset - "StretchyIcon", и текст в нём)

[[!yandexMaps?
    &id=`[[*id]]`
    &tvCoords=`coords`
    &markerPreset=`islands#yellowStretchyIcon`
    &markerPresetText=`Плавательный бассейн`
    &fieldForBalloonContent=`description`
    &fieldForHint=`pagetitle`
    &showMoreLink=`true`
]]

Пример 4 (вывод множества объектов используя параметр "objectsTypesJSON")

[[!yandexMaps?
    &tvCoords=`coords`
    &fieldForBalloonContent=`description`
    &fieldForHint=`pagetitle`
    &objectsTypesJSON=`[
        {
            "InvestProjects": {
                "parent":"5",
                "preset":"islands#violetStretchyIcon",
                "presetText":"Реализованный",
                "title":"Инвестиционные проекты"
            },
            "InvestPlaygrounds": {
                "parent":"6",
                "icon":"/images/playgrounds_map_icon.png",
                "title":"Инвестиционные площадки"
            }
        }
    ]`
]]

Пример 5 (вывод множества объектов с субфильтрами из TV, используя параметр "objectsTypesJSON")

[[!yandexMaps?
    &tvCoords=`coords`
    &fieldForBalloonContent=`description`
    &fieldForHint=`pagetitle`
    &objectsTypesJSON=`[
        {
            "InvestProjects": {
                "parent":"5",
                "icon":"/images/projects_map_icon.png",
                "title":"Инвестиционные проекты",
                "subFilters": {
                    "status": {
                        "title":"Статус проекта",
                        "options": {
                            "0":{ "value":"Реализуемый==1", "icon":"/images/projects_map_icon1.png" },
                            "1":{ "value":"Реализованный==2", "preset":"islands#violetStretchyIcon", "presetText":"Реализованный" },
                            "2":{ "value":"Подписано соглашение==3", "preset":"islands#blueStretchyIcon", "presetFieldText":"pagetitle" }
                        }
                    },
                    "branch": {
                        "title":"Отрасль",
                        "options": {
                            "0":{ "value":"Фармацевтика и биотехнологии==1" },
                            "1":{ "value":"Автомобили и автокомпоненты==2" },
                            "2":{ "value":"Транспортно-логистические==3" },
                            "3":{ "value":"Другие направления==4" }
                        }
                    }
                }
            },
            "InvestPlaygrounds": {
                "parent":"6",
                "icon":"/images/playgrounds_map_icon.png",
                "title":"Инвестиционные площадки",
                "subFilters": {
                    "types": {
                        "title":"",
                        "options": {
                            "0":{ "value":"Особые экономические зоны==1", "icon":"/images/playgrounds_map_icon1.png" },
                            "1":{ "value":"Индустриальные парки==2", "icon":"/images/playgrounds_map_icon2.png" }
                        }
                    }
                }
            }
        }
    ]`
]]

Maybe it's a good idea to add a note to the docs that dots (.) in a TV name will make the filters in mFilter2 stop working. Took me hours to figure out why my filters didn't work ;)

Does not work:
&filters=tv|car.color

Выписал все общие параметры из pdoTools (ядро + pdoFetch): https://gist.github.com/argnist/e39edc5721c3686a64d1
Хочу оформить их отдельно. Поэтому возникли следующие вопросы:

1. Как я понял часть из параметров остались для совместимости с getResources? Правильно ли я их указал и не стоит ли их вынести в сниппет pdoResources, чтобы не засорять код ядра? (Хотя по мне так legacy-код стоит удалять в каждой стабильной версии, чтобы меньше тормозило. Если меняешь сниппет - будь готов изучить его параметры).

2. Может быть в папках создавать какой-то специальной файл типа INDEX.md, который бы открывался в docs.modx.pro, когда нажимаешь на папку? Например, эти параметры можно было бы показывать сразу по нажатию на pdoTools или pdoTools/Сниппеты.

3. Как проводить обсуждение документации (коим примером является это сообщение)? Issue не особо кажется удобным.

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

5. Еще непонятные параметры:
   'tvsJoin' => array(),
   'tvsSelect' => array(),
   зачем они и почему тип массив, и что будет, если указать их в сниппете (и что указать можно)?

Компонент позволяет создавать Яндекс Карту и размещать на ней список объектов (1 объект = 1 ресурс). Можно вывести одиночный объект на карте по id ресурса.

Для добавления карты к ресурсу нужно всего лишь создать TV с типом "YandexMaps" (появится после установки компонента).

Чтобы указать местоположение объекта нужно просто кликнуть на том месте на карте в "дополнительных полях" ресурса.

Так выглядит TV поле в админке

Так выглядит карта со множеством объектов во фронтенде

Параметры сниппета YandexMaps

Инструкция

1. Установите компонент.
2. Добавьте TV поле (например: "coords"), у которого на вкладке "Параметры ввода" укажите тип: "yandexMaps":
   
3. Укажите это поле для шаблонов, которые будут присвоены ресурсам-объектам на карте.
4. Добавьте ресурс, у которого укажите шаблон, о котором говорилось выше. На вкладке "Дополнительные поля" кликните на том месте карты, на котором находится нужный объект. При необходимости воспользуйтесь поиском места на карте.
5. Примерное дерево, для которого указан вызов сниппета в примерах 4 и 5 (внизу):
   

Примеры

Пример 1 (вывод одиночного объекта используя свою иконку)

[[!yandexMaps?
    &id=`[[*id]]`
    &tvCoords=`coords`
    &markerIcon=`/images/cafe_marker_icon.png`
    &fieldForBalloonContent=`description`
    &fieldForHint=`pagetitle`
    &showMoreLink=`true`
]]

Пример 2 (вывод одиночного объекта используя preset - "DotIcon")

[[!yandexMaps?
    &id=`[[*id]]`
    &tvCoords=`coords`
    &markerPreset=`islands#violetDotIcon`
    &fieldForBalloonContent=`introtext`
    &fieldForHint=`menutitle`
]]

Пример 3 (вывод одиночного объекта используя preset - "StretchyIcon", и текст в нём)

[[!yandexMaps?
    &id=`[[*id]]`
    &tvCoords=`coords`
    &markerPreset=`islands#yellowStretchyIcon`
    &markerPresetText=`Плавательный бассейн`
    &fieldForBalloonContent=`description`
    &fieldForHint=`pagetitle`
    &showMoreLink=`true`
]]

Пример 4 (вывод множества объектов используя параметр "objectsTypesJSON")

[[!yandexMaps?
    &tvCoords=`coords`
    &fieldForBalloonContent=`description`
    &fieldForHint=`pagetitle`
    &objectsTypesJSON=`[
        {
            "InvestProjects": {
                "parent":"5",
                "preset":"islands#violetStretchyIcon",
                "presetText":"Реализованный",
                "title":"Инвестиционные проекты"
            },
            "InvestPlaygrounds": {
                "parent":"6",
                "icon":"/images/playgrounds_map_icon.png",
                "title":"Инвестиционные площадки"
            }
        }
    ]`
]]

Пример 5 (вывод множества объектов с субфильтрами из TV, используя параметр "objectsTypesJSON")

[[!yandexMaps?
    &tvCoords=`coords`
    &fieldForBalloonContent=`description`
    &fieldForHint=`pagetitle`
    &objectsTypesJSON=`[
        {
            "InvestProjects": {
                "parent":"5",
                "icon":"/images/projects_map_icon.png",
                "title":"Инвестиционные проекты",
                "subFilters": {
                    "status": {
                        "title":"Статус проекта",
                        "options": {
                            "0":{ "value":"Реализуемый==1", "icon":"/images/projects_map_icon1.png" },
                            "1":{ "value":"Реализованный==2", "preset":"islands#violetStretchyIcon", "presetText":"Реализованный" },
                            "2":{ "value":"Подписано соглашение==3", "preset":"islands#blueStretchyIcon", "presetFieldText":"pagetitle" }
                        }
                    },
                    "branch": {
                        "title":"Отрасль",
                        "options": {
                            "0":{ "value":"Фармацевтика и биотехнологии==1" },
                            "1":{ "value":"Автомобили и автокомпоненты==2" },
                            "2":{ "value":"Транспортно-логистические==3" },
                            "3":{ "value":"Другие направления==4" }
                        }
                    }
                }
            },
            "InvestPlaygrounds": {
                "parent":"6",
                "icon":"/images/playgrounds_map_icon.png",
                "title":"Инвестиционные площадки",
                "subFilters": {
                    "types": {
                        "title":"",
                        "options": {
                            "0":{ "value":"Особые экономические зоны==1", "icon":"/images/playgrounds_map_icon1.png" },
                            "1":{ "value":"Индустриальные парки==2", "icon":"/images/playgrounds_map_icon2.png" }
                        }
                    }
                }
            }
        }
    ]`
]]

Hi, I am using pdoTools pdoUser to return users from MODx using the code below:

[[!pdoUsers?
&groups=Partners
&xtpl=partnerTpl
&sortby=id
&sortdir=asc
&limit=3
&where={"modUserProfile.extended:LIKE":"%\"customField1\":\"Value\"%"}
&showLog=1
]]

This works well, My questions is... Is it possible to pass more than one customvalue to the Where element of the code? e.g. to search more than one of the custom fields for the searched value. e.g.

&where={"modUserProfile.extended:LIKE":"%\"customField1,customField2\":\"Value\"%"}

Please advise on how to achieve this...

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

Записал, чтобы не потерялось.

У меня при переходе на страницу http://docs.modx.pro/components/pdotools/snippets/pdopage выводится страница "О проекте", а по адресу http://docs.modx.pro/components/pdotools/snippets/pdousers выводится страница "Pdopage" - это так и задумано?

Простой конвертер арабских цифр в римские

Использование:

[[+my_digit:romanDigit]]
[[romanDigit? &input=23]]

Запрос новой документации

ru/01_Компоненты/15_Tickets/01_Интерфейс/04_Управление_комментариями.md

&tplCondition - Поле ресурса, из которого будет получено значение для выбора чанка по условию в &conditionalTpls. Это может быть любое поле , такое как template , pagetitle и т.п , чтобы указать ТВ нужно писать его с префиксом , типа : &tplCondition=tv.my_tvname

https://github.com/argnist/Docs/tree/master/ru/02_%D0%A1%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%B0/02_xPDO

Набросал структуру раздела. Планирую там смесь перевода официальной документации с напором на более развернутые примеры и использование в modx. Т.е. везде будет $modx (чтобы новички не путались с этими $xpdo), кроме своей модели работа с моделью modResource и т.п. Может быть даже куски из исходного кода ядра и дополнений, а не сферический класс Box в вакууме.
Но возможности конкретно класса modx, скорее всего, оставлю для другого раздела.

Есть какие-нибудь предложения по структуре, или может я чего забыл?

Назначение и принцип работы компонента

Компонент предназначен для ведения учёта остатка товара по его одному свойству, указанному в настройках компонента.

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

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

Настройки компонента

Для редактирования настроек компонента перейдите в раздел "Настройки системы" и выберите фильтр "msproductremains"

Для данного компонента доступны следующие настройки:

• включить / выключить учёт остатков товаров.
• назначить файл c Javascript для изменения количества оставшихся товаров на фронте сайта.
• назначить число оставшихся товаров, используемое для форматирования вывода количества оставшихся товаров.
• назначить свойство товара, на основании которого будут формироваться остатки.
• назначить статус заказа, при установке которого происходит учёт оставшихся товаров.
• выбрать выводить число в качестве остатка или текст.

Вкладка учёта остатков товара

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

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

Вывод количества оставшихся товаров

Для вывода количества оставшихся товаров на сайте в любое место сайта необходимо добавить тег с классом remains_change.

Пример вывода с включённым параметром "Возвращать число"

<div class="remains">Товара в наличии: <span class="remains_change"></span> шт.</div>

После загрузки страницы автоматически в тег <span class="remains_change"> будет добавлено количество оставшихся товаров для выбранного свойства или для значения по умолчанию.

Пример вывода с выключенным параметром "Возвращать число"

<div class="remains_change">[[%msproductremains_text_more]]</div>

После загрузки страницы автоматически текст внутри тега <div class="remains_change"> будет изменён на текст, соответствующий условию выборки и количеству оставшихся товаров.

Wonderful plugin, it's the best! I think I found a bug in pdoPage

Does not show Template Variables
&element=pdoResources
&includeTVs=newsDate
&processTVs=newsDate

Work around
&element=getResources
&includeTVs=newsDate
&processTVs=newsDate

Any way to fix the pdoPage to show custom template variables?

Расширение реализует основу для постинга в соцсети. В основной набор входит только Twitter.

Как настроить mSocial?

• Устанавливаем расширение.
• Регистрируемся в Twitter, авторизовываемся.
• Регистрируем приложение здесь.
• Жмем кнопочку Create New App и заполняем простую форму.
• После создания приложения переходим на вкладку Keys and Access Tokens и жмем кнопку Create my access token. Важно:в поле Access Level должно стоять значение Read and write. Копируем поля: Consumer Key, Consumer Secret, Access Token, Access Token Secret.

• Теперь открываем наш сайт. Переходим в Системные настройки / mSocial.

• Открываем чанк tpl.msocial.tw или тот который используется для постинга, вносим нужные параметры для постинга. Пример: [[+pagetitle]] - [[+content]]
• Теперь осталось только включить tv-параметр twPost для тех шаблонов, документы которых должны участвовать в постинге. Постинг происходит при сохранении ресурса, в том случае если tv-параметр twPost переключен на Да.

Системные настройки

Содержимое компонента

• Плагины
  mSocial - производит постинг в соцсети.
• TVs
  twPost - tv для отслеживания постинга в Twitter.
• Чанки
  tpl.msocial.tw - шаблон для постинга в Twitter.
  Список поддерживаемых полей: id, type, contentType, pagetitle, longtitle, description, alias, link_attributes, published, pub_date, unpub_date, parent, isfolder, introtext, content, richtext, template, menutitle, publishedby, publishedon, menuindex, hidemenu, class_key, context_key, content_type.
  TV поля не поддерживаются, пока :)

Информация о прикрепляемых изображениях для Twitter.

Для того что бы изображения корректно загружались нужно что бы они присутствовали в теле сообщения, в виде <img src="путь до изображения"/>. Например можно вставлять изображения в тело поля content с помощью редактора TinyMCE. Путь к изображению должен быть следующего вида files/mSocial.jpg.

Twitter поддерживаются следующие форматы: PNG, JPEG, WEBP и GIF.
С требованиями к изображениям можно ознакомиться здесь: https://dev.twitter.com/rest/public/uploading-media.

Затронутые страницы

https://docs.modx.pro/komponentyi/minishop2

Что нужно улучшить?

Не хватает описания и перечня функций (возможностей) minishop2 из коробки.

Здравствуйте!
Спасибо вам за вашу работу!

На данный момент не работает плагин HybridAuth в связке с Вконтакте.
Для начала как минимум плагин генерирует неправильный редирект урл, у вконтакте (как минимум на данный момент) нельзя задать урл с ? в поле "доверенный redirect url". В результате вконтакте выдает сообщение о неправильном редирект урле и не работает.

Я попробовал решить эту проблему, прописал урл /havkontakte, на своей стороне настроил редирект в .htaccess и заменил в файле /core/components/hybridauth/model/hybridauth/lib/Provider_Adapter.php строку 162

$this->params["login_done"] = $HYBRID_AUTH_URL_BASE . ( strpos($HYBRID_AUTH_URL_BASE, '?') ? '&' : '?' ) . "hauth_done={$this->id}";

на

if($this->id === 'Vkontakte')
	       	$this->params["login_done"] = $HYBRID_AUTH_URL_BASE . 'havkontakte';
        else
	    	$this->params["login_done"]  = $HYBRID_AUTH_URL_BASE . ( strpos( $HYBRID_AUTH_URL_BASE, '?' ) ? '&' : '?' ) . "hauth.done={$this->id}";

Вконтакте перестал ругаться, но теперь после возвращения на сайт я вижу опять блок login.
То есть сама аутентификация не происходит.

Как минимум надо исправить генерацию урла для вк и перепроверить работоспособность плагина в целом.
Было бы круто выложить где-то работающий пример.

Привет!
Классный проект!
Наконец-то документация по и по Васиным работам будет находиться в одном месте.
Вась, огромная просьба, добавь пожалуйста к описанию твоих продуктов список используемых плейсхолдеров. Постоянно приходится лазить где-то искать. Например, для освежения памяти по pdoResources приходится лезть в описание getResources. Жутко не удобно :(

Спасибо за ответственный и комплексный подход к работе!

Я думаю его стоит создать и добавить в игнор при импорте. Мнения?

Затронутые страницы

https://docs.modx.pro/komponentyi/pdotools/klassyi/pdofetch#%D0%9C%D0%B5%D1%82%D0%BE%D0%B4-addJoins

После заголовка Как нужно указывать параметры для присоединения в pdoFetch? есть код:

$pdo->setConfig(array(
    'class' => 'modUser',
    'leftJoin' => array(
        'Profile' => array(
            'class' => 'modUserProfile',
            'on' => 'modUser.id = Profile.internalKey',
        ),
    'select' => array(
        'modUser' => '*',
        'Profile' => 'fullname,email',
    )
));

В коде ошибка, не закрыта скобка после leftJoin и перед select, должно быть так:

$pdo->setConfig(array(
    'class' => 'modUser',
    'leftJoin' => array(
        'Profile' => array(
            'class' => 'modUserProfile',
            'on' => 'modUser.id = Profile.internalKey',
        )
    ),
    'select' => array(
        'modUser' => '*',
        'Profile' => 'fullname,email',
    )
));

Раздел TicketComments

Под заголовком стоит ссылка Скачать TicketComments в магазине дополнений →, которая перекидывает в магазин Simple Dream на компонент msOptionsPrice.
Первое предложение:

Выводит комментарии и форму для ко мментирования ресурса.

Ошибка в слове "ко мментирования".

РазделTicketLatest

Описание

Сниппет обрабатывает только документы с Не знаю как сформулировать. Кто нибудь поправте как надо

Как-то не кошерно.

Надо написать workflow:telegram который бы отправлял оповещения о новых обновлениях в главный чат

Страницы в документации не соответствуют страницам на гите.

После строки "Класс gsProduct генерирует следующие события:" пусто, а должен быть текст.

https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker
https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell