El módulo
Content Construction Kit (CCK) es uno de los módulos que debería tener implementada toda instalación de
Drupal. Es tan imprescindible que en Drupal 7 va a ir incorporado de serie.
En Drupal la primera clasificación que tenemos es la de tipos de contenido, por defecto vienen creados el tipos de contenido historia y el tipos de contenido artículo. Estos contenidos tienen un título y un texto. Pero para poder crear tipos de contenidos más complejos y que tengan más campos aparte de estos 2, como pueden ser imágenes o fechas, será necesario utilizar el módulo CCK.
Una vez lo hayamos hecho deberemos descargar e instalar módulos que proporcionen los tipos de campo especiales que necesitemos.Lo interesante de este sistema es que no hace falta programar una sola línea de código para crear un tipo de contenido completamente personalizado, a base de clicks de ratón podemos crear todos los tipos de contenido que requiera un gran portal.
Si nosotros como desarrolladores deseamos crear un nuevo tipo de contenido específico para nuestra aplicación, deberemos crear un módulo que utilice el API que proporciona CCK para poder crear el campo que necesitemos. El módulo CCK tiene un extenso API que principalmente se basa en distintos hooks, que son necesarios para poder crear los diferentes componentes que ofrece, como pueden ser
widgets, campos y formatters. En este post hago un breve resumen de los principales hooks que ofrece este módulo. Para información más detallada se puede acudir a la
documentación del módulo.
hook_field_info()
Declara información sobre un tipo de campo. Importante: El nombre del campo será truncado a 32 caracteres enla BD y arrays internos.
Parámetros
Este hook no tiene parámetros de entrada.
Retorna
Un array asociativo cuya llave es el nombre del tipo de campo. Cada elemento del array es un array con estas llaves y valores:
- 'label': El nombre que se le mostrará al usuario del tipo de campo.
hook_field($op, &$node, $field, &$node_field, $teaser, $page)
Este hook define el comportamiento de un campo. En la mayoría de los casos, sólo la operación 'validate' es relevante, el resto están implementadas en content_field(), y son suficientes.
Parámetros
- $op, en el que se define la operación del campo que se requiere en ese momento:
- 'load': Lo que ocurre cuando el nodo es cargado de la BD. Este hook debería ser usado para cargar el campo.
- 'view': Lo que sucede cuando el campo es mostrado al usuario. El módulo debería preparar y devolver una cadena HTML que contenga la representación por defecto del campo. Será llamado sólo si 'view' es puesto a TRUE en el hook_field_settings('callbacks')
- 'validate':El usuario acaba de editar el nodo y quiere ver la vista previa o enviarlo. Este hook puede usarse para comprobar o incluso modificar el nodo. Los errores deben mostrarse de la forma form_set_error().
- 'submit': El usuario acaba de enviar el nodo y ha pasado la validación. Este hook se puede utilizar para modificar algun dato del nodo.
- 'presave':Modificaciones en el nodo justo antes de ser guardado.
- 'insert':El nodo está siendo creado.
- 'update':El nodo está siendo actualizado.
- 'delete':El nodo está siendo borrado.
- &$node: El nodo sobre el que se estaá actuando. Este argumento es pasado por referencia. Aconsejable no modificarlo.
- &$node_field:El contenido de ese campo para el nodo. Los cambios en esta variable serán guardados en el nodo.
Retorna
Esta valor varía en función del valor de '$op':
- $op=='load':Se debe retornar un objeto que contenga valores extra que añadir al objeto nodo.
- $op=='view':Una cadena HTML representando el campo
- El resto de operaciones no retornan ningún valor.
hook_field_settings($op, $field)
Maneja los parámetros de un campo.
Parámetros
- $op La operación a la que se refier, puede ser:
- 'form':Muestra el formulario de configuración del campo.
- 'validate':Comprueba la configuración del campo por posibles errores.
- 'save':Declara que campos se deben guardar en la BD.
- 'database columns':Declara las columnas que content.module deberá crear y manejar. Si el módulo de campo desea manejar por el mismo el almacenamiento en BD, deberá ser omitido.
- 'callbacks:Describe el ámbito del comportamiento en relación con las operaciones del hook_field.
- 'views data': Declara la información para Views del campo. Pueden ser tabla, argumentos, filtros... Usar este operador sólo si se quieren sobreescribir la implementación por defecto de CCK.
- $field: El campo sobre el que se hace la operación.
Retorna
Esto varía según el valor de $op:
- $op=='form': Un array de elementos de formulario para añadir a la página de configuración del campo.
- $op=='validate': No retorna nada. Los errores deben enviarse de la forma form_set_error().
- $op=='save': Un array de nombres de elementos del formulario que deben almacenarse en la BD.
- $op=='database columns': Un array asociativo por el nombre de la columna con arrays con la información sobre la columna. Se deben incluir los campos 'type',con el tipo de dato de MySQL para la columna, y puede incluir el campo 'sortable para indicar al módulo views uqe la columna contiene información ordenable.
- $op=='callbacks': Un array describiendo el comportamiento del campo respecto al comportamiento del hook_field(). El array está asociado por las acciones de hook_field()('view','validate'...)y sus posibles valores son los siguientes:
- CONTENT_CALLBACK_NONE: No hace nada.
- CONTENT_CALLBACK_CUSTOM: Usa el mismo comportamiento que en hook_field(operacion).
- CONTENT_CALLBACK_DEFAULT:Usa el comportamiento por defecto.
- $op=='views data': Un array de tablas, argumentos y filtros utilizados por views.
hook_widget_info()
Declara información sobre un tipo de widget. Importante: El nombre del widget será truncado a 32 caracteres enla BD y arrays internos.
Parámetros
Este hook no tiene parámetros de entrada.
Retorna
Un array asociativo cuya llave es el nombre del tipo de campo. Cada elemento del array es un array con estas llaves y valores:
- 'label': El nombre que se le mostrará al usuario del tipo de campo.
- 'field types': Un array con los tipos de campos a los que se puede asociar el widget.
- 'multiple values': Pueden ser:
- CONTENT_HANDLE_CORE (Por defecto)
- CONTENT_HANDLE_MODULE Para manejar el caso de múltiples valores dentro del módulo.
- 'callbacks:Un array de callbacks, para poner el valor del 'valor por defecto' a uno de los siguientes valores:
- CONTENT_CALLBACK_NONE: No hace nada.
- CONTENT_CALLBACK_CUSTOM: Usa el mismo comportamiento que en hook_field(operacion).
- CONTENT_CALLBACK_DEFAULT: Usa el comportamiento por defecto.
Normalmente estos 2 últimos valores se obvian y se utiliza el comportamiento por defecto.
hook_widget(&$form, &$form_state, $field, $items, $delta = 0)
El hook widget() controla el comportamiento del widget, principalmente para crear y validar el formulario de edición, la operación de 'proccess form values' debería ser usada para manipular los valores antes de ser salvados
Parámetros
- $op, que puede tomar los siguientes valores:
- 'prepare form values': Prepara el almacenamiento de los datos almacenados para mostrarlos en el widget.
- 'form': El nodo está siendo editado y un formulario debe ser preparado para mostrar al usuario.
- 'validate:El usuario acaba de editar el nodo y quiere ver la vista previa o enviarlo. Este hook puede usarse para comprobar o incluso modificar el nodo.Los errores deben mostrarse de la forma form_set_error().
- 'proccess form values': El widget convierte los datos obtenidos al formato nativo de los datos
- 'submit':El usuario acaba de enviar el nodo y ha pasado la validación. Este hook se puede utilizar para modificar algun dato del nodo.
- &$node: El nodo sobre el que se estaá actuando. Este argumento es pasado por referencia. Aconsejable no modificarlo.
- $field: El campo sobre el que se está actuando.
- &$node_field:El contenido de ese campo para el nodo. Los cambios en esta variable será guardados en el nodo.
Retorna
Depende del valor que tome $op:
- $op=='form': Retorna un array de elementos de formulario para mostrar.
- El resto de valores no retornan nada.
hook_widget_settings($op, $widget)
Este hoook controla el comportamiento de los datos insertados mediante el widget en cuestión. Este hook es muy parecido al hook_field_settings(), con la diferencia de que este afecta al comportamiento del widget.
Parámetros
- $op, que puede tomar los siguientes valores:
- 'form':Muestra el formulario de configuración del campo.
- 'validate':Comprueba la configuración del campo por posibles errores.
- 'save':Declara que campos se deben guardar en la BD.
- 'callbacks:Describe el comportamiento del campo en relación con las operaciones del hook_field.
Retorna
Esto varía según el valor de $op:
- $op=='form': Un array de elementos de formulario para añadir a la página de configuración del campo.
- $op=='validate': No retorna nada. Los errores deben enviarse de la forma form_set_error().
- $op=='save': Un array de nombres de elementos del formulario que deben almacenarse en la BD.
- $op=='callbacks': Un array describiendo el comportamiento del campo respecto al comportamiento del hook_field(). El array está asociado por las acciones de hook_field()('view','validate'...)y sus posibles valores son los siguientes:
- CONTENT_CALLBACK_NONE: No hace nada.
- CONTENT_CALLBACK_CUSTOM: Usa el mismo comportamiento que en hook_field(operacion).
- CONTENT_CALLBACK_DEFAULT:Usa el comportamiento por defecto.
