ShareToken Class Reference

Inherits DataItem.

Public Member Functions
	User ()
	Accesses ($constraint="ORDER BY access_timestamp")
	getTitle ()
	countViews ()

Static Public Member Functions
static	getShare ($token)
static	forObject ($obj)

Public Attributes
	$table = "share_token"
	$primary_key = "share_id"
	$fields
	$relations

Detailed Description

Definition at line 7 of file share_token.inc.

Member Function Documentation

Accesses()

ShareToken::Accesses

(

$constraint = "ORDER BY access_timestamp"

)

Definition at line 27 of file share_token.inc.

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

countViews()

ShareToken::countViews

(

)

Definition at line 38 of file share_token.inc.

     {
          return Query::create('ShareAccess', "WHERE share_id=:s")
                         ->bind(":s", $this->share_id)
                         ->count();
     }

forObject()

static ShareToken::forObject (   $obj )

static

Definition at line 64 of file share_token.inc.

     {
          $type = get_class($obj);
          $key = $obj->getPrimaryKeyValue();
          
          $matches = Query::create(ShareToken, "WHERE item_type=:t AND item_key=:k")
                              ->bind(":t", $type, ":k", $key)
                              ->execute();
          
          return count($matches) > 0 ? $matches[0] : null;
     }

getShare()

static ShareToken::getShare (   $token )

static

Definition at line 45 of file share_token.inc.

     {
          if (!checkPlainGUID($token))
          {
               throw new FakoliException("Invalid Token");
          }
          
          try
          {
               return Query::create(ShareToken, "WHERE token=:t")
                              ->bind(":t", $token)
                              ->executeSingle();
          }
          catch(DataNotFoundException $e)
          {
               throw new FakoliException("Token not found");
          }
     }

getTitle()

ShareToken::getTitle

(

)

Definition at line 32 of file share_token.inc.

     {
          $handler = SharingManager::getShareHandler($this->item_type);
          return $handler->getTitle($this->item_key);
     }

User()

ShareToken::User

(

)

Definition at line 26 of file share_token.inc.

{ return $this->getRelated('SiteUser'); }

Member Data Documentation

$fields

ShareToken::$fields

Initial value:

= array("share_id"                 =>   Number,
                              "token"                       =>   String,
                              "item_type"                   =>   String,
                              "item_key"                    =>   Number,
                              "active"                 =>   Boolean,
                              "user_id"                =>   Number,
                              "created_date"           =>   DateTime,
                              "last_updated"           =>   DateTime,
                              "last_updated_by_id"     =>   Number
     )

Definition at line 12 of file share_token.inc.

$primary_key

ShareToken::$primary_key = "share_id"

Definition at line 10 of file share_token.inc.

$relations

ShareToken::$relations

Initial value:

= array(  "User"         =>   'SiteUser',
                                   "Accesses"     =>   'ShareAccess')

Definition at line 23 of file share_token.inc.

$table

ShareToken::$table = "share_token"

Definition at line 9 of file share_token.inc.

---

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

• C:/code/cms.sonjara.com/cms/components/sharing/datamodel/share_token.inc