connectable_manager.inc

Go to the documentation of this file.

<?php
interface Connectable
{
     function getConnectableIcon();
     function getConnectableDisabledIcon();
     function getConnectableConstraint();
     function getConnectableLink($source);
     function getConnectableTitle();
     function getConnectableHome();
     function populateSelectionTable($table);
}
 
class ConnectableManager
{
     static $connectables = array();    
     static $classLookup = array();     
     static $contextRouter = "";
     
     function ConnectableManager()
     {
 
     }
 
     static function setDefaults()
     {
          //TODO: Set default configuration parameters here
     }
 
     static function onInitialize()
     {
          ComponentManager::fireEvent("RegisterConnectables");
     }
     
     static function registerConnectable($connectable, $targets)
     {
          ConnectableManager::$connectables[$connectable] = $targets;
          $obj = new $connectable;
          ConnectableManager::$classLookup[$obj->getPrimaryKey()] = $connectable;    
     }
 
     static function getConnectableFromRequest()
     {
          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;
     }
     
     static function instantiate($class, $id)
     {
          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;
     }
     
     static function canConnect($source, $target)
     {
          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;
     }
     
     static function connectionExists($source, $target)
     {
          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();
     }
     
     static function addConnection($source, $target)
     {
          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();
          }         
     }
     
     static function removeConnection($source, $target)
     {
          $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})");
     }
     
     static function removeConnections($source, $targetClass)
     {
          $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})");
     }
     
     static function removeAllConnections($object)
     {
          $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})");
     }
     
     static function getTargetClasses($sourceItem)
     {
          $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];
          
     }
     
 
     static function getConnectedItems($sourceItem, $targetClass, $constraint = "")
     {
          $query = ConnectableManager::generateConnectedQuery($sourceItem, $targetClass, $constraint);        
          return Query::create($targetClass, $query)
                         ->bind(":sc", get_class($sourceItem), ":si", $sourceItem->get($sourceItem->getPrimaryKey()), ":tc", $targetClass)
                         ->execute();
     }
     
     static function getConnectedItemCount($sourceItem, $targetClass, $constraint = "")
     {
          $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)");
     }
     
     private static function generateConnectedQuery($sourceItem, $targetClass, $constraint)
     {
          $constraint = preg_replace("/^\\s*WHERE/i", " AND", $constraint);
          
          $sourceClass = get_class($sourceItem);
          
          $targetClasses = ConnectableManager::getTargetClasses($sourceItem);
          
          trace(print_r($targetClasses, true), 3);
          
          if (!ConnectableManager::canConnect($sourceClass, $targetClass))
          {
               throw new FakoliException("$sourceClass cannot be connected to $targetClass");
          }
          
          $obj = new $targetClass;
          $pk = $obj->getPrimaryKey();
          
          return "WHERE $pk in (SELECT target_id FROM connection_record WHERE source_class=:sc AND source_id=:si AND target_class = :tc) $constraint";
     }
     static function upgradeComponent($version)
     {
          $mgr = new ConnectableUpgradeManager();
          $mgr->upgrade($version);
     }
}
?>