J3.x

J3.x:Añadir campos personalizados/Sobrescrituras

From Joomla! Documentation

< J3.x:Adding custom fields
This page is a translated version of the page J3.x:Adding custom fields/Overrides and the translation is 100% complete.

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎Bahasa Indonesia • ‎Nederlands • ‎中文(中国大陆)‎ • ‎中文(台灣)‎


Cómo usar campos personalizados en tus sobrescrituras (overrides)


Cómo usar campos personalizados en tus sobrescrituras

Introducción

El verdadero poder de los campos personalizados es que puedes usarlos en tus sobrescrituras. A continuación un ejemplo de cómo puede hacerse.

Cómo usar campos personalizados en tus sobrescrituras

Básicamente tienes todos los campos personalizados correspondientes al elemento actual accesibles vía una nueva propiedad en tu $item en una variable denominada jcfields. La propiedad $item->jcfields es un array que contiene los datos de cada campo, donde un campo puede ser como el siguiente ejemplo:

Array
(
    [4] => stdClass Object
        (
            [id] => 4
            [title] => article-editor
            [name] => article-editor
            [checked_out] => 0
            [checked_out_time] => 0000-00-00 00:00:00
            [note] => 
            [state] => 1
            [access] => 1
            [created_time] => 2017-04-07 12:08:59
            [created_user_id] => 856
            [ordering] => 0
            [language] => *
            [fieldparams] => Joomla\Registry\Registry Object
                (
                    [data:protected] => stdClass Object
                        (
                            [buttons] => 
                            [width] => 
                            [height] => 
                            [filter] => 
                        )

                    [initialized:protected] => 1
                    [separator] => .
                )

            [params] => Joomla\Registry\Registry Object
                (
                    [data:protected] => stdClass Object
                        (
                            [hint] => 
                            [render_class] => 
                            [class] => 
                            [showlabel] => 1
                            [disabled] => 0
                            [readonly] => 0
                            [show_on] => 
                            [display] => 2
                        )

                    [initialized:protected] => 1
                    [separator] => .
                )

            [type] => editor
            [default_value] => 
            [context] => com_content.article
            [group_id] => 0
            [label] => article-editor
            [description] => 
            [required] => 0
            [language_title] => 
            [language_image] => 
            [editor] => 
            [access_level] => Public
            [author_name] => Super User
            [group_title] => 
            [group_access] => 
            [group_state] => 
            [value] => Bar
            [rawvalue] => Bar
        )

)

Mostrando un campo usando FieldsHelper

Para mostrar un campo puedes usar FieldsHelper::render() pasando los valores necesarios.

/**
 * Renders the layout file and data on the context and does a fall back to
 * Fields afterwards.
 *
 * @param   string  $context      The context of the content passed to the helper
 * @param   string  $layoutFile   layoutFile
 * @param   array   $displayData  displayData
 *
 * @return  NULL|string
 *
 * @since  3.7.0
 */
public static function render($context, $layoutFile, $displayData)

Ejemplo de código para la sobrescritura usando FieldsHelper

// Load the FieldsHelper
<?php JLoader::register('FieldsHelper', JPATH_ADMINISTRATOR . '/components/com_fields/helpers/fields.php'); ?>

<?php foreach ($this->item->jcfields as $field) : ?>
	// Render the field using the fields render method
	<?php echo FieldsHelper::render($field->context, 'field.render', array('field' => $field)); ?>
<?php endforeach ?>

Ejemplo de código para una sobrescritura en bruto

<?php foreach ($this->item->jcfields as $field) : ?>
	// Render the field using the fields render method
	<?php echo $field->label . ':' . $field->value; ?>
<?php endforeach ?>

$item->jcfields no contiene el campo que necesito

La propiedad jcfields es generada usando el evento onContentPrepare y pasándole el contexto de los campos. El plugin de campos entonces lee los campos de la base de datos y añade los valores a la propiedad jcfields. Asegúrate por favor que el componente que usas implementa el evento onContentPrepare con el contexto que usas para los campos.

Si usas los componentes del núcleo esto debe funcionar desde el primer momento.


Cargando campos individuales

Para añadir campos individuales a tu componente, comienza eligiendo los nombres específicos para ellos, empleando el campo "Nombre", el cual será usado para referenciar tu campo directamente en tu código de sobrescritura. En la pestaña Opciones, selecciona "No" en campo de Mostrar automáticamente para prevenir que se muestre automáticamente en sus posiciones estándar.

A continuación, para habilitar el acceso directo por nombre a los campos personalizados en una sobrescritura, sitúa el siguiente código al principio de tu fichero. Debes hacer esto en cada archivo PHP de sobrescritura en el que quieras ubicar campos personalizados en él.

<?php foreach($item->jcfields as $jcfield)
     {
          $item->jcFields[$jcfield->name] = $jcfield;
     }
?>

Y por último, debes añadir el código al lugar en el que desees mostrar la etiqueta o el valor del campo.

Para añadir la etiqueta del campo a tu sobrescritura, inserta el siguiente código, reemplazando name-of-field por el nombre de tu campo.

<?php echo $item->jcFields['name-of-field']->label; ?>

Para añadir el valor del campo a tu sobrescritura, inserta el código siguiente, reemplazando name-of-field por el nombre del campo. Cuidado: en las versiones 3.x el valor es de hecho el rawvalue https://github.com/joomla/joomla-cms/issues/20216

<?php echo $item->jcFields['name-of-field']->rawvalue; ?>

Puedes añadir este código a cualquier parte de tu sobrescritura. Ejemplos: En el contenido de un div, en el src de una etiqueta img, como un atributo clase de CSS, etc.