SharingManager Class Reference

Provides a central management class for event handlers and common functionality for the sharing component. More...

Public Member Functions
	SharingManager ()

Static Public Member Functions
static	setDefaults ()
static	getShareHandler ($type)
static	registerShareHandler ($type, $handler)
static	registerSectionContentManager ()
static	drawShare ($token)
static	shareItem ($item)
	Creates a ShareToken for the specified item. More...
static	embedSharedItem ($template)
static	getURL ($token)
static	formatStatusToggle ($token)
static	upgradeComponent ($version)

Static Public Attributes
static	$shareHandlerMap = null

Detailed Description

Provides a central management class for event handlers and common functionality for the sharing component.

Definition at line 20 of file sharing_manager.inc.

Member Function Documentation

drawShare()

static SharingManager::drawShare (   $token )

static

Definition at line 60 of file sharing_manager.inc.

     {
          global $user;
          
          $share = ShareToken::getShare($token);
          if (!$share->active)
          {
               throw new FakoliException("This shared item is no longer available");
          }
          
          $handler = SharingManager::getShareHandler($share->item_type);
          $handler->draw($share->item_key);
          
          $access = new ShareAccess();
          $access->share_id = $share->share_id;
          $access->user_id = $user ? $user->user_id : 0;
          $access->access_timestamp = now();
          $access->ip_address = $_SERVER["REMOTE_ADDR"];
          $access->save();
     }

embedSharedItem()

static SharingManager::embedSharedItem (   $template )

static

Definition at line 106 of file sharing_manager.inc.

     {
          $match = [];
          while(preg_match("/\\[share:(.*?)\\]/", $template, $match))
          {
               $id = $match[1];
               
               $token = ShareToken::getShare($id);
               
               if (!$token) continue;
               
               ob_start();
               
               $handler = SharingManager::getShareHandler($token->item_type);
               $handler->draw($token->item_key);
               
               $out = ob_get_contents();
               ob_end_clean();
               $template = str_replace($match[0], $out, $template);
          }
          
          return $template;
     }

formatStatusToggle()

static SharingManager::formatStatusToggle (   $token )

static

Definition at line 141 of file sharing_manager.inc.

     {
          if ($token->active)
          {
               $out = $token->format("<a href='#' data-share_id='{share_id}' class='share_enabled' onclick='SharingManager.toggleStatus(this); return false;'><i class='icon-ok'></i> Enabled</a>");
          }
          else
          {
               $out = $token->format("<a href='#' data-share_id='{share_id}' class='share_disabled' onclick='SharingManager.toggleStatus(this); return false;'><i class='icon-cancel'></i> Disabled</a>");
          }
          
          return $out;
     }

getShareHandler()

static SharingManager::getShareHandler (   $type )

static

Definition at line 34 of file sharing_manager.inc.

     {
          if (!SharingManager::$shareHandlerMap)
          {
               SharingManager::$shareHandlerMap = array();
               ComponentManager::fireEvent("RegisterShareHandlers");
          }
          
          if (!isset(SharingManager::$shareHandlerMap[$type]))
          {
               throw new FakoliException("Unknown share handler");
          }
          
          return SharingManager::$shareHandlerMap[$type];
     }

getURL()

static SharingManager::getURL (   $token )

static

Definition at line 130 of file sharing_manager.inc.

     {
          global $config;
          
          $sharing = Query::create('Section', "WHERE section_type='Sharing'")->execute();
          if (count($sharing) == 0) return "No Sharing Section";
          $sharing = $sharing[0];
          
          return "https://".$config['http_host']."/".$sharing->section."/".$token->token;
     }

registerSectionContentManager()

static SharingManager::registerSectionContentManager ( )

static

Definition at line 55 of file sharing_manager.inc.

     {
          SectionContentManagerMap::registerManager("Sharing", new SharingContentManager());
     }

registerShareHandler()

static SharingManager::registerShareHandler (   $type,   $handler  )

static

Definition at line 50 of file sharing_manager.inc.

     {
          SharingManager::$shareHandlerMap[$type] = $handler;
     }

setDefaults()

static SharingManager::setDefaults ( )

static

Definition at line 29 of file sharing_manager.inc.

     {
          //TODO: Set default configuration parameters here
     }

shareItem()

static SharingManager::shareItem (   $item )

static

Creates a ShareToken for the specified item.

Parameters

DataItem

$item

the item to be shared

Definition at line 85 of file sharing_manager.inc.

     {
          global $user;
          
          $type = get_class($item);
          SharingManager::getShareHandler($type); // Trigger an exception if the item is not a registered type
          
          $token = new ShareToken();
          $token->token = plainGUID();
          $token->item_type = $type;
          $token->item_key = $item->getPrimaryKeyValue();
          $token->user_id = $user->user_id;
          $token->created_date = now();
          $token->last_updated = now();
          $token->last_updated_by_id = $user->user_id;
          $token->active = true;
          $token->save();
          
          return $token;
     }

SharingManager()

SharingManager::SharingManager

(

)

Definition at line 24 of file sharing_manager.inc.

     {
 
     }

upgradeComponent()

static SharingManager::upgradeComponent (   $version )

static

Definition at line 155 of file sharing_manager.inc.

     {
          $mgr = new SharingUpgradeManager();
          $mgr->upgrade($version);
     }

Member Data Documentation

$shareHandlerMap

SharingManager::$shareHandlerMap = null

static

Definition at line 22 of file sharing_manager.inc.

---

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

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