Блог

У меня есть пара вопросов по соглашениям о кодировании в Drupal, которые я не смог прояснить из документов или кода.

Помимо знания имени каждого перехвата в Drupal, есть ли способ отличить функцию, которая реализует перехват, от функции, которая просто предоставляет немного функциональности для перехвата? Либо что-то принудительное с помощью кода, либо какое-то соглашение?

Второй, возможно, связанный с этим вопрос. После просмотра основных модулей я заметил, что некоторые функции называются с начальным подчеркиванием

 function _node_rankings(SelectQueryExtender $query) {
    ...
}
  

Какое значение придается подчеркиванию? Я предполагаю, что это имитирует «защищенное» соглашение, что означает, что его следует вызывать только из других функций в node.module файле; однако я не смог найти ничего, что подтверждало бы это.

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

Вы правы, префикс подчеркивания в именах функций указывает на то, что ее следует рассматривать как закрытую функцию, вызываемую только модулем, который ее объявил.

Я не знаю, есть ли это в официальных документах Drupal, но есть несколько сообщений о drupal.org подтверждаю это (например, это или this).

РЕДАКТИРОВАТЬ: и да, это также помогает избежать превращения «обычной» функции в реализацию перехвата (хотя вам следует стараться не называть функции в честь существующих перехватов).

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

 /**
 * Implementation of hook_foo().
 */
  

Поработав некоторое время с Drupal, вы начнете распознавать наиболее распространенные перехваты.