1. Render API
Render API
Виктория Султановская
victoria.sultanovskaya@volcanoideas.com

2. Render API
Render API
Что такое Render API
Концепция Render Arrays
Преимущества подхода
Ключевые свойства
Работа функций render(), drupal_render()
и drupal_render_children()
Рендеринг страницы
Render API и темизация
2

3. Render API
Что такое Render API
3

4. Render API
Что такое Render API
4

5. Render API
Что такое Render API
/**
* Drupal 6 page callback
* @return string
*/
function mymodule_drupal6_page() {
$items = mymodule_get_items();
$output = theme('mymodule_items', $items);
$output .= theme('pager');
return $output;
}
5

6. Render API
Что такое Render API
/**
* Drupal 7 page callback
* @return array
*/
function mymodule_drupal7_page() {
$items = mymodule_get_items();
...
$output[] = array(
'#theme' => 'mymodule_items', '#items' => $items
);
$output[] = array(
'#theme' => 'pager'
);
...
return $output;
}
6

7. Render API
Концепция Render Arrays
Рендер массив
Рендеринг
7

8. Render API
Концепция Render Arrays
Страница в Drupal 7
8

9. Render API
Преимущества подхода
- Модули могут внести свои
изменения в отдаваемый
контент.
- Единая система
формирования контента
9

10. Render API
Ключевые свойства
#type
hook_element_info()
(link, radio,
checkbox)
#theme
имя вызываемой
функции темизации
Функция должна отрендерить
все дочерние элементы
10

11. Render API
Ключевые свойства
#theme_wrappers
Обрабатывается после #theme
Это позволяет дополнительно обернуть дочерние
элементы нужными нам тегами
<form>
<input type=”checkbox”/>
<input type=”text”/>
</form>
11

12. Ключевые свойства
#theme_wrappers
<form>
<div class=”extra-container”>
<input type=”checkbox”/>
<input type=”text”/>
</div>
</form>
12
Render API

13. Render API
Ключевые свойства
#attached
js
css
libraries
function
13

14. Render API
Ключевые свойства
//attach internal resources
$build['#attached']
'js'
'css'
=>
=>
'library'
=
array(
$module_path
$module_path
=>
.
'/block.js',
.
'/block.css',
array(
array('system',
'drupal.ajax')
)
);
14

15. Render API
Ключевые свойства
//attach external resources
$build['#attached']['js'][] = array(
'http://code.jquery.com/jquery.min.js'
=>
array('type ' => 'external')
);
15

16. Render API
Ключевые свойства
//attach function
$build['#attached']['drupal_add_http_header']
= array(
array('Content-Type',
charset = utf-8')
'application/rss-xml;
);
16

17. Render API
Ключевые свойства
#attached
drupal_add_js()
drupal_add_css()
17

18. Render API
Ключевые свойства
#cache: настройки кэширования
элемента
Возможность кэширования отдельных частей
страницы
Свойства:
keys / cid – ключ кэша
granularity – кэш по роли, юзеру, странице
expire – время жизни
bin – хранилище (таблица cache по умолчанию)
18

19. Render API
Ключевые свойства
#states – условия изменения состояния
состояния - enabled/disabled,
visible/invisible, …
условия - empty/filled, checked, value …
19

20. Render API
Ключевые свойства
#states
20

21. Ключевые свойства
#states
21
Render API

22. Render API
Ключевые свойства
banner_display_type
show_banner_image
show_banner_html
22

23. Render API
Ключевые свойства
/**
* Implement hook_form
*/
$form['banner_html']['#states'] = array(
'visible' => array(
':input[name="banner_display_type"]' =>
array('value' => 'show_banner_html')
)
);
23

24. Ключевые свойства
/**
* Implement hook_form
*/
$form['banner_image']['#states'] = array(
//banner_image - fieldset
'visible' => array(
':input[name="banner_display_type"]' =>
array('value' => 'show_banner_image')
)
);
);
24
Render API

25. Render API
Ключевые свойства
#pre_render/#post_render
преобработка/постобработка (содержат массив
функций, которые будут вызваны перед/после
рендеринга массива)
#prefix/#suffix
#printed
#access
25

26. Render API
drupal_render()
render()
drupal_render_children()
26

27. Render API
Этапы работы drupal_render()
- #access и #pinted
- загрузка свойств поумолчанию (если указан #type)
- #pre_render
- #theme
- #theme_wrappers
27

28. Render API
Этапы работы drupal_render()
- #post_render
- #states
- #attached
- #cache
- Возвращает
#prefix.$output.#suffix
28

29. Render API
Рендеринг страницы
- Все элементы страницы собраны в
рендер массиве
- Можно изменить страницу с помощью
двух хуков hook_page_build() - дает
возможность добавить элементы на
страницу
- hook_page_alter() - дает возможность
изменить уже существующие элементы
29

30. Render API и темизация
- Для обработки рендер-массивов
в шаблоне нужно использовать
drupal_render()/render().
- hide()/show() - управляют
видимостью элемента в рендермассиве.
30
Render API

31. Render API
Render API и темизация
<!-- node.tpl.php -->
<div class="content"<?php print $content_attributes;?>>
<?php
// We hide the comments and links now so that we can render them
later.
hide($content['comments']);
hide($content['links']);
print render($content);
?>
</div>
<?php print render($content['links']); ?>
<?php print render($content['comments']); ?>
31

32. Render API
Render API и темизация
- В Drupal 7 есть два вида
передачи данных в функцию
темизации
properties-as-variable
element-as-variable
32

33. Render API
Render API и темизация
function mymodule_theme() {
return array(
//properties-as-variable
'mymodule_items' => array(
'variables' => array(
'items' => array(),
'title' => ''
)
)
);
}
33

34. Render API
Render API и темизация
properties-as-variable
function theme_mymodule_items($vars)
{
$items = $vars['items'];
$title =
$vars['title'];
}
34

35. Render API
Render API и темизация
function mymodule_theme() {
return array(
//element-as-variable
'mymodule_element' => array(
'render_element' => 'items'
)
);
}
35

36. Render API
Render API и темизация
element-as-variable
function theme_mymodule_element($vars){
$element = $vars['item'];
$items = $element['items'];
$title =
$element['title'];
}
36

37. Render API
Вывод
Render API - позволяет сделать код
- быстрым (благодаря #cache),
- прозрачным и понятным
(благодаря концепции рендермассивов)
- удобным (благодаря #states,
#attached)
37

38. Render API
Вопросы
38

39. Render API
Виктория Султановская
victoria.sultanovskaya@volcanoideas.com