Actions

Difference between revisions of "Applying custom module chrome"

From Joomla! Documentation

m
(Custom chrome attributes)
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
===== Applying custom Module chrome =====
+
<includeonly>==Applying custom Module chrome==</includeonly>
 +
To define custom Module chrome in your template you need to create a file called modules.php in your template html directory.  For example, this might be PATH_TO_JOOMLA/templates/TEMPLATE_NAME/html/modules.php.
  
To define custom Module chrome in your template you need to create a file called modules.php in your template html directoryFor example, this might be [path-to-Joomla!]/templates/my_template/html/modules.php.
+
In this file you should define a function called <code>modChrome_STYLE</code> where '<code>STYLE</code>' is the name of your custom Module chrome.  This function will take three arguments, <code>$module</code>, <code>&$params</code>, and <code>&$attribs</code>, as shown:
  
In this file you should define a function called modChrome_style where "style" is the name of your custom Module chrome.  This function will take three arguments:
+
<source lang="php">
 +
<?php
 +
  function modChrome_STYLE( $module, &$params, &$attribs )
 +
  {
 +
    /* chromed Module output goes here */
 +
  }
 +
?>
 +
</source>
  
* the module object;
+
Within this function you can make use of any of the available Module properties (i.e. the fields in the <code>jos_modules</code> table in the Joomla! database on your server) for that Module, but the main ones you are likely to need are <code>$module->content</code>, <code>$module->showtitle</code> and <code>$module->title</code>.  <code>$module->showtitle</code> is a Boolean variable, so is either ''true'' (when the Module title '''should''' be shown) or ''false'' (when it '''shouldn't''' be shown). <code>$module->content</code> and <code>$module->title</code> will return the main Module content and the Module title respectively.
* a reference to the Module parameters array;
+
* a reference to the Module attribute array.
+
  
The function should echo the $module->content, wrapped in whatever chrome is requiredTo see how this is done look at the code for the standard Module chromes in [path-to-Joomla!]/templates/system/html/modules.php.
+
The function is a normal PHP function and so can use any regular PHP codeOne common example is to use an <code>if</code> statement to check the value of <code>$module->showtitle</code>, and then include the title or not accordingly:
  
Note that this makes it possible to pass parameters from the <jdoc:include> into the Module chrome function.  See: [[jforum:115953]]
+
<source lang="php">
<noinclude>[[Category:Advanced]][[Category:Modules]][[Category:Templates]][[Category:Topics]]</noinclude>
+
<?php
 +
  if ($module->showtitle)
 +
  {
 +
    echo '<h2>' .$module->title .'</h2>';
 +
  }
 +
?>
 +
</source>
 +
 
 +
The Module parameters are accessed using the <code>$params</code> object.  For example, it is possible to assign a ''Module class suffix'' to a Module in the backend of your Joomla! site; this is then stored in the parameters for that Module as <code>moduleclass_sfx</code>.  To create a <code>&lt;div&gt;</code> with  a <code>class</code> determined by the Module class suffix, you would use:
 +
 
 +
<source lang="php">
 +
<div class="<?php echo $params->get( 'moduleclass_sfx' ); ?>">
 +
  <!-- div contents -->
 +
</div>
 +
</source>
 +
 
 +
=== Custom chrome attributes ===
 +
It is also possible to pass further attributes into the Module chrome function using the same <code><jdoc:include /></code> statement that sets the Module chrome. These additional attributes can be anything you like, and are stored in the <code>$attribs</code> array.  Take the following example Module chrome function:
 +
 
 +
<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>
 +
 
 +
You would then set the values for <code>background</code> and <code>headerLevel</code> in the <code><jdoc:include /></code> statement as shown belowIf no values are set, the attributes default to 'blue' and '3' respectively.
 +
 
 +
{| class="wikitable"
 +
|+ Passing attributes to Module chrome from <code><jdoc:include /></code>
 +
! <code><jdoc:include /></code> statement
 +
! Output
 +
|-
 +
|
 +
<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>
 +
|}
 +
Further information about passing attributes to Module chrome can be found in [[jtopic:115953]].
 +
<noinclude>
 +
[[Category:Advanced]]
 +
[[Category:Modules]]
 +
[[Category:Templates]]
 +
[[Category:Topics]]</noinclude>

Revision as of 21:09, 23 April 2009

To define custom Module chrome in your template you need to create a file called modules.php in your template html directory. For example, this might be PATH_TO_JOOMLA/templates/TEMPLATE_NAME/html/modules.php.

In this file you should define a function called modChrome_STYLE where 'STYLE' is the name of your custom Module chrome. This function will take three arguments, $module, &$params, and &$attribs, as shown:

<?php 
  function modChrome_STYLE( $module, &$params, &$attribs ) 
  {
    /* chromed Module output goes here */
  }
?>

Within this function you can make use of any of the available Module properties (i.e. the fields in the jos_modules table in the Joomla! database on your server) for that Module, but the main ones you are likely to need are $module->content, $module->showtitle and $module->title. $module->showtitle is a Boolean variable, so is either true (when the Module title should be shown) or false (when it shouldn't be shown). $module->content and $module->title will return the main Module content and the Module title respectively.

The function is a normal PHP function and so can use any regular PHP code. One common example is to use an if statement to check the value of $module->showtitle, and then include the title or not accordingly:

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

The Module parameters are accessed using the $params object. For example, it is possible to assign a Module class suffix to a Module in the backend of your Joomla! site; this is then stored in the parameters for that Module as moduleclass_sfx. To create a <div> with a class determined by the Module class suffix, you would use:

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

Custom chrome attributes

It is also possible to pass further attributes into the Module chrome function using the same <jdoc:include /> statement that sets the Module chrome. These additional attributes can be anything you like, and are stored in the $attribs array. Take the following example Module chrome function:

<?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>';
  }
?>

You would then set the values for background and headerLevel in the <jdoc:include /> statement as shown below. If no values are set, the attributes default to 'blue' and '3' respectively.

Passing attributes to Module chrome from <jdoc:include />
<jdoc:include /> statement Output

<jdoc:include type="modules" name="user1" style="custom" />

<div>
  <h3><!-- Module title --></h3>
 
  <div class="blue">
    <!-- Module content -->
  </div>
</div>

<jdoc:include type="modules" name="user1" style="custom" background="green" />

<div>
  <h3><!-- Module title --></h3>
 
  <div class="green">
    <!-- Module content -->
  </div>
</div>

<jdoc:include type="modules" name="user1" style="custom" headerLevel="1" background="yellow" />

<div>
  <h1><!-- Module title --></h1>
 
  <div class="yellow">
    <!-- Module content -->
  </div>
</div>

Further information about passing attributes to Module chrome can be found in jtopic:115953.