УрокКорректная работа с полями в седьмом Друпале. Entity metadata wrappers.

В седьмой версии Друпала вывод полей был несколько изменён в связи с усовершенствованием многоязычной системы. Если раньше для вывода содержимого поля достаточно было написать так:

print $node->field_name[0]['value'];

то в семёрке добавился к полю ещё и язык (для одноязычных сайтов по умолчанию 'und' - undefined, константа LANGUAGE_NONE):

print $node->field_name[LANGUAGE_NONE][0]['value'];

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

print $node->field_name['en'][0]['value'];

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

$lang = field_language('node', $node, 'field_name');
print $node->field_name[$lang][0]['value'];

Уже лучше - такой код поможет избежать коллапса при смене языка сайта. Однако дальше - лучше. В ядре нашлась ещё одна полезная функция field_get_items(). Она возвращает массив из всех значений поля. Например, если в поле только одно значение, то пользоваться ей так:

$field_values = field_get_items('node', $node, 'field_name');
print $field_values[0]['value'];

Если же количество значений больше одного, то можно их выводить циклом:

$field_values = field_get_items('node', $node, 'field_name');
foreach ($field_values as $field) {
  print $field['value'];
}

В принципе, второй вариант является более общим, т.к. работает и для случая с одним значением поля.

На самом деле, на этом можно было бы даже остановиться, однако не рассказать о возможностях Entity API для работы с полями было бы крайне неправильно. Итак,

Возможности Entity API по работе с полями

В этом модуле есть великолепная функция entity_metadata_wrapper(). Она возвращает объект, который является удобной обёрткой для вывода и изменения данных объекта вместе с его полями. Например, значение поля можно получить так:

$wrapper = entity_metadata_wrapper('node', $node);
print $wrapper->field_name->value();

Если же значений несколько, то можно воспользоваться такой конструкцией:

$wrapper = entity_metadata_wrapper('node', $node);
foreach ($wrapper->field_name as $field) {
  print $field->value();
}

Пример из README.txt модуля Entity API (получаем емейл автора материала):

$wrapper = entity_metadata_wrapper('node', $node);
$wrapper->author->mail->value();

Если вы хотите получить значение поля, которое может быть безопасно выведено на экран, то передайте в value() атрибут 'sanitize', установленный в TRUE (в этом случае все тэги будут выведены в виде текста).

print $wrapper->field_name->value(array('sanitize' => TRUE));

Также существует атрибут 'decode', который отвечает за раскодирование всех HTML сущностей поля и вырезание тэгов из текста:

print $wrapper->body->value->value(array('decode' => TRUE));

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

print $wrapper->body->value->raw();

Ещё одной отличительной особенностью этого подуля является автоматическое определение полей, которые ссылаются на другую сущность. Например, если у вас поле ссылается на другой материал, то вы на лету можете использовать объект этого материала:

$wrapper = entity_metadata_wrapper('node', $node);
// Выведем заголовок материала, на которое ссылается поле.
print $wrapper->field_some_relation->value()->title;

Отдельно стоит отметить, что $wrapper->field_name - это и массив и объект одновременно. То есть вы можете использовать его как объект ($wrapper->field_name->value()) или как массив ($wrapper->field_name[0]). Говоря техническим языком, он реализует интерфейсы IteratorAggregate, ArrayAccess и Countable.

Ещё одна важная деталь, на которую можно было не обратить внимание: entity_metadata_wrapper() даёт доступ не только к полям, но и к самим сущностям. Поэтому если вы загрузили сущность через entity_metadata_wrapper(), вы можете продолжать с ней работать:

$node = node_load(123);
$wrapper = entity_metadata_wrapper('node', $node);
$wrapper->title = 'New title for the node';
$wrapper->save();

При использовании обёрточного класса из модуля Entity API есть один недостаток - поле будет отображаться через entity_metadata_wrapper() только в том случае, если поле было описано через hook_entity_property_info(). Все поля ядра и наиболее популярные поляиз контриб-модулей поддерживают такую обёртку, однако среди множества модулей можете наткнуться на всякое, поэтому не стоит об этом забывать.

Вдохновение черпал отсюда: http://pixeljets.com/blog/writing-robust-code-uses-fields-drupal-7.