User Tools

Site Tools


dev:skeleton:draft
The most recent version of this page is a draft.DiffThis version (2013/05/22 05:16) is a draft.
Approvals: 0/1

This is an old revision of the document!


Создать dev crash course (DCC), который будет содержаться в себе вводные инструкции по работе с кодом Oxwall, сопровождаемые последовательно расставлеными (закоменченными) примерами в плагине-скелетоне. Которые юзер может раскомменчивать по ходу чтения DCC.

Выглядеть это будет так:

Add menu item

чтобы добавить новую странице в главное меню, расскоменьте:

File: /ow_plugins/skeleton/routing.php Line: 83

Some PHP here

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

Skeleton

Это должен быть самодостаточнй плагин, который устанавлиается/активируется/деактивируется и работает на сайте без дополнительных телодвижений. Он должен содержать весб набор дефолтных папок и файлов для работы плагина в Oxwall

Сценарий

File structure

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

Debug/Dev tools

Указать инструменты в софте для debug и dev.

Расписать каждую константу:

  1. где активируется
  2. зачем нужно, на что влияет
plugin.xml
  1. указать в кратце зачем он нужен
  2. указать путь, по которому он находится
  3. описать каждый параметр в этом файле: зачем он нужен и какие возможные значения может принимать
Routing
  1. добавить в меню новый айтем text(“Skeleton”)
  2. добавить новый маршрут “/skeleton”
  3. задать meta данные страницы (title: text(“Skeleton Page”), meta description: text(“skeleton description”), header: text(“Skeleton Header”) ).
Localization
  1. добавить новый ключ в админке (key: hello-world, text: Hello world), с префиксом skeleton (создается автоматом, при установке) <link-to-user-manual|Ask-Den>. Оставить ссылку на секцию с описанием Pre Installation/Activation.
  2. вызвать текстовый ключ hello-world в PHP коде на странице /skeleton и присвоить значение переменной.
  3. вызвать текстовый ключ hello-world в шаблоне компонента
Forms
  1. создать форму, на странице /skeleton с полями:
	- name: text("Text") / type: text-input / description: text("additional field's description")
- name: text("Extended text") / type: textarea 
- name: text("Single Choice(dropdown)") / type: selectbox / values: invitation=text("Select any"), val1=text("Red"), val2=text("Blue") 
- name: text("Multiple Choice") / type: multicheckbox / values: val1=New York, val2=Boston, val3=Chicago
- name: text("Upload files") / type: file
- name: text("Hidden") / type: hidden
- name: text("Submit ME") / type: submit

* для каждого элемента добавить PHP/JS проверки валидации
** указать ссылку на form_element.php и validator.php и сказать что там лежит полный список возможных типов и их валидаторов
	
- указать все возможные опции у формы 
- дать инструкции, как вывести на той же странице введенные данные в табличном виде. Для файла вывести только название подгруженного файла
Using database
  1. как выполнить несколько самых частоиспользуемых типов запросов
  2. DBO и DTO на примере полей из пункта Forms. Для файлов записать в таблицу только имя файла
File storage
Decorators
Mail sending
Activity Notifications
Newsfeed
Widgets
Javascript
Ajax
Profile questions
ACL
Admin Settings
Pre Installation/Activation
Post Uninstallation/Deactivate
dev/skeleton/draft.1369199799.txt.gz · Last modified: 2015/09/15 09:10 (external edit)