View source for Applying custom module chrome/de

<noinclude><languages /></noinclude> <includeonly>==Applying custom Module chrome==</includeonly>
Um benutzerdefinierten Module Chrome in einem Template zu definieren, muss eine Datei mit dem Namen modules.php in dem Verzeichnis html des Templates erstellt werden. Das könnte zum Beispiel PATH_TO_JOOMLA/templates/TEMPLATE_NAME/html/modules.php sein.

In dieser Datei sollte eine Funktion mit dem Namen <code>modChrome_STYLE</code> definiert werden, wobei '<code>STYLE</code>' der Name des benutzerdefinierten Moduls Chrome ist.  Diese Funktion übernimmt, wie gezeigt, drei Argumente, <code>$module</code>, <code>&$params</code> und <code>&$attribs</code>:

<source lang="php">
<?php 
  function modChrome_STYLE( $module, &$params, &$attribs ) 
  {
    /* chromed Modulausgabe folgt hier */
  }
?>
</source>

Innerhalb dieser Funktion können alle verfügbaren Moduleigenschaften (d.h. die Felder in der Tabelle <code>jos_modules</code> in der Joomla-Datenbank auf dem Server) für dieses Modul verwendet werden. Die am Wichtigsten benötigten sind vermutlich <code>$module->content</code>, <code>$module->showtitle</code> und <code>$module->title</code>. <code>$module->showtitle</code> ist eine boolesche Variable, ist also entweder ''true'' (wenn der Modultitel '''angezeigt''' werden soll) oder ''false'' (wenn er '''nicht angezeigt''' werden soll). <code>$module->content</code> und <code>$module->title</code> geben den Hauptmodulinhalt bzw. den Modultitel zurück.

Die Funktion ist eine normale PHP-Funktion und kann daher jeden normalen PHP-Code verwenden. Ein gängiges Beispiel ist die Verwendung einer <code>if</code>-Anweisung, um den Wert von <code>$module->showtitle</code> zu prüfen und dann den Titel entsprechend einzubinden oder nicht:

<source lang="php">
<?php
  if ($module->showtitle) 
  {
    echo '<h2>' .$module->title .'</h2>';
  }
?>
</source>

Der Zugriff auf die Modulparameter erfolgt über das Objekt <code>$params</code>.  So ist es z.B. möglich, einem Modul im Backend der Joomla!-Seite ein ''Modulklassensuffix'' zuzuweisen; dieses wird dann in den Parametern für dieses Modul als <code>moduleclass_sfx</code> gespeichert. Um ein <code>&lt;div&gt;</code> mit einer <code>Klasse</code> zu erstellen, die durch das Modulklassensuffix bestimmt wird, würde man folgendes verwenden:

<source lang="php">
<div class="<?php echo $params->get( 'moduleclass_sfx' ); ?>">
  <!-- div contents -->
</div>
</source>

=== Benutzerdefinierte Chrom-Attribute ===
Es ist auch möglich, weitere Attribute an die Funktion Modul Chrome zu übergeben, indem Sie die gleiche <code><jdoc:include /></code>-Anweisung verwenden, die das Modul Chrome setzt. Diese zusätzlichen Attribute können beliebig sein und werden in dem Array <code>$attribs</code> gespeichert.  Das folgende Beispiel zeigt die Funktion "Module chrome":

<source lang="php">
<?php
  function modChrome_custom( $module, &$params, &$attribs ) {
    if (isset( $attribs['headerLevel'] )) 
    {
      $headerLevel = $attribs['headerLevel'];
    } else {
      $headerLevel = 3;
    }

    if (isset( $attribs['background'] )) 
    {
      $background = $attribs['background'];
    } else {
      $background = 'blue';
    }

    echo '<div class="' .$params->get( 'moduleclass_sfx' ) .'" >';

    if ($module->showtitle) 
    {
      echo '<h' .$headerLevel .'>' .$module->title .'</h' .$headerLevel .'>';
    }

    echo '<div class="' .$background .'">';
    echo $module->content;
    echo '</div>';

    echo '</div>';
  }
?>
</source>

Man würde dann die Werte für <code>background</code> und <code>headerLevel</code> in der <code><jdoc:include /></code>-Anweisung wie unten gezeigt setzen.  Wenn keine Werte gesetzt werden, sind die Attribute standardmäßig auf "blau" bzw. "3" eingestellt.

{| class="wikitable"
|+ Übergabe von Attributen an Modul Chrome von <code><jdoc:include /></code>
! <code><jdoc:include /></code>Anweisung
! Ausgabe
|-
|
<code><jdoc:include type="modules" name="user1" style="custom" /></code>
|
<source lang="html4strict">
<div>
  <h3><!-- Module title --></h3>

  <div class="blue">
    <!-- Module content -->
  </div>
</div>
</source>
|-
|
<code><jdoc:include type="modules" name="user1" style="custom" background="green" /></code>
|
<source lang="html4strict">
<div>
  <h3><!-- Module title --></h3>

  <div class="green">
    <!-- Module content -->
  </div>
</div>
</source>
|-
|
<code><jdoc:include type="modules" name="user1" style="custom" headerLevel="1" background="yellow" /></code>
|
<source lang="html4strict">
<div>
  <h1><!-- Module title --></h1>

  <div class="yellow">
    <!-- Module content -->
  </div>
</div>
</source>
|}
Weitere Informationen zur Übergabe von Attributen an Modul chrome sind unter [[jtopic:115953]] zu finden.
<noinclude>
[[Category:Advanced]]
[[Category:Modules]]
[[Category:Template Development]]
[[Category:Template Reference]]
</noinclude>