VersionedContentManager Class Reference

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

Public Member Functions
	VersionedContentManager ()

Static Public Member Functions
static	onInitialize ()
static	setDefaults ()
static	enableVersioning ($form)
static	registerVersionedContent ()
static	onSavePreProcess ($form)
static	onDrawForm ($form)
static	onDrawInlineControls ($item)
static	revert ($target)
	Revert the versioned fields on specified target to the current live values. More...
static	approve ($target)
static	selectDisplayVersion ($target, $param="version")
static	renderVersioningControls ($item, $formMode=false)
static	upgradeComponent ($version)

Static Public Attributes
static	$versionedContentClasses = array()

Detailed Description

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

Definition at line 13 of file versioned_content_manager.inc.

Member Function Documentation

approve()

static VersionedContentManager::approve (   $target )

static

Definition at line 94 of file versioned_content_manager.inc.

     {
          $contentVersion = ContentVersion::getVersion($target, "draft");
          if (!$contentVersion) throw new FakoliException("No draft found for item");
          $contentVersion->approve($target);
     }

enableVersioning()

static VersionedContentManager::enableVersioning (   $form )

static

Definition at line 32 of file versioned_content_manager.inc.

     {
          if (!Settings::getValue("settings", "enable_content_versioning")) return;
          
          $target = &$form->data;
          
          ContentVersion::loadDraft($target);
          $form->onDrawStart = array(VersionedContentManager, "onDrawForm");
          $form->onSavePreProcess = array(VersionedContentManager, 'onSavePreProcess');
          
     }

onDrawForm()

static VersionedContentManager::onDrawForm (   $form )

static

Definition at line 60 of file versioned_content_manager.inc.

     {
          $target = $form->data;
          $versionControls = VersionedContentManager::renderVersioningControls($form->data, true);
          if ($versionControls)
          {
               echo "<p class='version_info'>$versionControls</p>";
          }
     }

onDrawInlineControls()

static VersionedContentManager::onDrawInlineControls (   $item )

static

Definition at line 70 of file versioned_content_manager.inc.

     {
          return VersionedContentManager::renderVersioningControls($item, false);
     }

onInitialize()

static VersionedContentManager::onInitialize ( )

static

Definition at line 22 of file versioned_content_manager.inc.

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

onSavePreProcess()

static VersionedContentManager::onSavePreProcess (   $form )

static

Definition at line 52 of file versioned_content_manager.inc.

     {
          $target = $form->data;
          ContentVersion::saveDraft($target);
          VersionedContentManager::revert($target);
          return true;
     }

registerVersionedContent()

static VersionedContentManager::registerVersionedContent ( )

static

Definition at line 44 of file versioned_content_manager.inc.

     {
          for($i = 0; $i < func_num_args(); ++$i)
          {
               VersionedContentManager::$versionedContentClasses[] = func_get_arg($i);
          }
     }

renderVersioningControls()

static VersionedContentManager::renderVersioningControls (   $item,   $formMode = false  )

static

Definition at line 118 of file versioned_content_manager.inc.

     {
          if (!Settings::getValue("settings", "enable_content_versioning")) return;
          
          if ($formMode)
          {
               $version = "draft";
          }
          else
          {
               $param = "version";
               
               $version = $_GET[$param];
               if (!$version) $version = "";
               
               $params = array();
               
               $qs = getCleanQueryString();
               parse_str($qs, $params);
               
               unset($params[$param]);
          }
          
          $liveQs = http_build_query($params);
          $params[$param] = "draft";
          $draftQs = http_build_query($params);
          $hasDraft = ContentVersion::hasDraft($item);
          
          if (!$hasDraft && $formMode)
          {
               $version = "";
          }
          
          $out = "";
          
          if ($hasDraft && !$formMode)
          {
               $draftSelected = ($version == "draft") ? " selected" : "";
               $liveSelected = ($version == "") ? " selected" : "";
               
               $out .= " <a class='pushbutton first{$liveSelected}' href='?{$liveQs}'>Live</a><a class='pushbutton last{$draftSelected}' href='?{$draftQs}'> Draft</a>";
          }
          
          $selectedVersion = ContentVersion::getVersion($item, $version);
          if ($selectedVersion)
          {
               $mgr = new UserManager();
               $owner = $mgr->getUserFullName($selectedVersion->LastModifiedBy());
               
               $out .= $selectedVersion->format("<span class='version'>Version {version_number} Last Edited By {$owner} on {last_modified}</span>");
          }
          
          if ($version == "draft" && $hasDraft)
          {
               $class = get_class($item);
               $pkval = $item->getPrimaryKeyValue();
               $out .= "<a class='approve' href='#' onclick='VersionedContentManager.approve(\"{$class}\", {$pkval}); return false'>Approve</a>";
               $out .= "&nbsp;<a class='revert' href='#' onclick='VersionedContentManager.revert(\"{$class}\", {$pkval}); return false'>Discard Changes</a>";
          }
          return $out;
     }

revert()

static VersionedContentManager::revert (   $target )

static

Revert the versioned fields on specified target to the current live values.

Parameters

DataItem

$target

the target content object

Definition at line 79 of file versioned_content_manager.inc.

     {
          $class = get_class($target);
          $reversion = new $class;
          $id = $target->getPrimaryKeyValue();
          if (!$id) return;
          
          $reversion->load($id);
          
          foreach($reversion->versioned_fields as $field)
          {
               $target->set($field, $reversion->get($field));
          }
     }

selectDisplayVersion()

static VersionedContentManager::selectDisplayVersion (   $target,   $param = "version"  )

static

Definition at line 101 of file versioned_content_manager.inc.

     {
          if (!isset($_GET[$param])) return $target;
          $version = $_GET[$param];
          
          if ($version == 'draft')
          {
               ContentVersion::loadDraft($target);
               return;
          }
          
          checkNumeric($version);
          
          ContentVersion::loadVersion($target, $version);
     }

setDefaults()

static VersionedContentManager::setDefaults ( )

static

Definition at line 27 of file versioned_content_manager.inc.

     {
          Settings::setDefaultValue("settings", "enable_content_versioning", false, Boolean, "Enables content versioning for supported content items", "Content Versioning");
     }

upgradeComponent()

static VersionedContentManager::upgradeComponent (   $version )

static

Definition at line 180 of file versioned_content_manager.inc.

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

VersionedContentManager()

VersionedContentManager::VersionedContentManager

(

)

Definition at line 15 of file versioned_content_manager.inc.

     {
 
     }

Member Data Documentation

$versionedContentClasses

VersionedContentManager::$versionedContentClasses = array()

static

Definition at line 20 of file versioned_content_manager.inc.

---

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

• C:/code/cms.sonjara.com/cms/components/versioned_content/versioned_content_manager.inc