ToolHint Class Reference

Inherits DataItem.

Public Member Functions
	isHidden ()
	setHidden ($hidden=true)

Static Public Member Functions
static	findToolHint ($code)

Public Attributes
	$table = "tool_hint"
	$primary_key = "hint_id"
	$fields

Detailed Description

Definition at line 39 of file tool_hint.inc.

Member Function Documentation

findToolHint()

static ToolHint::findToolHint (   $code )

static

Definition at line 51 of file tool_hint.inc.

     {
          return Query::create(ToolHint, "WHERE code=:c")
                         ->bind(":c", $code)
                         ->executeSingle();
     }

isHidden()

ToolHint::isHidden

(

)

Definition at line 58 of file tool_hint.inc.

     {
          global $user;
          
          try
          {
               $status = Query::create(ToolHintUserStatus, "WHERE hint_id=:h AND user_id=:u")
                                ->bind(":h", $this->hint_id, ":u", $user->get($user->getPrimaryKey()))
                                ->executeSingle();
               
               return $status->hidden;
          }
          catch(DataNotFoundException $e)
          {
               return false;
          }
     }

setHidden()

ToolHint::setHidden

(

$hidden = true

)

Definition at line 76 of file tool_hint.inc.

     {
          global $user;
          $status = null;
          
          try
          {
               $status = Query::create(ToolHintUserStatus, "WHERE hint_id=:h AND user_id=:u")
               ->bind(":h", $this->hint_id, ":u", $user->get($user->getPrimaryKey()))
               ->executeSingle();
          }
          catch(DataNotFoundException $e)
          {
               $status = new ToolHintUserStatus();
               $status->hint_id = $this->hint_id;
               $status->user_id = $user->get($user->getPrimaryKey());
          }
 
          $status->hidden = $hidden;
          $status->save();
     }

Member Data Documentation

$fields

ToolHint::$fields

Initial value:

= array("hint_id"        =>   Number,
                              "code"              =>   String,
                              "title"             =>   String,
                              "hint"              =>   HTML,
                              "can_be_hidden"     =>   Boolean,
                              "read_access"  =>   String)

Definition at line 44 of file tool_hint.inc.

$primary_key

ToolHint::$primary_key = "hint_id"

Definition at line 42 of file tool_hint.inc.

$table

ToolHint::$table = "tool_hint"

Definition at line 41 of file tool_hint.inc.

---

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

• C:/code/cms.sonjara.com/cms/components/tool_hints/datamodel/tool_hint.inc