OnlineHelpHelper Class Reference

Static Public Member Functions
static	formatHelpPageContent ($helpPage)
static	formatParentOptions ($helpBook, $helpPage)
static	formatSubpages ($helpPage)
static	buildRootPageTable ($pages, $help_book_id)
static	buildPageTable ($pages, $help_book_id)

Detailed Description

Definition at line 8 of file online_help_helper.inc.

Member Function Documentation

buildPageTable()

static OnlineHelpHelper::buildPageTable (   $pages,   $help_book_id  )

static

Definition at line 67 of file online_help_helper.inc.

     {
          $table = new DataListView($pages, "help_pages");
          $table->column("Help Page", "<a href='help_page_form?help_page_id={help_page_id}&help_book_id={help_book_id}'>{title}</a>")
               ->column("Identifier", "{identifier}", false, "width: 25%")
               ->column("Content", array(OnlineHelpHelper, formatHelpPageContent), false, "width: 30%")
               ->column("Subpages", array(OnlineHelpHelper, formatSubPages), false, "width: 20%")
               ->column("Public", "{public:Yes/No}", false, "text-align: center; width: 15%")
               ;
          
          if(count($pages) > 1)
          {
               $table->enableDragReorder("/action/online_help/reorder_help_pages?help_book_id=$help_book_id");
               $table->dragText = "<span style='font-size: 10px'>Click and drag to change the order of the help pages</span>";
          }
          $table->filter = false;
          $table->sortable = false;
          $table->paginate = false;     
 
          return $table;
     }

buildRootPageTable()

static OnlineHelpHelper::buildRootPageTable (   $pages,   $help_book_id  )

static

Definition at line 50 of file online_help_helper.inc.

     {
          $nodes = array();
          if(count($pages))
          {
               foreach($pages as $page)
               {
                    if(!$page->parent_id)
                    {
                         $nodes[] = $page;
                    }
               }
          }
          
          return OnlineHelpHelper::buildPageTable($nodes, $help_book_id);
     }

formatHelpPageContent()

static OnlineHelpHelper::formatHelpPageContent (   $helpPage )

static

Definition at line 11 of file online_help_helper.inc.

     {
          return ellipsis(stripHTML($helpPage->content), 100, true);
     }

formatParentOptions()

static OnlineHelpHelper::formatParentOptions (   $helpBook,   $helpPage  )

static

Definition at line 16 of file online_help_helper.inc.

     {
          if($helpPage->identifier)
          {
               $constraint = "WHERE identifier != '{$helpPage->identifier}'";
          }
          $helpPages = $helpBook->Pages("$constraint ORDER BY sort_order");
          $options = array();
          
          $options[0] = "";
          if(count($helpPages))
          {
               foreach($helpPages as $hp)
               {
                    if($helpPage->identifier && $hp->isChildOf($helpPage)) continue;
                    $options[$hp->help_page_id] = $hp->title;
               }
          }    
     
          return $options;
     }

formatSubpages()

static OnlineHelpHelper::formatSubpages (   $helpPage )

static

Definition at line 38 of file online_help_helper.inc.

     {
          $children = $helpPage->Children();
          
          if(count($children))
          {
               return formatItems($children, "<a style='display: inline' href='help_page_form?help_book_id={help_book_id}&help_page_id={help_page_id}'>{title}</a>", ", ");
          }
          
          return "None";
     }

---

The documentation for this class was generated from the following file:

• C:/code/cms.sonjara.com/cms/components/online_help/online_help_helper.inc