Developing (v7+)

Custom controller.php to add page types, add blocks, add content to blocks and add pages

Permalink 1 user found helpful August 28, 2012 at 11:48 AM

Hello all!

Thank you in advance for helping.
I've been working for 3 days in creating my own custom theme but now I've hit the wall.

So this is what I have so far in my controller.php:

<?php
defined('C5_EXECUTE') or die(_("Access Denied."));
class ThemeultimatePackage extends Package {
  protected $pkgHandle = 'theme_ultimate';
  protected $appVersionRequired = '5.5.2';
  protected $pkgVersion = '1.0';
  public function getPackageDescription() {
    return t("Installs the " . $this->getPackageName(). " theme.");
  }
  public function getPackageName() {
    return t("Theme ultimate");
  }
  public function install() {
    $pkg = parent::install();
    // Load stuff we need

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

 
<?php
 
defined('C5_EXECUTE') or die(_("Access Denied."));
 
class ThemeultimatePackage extends Package {
 
  protected $pkgHandle = 'theme_ultimate';
  protected $appVersionRequired = '5.5.2';
  protected $pkgVersion = '1.0';
 
  public function getPackageDescription() {
    return t("Installs the " . $this->getPackageName(). " theme.");
  }
 
  public function getPackageName() {
    return t("Theme ultimate");
  }
 
  public function install() {
    $pkg = parent::install();
    // Load stuff we need
    Loader::model('collection_types');
    Loader::model('collection_attributes');
    Loader::model('package');
    // Install theme
    PageTheme::add('ultimate', $pkg);
    // Install blocks
    BlockType::installBlockTypeFromPackage('heading_one', $pkg);
    BlockType::installBlockTypeFromPackage('heading_two', $pkg);
    BlockType::installBlockTypeFromPackage('heading_three', $pkg);
    BlockType::installBlockTypeFromPackage('news_home_page', $pkg);
    BlockType::installBlockTypeFromPackage('news_block', $pkg);
    BlockType::installBlockTypeFromPackage('contact_method_box_phone', $pkg);
    BlockType::installBlockTypeFromPackage('contact_method_box', $pkg);
    // Install  page types
    $ct = CollectionType::getByHandle('home');
    if((!is_object($ct)) || ($ct->getCollectionTypeID() < 1)) {
      $data['ctHandle'] = 'home';
      $data['ctName'] = t('Home');
      $hpt = CollectionType::add($data, $pkg);
    }
    $ct = CollectionType::getByHandle('news');
    if((!is_object($ct)) || ($ct->getCollectionTypeID() < 1)) {
      $data['ctHandle'] = 'news';
      $data['ctName'] = t('News');
      $hpt = CollectionType::add($data, $pkg);
    }
    $ct = CollectionType::getByHandle('gallery');
    if((!is_object($ct)) || ($ct->getCollectionTypeID() < 1)) {
      $data['ctHandle'] = 'gallery';
      $data['ctName'] = t('Gallery');
      $hpt = CollectionType::add($data, $pkg);
    }
    $ct = CollectionType::getByHandle('contact');
    if((!is_object($ct)) || ($ct->getCollectionTypeID() < 1)) {
      $data['ctHandle'] = 'contact';
      $data['ctName'] = t('Contact');
      $hpt = CollectionType::add($data, $pkg);
    }
    $ct = CollectionType::getByHandle('internal_1_box');
    if((!is_object($ct)) || ($ct->getCollectionTypeID() < 1)) {
      $data['ctHandle'] = 'internal_1_box';
      $data['ctName'] = t('Internal 1 Box');
      $hpt = CollectionType::add($data, $pkg);
    }
    $ct = CollectionType::getByHandle('internal_3_boxes');
    if((!is_object($ct)) || ($ct->getCollectionTypeID() < 1)) {
      $data['ctHandle'] = 'internal_3_boxes';
      $data['ctName'] = t('Internal 3 Boxes');
      $hpt = CollectionType::add($data, $pkg);
    }
    // Add blocks
 
    $page = Page::getByID($pid);
    $block = BlockType::getByHandle('html');
    //set block data (differs for each block type... following is an example for the 'content' type)
    $data = array(
    'content' => '<p>test</p>',
    );
    /* $data = array(); */
    /* $data['content'] =' */
                                /* <h2>Hello World!</h2> */
/* '; */
    $page->addBlock($block, 'Main', $data);
 
  }
  public function uninstall(){
    parent::uninstall();
  }
}

So I've managed to achieve the following:
- Install my custom theme
- Install 7 custom blocks (heading_one, heading_two,etc...)
- Add 5 different page types (home,news,gallery,etc...)

So this is my first question. If I edit that controller.php file, do I have to Uninstall and Install the package to make the changes take effect?

Second question. Something I can't make it work is adding a block with some content.
In my header.php template I have

<?php $a = new GlobalArea('description'); $a->display($c); ?>

I would like to add a Content block with the text 'Add some content'
I know my code for adding a block doesn't work and I know that it makes reference to a HTML block in the Main area, but it's because I tried tried several things and now I'm completely lost.
I specially struggled getting the right value for the variable $page.

Third question is, how can I add some pages, again, using the controller.php, and assign them a page type?
Once again, I've tried several thins, read the docu, read the forum... but everything I tried didn't work at all.

Any help will be highly appreciated.

---- Summary ----
Using controller.php:
1- How to add a block to a Global Area
2- How to add some content to that added block
3- How to add pages to the template
4- How to assign a page type to the previously added pages.

Once again, thank you for helping.

Cheers

Rafael