Developing (v7+)

Problem with Package Single Page Controller

Permalink September 28, 2011 at 7:03 PM

Hello again!

I'm trying to implement a package based upon the book "Concrete5 Beginner's Guide" and my singe page controller seems to be ignored. Specifically I have a "page_categories" package with the following single file layout:

page_categories -> controllers -> dashboard -> pages -> page_categories.php
page_categories -> single_pages -> dashboard -> pages -> page_categories.php

If I go to the "Pages" section of the dashboard, the single page appears, but I'm unable to see any data set in the controller and none of the Log::addEntry() calls are being executed in the controller making me think that it's not being run at all. Finally the helper I'm loading in the controller are not available in the single page. The controller looks like:

<?php
defined('C5_EXECUTE') or die(_("Access Denied."));
class DashboardPageCategoriesController extends Controller {
   public $helpers = array('form', 'html');
   public function view() {
      Log::addEntry('Calling $this->getCategories();');
      $categories = $this->getCategories();
      $this->set('categories', $categories);
   }
   public function getCategories() {
      $db = Loader::db();
      $categories = $db->GetAssoc('SELECT categoryID,category FROM btPageCategoriesCategories ORDER BY category');
      Log::addEntry('getCategories called!');
      return $categories;
   }

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

 
<?php
defined('C5_EXECUTE') or die(_("Access Denied."));
class DashboardPageCategoriesController extends Controller {
   public $helpers = array('form', 'html');
 
   public function view() {
      Log::addEntry('Calling $this->getCategories();');
      $categories = $this->getCategories();
      $this->set('categories', $categories);
   }
 
   public function getCategories() {
      $db = Loader::db();
      $categories = $db->GetAssoc('SELECT categoryID,category FROM btPageCategoriesCategories ORDER BY category');
      Log::addEntry('getCategories called!');
      return $categories;
   }
}

What could I be missing? I thought the controller was magically used if it had the same file name, non?

Thanks for any advice!

Alex

alexaalto replied on Sep 28, 2011 at 8:18 pm Permalink Reply

...so I'm trying to see if my controller is the controller being used to render this. I've put "var_dump($this);" in the php of the single page and get the following:

object(View)[3]
  private 'viewPath' => string '/dashboard/pages/page_categories' (length=32)
  public 'controller' => 
    object(Controller)[85]
      public 'theme' => null
      private 'sets' => 
        array
          empty
      protected 'helperObjects' => 
        array
          'html' => 
            object(HtmlHelper)[86]
              ...
      protected 'c' => 
        object(Page)[75]

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

 
object(View)[3]
  private 'viewPath' => string '/dashboard/pages/page_categories' (length=32)
  public 'controller' => 
    object(Controller)[85]
      public 'theme' => null
      private 'sets' => 
        array
          empty
      protected 'helperObjects' => 
        array
          'html' => 
            object(HtmlHelper)[86]
              ...
      protected 'c' => 
        object(Page)[75]
          protected 'blocksAliasedFromMasterCollection' => null
          public 'cID' => string '127' (length=3)
          protected 'attributes' => 
            array
              ...
          public 'error' => string '' (length=0)
          public 'pkgID' => string '4' (length=1)
          public 'cPointerID' => string '0' (length=1)
          public 'cPointerExternalLink' => null
          public 'cPointerExternalLinkNewWindow' => string '0' (length=1)
          public 'cFilename' => string '/dashboard/pages/page_categories.php' (length=36)
          public 'cDateAdded' => string '2011-09-28 13:38:08' (length=19)
          public 'cDisplayOrder' => string '5' (length=1)
          public 'cDateModified' => string '2011-09-28 13:38:08' (length=19)
          public 'cInheritPermissionsFromCID' => string '15' (length=2)
          public 'cInheritPermissionsFrom' => string 'PARENT' (length=6)
          public 'cOverrideTemplatePermissions' => string '1' (length=1)
          public 'cPendingAction' => null
          public 'cPendingActionUID' => null
          public 'cPendingActionTargetCID' => null
          public 'cPendingActionDatetime' => string '0000-00-00 00:00:00' (length=19)
          public 'cCheckedOutUID' => null
          public 'cIsTemplate' => string '0' (length=1)
          public 'uID' => string '1' (length=1)
          public 'cPath' => string '/dashboard/pages/page_categories' (length=32)
          public 'ctID' => string '0' (length=1)
          public 'ctHandle' => null
          public 'ctIcon' => null
          public 'ptID' => string '0' (length=1)
          public 'cParentID' => string '37' (length=2)
          public 'cChildren' => string '0' (length=1)
          public 'ctName' => null
          public 'cCacheFullPageContent' => string '-1' (length=2)
          public 'cCacheFullPageContentOverrideLifetime' => string '0' (length=1)
          public 'cCacheFullPageContentLifetimeCustom' => string '0' (length=1)
          public 'isMasterCollection' => string '0' (length=1)
          public 'vObj' => 
            object(CollectionVersion)[79]
              ...
      protected 'task' => string 'view' (length=4)
      protected 'parameters' => 
        array
          empty
      private 'restrictedMethods' => 
        array
          empty
      public 'helpers' => 
        array
          0 => string 'html' (length=4)
  private 'headerItems' => 
    array
      'CONTROLLER' => 
        array
          0 => 
            object(CSSOutputObject)[90]
              ...
          1 => 
            object(JavaScriptOutputObject)[92]
              ...
          2 => 
            object(CSSOutputObject)[97]
              ...
          3 => 
            object(JavaScriptOutputObject)[103]
              ...
  private 'themePaths' => 
    array
      '/dashboard' => string 'dashboard' (length=9)
      '/dashboard/*' => string 'dashboard' (length=9)
      '/page_forbidden' => string 'concrete' (length=8)
      '/page_not_found' => string 'concrete' (length=8)
      '/install' => string 'concrete' (length=8)
      '/login' => string 'concrete' (length=8)
      '/register' => string 'concrete' (length=8)
      '/maintenance_mode' => string 'concrete' (length=8)
  private 'areLinksDisabled' => boolean false
  private 'isEditingEnabled' => boolean true
  public 'error' => string '' (length=0)
  public 'c' => 
    object(Page)[75]
      protected 'blocksAliasedFromMasterCollection' => null
      public 'cID' => string '127' (length=3)
      protected 'attributes' => 
        array
          empty
      public 'error' => string '' (length=0)
      public 'pkgID' => string '4' (length=1)
      public 'cPointerID' => string '0' (length=1)
      public 'cPointerExternalLink' => null
      public 'cPointerExternalLinkNewWindow' => string '0' (length=1)
      public 'cFilename' => string '/dashboard/pages/page_categories.php' (length=36)
      public 'cDateAdded' => string '2011-09-28 13:38:08' (length=19)
      public 'cDisplayOrder' => string '5' (length=1)
      public 'cDateModified' => string '2011-09-28 13:38:08' (length=19)
      public 'cInheritPermissionsFromCID' => string '15' (length=2)
      public 'cInheritPermissionsFrom' => string 'PARENT' (length=6)
      public 'cOverrideTemplatePermissions' => string '1' (length=1)
      public 'cPendingAction' => null
      public 'cPendingActionUID' => null
      public 'cPendingActionTargetCID' => null
      public 'cPendingActionDatetime' => string '0000-00-00 00:00:00' (length=19)
      public 'cCheckedOutUID' => null
      public 'cIsTemplate' => string '0' (length=1)
      public 'uID' => string '1' (length=1)
      public 'cPath' => string '/dashboard/pages/page_categories' (length=32)
      public 'ctID' => string '0' (length=1)
      public 'ctHandle' => null
      public 'ctIcon' => null
      public 'ptID' => string '0' (length=1)
      public 'cParentID' => string '37' (length=2)
      public 'cChildren' => string '0' (length=1)
      public 'ctName' => null
      public 'cCacheFullPageContent' => string '-1' (length=2)
      public 'cCacheFullPageContentOverrideLifetime' => string '0' (length=1)
      public 'cCacheFullPageContentLifetimeCustom' => string '0' (length=1)
      public 'isMasterCollection' => string '0' (length=1)
      public 'vObj' => 
        object(CollectionVersion)[79]
          public 'cvIsApproved' => string '1' (length=1)
          public 'cID' => string '127' (length=3)
          protected 'attributes' => 
            object(AttributeValueList)[80]
              ...
          public 'customAreaStyles' => 
            array
              ...
          public 'layoutStyles' => 
            array
              ...
          public 'error' => string '' (length=0)
          public 'cvID' => string '1' (length=1)
          public 'cvIsNew' => string '0' (length=1)
          public 'cvHandle' => string 'page_categories' (length=15)
          public 'cvName' => string 'Page Categories' (length=15)
          public 'cvDescription' => null
          public 'cvDateCreated' => string '2011-09-28 13:38:08' (length=19)
          public 'cvDatePublic' => string '2011-09-28 13:38:08' (length=19)
          public 'cvAuthorUID' => string '1' (length=1)
          public 'cvApproverUID' => null
          public 'cvComments' => string 'Initial Version' (length=15)
          public 'cvIsMostRecent' => boolean true

The question is, should I see something identifying my controller (eg. btHandle) if it was being used?

alexaalto replied on Sep 28, 2011 at 8:21 pm Permalink Reply

...and can anyone verify that this directory structure is correct?

Alexs-MacBook-Pro:packages alex$ cd page_categories/
Alexs-MacBook-Pro:page_categories alex$ ls -l
total 8
drwxr-xr-x 3 alex alex 102 28 Sep 09:44 blocks
-rw-r--r-- 1 alex alex 698 28 Sep 13:38 controller.php
drwxr-xr-x 3 alex alex 102 28 Sep 09:51 controllers
drwxr-xr-x 2 alex alex 68 28 Sep 10:13 libraries
drwxr-xr-x 3 alex alex 102 28 Sep 09:51 single_pages
Alexs-MacBook-Pro:page_categories alex$ find controllers
controllers
controllers/dashboard
controllers/dashboard/page_categories.php
controllers/dashboard/pages
controllers/dashboard/pages/page_categories.php
Alexs-MacBook-Pro:page_categories alex$ find single_pages
single_pages
single_pages/dashboard
single_pages/dashboard/pages
single_pages/dashboard/pages/page_categories.php
Alexs-MacBook-Pro:page_categories alex$

I'm trying different locations for the controller to see if it helps.

alexaalto replied on Sep 28, 2011 at 9:12 pm Permalink Reply

...interestingly if I break the controller code by adding a syntax error, it does indeed breaks everything. So I guess it is being run? But then why doesn't the code:

$this->set('myvalue',"HELLO WORLD");

...does not show up in the view if I used:

echo $myvalue;

I'm starting to pull hair out - someone please help me save my hair!

alexaalto replied on Sep 29, 2011 at 12:37 pm Permalink Best Answer Reply

SOLUTION FOUND!

After tracing the code with Eclipse I see that line 470 in the loader.php is creating a name from the file PATH to be used as the class name. So in my case having the single page in "/dashboard/pages/page_categories" assumes the controller class name will be "DashboardPagesPageCategoriesController" by virtue if the line:

$class = Object::camelcase($path) . 'Controller';

Sadly I missed this in the book!

Alex

alexaalto replied on Sep 29, 2011 at 1:18 pm Permalink Reply

...as clearly noted in the documentation here:

http://www.concrete5.org/documentation/developers/pages/mvc-approac...

Forums

Developing (v7+)

Problem with Package Single Page Controller

Code

Post Reply

Delete Post

Mark Post as Spam

Destroy Spammer

Sign In?