mirror of
https://git.code.sf.net/p/seeddms/code
synced 2024-10-06 08:02:07 +00:00
468 lines
12 KiB
PHP
468 lines
12 KiB
PHP
<?php
|
||
/**
|
||
* Implementation of the attribute object in the document management system
|
||
*
|
||
* @category DMS
|
||
* @package LetoDMS_Core
|
||
* @license GPL 2
|
||
* @version @version@
|
||
* @author Uwe Steinmann <uwe@steinmann.cx>
|
||
* @copyright Copyright (C) 2012 Uwe Steinmann
|
||
* @version Release: @package_version@
|
||
*/
|
||
|
||
/**
|
||
* Class to represent an attribute in the document management system
|
||
*
|
||
* Attributes are key/value pairs which can be attachted to documents,
|
||
* folders and document content. The number of attributes is unlimited.
|
||
* Each attribute has a value and is related to an attribute definition,
|
||
* which holds the name and other information about the attribute..
|
||
*
|
||
* @see LetoDMS_Core_AttributeDefinition
|
||
*
|
||
* @category DMS
|
||
* @package LetoDMS_Core
|
||
* @author Markus Westphal, Malcolm Cowe, Uwe Steinmann <uwe@steinmann.cx>
|
||
* @copyright Copyright (C) 2012 Uwe Steinmann
|
||
* @version Release: @package_version@
|
||
*/
|
||
class LetoDMS_Core_Attribute {
|
||
/**
|
||
* @var integer id of attribute
|
||
*
|
||
* @access protected
|
||
*/
|
||
protected $_id;
|
||
|
||
/**
|
||
* @var object folder or document this attribute belongs to
|
||
*
|
||
* @access protected
|
||
*/
|
||
protected $_obj;
|
||
|
||
/**
|
||
* @var object definition of this attribute
|
||
*
|
||
* @access protected
|
||
*/
|
||
protected $_attrdef;
|
||
|
||
/**
|
||
* @var mixed value of this attribute
|
||
*
|
||
* @access protected
|
||
*/
|
||
protected $_value;
|
||
|
||
/**
|
||
* @var object reference to the dms instance this attribute belongs to
|
||
*
|
||
* @access protected
|
||
*/
|
||
protected $_dms;
|
||
|
||
function LetoDMS_Core_Attribute($id, $obj, $attrdef, $value) { /* {{{ */
|
||
$this->_id = $id;
|
||
$this->_obj = $obj;
|
||
$this->_attrdef = $attrdef;
|
||
$this->_value = $value;
|
||
$this->_dms = null;
|
||
} /* }}} */
|
||
|
||
function setDMS($dms) { /* {{{ */
|
||
$this->_dms = $dms;
|
||
} /* }}} */
|
||
|
||
function getID() { return $this->_id; }
|
||
|
||
function getValue() { return $this->_value; }
|
||
|
||
/**
|
||
* Set a value of an attribute
|
||
* The attribute is deleted completely if the value is the empty string
|
||
*
|
||
* @param string $value value to be set
|
||
* @return boolean true if operation was successfull, otherwise false
|
||
*/
|
||
function setValue($value) { /* {{{*/
|
||
$db = $this->_dms->getDB();
|
||
|
||
switch(get_class($this->_obj)) {
|
||
case "LetoDMS_Core_Document":
|
||
if(trim($value) === '')
|
||
$queryStr = "DELETE FROM tblDocumentAttributes WHERE `document` = " . $this->_obj->getID() . " AND `attrdef` = " . $this->_attrdef->getId();
|
||
else
|
||
$queryStr = "UPDATE tblDocumentAttributes SET value = ".$db->qstr($value)." WHERE `document` = " . $this->_obj->getID() . " AND `attrdef` = " . $this->_attrdef->getId();
|
||
break;
|
||
case "LetoDMS_Core_DocumentContent":
|
||
if(trim($value) === '')
|
||
$queryStr = "DELETE FROM tblDocumentContentAttributes WHERE `content` = " . $this->_obj->getID() . " AND `attrdef` = " . $this->_attrdef->getId();
|
||
else
|
||
$queryStr = "UPDATE tblDocumentContentAttributes SET value = ".$db->qstr($value)." WHERE `content` = " . $this->_obj->getID() . " AND `attrdef` = " . $this->_attrdef->getId();
|
||
break;
|
||
case "LetoDMS_Core_Folder":
|
||
if(trim($value) === '')
|
||
$queryStr = "DELETE FROM tblFolderAttributes WHERE `folder` = " . $this->_obj->getID() . " AND `attrdef` = " . $this->_attrdef->getId();
|
||
else
|
||
$queryStr = "UPDATE tblFolderAttributes SET value = ".$db->qstr($value)." WHERE `folder` = " . $this->_obj->getID() . " AND `attrdef` = " . $this->_attrdef->getId();
|
||
break;
|
||
default:
|
||
return false;
|
||
}
|
||
if (!$db->getResult($queryStr))
|
||
return false;
|
||
|
||
$this->_value = $value;
|
||
|
||
return true;
|
||
} /* }}} */
|
||
|
||
function getAttributeDefinition() { return $this->_attrdef; }
|
||
|
||
}
|
||
|
||
/**
|
||
* Class to represent an attribute definition in the document management system
|
||
*
|
||
* Attribute definitions specify the name, type, object type, minimum and
|
||
* maximum values and a value set. The object type determines the object
|
||
* an attribute may be attached to. If the object type is set to object_all
|
||
* the attribute can be used for documents, document content and folders.
|
||
*
|
||
* The type of an attribute specifies the skalar data type.
|
||
*
|
||
* Attributes for which multiple values are allowed must have the
|
||
* multiple flag set to true and specify a value set. A value set
|
||
* is a string consisting of n separated values. The separator is the
|
||
* first char of the value set. A possible value could be '|REV-A|REV-B'
|
||
* If multiple values are allowed, then minvalues and maxvalues may
|
||
* restrict the allowed number of values.
|
||
*
|
||
* @see LetoDMS_Core_Attribute
|
||
*
|
||
* @category DMS
|
||
* @package LetoDMS_Core
|
||
* @author Markus Westphal, Malcolm Cowe, Uwe Steinmann <uwe@steinmann.cx>
|
||
* @copyright Copyright (C) 2012 Uwe Steinmann
|
||
* @version Release: @package_version@
|
||
*/
|
||
class LetoDMS_Core_AttributeDefinition {
|
||
/**
|
||
* @var integer id of attribute definition
|
||
*
|
||
* @access protected
|
||
*/
|
||
protected $_id;
|
||
|
||
/**
|
||
* @var string name of attribute definition
|
||
*
|
||
* @access protected
|
||
*/
|
||
protected $_name;
|
||
|
||
/**
|
||
* @var string object type of attribute definition
|
||
*
|
||
* @access protected
|
||
*/
|
||
protected $_type;
|
||
|
||
/**
|
||
* @var string type of attribute definition
|
||
*
|
||
* @access protected
|
||
*/
|
||
protected $_objtype;
|
||
|
||
/**
|
||
* @var boolean whether an attribute can have multiple values
|
||
*
|
||
* @access protected
|
||
*/
|
||
protected $_multiple;
|
||
|
||
/**
|
||
* @var integer minimum values of an attribute
|
||
*
|
||
* @access protected
|
||
*/
|
||
protected $_minvalues;
|
||
|
||
/**
|
||
* @var integer maximum values of an attribute
|
||
*
|
||
* @access protected
|
||
*/
|
||
protected $_maxvalues;
|
||
|
||
/**
|
||
* @var string list of possible values of an attribute
|
||
*
|
||
* @access protected
|
||
*/
|
||
protected $_valueset;
|
||
|
||
/**
|
||
* @var object reference to the dms instance this attribute definition belongs to
|
||
*
|
||
* @access protected
|
||
*/
|
||
protected $_dms;
|
||
|
||
/*
|
||
* Possible skalar data types of an attribute
|
||
*/
|
||
const type_int = '1';
|
||
const type_float = '2';
|
||
const type_string = '3';
|
||
const type_boolean = '4';
|
||
|
||
/*
|
||
* The object type for which a attribute may be used
|
||
*/
|
||
const objtype_all = '0';
|
||
const objtype_folder = '1';
|
||
const objtype_document = '2';
|
||
const objtype_documentcontent = '3';
|
||
|
||
/**
|
||
* Constructor
|
||
*
|
||
* @param integer $id internal id of attribute definition
|
||
* @param string $name name of attribute
|
||
* @param integer $objtype type of object for which this attribute definition
|
||
* may be used.
|
||
* @param integer $type skalar type of attribute
|
||
* @param boolean $multiple set to true if multiple values are allowed
|
||
* @param integer $minvalues minimum number of values
|
||
* @param integer $maxvalues maximum number of values
|
||
* @param string $valueset separated list of allowed values, the first char
|
||
* is taken as the separator
|
||
*/
|
||
function LetoDMS_Core_AttributeDefinition($id, $name, $objtype, $type, $multiple, $minvalues, $maxvalues, $valueset) { /* {{{ */
|
||
$this->_id = $id;
|
||
$this->_name = $name;
|
||
$this->_type = $type;
|
||
$this->_objtype = $objtype;
|
||
$this->_multiple = $multiple;
|
||
$this->_minvalues = $minvalues;
|
||
$this->_maxvalues = $maxvalues;
|
||
$this->_valueset = $valueset;
|
||
$this->_separator = '';
|
||
$this->_dms = null;
|
||
} /* }}} */
|
||
|
||
function setDMS($dms) { /* {{{ */
|
||
$this->_dms = $dms;
|
||
} /* }}} */
|
||
|
||
function getID() { return $this->_id; }
|
||
|
||
function getName() { return $this->_name; }
|
||
|
||
function setName($name) { /* {{{ */
|
||
$db = $this->_dms->getDB();
|
||
|
||
$queryStr = "UPDATE tblAttributeDefinitions SET name =".$db->qstr($name)." WHERE id = " . $this->_id;
|
||
$res = $db->getResult($queryStr);
|
||
if (!$res)
|
||
return false;
|
||
|
||
$this->_name = $name;
|
||
return true;
|
||
} /* }}} */
|
||
|
||
function getObjType() { return $this->_objtype; }
|
||
|
||
function setObjType($objtype) { /* {{{ */
|
||
$db = $this->_dms->getDB();
|
||
|
||
$queryStr = "UPDATE tblAttributeDefinitions SET objtype =".intval($objtype)." WHERE id = " . $this->_id;
|
||
$res = $db->getResult($queryStr);
|
||
if (!$res)
|
||
return false;
|
||
|
||
$this->_objtype = $objtype;
|
||
return true;
|
||
} /* }}} */
|
||
|
||
function getType() { return $this->_type; }
|
||
|
||
function setType($type) { /* {{{ */
|
||
$db = $this->_dms->getDB();
|
||
|
||
$queryStr = "UPDATE tblAttributeDefinitions SET type =".intval($type)." WHERE id = " . $this->_id;
|
||
$res = $db->getResult($queryStr);
|
||
if (!$res)
|
||
return false;
|
||
|
||
$this->_type = $type;
|
||
return true;
|
||
} /* }}} */
|
||
|
||
function getMultipleValues() { return $this->_multiple; }
|
||
|
||
function setMultipleValues($mv) { /* {{{ */
|
||
$db = $this->_dms->getDB();
|
||
|
||
$queryStr = "UPDATE tblAttributeDefinitions SET multiple =".intval($mv)." WHERE id = " . $this->_id;
|
||
$res = $db->getResult($queryStr);
|
||
if (!$res)
|
||
return false;
|
||
|
||
$this->_multiple = $mv;
|
||
return true;
|
||
} /* }}} */
|
||
|
||
function getMinValues() { return $this->_minvalues; }
|
||
|
||
function setMinValues($minvalues) { /* {{{ */
|
||
$db = $this->_dms->getDB();
|
||
|
||
$queryStr = "UPDATE tblAttributeDefinitions SET minvalues =".intval($minvalues)." WHERE id = " . $this->_id;
|
||
$res = $db->getResult($queryStr);
|
||
if (!$res)
|
||
return false;
|
||
|
||
$this->_minvalues = $minvalues;
|
||
return true;
|
||
} /* }}} */
|
||
|
||
function getMaxValues() { return $this->_maxvalues; }
|
||
|
||
function setMaxValues($maxvalues) { /* {{{ */
|
||
$db = $this->_dms->getDB();
|
||
|
||
$queryStr = "UPDATE tblAttributeDefinitions SET maxvalues =".intval($maxvalues)." WHERE id = " . $this->_id;
|
||
$res = $db->getResult($queryStr);
|
||
if (!$res)
|
||
return false;
|
||
|
||
$this->_maxvalues = $maxvalues;
|
||
return true;
|
||
} /* }}} */
|
||
|
||
/**
|
||
* Get the value set as saved in the database
|
||
*
|
||
* @return string value set
|
||
*/
|
||
function getValueSet() { /* {{{ */
|
||
return $this->_valueset;
|
||
} /* }}} */
|
||
|
||
/**
|
||
* Get the whole value set as an array
|
||
*
|
||
* @return array values of value set or false if the value set has
|
||
* less than 2 chars
|
||
*/
|
||
function getValueSetAsArray() { /* {{{ */
|
||
if(strlen($this->_valueset) > 1)
|
||
return explode($this->_valueset[0], substr($this->_valueset, 1));
|
||
else
|
||
return false;
|
||
} /* }}} */
|
||
|
||
/**
|
||
* Get the n'th value of a value set
|
||
*
|
||
* @param interger $index
|
||
* @return string n'th value of value set or false if the index is
|
||
* out of range or the value set has less than 2 chars
|
||
*/
|
||
function getValueSetValue($ind) { /* {{{ */
|
||
if(strlen($this->_valueset) > 1) {
|
||
$tmp = explode($this->_valueset[0], substr($this->_valueset, 1));
|
||
if(isset($tmp[$ind]))
|
||
return $tmp[$ind];
|
||
else
|
||
return false;
|
||
} else
|
||
return false;
|
||
} /* }}} */
|
||
|
||
/**
|
||
* Set the value set
|
||
*
|
||
* A value set is a list of values allowed for an attribute. The values
|
||
* are separated by a char which must also be the first char of the
|
||
* value set string.
|
||
*
|
||
* @param string $valueset
|
||
* @return boolean true if value set could be set, otherwise false
|
||
*/
|
||
function setValueSet($valueset) { /* {{{ */
|
||
/*
|
||
$tmp = array();
|
||
foreach($valueset as $value) {
|
||
$tmp[] = str_replace('"', '""', $value);
|
||
}
|
||
$valuesetstr = implode(",", $tmp);
|
||
*/
|
||
$valuesetstr = $valueset;
|
||
|
||
$db = $this->_dms->getDB();
|
||
|
||
$queryStr = "UPDATE tblAttributeDefinitions SET valueset =".$db->qstr($valuesetstr)." WHERE id = " . $this->_id;
|
||
$res = $db->getResult($queryStr);
|
||
if (!$res)
|
||
return false;
|
||
|
||
$this->_valueset = $valueset;
|
||
$this->_separator = substr($valueset, 0, 1);
|
||
return true;
|
||
} /* }}} */
|
||
|
||
/**
|
||
* Check if the attribute definition is used
|
||
*
|
||
* Checks all attributes whether at least one of them referenceѕ
|
||
* this attribute definition
|
||
*
|
||
* @return boolean true if attribute definition is used, otherwise false
|
||
*/
|
||
function isUsed() { /* {{{ */
|
||
$db = $this->_dms->getDB();
|
||
|
||
$queryStr = "SELECT * FROM tblDocumentAttributes WHERE attrdef=".$this->_id;
|
||
$resArr = $db->getResultArray($queryStr);
|
||
if (is_array($resArr) && count($resArr) == 0) {
|
||
$queryStr = "SELECT * FROM tblFolderAttributes WHERE attrdef=".$this->_id;
|
||
$resArr = $db->getResultArray($queryStr);
|
||
if (is_array($resArr) && count($resArr) == 0) {
|
||
$queryStr = "SELECT * FROM tblDocumentContentAttributes WHERE attrdef=".$this->_id;
|
||
$resArr = $db->getResultArray($queryStr);
|
||
if (is_array($resArr) && count($resArr) == 0) {
|
||
|
||
return false;
|
||
}
|
||
}
|
||
}
|
||
return true;
|
||
} /* }}} */
|
||
|
||
/**
|
||
* Remove the attribute definition
|
||
* Removal is only executed when the definition is not used anymore.
|
||
*
|
||
* @return boolean true on success or false in case of an error
|
||
*/
|
||
function remove() { /* {{{ */
|
||
$db = $this->_dms->getDB();
|
||
|
||
if($this->isUsed())
|
||
return false;
|
||
|
||
// Delete user itself
|
||
$queryStr = "DELETE FROM tblAttributeDefinitions WHERE id = " . $this->_id;
|
||
if (!$db->getResult($queryStr)) return false;
|
||
|
||
return true;
|
||
} /* }}} */
|
||
}
|
||
?>
|