Zum Inhalt springen
Astrid

Joomla 4 Cassiopeia - Plugins für die Anzeige von Ansprechpartnern

Du suchst nach einer Möglichkeit, Ansprechpartner in Joomla 4 mit Cassiopeia anzuzeigen? Ich habe das Problem einmal mit einem Custom Field[^blog.astrid-guenther.de/joomla-plugins/#fields-felder---indexpluginfields-felder---] und ein anderes Mal mit einem Content Plugin[^blog.astrid-guenther.de/joomla-plugins/#inhalt-content---indexplugininhalt-content---] gelöst.

Warum zwei unterschiedliche Typen? Zuerst habe ich ein Custom Field für diesen Zweck geschrieben, weil in der ersten Version gewünscht war, dass jeder Beitrag mit einer Kontaktperson gefüllt wird. In einer weiteren Installation war es nicht mehr notwendig, das Einfügen zu erzwingen, sondern es wurde eine flexiblere Anwendung benötigt. Nach reiflicher Überlegung habe ich ein Content-Plugin verwendet. Der Vorteil eines Content-Plugins ist, dass man es ebenfalls in Modulen anwenden kann. Das benutzerdefinierte Feld ist mit dem Hauptinhalt der Anzeigeseite verknüpft, in der Regel dem Beitrag.

Custom Field

Ein Custom Field muss installiert werden. Hierfür benötigen wir ein Installations-Manifest plugins/fields/contact/contact.xml.

// https://codeberg.org/astrid/j/raw/branch/main/pkg_agpledges/j4/pkg_agpledges/src/plugins/fields/contact/contact.xml

<?xml version="1.0" encoding="utf-8" ?>
<extension type="plugin" group="fields" method="upgrade">
	<name>plg_fields_contact</name>
	<author>Astrid Günther</author>
	<creationDate>##DATE##</creationDate>
	<copyright>(C) Astrid Günther. All rights reserved.</copyright>
	<license>GNU General Public License version 2 or later; see LICENSE.txt</license>
	<authorEmail>info@astrid-guenther.de</authorEmail>
	<authorUrl>www.astrid-guenther.de</authorUrl>
	<version>##VERSION##</version>
	<description>PLG_FIELDS_CONTACT_XML_DESCRIPTION</description>
	<files>
		<filename plugin="contact">contact.php</filename>
		<folder>tmpl</folder>
		<folder>fields</folder>
		<folder>language</folder>
	</files>
</extension>

Als nächstes implementieren wir die Plugin Datei. Diese sorgt dafür, dass das Custom Field von der Joomla Klasse \Joomla\Component\Fields\Administrator\Plugin\FieldsPlugin erbt. So bietet es alle erforderlichen Schnittstellen ist korrekt in Joomla integriert.

// https://codeberg.org/astrid/j/raw/branch/main/pkg_agpledges/j4/pkg_agpledges/src/plugins/fields/contact/contact.php

<?php
use Joomla\CMS\Form\Form;

\defined('_JEXEC') or die;

class PlgFieldsContact extends \Joomla\Component\Fields\Administrator\Plugin\FieldsPlugin
{
	public function onCustomFieldsPrepareDom($field, DOMElement $parent, Form $form)
	{
		if ($this->app->isClient('site')) {
			// The user field is not working on the front end
			return;
		}

		return parent::onCustomFieldsPrepareDom($field, $parent, $form);
	}
}

Die Template-Datei organisiert die Anzeige im Frontend.

// https://codeberg.org/astrid/j/raw/branch/main/pkg_agpledges/j4/pkg_agpledges/src/plugins/fields/contact/tmpl/contact.php

<?php

defined('_JEXEC') or die;

use Joomla\CMS\Factory;
use Joomla\CMS\Component\ComponentHelper;
use Joomla\CMS\String\PunycodeHelper;

$value = $field->value;

if ($value == '') {
	return;
}

$app = Factory::getApplication();
$factory = $app->bootComponent('com_contact')->getMVCFactory();
$cparams = ComponentHelper::getParams('com_contact');
$model = $factory->createModel('Contact', 'Site', ['ignore_request' => true]);
$model->setState('params', $cparams);

try {
	$contact = $model->getItem($value);
} catch (\Exception $e) {
	return "";
}
?>

<div class="plg-loadcontact card mb-3" itemscope itemtype="https://schema.org/Person">
	<div class="row g-0">
			<div class="col-md-4">Ansprechpartner:
			</div>
		<div class="<?php echo $col; ?>">
			<div class="card-body">
				<p class="card-title" itemprop="name"><?php echo $contact->name; ?></p>
				<?php if ($contact->con_position && $cparams->get('show_position')) : ?>
					<p class="contact-position" itemprop="jobTitle"><?php echo $contact->con_position; ?></p>
				<?php endif; ?>
				<?php if ($contact->address || $contact->suburb  || $contact->state || $contact->country || $contact->postcode || $contact->mobile || $contact->telephone || $contact->fax || $contact->email_to || $contact->webpage) : ?>
					<address class="plg-loadcontact__address" itemprop="address" itemscope itemtype="https://schema.org/PostalAddress">
						<?php if ($contact->address && $cparams->get('show_street_address')) : ?>
							<span class="contact-street" itemprop="streetAddress">
								<?php echo nl2br($contact->address, false); ?>
							</span><br />
						<?php endif; ?>

						<?php if ($contact->postcode && $cparams->get('show_postcode')) : ?>
							<span class="contact-postcode" itemprop="postalCode">
								<?php echo $contact->postcode; ?>
							</span>
						<?php endif; ?>

						<?php if ($contact->suburb && $cparams->get('show_suburb')) : ?>
							<span class="contact-suburb" itemprop="addressLocality">
								<?php echo $contact->suburb; ?>
							</span><br />
						<?php endif; ?>

						<?php if ($contact->state && $cparams->get('show_state')) : ?>
							<span class="contact-state" itemprop="addressRegion">
								<?php echo $contact->state; ?>
							</span><br />
						<?php endif; ?>

						<?php if ($contact->country && $cparams->get('show_country')) : ?>
							<span class="contact-country" itemprop="addressCountry">
								<?php echo $contact->country; ?>
							</span><br />
						<?php endif; ?>

						<?php if ($contact->mobile && $cparams->get('show_mobile')) : ?>
							<span class="contact-mobile" itemprop="telephone">
								<?php echo $contact->mobile; ?>
							</span>
						<?php endif; ?>

						<?php if ($contact->telephone && $cparams->get('show_telephone')) : ?>
							<span class="contact-telephone" itemprop="telephone">
								<?php echo $contact->telephone; ?>
							</span><br />
						<?php endif; ?>

						<?php if ($contact->fax && $cparams->get('show_fax')) : ?>
							<span class="contact-fax" itemprop="faxNumber">
								<?php echo $contact->fax; ?>
							</span><br />
						<?php endif; ?>

						<?php if ($contact->email_to && $cparams->get('show_email')) : ?>
							<p class="contact-emailto" itemprop="email">
								<?php echo $contact->email_to; ?>
							</p>
						<?php endif; ?>

						<?php if ($contact->webpage && $cparams->get('show_webpage')) : ?>
							<p class="contact-webpage">
								<a href="<?php echo $contact->webpage; ?>" target="_blank" rel="noopener noreferrer" itemprop="url">
									<?php echo PunycodeHelper::urlToUTF8($contact->webpage); ?>
								</a>
							</p>
						<?php endif; ?>
					</address>
				<?php endif; ?>
			</div>
		</div>
	</div>
</div>

Per XML-Datei implementiert zusätzliche Parameter für die Backendansicht.

// https://codeberg.org/astrid/j/raw/branch/main/pkg_agpledges/j4/pkg_agpledges/src/plugins/fields/contact/params/contact.xml

<?xml version="1.0" encoding="utf-8"?>
<form>
	<fields name="params" label="COM_FIELDS_FIELD_BASIC_LABEL">
		<fieldset name="basic">
			<field
				name="show_on"
				type="hidden"
				filter="unset"
			/>
		</fieldset>
	</fields>
</form>

Nun kommen wir zum eigentlichen Feld. Wir erfinden das Rad nicht. Wir können das SQL-Feld erweitern.

// https://codeberg.org/astrid/j/raw/branch/main/pkg_agpledges/j4/pkg_agpledges/src/plugins/fields/contact/fields/contact.php

<?php
defined('JPATH_PLATFORM') or die;

jimport('joomla.form.fields.sqlfield');

class JFormFieldContact extends JFormFieldSQL
{
	public $type = 'Contact';

	public function setup(\SimpleXMLElement $element, $value, $group = null)
	{
		$return = parent::setup($element, $value, $group);

		if ($return) {
			if (empty($this->query)) {
				$query = [];
				$defaults = [];

				$query['select'] = 'id,name';
				$query['from'] = '#__contact_details';
				$query['join'] = '';
				$query['where'] = 'published = 1';
				$query['group'] = '';
				$query['order'] = 'name';

				$this->query = $this->processQuery($query, null, null);
			}

			$this->keyField = 'id';
			$this->valueField = 'name';
			$this->translate = false;
			$this->header = false;
		}

		return $return;
	}
}

Last but not least bieten wir zwei Dateien, die die Übersetzung in verschiedene Sprachen vereinfachen.

Mehr Informationen zu Sprachdateien habe ich unter “Sprachdateien nutzen”[^blog.astrid-guenther.de/sprachdateien-nutzen/] geschrieben.

// https://codeberg.org/astrid/j/raw/branch/main/pkg_agpledges/j4/pkg_agpledges/src/plugins/fields/contact/language/en-GB/plg_fields_contact.ini

PLG_FIELDS_CONTACT="Fields - Contact"
PLG_FIELDS_CONTACT_XML_DESCRIPTION="This plugin lets you create new fields of type 'contact' in any extensions where custom fields are supported."

PLG_FIELDS_CONTACT_DEFAULT_VALUE_LABEL="Default Contact"
PLG_FIELDS_CONTACT_LABEL="Contact (%s)"

// https://codeberg.org/astrid/j/raw/branch/main/pkg_agpledges/j4/pkg_agpledges/src/plugins/fields/contact/language/en-GB/plg_fields_contact.sys.ini

PLG_FIELDS_CONTACT="Fields - Contact"
PLG_FIELDS_CONTACT_XML_DESCRIPTION="This plugin lets you create new fields of type 'contact' in any extensions where custom fields are supported."

Nun sind alle Dateien fertig. Du kannst die Dateien zum Custom Field in eine Installationdatei packen und installieren. Falls du dies noch nie getan hast, kannst du die Dateien auch selbst an Ort und Stelle in eine Joomla Website kopieren und per Discover/Entdecken installieren. Wohin du die Dateien genau kopieren musst, siehst du an dem Pfad, unter dem ich sie beim Entwickeln gespeichert habe. Dieser steht immer im oberen Bereich des Quellcodes.

Wichtig ist, dass das Custom Field nach der Installation aktiviert wird.

add a contact person via custom field - activate the plugin

Beim Anlegen eines Custom Fields im Joomla Backend werden die Typen aller aktivierte Plugins angeboten.

add a contact person via custom field - create custom field

When creating an item, the contact can now be selected via the Custom Field form field.

A custom field is not limited to the com_content extension. It can be used in any component that supports custom fields.

add a contact person via custom field - fill custom field in backend

The following image shows the display of the custom field in the frontend, if the display has not been changed via override.

add a contact person via custom field - view of custom field in frontend

Content Plugin

Auch ein Content Plugin muss installiert werden. Deshalb beginnen wir auch hier mit dem Installationsmanifest.

// https://codeberg.org/astrid/j/raw/branch/main/pkg_agpledges/j4/pkg_agpledges/src/plugins/content/loadcontact/loadcontact.xml

<?xml version="1.0" encoding="utf-8"?>
<extension type="plugin" group="content" method="upgrade">
    <name>plg_content_loadcontact</name>
	<author>Astrid Günther</author>
	<creationDate>##DATE##</creationDate>
	<copyright>(C) Astrid Günther. All rights reserved.</copyright>
	<license>GNU General Public License version 2 or later; see LICENSE.txt</license>
	<authorEmail>info@astrid-guenther.de</authorEmail>
	<authorUrl>www.astrid-guenther.de</authorUrl>
	<version>##VERSION##</version>
    <description>PLG_CONTENT_LOADCONTACT_XML_DESCRIPTION</description>
    <files>
        <filename plugin="loadcontact">loadcontact.php</filename>
        <folder>tmpl</folder>
    </files>
</extension>

// https://codeberg.org/astrid/j/raw/branch/main/pkg_agpledges/j4/pkg_agpledges/src/plugins/content/loadcontact/loadcontact.php

<?php
use Joomla\CMS\Factory;
use Joomla\CMS\Component\ComponentHelper;
use Joomla\CMS\Plugin\CMSPlugin;
use Joomla\CMS\Plugin\PluginHelper;

\defined('_JEXEC') or die;

class PlgContentLoadcontact extends CMSPlugin
{
	public function onContentPrepare($context, &$article, &$params, $page = 0)
	{
		if ($context === 'com_finder.indexer') {
			return;
		}

		if (strpos($article->text, 'loadcontact') === false) {
			return;
		}

		$regexcontid = '/{loadcontact\s([1-9][0-9]*)}/i';

		preg_match_all($regexcontid, $article->text, $matchescontid, PREG_SET_ORDER);

		if ($matchescontid) {
			foreach ($matchescontid as $match) {
				$id     = trim($match[1]);
				$output = $this->_loadcontid($id);

				if (($start = strpos($article->text, $match[0])) !== false) {
					$article->text = substr_replace($article->text, $output, $start, strlen($match[0]));
				}
			}
		}
	}

	protected function _loadcontid($id)
	{
		$app = Factory::getApplication();
		$factory = $app->bootComponent('com_contact')->getMVCFactory();
		$cparams = ComponentHelper::getParams('com_contact');

		$model = $factory->createModel('Contact', 'Site', ['ignore_request' => true]);

		// Get item
		$model->setState('params', $cparams);
		$contact = $model->getItem($id);

		if ($contact->published == 1) {
			ob_start();
			include PluginHelper::getLayoutPath('content', 'loadcontact');

			return (string)ob_get_clean();
		}
	}
}

// https://codeberg.org/astrid/j/raw/branch/main/pkg_agpledges/j4/pkg_agpledges/src/plugins/content/loadcontact/tmpl/default.php

<?php
use Joomla\CMS\String\PunycodeHelper;

\defined('_JEXEC') or die;
?>
<div class="plg-loadcontact card mb-3" itemscope itemtype="https://schema.org/Person">
	<div class="row g-0">
			<div class="col-md-4">Ansprechpartner:
			</div>
		<div class="<?php echo $col; ?>">
			<div class="card-body">
				<p class="card-title" itemprop="name"><?php echo $contact->name; ?></p>
				<?php if ($contact->con_position && $cparams->get('show_position')) : ?>
					<p class="contact-position" itemprop="jobTitle"><?php echo $contact->con_position; ?></p>
				<?php endif; ?>
				<?php if ($contact->address || $contact->suburb  || $contact->state || $contact->country || $contact->postcode || $contact->mobile || $contact->telephone || $contact->fax || $contact->email_to || $contact->webpage) : ?>
					<address class="plg-loadcontact__address" itemprop="address" itemscope itemtype="https://schema.org/PostalAddress">
						<?php if ($contact->address && $cparams->get('show_street_address')) : ?>
							<span class="contact-street" itemprop="streetAddress">
								<?php echo nl2br($contact->address, false); ?>
							</span><br />
						<?php endif; ?>

						<?php if ($contact->postcode && $cparams->get('show_postcode')) : ?>
							<span class="contact-postcode" itemprop="postalCode">
								<?php echo $contact->postcode; ?>
							</span>
						<?php endif; ?>

						<?php if ($contact->suburb && $cparams->get('show_suburb')) : ?>
							<span class="contact-suburb" itemprop="addressLocality">
								<?php echo $contact->suburb; ?>
							</span><br />
						<?php endif; ?>

						<?php if ($contact->state && $cparams->get('show_state')) : ?>
							<span class="contact-state" itemprop="addressRegion">
								<?php echo $contact->state; ?>
							</span><br />
						<?php endif; ?>

						<?php if ($contact->country && $cparams->get('show_country')) : ?>
							<span class="contact-country" itemprop="addressCountry">
								<?php echo $contact->country; ?>
							</span><br />
						<?php endif; ?>

						<?php if ($contact->mobile && $cparams->get('show_mobile')) : ?>
							<span class="contact-mobile" itemprop="telephone">
								<?php echo $contact->mobile; ?>
							</span>
						<?php endif; ?>

						<?php if ($contact->telephone && $cparams->get('show_telephone')) : ?>
							<span class="contact-telephone" itemprop="telephone">
								<?php echo $contact->telephone; ?>
							</span><br />
						<?php endif; ?>

						<?php if ($contact->fax && $cparams->get('show_fax')) : ?>
							<span class="contact-fax" itemprop="faxNumber">
								<?php echo $contact->fax; ?>
							</span><br />
						<?php endif; ?>

						<?php if ($contact->email_to && $cparams->get('show_email')) : ?>
							<p class="contact-emailto" itemprop="email">
								<?php echo $contact->email_to; ?>
							</p>
						<?php endif; ?>

						<?php if ($contact->webpage && $cparams->get('show_webpage')) : ?>
							<p class="contact-webpage">
								<a href="<?php echo $contact->webpage; ?>" target="_blank" rel="noopener noreferrer" itemprop="url">
									<?php echo PunycodeHelper::urlToUTF8($contact->webpage); ?>
								</a>
							</p>
						<?php endif; ?>
					</address>
				<?php endif; ?>
			</div>
		</div>
	</div>
</div>

Last but not least bieten wir zwei Dateien, die die Übersetzung in verschiedene Sprachen vereinfachen.

Mehr Informationen zu Sprachdateien habe ich unter “Sprachdateien nutzen”[^blog.astrid-guenther.de/sprachdateien-nutzen/] geschrieben.

// https://codeberg.org/astrid/j/raw/branch/main/pkg_agpledges/j4/pkg_agpledges/src/plugins/content/loadcontact/language/en-GB/plg_content_loadcontact.ini

PLG_CONTENT_LOADCONTACT="Content - Load Contact"
PLG_CONTENT_LOADCONTACT_XML_DESCRIPTION="Within content this plugin loads a Contact by ID, Syntax: {loadcontact 1}. It display contact information (position, address, phone number, etc.) as defined in the contact component. The default layout is a Bootstrap card, but it can be overwritten by a template override."

// https://codeberg.org/astrid/j/raw/branch/main/pkg_agpledges/j4/pkg_agpledges/src/plugins/content/loadcontact/language/en-GB/plg_content_loadcontact.sys.ini

PLG_CONTENT_LOADCONTACT="Content - Load Contact"
PLG_CONTENT_LOADCONTACT_XML_DESCRIPTION="Within content this plugin loads a Contact by ID, Syntax: {loadcontact 1}. It display contact information (position, address, phone number, etc.) as defined in the contact component. The default layout is a Bootstrap card, but it can be overwritten by a template override."

add a contact person via content plugin - activate the plugin

add a contact person via content plugin - use code in content

add a contact person via content plugin - view in frontend