Inherits DataItem.

Public Member Functions
	HelpBook ()

	Parent ()

	Children ($constraint="ORDER BY sort_order, title")

	isChildOf ($helpPage)
	Whether this page is a child of the given page. More...

	HelpPage ()

Public Attributes
	$fields

	$relations

Detailed Description

Definition at line 39 of file help_page.inc.

Member Function Documentation

◆ Children()

HelpPage::Children ( $constraint = "ORDER BY sort_order, title" )

Definition at line 68 of file help_page.inc.

      {
           return Query::create(HelpPage, "WHERE parent_id=:id $constraint")
                          ->bind(":id", $this->help_page_id)
                          ->execute();
      }

◆ HelpBook()

HelpPage::HelpBook ( )

Definition at line 56 of file help_page.inc.

      {
           return $this->getRelated(HelpBook);
      }

◆ HelpPage()

HelpPage::HelpPage ( )

Definition at line 97 of file help_page.inc.

      {
           $this->table = "help_page";
           $this->primary_key = "help_page_id";
           
           $this->DataItem(func_get_args());
      }

◆ isChildOf()

HelpPage::isChildOf ( $helpPage )

Whether this page is a child of the given page.

Parameters

obj $helpPage

Definition at line 80 of file help_page.inc.

      {
           $child = false;
           $currPage = clone $this;
           // walk up the tree to get all parents of the page
           while(isset($currPage) && !$child)
           {
                $currPage = $currPage->Parent();
                if($currPage->identifier == $helpPage->identifier)
                {
                     $child = true;
                }
           }
           
           return $child;
      }

◆ Parent()

HelpPage::Parent ( )

Definition at line 61 of file help_page.inc.

      {
           if (!$this->parent_id) return null;
           
           return $this->getRelated(HelpPage, "parent_id");
      }

Member Data Documentation

◆ $fields

HelpPage::$fields

Initial value:

= array("help_page_id"   =>   Number,
                              "help_book_id" =>   Number,
                              "parent_id"         =>   Number,
                              "title"             =>   String,
                              "identifier"   =>   String,
                              "content"      =>   HTML,
                              "sort_order"   =>   Number,
                              "public"       =>   Boolean)

Definition at line 42 of file help_page.inc.

◆ $relations

HelpPage::$relations