Las reglas personalizadas acción Hosting Drupal

Definir reglas de acciones compatibles.

Se requiere este gancho con el fin de añadir una nueva acción normativa. Debe ser colocado en el archivo MODULENAME.rules.inc, que consigue incluye automáticamente cuando se invoca el gancho.

valor de retorno

Una gran variedad de información sobre las acciones previstas reglas del módulo. La matriz contiene una sub-matriz para cada acción, con el nombre de la acción como la clave. nombres acciones sólo pueden contener caracteres en minúscula y guiones alfanuméricos y deben ser prefijado con el nombre del módulo que proporciona. atributos posibles para cada sub-matriz son:

• etiqueta. La etiqueta de la acción. Comenzar con mayúscula. Necesario.
• grupo. Un grupo de este elemento, que se utiliza para agrupar las acciones en la interfaz. Debe comenzar con una letra mayúscula y ser traducido. Necesario.
• parámetro. (Opcional) Una matriz que describe todos los parámetros de la acción con el nombre del parámetro como clave. Cada parámetro tiene que ser descrito por una sub-matriz con posibles atributos como se describe después, mientras que el nombre de un parámetro necesita ser una minúscula, PHP válido nombre de variable.
• proporciona. (Opcional) Una matriz que describe las variables la acción proporciona al estado de evaluación con el nombre de la variable como clave. Cada variable tiene que ser descrito por una sub-matriz con posibles atributos como se describe después, mientras que el nombre de un parámetro necesita ser una minúscula, PHP válido nombre de variable.
• 'Parámetro denominado'. (Opcional) Si se establece en TRUE, los argumentos serán pasados ​​como una única matriz con los nombres de los parámetros como llaves. Esto emula nombrado parámetros en PHP y es en particular útil si el número de parámetros puede variar. El valor predeterminado es falso.
• base. (Opcional) La base para la implementación de las devoluciones de llamada de acción para utilizar en lugar del nombre de la acción. Por defecto es el nombre de la acción.
• devoluciones de llamada. (Opcional) Una matriz que permite fijar las devoluciones de llamada de función específicas para la acción. El valor por defecto para cada devolución de llamada es la base de acciones con el sufijo '_' y el nombre de devolución de llamada.
• 'Acceso de devolución de llamada'. (Opcional) Una llamada de retorno que tiene que devolver si el usuario actualmente conectado se permite configurar esta acción. Ver rules_node_integration_access () para un ejemplo de devolución de llamada.

Cada array 'parámetro' puede contener las siguientes propiedades:

• etiqueta. La etiqueta del parámetro. Comenzar con mayúscula. Necesario.
• tipo. El tipo de normas de datos del parámetro, que se va a pasar a la acción. Todos los tipos declarados en hook_rules_data_info () pueden ser especificadas, así como un conjunto de tipos posibles. También listas y listas de un tipo dado pueden especificarse mediante la lista notating introducido por el módulo de metadatos de entidad, consulte hook_entity_property_info (). La palabra clave especial '*' se puede utilizar cuando se debe permitir todo tipo. Necesario.
• manojos. (Opcional) Una matriz de nombres de lotes. Cuando el tipo especificado se establece en un solo tipo de entidad, esto puede ser utilizado para restringir los paquetes permitidos.
• descripción. (Opcional) Si es necesario, una descripción más detallada del parámetro.
• lista de opciones. (Opcional) una devolución de llamada que devuelve una matriz de valores posibles para este parámetro. La devolución de llamada tiene que devolver una matriz tal como se utiliza por hook_options_list (). Para ver un ejemplo de implementación rules_data_action_type_options ().
• salvar. (Opcional) Si se establece en TRUE, el parámetro será salvado por reglas cuando termina la evaluación reglas. Esto sólo es compatible con los tipos de datos salvables. Si la acción devuelve FALSO, el ahorro se pasa por alto.
• Opcional. (Opcional) se puede establecer en TRUE, cuando no se requiere el parámetro.
• 'valor por defecto'. (Opcional) El valor para pasar a la acción, en caso de que el parámetro es opcional y no hay valor especificado.
• 'permitir nula'. (Opcional) Por lo general, las Reglas no pasarán algún valor nulo como argumento, pero abortar la evaluación si un valor NULL está presente. Si se establece en TRUE, las reglas no se cancelarán y pasar el valor NULL a través. El valor predeterminado es falso.
• restricción. (Opcional) que restringen cómo se puede proporcionar el argumento para este parámetro. Los valores admitidos son 'selector' y 'de entrada'.
• modo por defecto. (Opcional) Personalizar el modo por defecto para proporcionar el valor del argumento para un parámetro. Los valores admitidos son 'selector' y 'de entrada'. El valor por defecto depende del tipo de datos requerido.
• desinfectar. (Opcional) permite que los parámetros de tipo 'texto' para exigir un argumento ya desinfectado. Si se habilita, cualquier valor especificado por el usuario no va a ser desinfectados en sí, sino reemplazos aplicados por los evaluadores de entrada son así como valores recuperados a partir de fuentes de datos seleccionados.
• traducible. (Opcional) Si se establece en TRUE, el valor del argumento del parámetro proporcionado es traducible través de la traducción i18n cadena. Esto es aplicable para los parámetros de texto solamente, es decir, los parámetros de 'texto' tipo 'símbolo', 'Lista'Y' lista'. El valor predeterminado es falso.
• la clase de interfaz de usuario. (Opcional) Permite anulando la clase de interfaz de usuario, que se utiliza para generar la interfaz de usuario de configuración de un parámetro. Por defecto es la clase de interfaz de usuario del tipo de datos especificado.
• devolución de llamada limpieza. (Opcional) una devolución de llamada que los evaluadores de entrada pueden utilizar para limpiar reemplazos insertados; p.ej. esto es utilizado por el evaluador token.
• envuelto. (Opcional) Ponga esto a TRUE en caso de que los datos deben ser transmitidos envueltos. Esto sólo se aplica a tipos de datos envuelto, por ejemplo, entidades.

Cada 'proporciona' array puede contener las siguientes propiedades:

• etiqueta. La etiqueta de la variable. Comenzar con mayúscula. Necesario.
• tipo. El tipo de reglas de datos de la variable. Todos los tipos declarados en hook_rules_data_info () pueden ser especificadas. Tipos pueden ser parametrizados por ejemplo el nodo tipos o una lista son validos.
• salvar. (Opcional) Si se establece en TRUE, la variable proporcionada es salvado por reglas cuando termina la evaluación reglas. Sólo es posible para los tipos de datos salvables. El valor predeterminado es falso.

El módulo tiene que proporcionar una implementación para cada acción, siendo una función llamada como se especifica en la 'base' tecla o para la devolución de llamada de ejecución. El resto de las devoluciones de llamada posibles son opcionales. devoluciones de llamada de acción apoyados por las reglas están definidas y documentadas en el RulesPluginImplInterface. Sin embargo, cualquier módulo puede extender el plugin acción basada en una interfaz definida usando hook_rules_plugin_info (). Todos los métodos definidos en las interfaces pueden ser anulados por la implementación de las acciones. Las implementaciones de devolución de llamada para las interfaces pueden residir en cualquier archivo especificado en hook_rules_file_info ().

Temas relacionados

Ganchos Ganchos reglas que pueden ser implementadas por otros módulos con el fin de ampliar las normas.

contribuciones / normas / rules.api.php. la línea 137 Este archivo contiene ningún código PHP de trabajo; que existe para proporcionar la documentación adicional para Doxygen, así como para documentar los ganchos de la manera estándar de Drupal.

Artículos relacionados

Definir reglas de acciones compatibles. Se requiere este gancho con el fin de añadir una nueva acción normativa. Debe ser colocado en el archivo MODULENAME.rules.inc, que consigue incluye automáticamente cuando el ...

Coloque campos de datos personalizados a las entidades de Drupal. La API permite Campo campos de datos personalizados que se adjunta a las entidades de Drupal y se encarga de almacenar, cargar, editar y renderizar datos de campo ....

Ejecutar funciones enganchado en un gancho de acción específica, la especificación de argumentos en una matriz. Esta función es idéntica a do_action. pero los argumentos que se pasan a las funciones enganchados a $ etiqueta son ...

Por defecto los artículos. Páginas. las páginas del blog. y otros tipos de contenido no tienen un lugar para los visitantes para dejar un comentario. A partir de Drupal 8, comentario convirtió en su propio tipo de campo. Esto significa que es ...

Declarar la ruta y sus opciones. Este paso incluye el título de la página, los requisitos de acceso para la página, y otros. En Drupal 7, había que aplicar hook_menu (). En Drupal 8, crear el ...