ConnectableManager Class Reference

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

Public Member Functions
	ConnectableManager ()

Static Public Member Functions
static	setDefaults ()
static	onInitialize ()
static	registerConnectable ($connectable, $targets)
	Register a connectable class and the list of classes it can connect with. More...
static	getConnectableFromRequest ()
	Create and populate a Connectable DataItem based on its primary key as passed in on the requesting URL. More...
static	instantiate ($class, $id)
	Safely instantiate a Connectable. More...
static	canConnect ($source, $target)
	Determine whether two objects or classes can connect based on the registered connectable map. More...
static	connectionExists ($source, $target)
	Check whether a connection exists between the given source and target objects. More...
static	addConnection ($source, $target)
	Add a connection between the given source and target objects. More...
static	removeConnection ($source, $target)
	Remove any connection that exists between the source and target object (including back-links if they were created). More...
static	removeConnections ($source, $targetClass)
	Remove any connection that exists between the source and objects of the specified target class (including back-links if they were created). More...
static	removeAllConnections ($object)
	Remove all the connections to and from the given object. More...
static	getTargetClasses ($sourceItem)
	Return an array of connectable target classes for the specified item. More...
static	getConnectedItems ($sourceItem, $targetClass, $constraint="")
	Returns the connected items for the specified source that are of the specified class. More...
static	getConnectedItemCount ($sourceItem, $targetClass, $constraint="")
	Returns the number of connected items for the specified source that are of the specified class. More...
static	upgradeComponent ($version)

Static Public Attributes
static	$connectables = array()
	Connectable type map defining which items can be connected together. More...
static	$classLookup = array()
	Look-up table of connectable classes from their primary keys. More...
static	$contextRouter = ""

Detailed Description

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

Definition at line 25 of file connectable_manager.inc.

Member Function Documentation

addConnection()

static ConnectableManager::addConnection (   $source,   $target  )

static

Add a connection between the given source and target objects.

If the target object registered itself as connectable to the source object, then a back-link is automatically inserted.

Parameters

DataItem	$source	the source object
DataItem	$target	the target object

Definition at line 144 of file connectable_manager.inc.

     {
          if (ConnectableManager::connectionExists($source, $target)) return;
          
          $sourceDefn = ConnectableManager::$connectables[get_class($source)];
          $targetDefn = ConnectableManager::$connectables[get_class($target)];
          
          $sourceClass = get_class($source);
          $targetClass = get_class($target);
          
          if (!$sourceDefn || !$targetDefn)
          {
               throw new FakoliException("Attempt to link an object that is not a registered Connectable");
          }
           
          if (!ConnectableManager::canConnect($sourceClass, $targetClass))
          {
               throw new FakoliException("Cannot create a link between a $sourceClass and a $targetClass");
          }
 
          $record = new ConnectionRecord();
          $record->source_class = $sourceClass;
          $record->source_id = $source->get($source->getPrimaryKey());
          $record->target_class = $targetClass;
          $record->target_id = $target->get($target->getPrimaryKey());
          
          $record->save();
          
          if (ConnectableManager::canConnect($targetClass, $sourceClass))
          {
               // Also insert back-link
               $record = new ConnectionRecord();
               $record->source_class = $sourceClass;
               $record->source_id = $target->get($target->getPrimaryKey());
               $record->target_class = $targetClass;
               $record->target_id = $source->get($source->getPrimaryKey());
               
               $record->save();
          }         
     }

canConnect()

static ConnectableManager::canConnect (   $source,   $target  )

static

Determine whether two objects or classes can connect based on the registered connectable map.

Parameters

mixed	$source	either a Connectable DataItem or its class name
mixed	$target	either a Connectable DataItem or its class name

Returns

boolean true if the items can be connected, false otherwise

Definition at line 107 of file connectable_manager.inc.

     {
          if (is_object($source)) $source = get_class($source);
          if (is_object($target)) $target = get_class($target);
          
          $targets = ConnectableManager::getTargetClasses($source);
          
          foreach($targets as $t)
          {
               if ($t == $target) return true;
          }
          
          return false;
     }

ConnectableManager()

ConnectableManager::ConnectableManager

(

)

Definition at line 31 of file connectable_manager.inc.

     {
 
     }

connectionExists()

static ConnectableManager::connectionExists (   $source,   $target  )

static

Check whether a connection exists between the given source and target objects.

Parameters

DataItem	$source	the source object
DataItem	$target	the target object

Definition at line 127 of file connectable_manager.inc.

     {
          return Query::create(ConnectionRecord, "WHERE source_class=:sc AND source_id=:si AND target_class=:tc AND target_id=:ti")
                          ->bind(":sc", get_class($source),
                                   ":si", $source->get($source->getPrimaryKey()),
                                   ":tc", get_class($target),
                                   ":ti", $target->get($target->getPrimaryKey()))
                          ->exists();
     }

getConnectableFromRequest()

static ConnectableManager::getConnectableFromRequest ( )

static

Create and populate a Connectable DataItem based on its primary key as passed in on the requesting URL.

Returns

Connectable

Definition at line 63 of file connectable_manager.inc.

     {
          foreach (ConnectableManager::$classLookup as $primaryKey => $class)
          {
               if (array_key_exists($primaryKey, $_GET))
               {
                    $id = checkNumeric($_GET[$primaryKey]);
                    $obj = new $class;
                              
                    if ($id) $obj->load($id);
                    return $obj;
               }
          }
          
          return null;
     }

getConnectedItemCount()

static ConnectableManager::getConnectedItemCount (   $sourceItem,   $targetClass,   $constraint = ""  )

static

Returns the number of connected items for the specified source that are of the specified class.

Parameters

Connectable	$sourceItem	the source DataItem (must implement the Connectable interface)
string	$targetClass	The class of DataItem Connectable objects that are to be returned
string	$constraint	additional constraints to be applied

Exceptions

FakoliException

Definition at line 278 of file connectable_manager.inc.

     {
          $query = ConnectableManager::generateConnectedQuery($sourceItem, $targetClass, $constraint);        
          return Query::create($targetClass, $query)
                         ->bind(":sc", get_class($sourceItem), ":si", $sourceItem->get($sourceItem->getPrimaryKey()), ":tc", $targetClass)
                         ->executeValue("COUNT(1)");
     }

getConnectedItems()

static ConnectableManager::getConnectedItems (   $sourceItem,   $targetClass,   $constraint = ""  )

static

Returns the connected items for the specified source that are of the specified class.

Parameters

Connectable	$sourceItem	the source DataItem (must implement the Connectable interface)
string	$targetClass	The class of DataItem Connectable objects that are to be returned
string	$constraint	additional constraints to be applied

Exceptions

FakoliException

Definition at line 262 of file connectable_manager.inc.

     {
          $query = ConnectableManager::generateConnectedQuery($sourceItem, $targetClass, $constraint);        
          return Query::create($targetClass, $query)
                         ->bind(":sc", get_class($sourceItem), ":si", $sourceItem->get($sourceItem->getPrimaryKey()), ":tc", $targetClass)
                         ->execute();
     }

getTargetClasses()

static ConnectableManager::getTargetClasses (   $sourceItem )

static

Return an array of connectable target classes for the specified item.

Parameters

Connectable

$sourceItem

the source DataItem (must implement the Connectable interface)

Returns

Array of class names

Exceptions

FakoliException

Definition at line 240 of file connectable_manager.inc.

     {
          $sourceClass = is_object($sourceItem) ? get_class($sourceItem) : $sourceItem;
          
          if (!array_key_exists($sourceClass, ConnectableManager::$connectables))
          {
               throw new FakoliException("$sourceClass is not a registered connectable class");
          }
          
          return ConnectableManager::$connectables[$sourceClass];
          
     }

instantiate()

static ConnectableManager::instantiate (   $class,   $id  )

static

Safely instantiate a Connectable.

Parameters

string	$class
int	$id

Exceptions

FakoliException

Returns

Connectable

Definition at line 87 of file connectable_manager.inc.

     {
          if (!array_key_exists($class, ConnectableManager::$connectables))
          {
               throw new FakoliException(htmlSafe($class)." is not a registered Connectable");
          }
          
          checkNumeric($id);
          
          $obj = new $class;
          if ($id) $obj->load($id);
          return $obj;
     }

onInitialize()

static ConnectableManager::onInitialize ( )

static

Definition at line 41 of file connectable_manager.inc.

     {
          ComponentManager::fireEvent("RegisterConnectables");
     }

registerConnectable()

static ConnectableManager::registerConnectable (   $connectable,   $targets  )

static

Register a connectable class and the list of classes it can connect with.

Parameters

string	$connectable	the connectable class
array	$targets	array of target classes to which it can be connected

Definition at line 51 of file connectable_manager.inc.

     {
          ConnectableManager::$connectables[$connectable] = $targets;
          $obj = new $connectable;
          ConnectableManager::$classLookup[$obj->getPrimaryKey()] = $connectable;    
     }

removeAllConnections()

static ConnectableManager::removeAllConnections (   $object )

static

Remove all the connections to and from the given object.

Use this method when the object is being deleted from the database to ensure that you don't end up with stale connections.

Parameters

DataItem

$object

the object for which connections are to be removed

Definition at line 226 of file connectable_manager.inc.

     {
          $record = new ConnectionRecord();
          $objectID = $object->get($object->getPrimaryKey());
          $class = get_class($object);
          $record->delete("WHERE (source_class='{$class}' AND source_id={$objectID}) OR (target_class='{$class}' AND target_id={$objectID})");
     }

removeConnection()

static ConnectableManager::removeConnection (   $source,   $target  )

static

Remove any connection that exists between the source and target object (including back-links if they were created).

Parameters

DataItem	$source	the source object
DataItem	$target	the target object

Definition at line 191 of file connectable_manager.inc.

     {
          $record = new ConnectionRecord();
          $sourceID = checkNumeric($source->get($source->getPrimaryKey()));
          $targetID = checkNumeric($target->get($target->getPrimaryKey()));
          
          $sourceClass = get_class($source);
          $targetClass = get_class($target);
          
          $record->delete("WHERE (source_class='{$sourceClass}' AND source_id={$sourceID} AND target_class='{$targetClass}' AND target_id={$targetID}') " .
                              "OR (source_class='{$targetClass}' AND source_id={$targetID} AND target_class='{$sourceClass}' AND target_id={$sourceID})");
     }

removeConnections()

static ConnectableManager::removeConnections (   $source,   $targetClass  )

static

Remove any connection that exists between the source and objects of the specified target class (including back-links if they were created).

Parameters

DataItem	$source	the source object
DataItem	$targetClass	the target class

Definition at line 210 of file connectable_manager.inc.

     {
          $record = new ConnectionRecord();
          $sourceClass = get_class($source);
          $sourceID = checkNumeric($source->get($source->getPrimaryKey()));
 
          $record->delete("WHERE (source_class='{$sourceClass}' AND source_id={$sourceID} AND target_class='{$targetClass}') " .
                              "OR (source_class='{$targetClass}' AND target_class='{$sourceClass}' AND target_id={$sourceID})");
     }

setDefaults()

static ConnectableManager::setDefaults ( )

static

Definition at line 36 of file connectable_manager.inc.

     {
          //TODO: Set default configuration parameters here
     }

upgradeComponent()

static ConnectableManager::upgradeComponent (   $version )

static

Definition at line 306 of file connectable_manager.inc.

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

Member Data Documentation

$classLookup

ConnectableManager::$classLookup = array()

static

Look-up table of connectable classes from their primary keys.

Definition at line 28 of file connectable_manager.inc.

$connectables

ConnectableManager::$connectables = array()

static

Connectable type map defining which items can be connected together.

Definition at line 27 of file connectable_manager.inc.

$contextRouter

ConnectableManager::$contextRouter = ""

static

Definition at line 29 of file connectable_manager.inc.

---

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

• C:/code/cms.sonjara.com/cms/components/connectable/connectable_manager.inc