This repository has been archived on 2024-11-28. You can view files and clone it, but cannot push or open issues or pull requests.
Incam_SGD/search2/search/fieldRegistry.inc.php

314 lines
7.4 KiB
PHP

<?php
/**
* $Id:$
*
* KnowledgeTree Community Edition
* Document Management Made Simple
* Copyright (C) 2008, 2009 KnowledgeTree Inc.
*
*
* This program is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License version 3 as published by the
* Free Software Foundation.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* You can contact KnowledgeTree Inc., PO Box 7775 #87847, San Francisco,
* California 94120-7775, or email info@knowledgetree.com.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU General Public License version 3.
*
* In accordance with Section 7(b) of the GNU General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "Powered by
* KnowledgeTree" logo and retain the original copyright notice. If the display of the
* logo is not reasonably feasible for technical reasons, the Appropriate Legal Notices
* must display the words "Powered by KnowledgeTree" and retain the original
* copyright notice.
* Contributor( s): ______________________________________
*
*/
require_once('search/expr.inc.php');
class ResolutionException extends Exception {}
/**
* This is the primary registry for fields.
*
*/
class ExprFieldRegistry
{
/**
* Stores all registered fields.
*
* @var array
*/
private $fields;
/**
* Stores all registered aliases.
*
* @var array
*/
private $alias;
/**
* Path to location of class definitions
*
* @var string
*/
private $path;
private $metadata;
private $display;
private $general;
/**
* Initialise the registry.
* This is private and class must be obtained via the get() method.
*
* @access private
*
*/
private function __construct()
{
$this->fields = array();
$this->alias = array();
$this->metadata = array();
$this->display=array();
$config = KTConfig::getSingleton();
$this->path = $config->get('search/fieldsPath');
}
/**
* Retuns a singleton to the class.
*
* @return ExprFieldRegistry
*/
public static function getRegistry()
{
static $singleton = null;
if (is_null($singleton))
{
$singleton = new ExprFieldRegistry();
$singleton->registerFields();
}
return $singleton;
}
/**
* Add a field to the registry.
*
* @param FieldExpr $field
*/
private function registerField($field)
{
assert(!is_null($field));
$classname = strtolower(get_class($field));
$alias = strtolower($field->getAlias());
if (array_key_exists($classname, $this->fields) || array_key_exists($alias, $this->alias))
{
throw new ResolutionException("Class $classname with alias $alias already registered.");
}
$this->fields[$classname] = $field;
$this->alias[$alias] = $field;
if ($field instanceof MetadataField )
{
$fieldsetn = $field->getFieldSet();
$fieldn= $field->getField();
$this->metadata[$fieldsetn][$fieldn] = $field;
$this->display[] = "[\"$fieldsetn\"][\"$fieldn\"]";
}
else
{
$this->display[] = $field->getAlias();
if (isset($field->general_op))
{
$this->general[] = get_class($field);
}
}
}
function getGeneralTextClasses()
{
return $this->general;
}
public function resolveAlias($alias)
{
return $this->getField($alias);
}
public function resolveMetadataField($fieldset, $field)
{
if ($fieldset instanceof ValueExpr)
{
$fieldset = $fieldset->getValue();
}
$fieldset = html_entity_decode($fieldset);
if (!array_key_exists($fieldset,$this->metadata))
{
throw new ResolutionException("Metadata class for fieldset '$fieldset' and field '$field' not found.");
}
if ($field instanceof ValueExpr)
{
$field = $field->getValue();
}
$field = html_entity_decode($field);
if (!array_key_exists($field,$this->metadata[$fieldset]))
{
throw new ResolutionException("Metadata class for fieldset '$fieldset' and field '$field' not found.");
}
return $this->metadata[$fieldset][$field];
}
/**
* A static method to lookup a field by fieldname.
*
* @param string $fieldname
* @return unknown
*/
public static function lookupField($fieldname)
{
$registry = ExprFieldRegistry::get();
return $registry->getField($fieldname);
}
/**
* Returns a field from the registry.
*
* @param string $fieldname
* @return ExprField
*/
public function getField($fieldname)
{
$fieldname = strtolower($fieldname);
if (array_key_exists($fieldname, $this->fields))
{
return $this->fields[$fieldname];
}
if (array_key_exists($fieldname, $this->alias))
{
return $this->alias[$fieldname];
}
throw new ResolutionException('Field not found: ' . $fieldname);
}
public function getAliasNames()
{
return $this->display;
}
/**
* Load all fields into the registry
*
*/
public function registerFields()
{
$this->fields = array();
$dir = opendir(SearchHelper::correctPath($this->path));
while (($file = readdir($dir)) !== false)
{
if (substr($file,-13) == 'Field.inc.php')
{
require_once($this->path . '/' . $file);
$class = substr($file, 0, -8);
if (!class_exists($class))
{
continue;
}
$field = new $class;
if (is_null($field) || !($field instanceof FieldExpr))
{
continue;
}
$this->registerField($field);
}
}
closedir($dir);
$this->registerMetdataFields();
}
/**
* Registers metdata fields in system.
*
*/
private function registerMetdataFields()
{
$sql = "SELECT
fs.name as fieldset, f.name as field, fs.id as fsid, f.id as fid, f.data_type
FROM
fieldsets fs
INNER JOIN document_fields f ON f.parent_fieldset=fs.id
WHERE
fs.disabled=0";
$result = DBUtil::getResultArray($sql);
foreach($result as $record)
{
$fieldset = addslashes($record['fieldset']);
$field = addslashes($record['field']);
$fieldsetid = $record['fsid'];
$fieldid = $record['fid'];
$type = $record['data_type'];
$classname = "MetadataField$fieldid";
$classdefn = "
class $classname extends MetadataField
{
public function __construct()
{
parent::__construct('$fieldset','$field',$fieldsetid, $fieldid);" .
(($type=='INT')?'$this->isValueQuoted(false);':'') . "
}
}";
eval($classdefn);
$field = new $classname;
$this->registerField($field);
}
}
public function getFields()
{
$result = array();
foreach($this->fields as $field)
{
if ($field instanceof MetadataField)
{
continue;
}
$result[] = $field;
}
return $result;
}
}
?>