HelpBook Class Reference

Inherits DataItem.

Public Member Functions
	Pages ($constraint="ORDER BY sort_order")
	findPage ($identifier)
	HelpBook ()

Static Public Member Functions
static	findByIdentifier ($identifier)

Public Attributes
	$fields
	$relations

Detailed Description

Definition at line 39 of file help_book.inc.

Member Function Documentation

findByIdentifier()

static HelpBook::findByIdentifier (   $identifier )

static

Definition at line 60 of file help_book.inc.

     {
          return Query::create(HelpBook, "WHERE identifier=:id")
                         ->bind(":id", $identifier)
                         ->executeSingle();
     }

findPage()

HelpBook::findPage

(

$identifier

)

Definition at line 67 of file help_book.inc.

     {
          $pages = Query::create(HelpPage, "WHERE help_book_id=:book_id AND identifier=:id")
                           ->bind(":book_id", $this->help_book_id, ":id", $identifier)
                           ->execute();
                           
          if (count($pages) > 0) return $pages[0];
          
          return null;
     }

HelpBook()

HelpBook::HelpBook

(

)

Definition at line 78 of file help_book.inc.

     {
          $this->table = "help_book";
          $this->primary_key = "help_book_id";
          
          $this->DataItem(func_get_args());
     }

Pages()

HelpBook::Pages

(

$constraint = "ORDER BY sort_order"

)

Definition at line 55 of file help_book.inc.

     {
          return $this->getRelatedList(HelpPage, "", $constraint);    
     }

Member Data Documentation

$fields

HelpBook::$fields

Initial value:

= array("help_book_id"             =>   Number,
                              "title"                       =>   String,
                              "identifier"             =>   String,
                              "description"            =>   HTML,
                              "searchable"             =>   Boolean,
                              "remote"                 =>   Boolean,
                              "url"                         =>   String,
                              "additional_css_files"   =>   String)

Definition at line 42 of file help_book.inc.

$relations

HelpBook::$relations

Initial value:

= array("Pages"          =>   HelpPage,
               )

Definition at line 51 of file help_book.inc.

---

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

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