inc.ClassObject.php

SeedDMS_Core/Core/inc.ClassDMS.php

@@ -294,7 +294,7 @@ class SeedDMS_Core_DMS {
 	 * given user. A link is only accessible, if it is publically visible,
 	 * owned by the user, or the accessing user is an administrator.
 	 *
-	 * @param array $links list of objects of type SeedDMS_Core_DocumentLink
+	 * @param SeedDMS_Core_DocumentLink[] $links list of objects of type SeedDMS_Core_DocumentLink
 	 * @param object $user user for which access is being checked
 	 * @param string $access set if source or target of link shall be checked
 	 * for sufficient access rights. Set to 'source' if the source document
@@ -1691,7 +1691,7 @@ class SeedDMS_Core_DMS {
 	 * This function retrieves a user from the database by its id.
 	 *
 	 * @param integer $id internal id of user
-	 * @return object instance of {@link SeedDMS_Core_User} or false
+	 * @return SeedDMS_Core_User|boolean instance of {@link SeedDMS_Core_User} or false
 	 */
 	function getUser($id) { /* {{{ */
 		$classname = $this->classnames['user'];
@@ -2095,7 +2095,7 @@ class SeedDMS_Core_DMS {
 	 * its id.
 	 *
 	 * @param integer $id internal id of attribute defintion
-	 * @return object instance of {@link SeedDMS_Core_AttributeDefinition} or false
+	 * @return bool|SeedDMS_Core_AttributeDefinition or false
 	 */
 	function getAttributeDefinition($id) { /* {{{ */
 		if (!is_numeric($id))

SeedDMS_Core/Core/inc.ClassDocument.php

@@ -4552,7 +4552,7 @@ class SeedDMS_Core_DocumentLink { /* {{{ */
 	protected $_id;
 
 	/**
-	 * @var object reference to document this link belongs to
+	 * @var SeedDMS_Core_Document reference to document this link belongs to
 	 */
 	protected $_document;
 
@@ -4571,6 +4571,14 @@ class SeedDMS_Core_DocumentLink { /* {{{ */
 	 */
 	protected $_public;
 
+    /**
+     * SeedDMS_Core_DocumentLink constructor.
+     * @param $id
+     * @param $document
+     * @param $target
+     * @param $userID
+     * @param $public
+     */
 	function __construct($id, $document, $target, $userID, $public) {
 		$this->_id = $id;
 		$this->_document = $document;
@@ -4579,35 +4587,52 @@ class SeedDMS_Core_DocumentLink { /* {{{ */
 		$this->_public = $public;
 	}
 
+    /**
+     * @return int
+     */
 	function getID() { return $this->_id; }
 
+    /**
+     * @return SeedDMS_Core_Document
+     */
 	function getDocument() {
 		return $this->_document;
 	}
 
+    /**
+     * @return object
+     */
 	function getTarget() {
 		return $this->_target;
 	}
 
+    /**
+     * @return bool|SeedDMS_Core_User
+     */
 	function getUser() {
 		if (!isset($this->_user))
 			$this->_user = $this->_document->_dms->getUser($this->_userID);
 		return $this->_user;
 	}
 
+    /**
+     * @return int
+     */
 	function isPublic() { return $this->_public; }
 
-	/**
+    /**
-	 * Returns the access mode similar to a document
+     * Returns the access mode similar to a document
-	 *
+     *
-	 * There is no real access mode for document links, so this is just
+     * There is no real access mode for document links, so this is just
-	 * another way to add more access restrictions than the default restrictions.
+     * another way to add more access restrictions than the default restrictions.
-	 * It is only called for public document links, not accessed by the owner
+     * It is only called for public document links, not accessed by the owner
-	 * or the administrator.
+     * or the administrator.
-	 *
+     *
-	 * @param object $u user
+     * @param SeedDMS_Core_User $u user
-	 * @return integer either M_NONE or M_READ
+     * @param $source
-	 */
+     * @param $target
+     * @return int either M_NONE or M_READ
+     */
 	function getAccessMode($u, $source, $target) { /* {{{ */
 		$dms = $this->_document->_dms;
 
@@ -4649,7 +4674,7 @@ class SeedDMS_Core_DocumentFile { /* {{{ */
 	protected $_id;
 
 	/**
-	 * @var object reference to document this file belongs to
+	 * @var SeedDMS_Core_Document reference to document this file belongs to
 	 */
 	protected $_document;
 
@@ -4706,6 +4731,21 @@ class SeedDMS_Core_DocumentFile { /* {{{ */
 	 */
 	protected $_name;
 
+    /**
+     * SeedDMS_Core_DocumentFile constructor.
+     * @param $id
+     * @param $document
+     * @param $userID
+     * @param $comment
+     * @param $date
+     * @param $dir
+     * @param $fileType
+     * @param $mimeType
+     * @param $orgFileName
+     * @param $name
+     * @param $version
+     * @param $public
+     */
 	function __construct($id, $document, $userID, $comment, $date, $dir, $fileType, $mimeType, $orgFileName,$name,$version,$public) {
 		$this->_id = $id;
 		$this->_document = $document;
@@ -4721,29 +4761,80 @@ class SeedDMS_Core_DocumentFile { /* {{{ */
 		$this->_public = $public;
 	}
 
+    /**
+     * @return int
+     */
 	function getID() { return $this->_id; }
+
+    /**
+     * @return SeedDMS_Core_Document
+     */
 	function getDocument() { return $this->_document; }
+
+    /**
+     * @return int
+     */
 	function getUserID() { return $this->_userID; }
+
+    /**
+     * @return string
+     */
 	function getComment() { return $this->_comment; }
+
+    /**
+     * @return string
+     */
 	function getDate() { return $this->_date; }
+
+    /**
+     * @return string
+     */
 	function getDir() { return $this->_dir; }
+
+    /**
+     * @return string
+     */
 	function getFileType() { return $this->_fileType; }
+
+    /**
+     * @return string
+     */
 	function getMimeType() { return $this->_mimeType; }
+
+    /**
+     * @return string
+     */
 	function getOriginalFileName() { return $this->_orgFileName; }
+
+    /**
+     * @return string
+     */
 	function getName() { return $this->_name; }
 
+    /**
+     * @return bool|SeedDMS_Core_User
+     */
 	function getUser() {
 		if (!isset($this->_user))
 			$this->_user = $this->_document->_dms->getUser($this->_userID);
 		return $this->_user;
 	}
 
+    /**
+     * @return string
+     */
 	function getPath() {
 		return $this->_document->getDir() . "f" .$this->_id . $this->_fileType;
 	}
 
+    /**
+     * @return int
+     */
 	function getVersion() { return $this->_version; }
 
+    /**
+     * @return int
+     */
 	function isPublic() { return $this->_public; }
 
 	/**
@@ -4794,18 +4885,45 @@ class SeedDMS_Core_DocumentFile { /* {{{ */
  */
 class SeedDMS_Core_AddContentResultSet { /* {{{ */
 
+    /**
+     * @var null
+     */
 	protected $_indReviewers;
+
+    /**
+     * @var null
+     */
 	protected $_grpReviewers;
+
+    /**
+     * @var null
+     */
 	protected $_indApprovers;
+
+    /**
+     * @var null
+     */
 	protected $_grpApprovers;
+
+    /**
+     * @var
+     */
 	protected $_content;
+
+    /**
+     * @var null
+     */
 	protected $_status;
 
 	/**
-	 * @var object back reference to document management system
+	 * @var SeedDMS_Core_DMS back reference to document management system
 	 */
 	protected $_dms;
 
+    /**
+     * SeedDMS_Core_AddContentResultSet constructor.
+     * @param $content
+     */
 	function __construct($content) { /* {{{ */
 		$this->_content = $content;
 		$this->_indReviewers = null;
@@ -4816,7 +4934,7 @@ class SeedDMS_Core_AddContentResultSet { /* {{{ */
 		$this->_dms = null;
 	} /* }}} */
 
-	/*
+	/**
 	 * Set dms this object belongs to.
 	 *
 	 * Each object needs a reference to the dms it belongs to. It will be
@@ -4824,12 +4942,18 @@ class SeedDMS_Core_AddContentResultSet { /* {{{ */
 	 * The dms has a references to the currently logged in user
 	 * and the database connection.
 	 *
-	 * @param object $dms reference to dms
+	 * @param SeedDMS_Core_DMS $dms reference to dms
 	 */
 	function setDMS($dms) { /* {{{ */
 		$this->_dms = $dms;
 	} /* }}} */
 
+    /**
+     * @param $reviewer
+     * @param $type
+     * @param $status
+     * @return bool
+     */
 	function addReviewer($reviewer, $type, $status) { /* {{{ */
 		$dms = $this->_dms;
 
@@ -4857,6 +4981,12 @@ class SeedDMS_Core_AddContentResultSet { /* {{{ */
 		return true;
 	} /* }}} */
 
+    /**
+     * @param $approver
+     * @param $type
+     * @param $status
+     * @return bool
+     */
 	function addApprover($approver, $type, $status) { /* {{{ */
 		$dms = $this->_dms;
 
@@ -4884,6 +5014,10 @@ class SeedDMS_Core_AddContentResultSet { /* {{{ */
 		return true;
 	} /* }}} */
 
+    /**
+     * @param $status
+     * @return bool
+     */
 	function setStatus($status) { /* {{{ */
 		if (!is_integer($status)) {
 			return false;
@@ -4895,14 +5029,24 @@ class SeedDMS_Core_AddContentResultSet { /* {{{ */
 		return true;
 	} /* }}} */
 
+    /**
+     * @return null
+     */
 	function getStatus() { /* {{{ */
 		return $this->_status;
 	} /* }}} */
 
+    /**
+     * @return mixed
+     */
 	function getContent() { /* {{{ */
 		return $this->_content;
 	} /* }}} */
 
+    /**
+     * @param $type
+     * @return array|bool|null
+     */
 	function getReviewers($type) { /* {{{ */
 		if (strcasecmp($type, "i") && strcasecmp($type, "g")) {
 			return false;
@@ -4915,6 +5059,10 @@ class SeedDMS_Core_AddContentResultSet { /* {{{ */
 		}
 	} /* }}} */
 
+    /**
+     * @param $type
+     * @return array|bool|null
+     */
 	function getApprovers($type) { /* {{{ */
 		if (strcasecmp($type, "i") && strcasecmp($type, "g")) {
 			return false;
@@ -4927,4 +5075,3 @@ class SeedDMS_Core_AddContentResultSet { /* {{{ */
 		}
 	} /* }}} */
 } /* }}} */
-?>

SeedDMS_Core/Core/inc.ClassObject.php

@@ -34,7 +34,7 @@ class SeedDMS_Core_Object { /* {{{ */
 	protected $_attributes;
 
 	/**
-	 * @var object back reference to document management system
+	 * @var SeedDMS_Core_DMS back reference to document management system
 	 */
 	public $_dms;
 
@@ -67,8 +67,8 @@ class SeedDMS_Core_Object { /* {{{ */
 	/**
 	 * Returns all attributes set for the object
 	 *
-	 * @return array list of objects of class SeedDMS_Core_Attribute
+	 * @return array|bool
-	 */
+     */
 	function getAttributes() { /* {{{ */
 		if (!$this->_attributes) {
 			$db = $this->_dms->getDB();
@@ -102,12 +102,13 @@ class SeedDMS_Core_Object { /* {{{ */
 
 	} /* }}} */
 
-	/**
+    /**
-	 * Returns an attribute of the object for the given attribute definition
+     * Returns an attribute of the object for the given attribute definition
-	 *
+     *
-	 * @return array|string value of attritbute or false. The value is an array
+     * @param SeedDMS_Core_AttributeDefinition $attrdef
-	 * if the attribute is defined as multi value
+     * @return array|string value of attritbute or false. The value is an array
-	 */
+     * if the attribute is defined as multi value
+     */
 	function getAttribute($attrdef) { /* {{{ */
 		if (!$this->_attributes) {
 			$this->getAttributes();
@@ -124,6 +125,7 @@ class SeedDMS_Core_Object { /* {{{ */
 	/**
 	 * Returns an attribute value of the object for the given attribute definition
 	 *
+	 * @param SeedDMS_Core_AttributeDefinition $attrdef
 	 * @return array|string value of attritbute or false. The value is an array
 	 * if the attribute is defined as multi value
 	 */
@@ -154,16 +156,17 @@ class SeedDMS_Core_Object { /* {{{ */
 
 	} /* }}} */
 
-	/**
+    /**
-	 * Returns an attribute value of the object for the given attribute definition
+     * Returns an attribute value of the object for the given attribute definition
-	 *
+     *
-	 * This is a short cut for getAttribute($attrdef)->getValueAsArray() but
+     * This is a short cut for getAttribute($attrdef)->getValueAsArray() but
-	 * first checks if the object has an attribute for the given attribute
+     * first checks if the object has an attribute for the given attribute
-	 * definition.
+     * definition.
-	 *
+     *
-	 * @return array value of attritbute or false. The value is always an array
+     * @param SeedDMS_Core_AttributeDefinition $attrdef
-	 * even if the attribute is not defined as multi value
+     * @return array|bool
-	 */
+     * even if the attribute is not defined as multi value
+     */
 	function getAttributeValueAsArray($attrdef) { /* {{{ */
 		if (!$this->_attributes) {
 			$this->getAttributes();
@@ -183,6 +186,7 @@ class SeedDMS_Core_Object { /* {{{ */
 	 * first checks if the object has an attribute for the given attribute
 	 * definition.
 	 *
+     * @param SeedDMS_Core_AttributeDefinition $attrdef
 	 * @return string value of attritbute or false. The value is always a string
 	 * even if the attribute is defined as multi value
 	 */
@@ -201,8 +205,8 @@ class SeedDMS_Core_Object { /* {{{ */
 	/**
 	 * Set an attribute of the object for the given attribute definition
 	 *
-	 * @param object $attrdef definition of attribute
+	 * @param SeedDMS_Core_AttributeDefinition $attrdef definition of attribute
-	 * @param array|sting $value value of attribute, for multiple values this
+	 * @param array|string $value value of attribute, for multiple values this
 	 * must be an array
 	 * @return boolean true if operation was successful, otherwise false
 	 */
@@ -254,7 +258,7 @@ class SeedDMS_Core_Object { /* {{{ */
 
 	/**
 	 * Remove an attribute of the object for the given attribute definition
-	 *
+	 * @param SeedDMS_Core_AttributeDefinition $attrdef
 	 * @return boolean true if operation was successful, otherwise false
 	 */
 	function removeAttribute($attrdef) { /* {{{ */
@@ -285,4 +289,3 @@ class SeedDMS_Core_Object { /* {{{ */
 		return true;
 	} /* }}} */
 } /* }}} */
-?>