Monitor Reply

Support

Starter Templates

Permalink Browser Info Environment September 11, 2012 at 5:39 AM

Blocks by AJAX includes a standard starter template for those wishing to develop their own block templates. In most cases, creating a Blocks by AJAX template is as simple as inserting the original block view code where marked.

<?php defined('C5_EXECUTE') or die("Access Denied.");
/*
Blocks by AJAX starter template. 
Simply insering the guts of an existing template where it 
says ORIGINAL BLOCK CONTENT HERE will serve to create an 
ajax template for most bocks.
*/
$c = Page::getCurrentPage();
$blkah = Loader::Helper('blocks_by_ajax','jl_blocks_by_ajax');
if($blkah->regular_block($bID) ) {
if($c->isEditMode()) {
  echo $blkah->edit_mode_marker();
}
/* 
ORIGINAL BLOCK CONTENT HERE

Viewing 15 lines of 19 lines. View entire code block.

 
<?php defined('C5_EXECUTE') or die("Access Denied.");
 
/*
Blocks by AJAX starter template. 
 
Simply insering the guts of an existing template where it 
says ORIGINAL BLOCK CONTENT HERE will serve to create an 
ajax template for most bocks.
*/
 
$c = Page::getCurrentPage();
$blkah = Loader::Helper('blocks_by_ajax','jl_blocks_by_ajax');
if($blkah->regular_block($bID) ) {
if($c->isEditMode()) {
  echo $blkah->edit_mode_marker();
}
 
/* 
ORIGINAL BLOCK CONTENT HERE 
*/
 
} else {
  echo $blkah->ajax_loader($bID, $c->getCollectionID());
}

This starter template is included with the addon and is also attached here.

1 Attachment

Type:	Discussion
Status:	Archived

JohntheFish replied on Sep 11, 2012 at 5:51 am Permalink Reply 1 Attachment

For addon developers who would like to distribute a Blocks by AJAX template with the addon, the starter template also needs to test whether Blocks by AJAX is installed, as per the following package starter template.

<?php  defined('C5_EXECUTE') or die("Access Denied.");
/*
Blocks by AJAX starter template FOR DEVELOPERS TO USE WHEN
PACKAGING a Blocks by AJAX template with an addon block
*/
$rq_pkg  = Package::getByHandle('jl_blocks_by_ajax');
$c = Page::getCurrentPage();
/*
Blocks By AJAX is not installed - edit mode - leave a message
*/
if (empty($rq_pkg) && $c->isEditMode()){
  ?>
  <div class="ccm-edit-mode-disabled-item"><div style="padding:8px 0px;">
    <?php
      echo t('The \'Blocks by AJAX\' addon IS REQUIRED FOR THIS TEMPLATE TO WORK');

Viewing 15 lines of 38 lines. View entire code block.

 
<?php  defined('C5_EXECUTE') or die("Access Denied.");
 
/*
Blocks by AJAX starter template FOR DEVELOPERS TO USE WHEN
PACKAGING a Blocks by AJAX template with an addon block
*/
$rq_pkg  = Package::getByHandle('jl_blocks_by_ajax');
$c = Page::getCurrentPage();
 
/*
Blocks By AJAX is not installed - edit mode - leave a message
*/
if (empty($rq_pkg) && $c->isEditMode()){
  ?>
  <div class="ccm-edit-mode-disabled-item"><div style="padding:8px 0px;">
    <?php
      echo t('The \'Blocks by AJAX\' addon IS REQUIRED FOR THIS TEMPLATE TO WORK');
    ?>
  </div></div>
  <?php
 
/*
Blocks By AJAX is installed, so
*/
} else {
  /*
  See note above about deliberately letting it give a php error
  */
  $blkah = Loader::Helper('blocks_by_ajax','jl_blocks_by_ajax');
  if($blkah->regular_block($bID) ) {
    if($c->isEditMode()) {
      echo $blkah->edit_mode_marker();
    } else {
 
    /*
    ORIGINAL BLOCK CONTENT HERE
    */
 
    }
  } else {
    echo $blkah->ajax_loader($bID, $c->getCollectionID());
  }
}

If Blocks by AJAX is not installed, in edit mode an error message is shown. In normal display it is deliberately left to give a code error about the missing object/method (seems like the best way to get the editing user's attention).

From v1.1 this code is also included with the Blocks by AJAX package and is also attached here.

Blocks by AJAX (c5.6)

Support

Starter Templates

Issue Reply

concrete5 Environment Information

Browser User-Agent String

Hide Post Content

Request Refund

Code

Delete Post