Question

I want to minimize a repeated php code using function, I am a designer and now I am trying to learn PHP.
below code check if a Module block is active, and count blocks,

$TopCol1 = (int)($this->countModules('top-col-1') > 0);
$TopCol2 = (int)($this->countModules('top-col-2') > 0);
$TopCol3 = (int)($this->countModules('top-col-3') > 0);

$topColCount = $TopCol1 + $TopCol2 + $TopCol3;
if ($topColCount) : $TopColClass = 'count-' . $topColCount; 
endif;

Then below code will be processed

    <?php if ($topColCount) : ?>
    <div class="row">
        <?php if ($this->countModules('top-col-1')) : ?>    
        <div id="top-col" class="<?php echo $TopColClass ?> columns">
            <div class="panel">
                <jdoc:include type="modules" name="top-col-1" style="html5" />
            </div>
        </div>
        <?php endif ?>
        <?php if ($this->countModules('top-col-2')) : ?>    
        <div id="top-col" class="<?php echo $TopColClass ?> columns">
            <div class="panel">
                <jdoc:include type="modules" name="top-col-2" style="html5" />
            </div>
        </div>
        <?php endif ?>
        <?php if ($this->countModules('top-col-3')) : ?>    
        <div id="top-col" class="<?php echo $TopColClass ?> columns">
            <div class="panel">
                <jdoc:include type="modules" name="top-col-3" style="html5" />
            </div>
        </div>
        <?php endif ?>
    </div>
<?php endif ?>

I need to repeat this type of code many time in my template, please help me make a function that will create the blocks without repeating this codes again and again

Answer 1

While I don’t recommend the syntax, you can put raw HTML code inline inside a php function.

<?php
function code_block( $jdoc_name ) {
global $TopColClass;  //// for variables created outside the function to be visible inside it, we have to include them with "global"
?>
<div id="top-col" class="<?php echo $TopColClass; ?> columns">
        <div class="panel">
            <jdoc:include type="modules" name="<?php echo $jdoc_name; ?>" style="html5" />
        </div>
    </div>
<?php
}

$MODULES = array(
  'top-col-1',
  'top-col-2',
  'top-col-3',
);


//// ....


//// in the page body a foreach loop would also be a good idea:
foreach( (array)$MODULES as $module_name ) {
    if ($this->countModules( $module_name )) {
        code_block( $module_name );
    }
}


?>

---

EDIT, to solve as requested:

<?php
function code_block( $jdoc_name ) {
global $TopColClass;  //// for variables created outside the function to be visible inside it, we have to include them with "global"
?>
<div id="top-col" class="<?php echo $TopColClass; ?> columns">
        <div class="panel">
            <jdoc:include type="modules" name="<?php echo $jdoc_name; ?>" style="html5" />
        </div>
    </div>
<?php
}

function module( $prefix, $comma_seperated_suffixes ) {
    foreach( (array)explode( ",", $comma_seperated_suffixes ) as $suffix ) {
        $module_name = $prefix.trim($suffix);
        code_block( $module_name );
    }
}


//// shorter call, as requested :)
module("top-col-", "1,2,3");


?>

---

Final Edit, transformed into a class

<?php
class tovolt{
    function tovolt() {
        //// constructor function - used to setup default variable states, etc. - if this is omitted PHP may have a fit ( depending on version and config )
    }

    public static $TopColClass = 'default-value';

    function code_block( $jdoc_name ) {
?>
<div id="top-col" class="<?php echo self::$TopColClass; ?> columns">
        <div class="panel">
            <jdoc:include type="modules" name="<?php echo $jdoc_name; ?>" style="html5" />
        </div>
    </div>
<?php
    }

    function module( $prefix, $comma_seperated_suffixes ) {
        foreach( (array)explode( ",", $comma_seperated_suffixes ) as $suffix ) {
            $module_name = $prefix.trim($suffix);
            self::code_block( $module_name );
        }
    }
}


//// calling the class
tovolt::$TopColClass = 'new-value';                //// if you need to change: $TopColClass
tovolt::module("top-col-", "1,2,3");

?>