Мы переписали большую часть документации для разработчиков. Это связано с серьезными изменениями, которые произошли в 2.6 и недостатками предыдущей документации. В данный момент документация доступна по адресу api.umi-cms.ru и находится в состоянии беты. Надеемся, что будут поступать предложения по ее улучшению. После появления итоговой версии мы сделаем скачиваемые pdf и chm версии.
Комментирование доступно только авторизованным пользователям.
Пожалуйста, зарегистрируйтесь или войдите на сайт.
будем наблюдать за развитием
Примечание: Классы и методы, которые не могут помочь стороннему разработчику, намеренно вынесены из документации."
Так вот остается непонятным почему некоторые я бы сказал жизненно необходимые функции намеренно вынесены из документации?
вот например функция generateNumPage() нигде собственно не встретишь ее описания.. но в тоже время она прямтаки жизненно необходима для админки. Я так понимаю что это функция корневого класса def_module... а может и еще выше.. но дело то не в этом, ведь есть некоторые функции ядра, которые приходится вычислять эксперементально.. это большой недочет в API
Примечание: Классы и методы, которые не могут помочь стороннему разработчику, намеренно вынесены из документации."
Так вот собственно уж както много "намеренного" вырезано вот например метод generateNumPage, я так понимаю что он принадлежит классу def_module... если подумать то это тоже жизненно важный метод.. опасности для разработчика он не представляет, т.к. коммерческой тайны все равно не раскрет, однако же его не найти в документации... узнать о его существовании можно только эксперементальным путем..
или еще пример prepareTemplatesSelectBox() без этой функции тоже как то тяжко.
Предлагаю открыть занавес тайны с некоторых функция самого ядра
ps. в версиях 2.6 уже можно без prepareTemplatesSelectBox()
А какие примеры наиболее полезно показать?
можно по каждой функции несколько примеров дать
В общем случае - когда применение или возвращаемый методом результат неочевиден.
Например, umiSelection - есть методы set и add для фильтров. Когда какой применять? Вот показать как получить массив объектов каталога со значением некоего поля в каких-то пределах.
Или читаю я из страницы значение поля справочника. Что я получу? Это можно даже и без кода, но хотя бы сказать что это Id объекта справочника, а не его название. Мелочь, конечно, которую нетрудно и самостоятельно раскопать, но из таких мелочей складывается ощущение удобства и впечатление о разработчике)
В итоге, такие опреации напрашиваются:
- как выбрать группу страниц по определенным параметрам;
- как прочитать значения полей;
- как записать значения в поле;
- как создать страницу/объект;