PersistableFilter.inc.php

<?php
import('lib.pkp.classes.filter.Filter');
import('lib.pkp.classes.filter.FilterGroup');
 
define('FILTER_GROUP_TEMPORARY_ONLY', '$$$temporary$$$');
 
class PersistableFilter extends Filter {
   var $_filterGroup;
 
   var $_settings = array();
 
   function __construct($filterGroup) {
      // Check and set the filter group.
      assert(is_a($filterGroup, 'FilterGroup'));
      $this->_filterGroup = $filterGroup;
 
      // Initialize the filter.
      $this->setParentFilterId(0);
      $this->setIsTemplate(false);
      parent::__construct($filterGroup->getInputType(), $filterGroup->getOutputType());
   }
 
 
   //
   // Setters and Getters
   //
   function getFilterGroup() {
      return $this->_filterGroup;
   }
 
   function setIsTemplate($isTemplate) {
      $this->setData('isTemplate', (boolean)$isTemplate);
   }
 
   function getIsTemplate() {
      return $this->getData('isTemplate');
   }
 
   function setParentFilterId($parentFilterId) {
      $this->setData('parentFilterId', $parentFilterId);
   }
 
   function getParentFilterId() {
      return $this->getData('parentFilterId');
   }
 
   function addSetting($setting) {
      assert(is_a($setting, 'FilterSetting'));
      $settingName = $setting->getName();
 
      // Check that the setting name does not
      // collide with one of the internal settings.
      if (in_array($settingName, $this->getInternalSettings())) fatalError('Trying to override an internal filter setting!');
 
      assert(!isset($this->_settings[$settingName]));
      $this->_settings[$settingName] = $setting;
   }
 
   function getSetting($settingName) {
      assert(isset($this->_settings[$settingName]));
      return $this->_settings[$settingName];
   }
 
   function &getSettings() {
      return $this->_settings;
   }
 
   function hasSetting($settingName) {
      return isset($this->_settings[$settingName]);
   }
 
   function hasSettings() {
      return (is_array($this->_settings) && count($this->_settings));
   }
 
   //
   // Abstract template methods to be implemented by subclasses
   //
   function getClassName() {
      assert(false);
   }
 
   //
   // Public methods
   //
   function getSettingNames() {
      $settingNames = array();
      foreach($this->getSettings() as $setting) { /* @var $setting FilterSetting */
         if (!$setting->getIsLocalized()) {
            $settingNames[] = $setting->getName();
         }
      }
      return $settingNames;
   }
 
   function getLocalizedSettingNames() { /* @var $setting FilterSetting */
      $localizedSettingNames = array();
      foreach($this->getSettings() as $setting) {
         if ($setting->getIsLocalized()) {
            $localizedSettingNames[] = $setting->getName();
         }
      }
      return $localizedSettingNames;
   }
 
 
   //
   // Public static helper methods
   //
   static function tempGroup($inputType, $outputType) {
      $temporaryGroup = new FilterGroup();
      $temporaryGroup->setSymbolic(FILTER_GROUP_TEMPORARY_ONLY);
      $temporaryGroup->setInputType($inputType);
      $temporaryGroup->setOutputType($outputType);
      return $temporaryGroup;
   }
 
 
   //
   // Protected helper methods
   //
   function getInternalSettings() {
      return array('id', 'displayName', 'isTemplate', 'parentFilterId', 'seq');
   }
}