[Fusionforge-commits] FusionForge branch master updated. v6.0.5-2050-g38b9bb7
Marc-Etienne VARGENAU
vargenau at libremir.placard.fr.eu.org
Thu Aug 3 14:58:39 CEST 2017
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "FusionForge".
The branch, master has been updated
via 38b9bb71772417970b439a0abe9ec8c0097af331 (commit)
from fe21219d27284233a3a5fba68cb7210c94382764 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
https://scm.fusionforge.org/anonscm/gitweb/?p=fusionforge/fusionforge.git;a=commitdiff;h=38b9bb71772417970b439a0abe9ec8c0097af331
commit 38b9bb71772417970b439a0abe9ec8c0097af331
Author: Marc-Etienne Vargenau <marc-etienne.vargenau at nokia.com>
Date: Thu Aug 3 14:58:24 2017 +0200
PHP Doc
diff --git a/src/common/dao/include/DataAccessObject.class.php b/src/common/dao/include/DataAccessObject.class.php
index 975212b..45f54db 100644
--- a/src/common/dao/include/DataAccessObject.class.php
+++ b/src/common/dao/include/DataAccessObject.class.php
@@ -47,7 +47,7 @@ class DataAccessObject {
* For INSERT, UPDATE and DELETE queries
* @param string $sql the query string
* @param array $params The arguments
- * @return boolean true if success
+ * @return bool true if success
*/
function update($sql,$params) {
$result = db_query_params($sql,$params);
diff --git a/src/common/docman/Document.class.php b/src/common/docman/Document.class.php
index 4d747ae..dac69b7 100644
--- a/src/common/docman/Document.class.php
+++ b/src/common/docman/Document.class.php
@@ -289,7 +289,7 @@ class Document extends FFObject {
* fetchData() - re-fetch the data for this document from the database.
*
* @param int $docid The document id.
- * @return boolean success
+ * @return bool success
*/
function fetchData($docid) {
$res = db_query_params('SELECT * FROM docdata_vw WHERE docid=$1 AND group_id=$2',
@@ -344,7 +344,7 @@ class Document extends FFObject {
/**
* isURL - whether this document is a URL and not a local file.
*
- * @return boolean is_url.
+ * @return bool is_url.
*/
function isURL() {
return ($this->data_array['filetype'] == 'URL');
@@ -353,7 +353,7 @@ class Document extends FFObject {
/**
* isText - whether this document is a text document and not a binary one.
*
- * @return boolean is_text.
+ * @return bool is_text.
*/
function isText() {
$doctype = $this->data_array['filetype'];
@@ -366,7 +366,7 @@ class Document extends FFObject {
/**
* isHtml - whether this document is a html document.
*
- * @return boolean is_html.
+ * @return bool is_html.
*/
function isHtml() {
$doctype = $this->data_array['filetype'];
@@ -379,7 +379,7 @@ class Document extends FFObject {
/**
* isPublic - whether this document is available to the general public.
*
- * @return boolean is_public.
+ * @return bool is_public.
*/
function isPublic() {
return (($this->data_array['stateid'] == 1) ? true : false);
@@ -486,7 +486,7 @@ class Document extends FFObject {
/**
* getFileData - the filedata of this document.
*
- * @param boolean $download update the download flag or not. default is true
+ * @param bool $download update the download flag or not. default is true
* @return string The filedata.
*/
function getFileData($download = true) {
@@ -633,7 +633,7 @@ class Document extends FFObject {
* removeMonitoredBy - remove this document for a specific user id for monitoring.
*
* @param int $userid User ID
- * @return boolean true if success
+ * @return bool true if success
*/
function removeMonitoredBy($userid) {
$MonitorElementObject = new MonitorElement('docdata');
@@ -648,7 +648,7 @@ class Document extends FFObject {
* addMonitoredBy - add this document for a specific user id for monitoring.
*
* @param int $userid User ID
- * @return boolean true if success
+ * @return bool true if success
*/
function addMonitoredBy($userid) {
$MonitorElementObject = new MonitorElement('docdata');
@@ -662,7 +662,7 @@ class Document extends FFObject {
/**
* clearMonitor - remove all entries of monitoring for this document.
*
- * @return boolean true if success.
+ * @return bool true if success.
*/
function clearMonitor() {
$MonitorElementObject = new MonitorElement('docdata');
@@ -677,7 +677,7 @@ class Document extends FFObject {
* setState - set the stateid of the document.
*
* @param int $stateid The state id of the doc_states table.
- * @return boolean success or not.
+ * @return bool success or not.
*/
function setState($stateid) {
return $this->setValueinDB(array('stateid'), array($stateid));
@@ -688,7 +688,7 @@ class Document extends FFObject {
* setDocGroupID - set the doc_group of the document.
*
* @param int $newdocgroupid The group_id of this document.
- * @return boolean success or not.
+ * @return bool success or not.
*/
function setDocGroupID($newdocgroupid) {
return $this->setValueinDB(array('doc_group'), array($newdocgroupid));
@@ -720,7 +720,7 @@ class Document extends FFObject {
*
* @param int $statusReserved The status of the reserved
* @param int $idReserver The ID of the owner : by default : noone
- * @return boolean success
+ * @return bool success
*/
function setReservedBy($statusReserved, $idReserver = NULL) {
$colArr = array('reserved', 'reserved_by');
@@ -846,7 +846,7 @@ class Document extends FFObject {
* @param array $importData Array of data to change creator, time of creation, bypass permission check and do not send notification like:
* array('user' => 127, 'time' => 1234556789, 'nopermcheck' => 1, 'nonotice' => 1)
* @param string $vcomment The comment of this version
- * @return boolean success.
+ * @return bool success.
*/
function update($filename, $filetype, $data, $doc_group, $title, $description, $stateid, $version = 1, $current_version = 1, $new_version = 0, $importData = array(), $vcomment = '') {
@@ -993,7 +993,7 @@ class Document extends FFObject {
/**
* sendNotice - Notifies of document submissions
*
- * @param boolean true = new document (default value)
+ * @param bool true = new document (default value)
* @return bool
*/
function sendNotice($new = true) {
@@ -1033,7 +1033,7 @@ class Document extends FFObject {
/**
* sendApprovalNotice - send email to project admin for pending documents.
*
- * @return boolean success.
+ * @return bool success.
*/
function sendApprovalNotice() {
if ($this->getStateID() != 3)
@@ -1081,7 +1081,7 @@ class Document extends FFObject {
/**
* delete - Delete this file
*
- * @return boolean success
+ * @return bool success
*/
function delete() {
$perm =& $this->Group->getPermission();
@@ -1121,7 +1121,7 @@ class Document extends FFObject {
/**
* trash - move this file to trash
*
- * @return boolean success or not.
+ * @return bool success or not.
*/
function trash() {
if (!$this->getLocked() || ((time() - $this->getLockdate()) > 600)) {
@@ -1159,8 +1159,7 @@ class Document extends FFObject {
*
* @param array $colArr the columns to update in array form array('col1', col2')
* @param array $valArr the values to store in array form array('val1', 'val2')
- * @return boolean success or not
- * @access private
+ * @return bool success or not
*/
private function setValueinDB($colArr, $valArr) {
if ((count($colArr) != count($valArr)) || !count($colArr) || !count($valArr)) {
diff --git a/src/common/docman/DocumentFactory.class.php b/src/common/docman/DocumentFactory.class.php
index f393958..195bd58 100644
--- a/src/common/docman/DocumentFactory.class.php
+++ b/src/common/docman/DocumentFactory.class.php
@@ -54,7 +54,7 @@ class DocumentFactory extends FFError {
/**
* The doc_group_id limit
- * @var integer Contains the doc_group id to limit return documents in getDocuments.
+ * @var int Contains the doc_group id to limit return documents in getDocuments.
*/
var $docgroupid;
@@ -74,7 +74,7 @@ class DocumentFactory extends FFError {
/**
* The limit
- * @var integer Contains the limit of documents retrieve by getDocuments.
+ * @var int Contains the limit of documents retrieve by getDocuments.
* Default value is 0 which means NO LIMIT
*/
var $limit = 0;
@@ -88,7 +88,7 @@ class DocumentFactory extends FFError {
/**
* The offset
- * @var integer Contains the offset of the query used to retrive documents using getDocuments.
+ * @var int Contains the offset of the query used to retrive documents using getDocuments.
* Default value is 0 which means NO OFFSET
*/
var $offset = 0;
@@ -382,8 +382,7 @@ class DocumentFactory extends FFError {
* getFromStorage - Retrieve documents from storage (database for all informations).
* you can limit query to speed up: warning, once $this->documents is retrieve, it's cached.
*
- * @return boolean success or not
- * @access private
+ * @return bool success or not
*/
private function getFromStorage() {
$this->Documents = array();
diff --git a/src/common/docman/DocumentGroup.class.php b/src/common/docman/DocumentGroup.class.php
index e7d7d32..12564f6 100644
--- a/src/common/docman/DocumentGroup.class.php
+++ b/src/common/docman/DocumentGroup.class.php
@@ -332,7 +332,7 @@ class DocumentGroup extends FFError {
/**
* getID - get this DocumentGroup's ID.
*
- * @return integer The id #.
+ * @return int The id #.
* @access public
*/
function getID() {
@@ -342,7 +342,7 @@ class DocumentGroup extends FFError {
/**
* getID - get parent DocumentGroup's id.
*
- * @return integer The id #.
+ * @return int The id #.
* @access public
*/
function getParentID() {
@@ -362,7 +362,7 @@ class DocumentGroup extends FFError {
/**
* getState - get the state id.
*
- * @return integer The state id.
+ * @return int The state id.
* @access public
*/
function getState() {
@@ -372,7 +372,7 @@ class DocumentGroup extends FFError {
/**
* getCreatedate - get the creation date.
*
- * @return integer The creation date.
+ * @return int The creation date.
* @access public
*/
function getCreatedate() {
@@ -382,7 +382,7 @@ class DocumentGroup extends FFError {
/**
* getUpdatedate - get the update date.
*
- * @return integer The update date.
+ * @return int The update date.
* @access public
*/
function getUpdatedate() {
@@ -392,7 +392,7 @@ class DocumentGroup extends FFError {
/**
* getLastModifyDate - get the bigger value between update date and creation date.
*
- * @return integer The last modified date.
+ * @return int The last modified date.
* @access public
*/
function getLastModifyDate() {
@@ -433,7 +433,7 @@ class DocumentGroup extends FFError {
* removeMonitoredBy - remove this document directory for a specific user id for monitoring.
*
* @param int $userid User ID
- * @return boolean true if success
+ * @return bool true if success
*/
function removeMonitoredBy($userid) {
$MonitorElementObject = new MonitorElement('docgroup');
@@ -448,7 +448,7 @@ class DocumentGroup extends FFError {
* addMonitoredBy - add this document for a specific user id for monitoring.
*
* @param int $userid User ID
- * @return boolean true if success
+ * @return bool true if success
*/
function addMonitoredBy($userid) {
$MonitorElementObject = new MonitorElement('docgroup');
@@ -462,7 +462,7 @@ class DocumentGroup extends FFError {
/**
* clearMonitor - remove all entries of monitoring for this document.
*
- * @return boolean true if success.
+ * @return bool true if success.
*/
function clearMonitor() {
$MonitorElementObject = new MonitorElement('docgroup');
@@ -476,7 +476,7 @@ class DocumentGroup extends FFError {
/**
* getCreated_by - get the creator (user) id.
*
- * @return integer The User id.
+ * @return int The User id.
* @access public
*/
function getCreated_by() {
@@ -491,7 +491,7 @@ class DocumentGroup extends FFError {
* @param int $metadata update only the metadata : created_by, updatedate
* @param int $state state of the directory. Default is 1 = public. See create function for valid values
* @param int $updatetimestamp Timestamp of the update
- * @return boolean success or not
+ * @return bool success or not
* @access public
*/
function update($name, $parent_doc_group = 0, $metadata = 0, $state = 1, $updatetimestamp = null) {
@@ -664,9 +664,9 @@ class DocumentGroup extends FFError {
/**
* getPath - return the complete_path
*
- * @param boolean $url does path is url clickable (default is false)
- * @param boolean $includename does path include this document group name ? (default is true)
- * @return string|boolean the complete_path or false if user has not proper access to this path.
+ * @param bool $url does path is url clickable (default is false)
+ * @param bool $includename does path include this document group name ? (default is true)
+ * @return string|bool the complete_path or false if user has not proper access to this path.
* @access public
*/
function getPath($url = false, $includename = true) {
@@ -716,7 +716,7 @@ class DocumentGroup extends FFError {
*
* @param int $stateid State ID.
* @param bool $recursive set the state id recursively. (i.e. move the directory and his content to trash)
- * @return boolean success or not.
+ * @return bool success or not.
* @access public
*/
function setStateID($stateid, $recursive = false) {
@@ -779,7 +779,7 @@ class DocumentGroup extends FFError {
* setParentDocGroupId - set the parent doc_group id of this document group.
*
* @param int $parentDocGroupId Parent Doc_group Id.
- * @return boolean success or not.
+ * @return bool success or not.
* @access public
*/
function setParentDocGroupId($parentDocGroupId) {
@@ -789,7 +789,7 @@ class DocumentGroup extends FFError {
/**
* sendNotice - Notifies of directory submissions
*
- * @param boolean $new true = new directory (default value)
+ * @param bool $new true = new directory (default value)
* @return bool
*/
function sendNotice($new = true) {
@@ -850,8 +850,7 @@ class DocumentGroup extends FFError {
* injectZip - private method to inject a zip archive tree and files
*
* @param array $uploadedZip uploaded zip
- * @return boolean success or not
- * @access private
+ * @return bool success or not
*/
private function injectZip($uploadedZip) {
$zip = new ZipArchive();
@@ -880,8 +879,7 @@ class DocumentGroup extends FFError {
* injectRar - private method to inject a rar archive tree and files
*
* @param array $uploadedRar uploaded rar
- * @return boolean success or not
- * @access private
+ * @return bool success or not
*/
private function injectRar($uploadedRar) {
return true;
@@ -891,8 +889,7 @@ class DocumentGroup extends FFError {
* injectContent - private method to inject a directory tree and files
*
* @param string $directory the directory to inject
- * @return boolean success or not
- * @access private
+ * @return bool success or not
*/
private function injectContent($directory) {
if (is_dir($directory)) {
@@ -1007,8 +1004,7 @@ class DocumentGroup extends FFError {
*
* @param array $colArr the columns to update in array form array('col1', col2')
* @param int $valArr the values to store in array form array('val1', 'val2')
- * @return boolean success or not
- * @access private
+ * @return bool success or not
*/
private function setValueinDB($colArr, $valArr) {
if ((count($colArr) != count($valArr)) || !count($colArr) || !count($valArr)) {
diff --git a/src/common/docman/DocumentManager.class.php b/src/common/docman/DocumentManager.class.php
index e9dfe7b..520f5dc 100644
--- a/src/common/docman/DocumentManager.class.php
+++ b/src/common/docman/DocumentManager.class.php
@@ -72,7 +72,7 @@ class DocumentManager extends FFError {
/**
* getTrashID - the trash doc_group id for this DocumentManager.
*
- * @return integer The trash doc_group id.
+ * @return int The trash doc_group id.
*/
function getTrashID() {
if (isset($this->data_array['trashid']))
@@ -98,7 +98,7 @@ class DocumentManager extends FFError {
/**
* cleanTrash - delete all items in trash for this DocumentManager
*
- * @return boolean true on success
+ * @return bool true on success
*/
function cleanTrash() {
$trashId = $this->getTrashID();
@@ -126,7 +126,7 @@ class DocumentManager extends FFError {
/**
* isTrashEmpty - check if the trash is empty
- * @return boolean success or not
+ * @return bool success or not
*/
function isTrashEmpty() {
if ($this->Group->usesPlugin('projects-hierarchy')) {
diff --git a/src/common/docman/DocumentVersion.class.php b/src/common/docman/DocumentVersion.class.php
index 6c1df25..131cf58 100644
--- a/src/common/docman/DocumentVersion.class.php
+++ b/src/common/docman/DocumentVersion.class.php
@@ -275,7 +275,7 @@ class DocumentVersion extends FFError {
/**
* isURL - whether this document is a URL and not a local file.
*
- * @return boolean is_url.
+ * @return bool is_url.
*/
function isURL() {
return ($this->data_array['filetype'] == 'URL');
@@ -345,8 +345,7 @@ class DocumentVersion extends FFError {
* @param int $version the version id to update
* @param array $colArr the columns to update in array form array('col1', col2')
* @param array $valArr the values to store in array form array('val1', 'val2')
- * @return boolean success or not
- * @access private
+ * @return bool success or not
*/
private function setValueinDB($version, $colArr, $valArr) {
if ((count($colArr) != count($valArr)) || !count($colArr) || !count($valArr)) {
diff --git a/src/common/docman/include/utils.php b/src/common/docman/include/utils.php
index effe5ef..8518e1e 100644
--- a/src/common/docman/include/utils.php
+++ b/src/common/docman/include/utils.php
@@ -56,7 +56,7 @@ function doc_get_state_box($checkedval = 'xzxz', $removedval = array()) {
* @param object $document_factory
* @param int $docgroup id : default value = 0
* @param string $parent_docname parent name : default value = empty
- * @return boolean success or not
+ * @return bool success or not
* @access public
*/
function docman_fill_zip($zip, $nested_groups, $document_factory, $docgroup = 0, $parent_docname = '') {
diff --git a/src/common/forum/Forum.class.php b/src/common/forum/Forum.class.php
index bb5cabd..e9ad867 100644
--- a/src/common/forum/Forum.class.php
+++ b/src/common/forum/Forum.class.php
@@ -250,7 +250,7 @@ class Forum extends FFError {
* fetchData - re-fetch the data for this forum from the database.
*
* @param int $group_forum_id The forum_id.
- * @return boolean success.
+ * @return bool success.
*/
function fetchData($group_forum_id) {
$res=db_query_params('SELECT * FROM forum_group_list_vw WHERE group_forum_id=$1 AND group_id=$2',
@@ -424,7 +424,7 @@ class Forum extends FFError {
* setMonitor - Add the current user to the list of people monitoring the forum.
*
* @param int $u user id of the user which will be set to monitor this forum. Defaults to 0, meaning the current logged in user will be used.
- * @return boolean success.
+ * @return bool success.
*/
function setMonitor($u = -1) {
if ($u == -1) {
@@ -446,7 +446,7 @@ class Forum extends FFError {
* stopMonitor - Remove the current user from the list of people monitoring the forum.
*
* @param $u
- * @return boolean success.
+ * @return bool success.
*/
function stopMonitor($u = -1) {
if ($u == -1) {
@@ -467,7 +467,7 @@ class Forum extends FFError {
/**
* isMonitoring - See if the current user is in the list of people monitoring the forum.
*
- * @return boolean is_monitoring.
+ * @return bool is_monitoring.
*/
function isMonitoring() {
if (!session_loggedin()) {
@@ -480,7 +480,7 @@ class Forum extends FFError {
/**
* savePlace - set a unix time into the database for this user, so future messages can be highlighted.
*
- * @return boolean success.
+ * @return bool success.
*/
function savePlace() {
if (!session_loggedin()) {
@@ -526,7 +526,7 @@ class Forum extends FFError {
* @param string $forum_name The name of the forum.
* @param string $description The description of the forum.
* @param string $send_all_posts_to The email address to send all new posts to.
- * @return boolean success.
+ * @return bool success.
*/
function update($forum_name, $description, $send_all_posts_to = '') {
if (strlen($forum_name) < 3) {
diff --git a/src/common/forum/ForumFactory.class.php b/src/common/forum/ForumFactory.class.php
index 373ea36..5ba1617 100644
--- a/src/common/forum/ForumFactory.class.php
+++ b/src/common/forum/ForumFactory.class.php
@@ -173,7 +173,7 @@ class ForumFactory extends FFError {
*
* Note: old forum ID is useless if forum_agg_msg_count table is no longer used
*
- * @return boolean success.
+ * @return bool success.
*/
function moveThread($group_forum_id,$thread_id,$old_forum_id = false) {
$res = db_query_params('UPDATE forum SET group_forum_id=$1 WHERE thread_id=$2',
diff --git a/src/common/forum/ForumMessage.class.php b/src/common/forum/ForumMessage.class.php
index 9811d83..74615ac 100644
--- a/src/common/forum/ForumMessage.class.php
+++ b/src/common/forum/ForumMessage.class.php
@@ -99,7 +99,7 @@ class ForumMessage extends FFError {
* @param int $thread_id The thread_id of the message, if known.
* @param int $is_followup_to The message_id of the parent message, if any.
* @param int $user_id The id of the user that is posting the message
- * @return boolean success.
+ * @return bool success.
*/
function insertmoderated($subject, $body, $thread_id=0, $is_followup_to=0,$user_id) {
if (!$thread_id) {
@@ -244,7 +244,7 @@ class ForumMessage extends FFError {
* @param int $user_id The id of the user that is posting the message
* @param bool $has_attach Whether the message has an attach associated. Defaults to false
* @param int $timestamp The timestamp of the message to insert, defaults to 0.
- * @return boolean success.
+ * @return bool success.
*/
function insertmsg($subject, $body, $thread_id=0, $is_followup_to=0,
$user_id, $has_attach=false, $timestamp=0) {
@@ -345,7 +345,7 @@ class ForumMessage extends FFError {
* @param int $is_followup_to The message_id of the parent message, if any.
* @param bool $has_attach Whether the message has an attach associated. Defaults to false
* @param int $timestamp The timestamp of the message to create. Defaults to 0, meaning the timestamp used for this message will be "time()"
- * @return boolean success.
+ * @return bool success.
*/
function create($subject, $body, $thread_id=0, $is_followup_to=0, $has_attach=false, $timestamp = 0) {
if (!strlen(trim($body)) || !strlen(trim($subject))) {
@@ -392,7 +392,7 @@ class ForumMessage extends FFError {
* fetchData - re-fetch the data for this forum_message from the database.
*
* @param int $msg_id The message ID.
- * @return boolean success.
+ * @return bool success.
*/
function fetchData($msg_id) {
$res = db_query_params ('SELECT * FROM forum_user_vw WHERE msg_id=$1 AND group_forum_id=$2',
@@ -410,7 +410,7 @@ class ForumMessage extends FFError {
* fetchModeratedData - re-fetch the data for this forum_message from the database, for pending messages
*
* @param int The message ID.
- * @return boolean success.
+ * @return bool success.
*/
function fetchModeratedData($msg_id) {
$res = db_query_params ('SELECT * FROM forum_pending_user_vw WHERE msg_id=$1 AND group_forum_id=$2',
@@ -535,7 +535,7 @@ class ForumMessage extends FFError {
/**
* hasFollowups - whether this message has any followups.
*
- * @return boolean has_followups.
+ * @return bool has_followups.
*/
function hasFollowups() {
return $this->data_array['has_followups'];
@@ -544,7 +544,7 @@ class ForumMessage extends FFError {
/**
* hasAttach - whether this message has an attachment.
*
- * @return boolean has_attach.
+ * @return bool has_attach.
*/
function hasAttach() {
if ($this->isPending()) {
@@ -620,8 +620,8 @@ class ForumMessage extends FFError {
/**
* sendNotice - contains the logic to send out email followups when a message is posted.
*
- * @param boolean $has_attach Whether the message has an attach associated. Defaults to false
- * @return boolean success.
+ * @param bool $has_attach Whether the message has an attach associated. Defaults to false
+ * @return bool success.
*/
function sendNotice($has_attach=false) {
$ids = $this->Forum->getMonitoringIDs();
@@ -714,7 +714,7 @@ Or reply to this e-mail entering your response between the following markers:
/**
* sendNewModeratedMsgNotice - contains the logic to send out email notifications to the forum admins when a new moderated message is posted
*
- * @return boolean success.
+ * @return bool success.
*/
function sendNewModeratedMsgNotice() {
$ids = array();
@@ -788,7 +788,7 @@ Or reply to this e-mail entering your response between the following markers:
* @param int $thread_id The thread_id of the message, if known.
* @param int $has_followups has followups?
* @param string $most_recent_date The most recent date.
- * @return boolean success.
+ * @return bool success.
*/
function updatemsg($group_forum_id, $posted_by, $subject, $body,
$post_date, $is_followup_to, $thread_id, $has_followups, $most_recent_date) {
@@ -828,7 +828,7 @@ Or reply to this e-mail entering your response between the following markers:
* sendAttachNotice - contains the logic to send out email attachement followups when a message is posted.
*
* @param int $attach_id - The id of the file that has been attached
- * @return boolean success.
+ * @return bool success.
*/
function sendAttachNotice($attach_id) {
if ($attach_id) {
diff --git a/src/common/frs/FRSFile.class.php b/src/common/frs/FRSFile.class.php
index fce59de..c564183 100644
--- a/src/common/frs/FRSFile.class.php
+++ b/src/common/frs/FRSFile.class.php
@@ -219,7 +219,7 @@ class FRSFile extends FFError {
* fetchData - re-fetch the data for this FRSFile from the database.
*
* @param int $file_id The file_id.
- * @return boolean success.
+ * @return bool success.
*/
function fetchData($file_id) {
$res = db_query_params ('SELECT * FROM frs_file_vw WHERE file_id=$1 AND release_id=$2',
@@ -337,7 +337,7 @@ class FRSFile extends FFError {
/**
* delete - Delete this file from the database and file system.
*
- * @return boolean success.
+ * @return bool success.
*/
function delete() {
if (!forge_check_perm('frs', $this->FRSRelease->FRSPackage->getID(), 'file')) {
@@ -380,7 +380,7 @@ class FRSFile extends FFError {
* @param int $processor_id The processor_id of this file from the frs-processor-types table.
* @param int $release_time The release_date of this file in unix time (seconds).
* @param int|bool $release_id The release_id of the release this file belongs to (if not set, defaults to the release id of this file).
- * @return boolean success.
+ * @return bool success.
*/
function update($type_id, $processor_id, $release_time, $release_id = false) {
if (!forge_check_perm('frs', $this->FRSRelease->FRSPackage->getID(), 'file')) {
diff --git a/src/common/frs/FRSPackage.class.php b/src/common/frs/FRSPackage.class.php
index e7a7bc1..d86e3ce 100644
--- a/src/common/frs/FRSPackage.class.php
+++ b/src/common/frs/FRSPackage.class.php
@@ -77,8 +77,8 @@ function frspackage_get_object($package_id, $data = false) {
/**
* frspackage_get_groupid - get the project id from a package id
*
- * @param integer $package_id the package id
- * @return integer the project id
+ * @param int $package_id the package id
+ * @return int the project id
*/
function frspackage_get_groupid($package_id) {
$res = db_query_params('SELECT group_id FROM frs_package WHERE package_id=$1',
@@ -148,7 +148,7 @@ class FRSPackage extends FFError {
*
* @param string $name Name of the package
* @param int $status Status ID. Default is 1 => Active
- * @return boolean success.
+ * @return bool success.
*/
function create($name, $status = 1) {
if (strlen($name) < 3) {
@@ -214,7 +214,7 @@ class FRSPackage extends FFError {
* fetchData - re-fetch the data for this Package from the database.
*
* @param int $package_id The package_id.
- * @return boolean success.
+ * @return bool success.
*/
function fetchData($package_id) {
$res = db_query_params('SELECT * FROM frs_package WHERE package_id = $1 AND group_id = $2',
@@ -291,7 +291,7 @@ class FRSPackage extends FFError {
/**
* isPublic - whether non-group-members can view.
*
- * @return boolean is_public.
+ * @return bool is_public.
*/
function isPublic() {
$ra = RoleAnonymous::getInstance();
@@ -308,7 +308,7 @@ class FRSPackage extends FFError {
/**
* setMonitor - Add the current user to the list of people monitoring this package.
*
- * @return boolean success.
+ * @return bool success.
*/
function setMonitor() {
if (!session_loggedin()) {
@@ -326,7 +326,7 @@ class FRSPackage extends FFError {
/**
* stopMonitor - Remove the current user from the list of people monitoring this package.
*
- * @return boolean success.
+ * @return bool success.
*/
function stopMonitor() {
if (!session_loggedin()) {
@@ -368,7 +368,7 @@ class FRSPackage extends FFError {
/**
* isMonitoring - Is the current user in the list of people monitoring this package.
*
- * @return boolean is_monitoring.
+ * @return bool is_monitoring.
*/
function isMonitoring() {
if (!session_loggedin()) {
@@ -401,7 +401,7 @@ class FRSPackage extends FFError {
*
* @param string $name The name of this package.
* @param int $status The status_id of this package from frs_status table.
- * @return boolean success.
+ * @return bool success.
*/
function update($name, $status) {
if (strlen($name) < 3) {
@@ -545,7 +545,7 @@ class FRSPackage extends FFError {
* getNewestReleaseID - return the newest release_id of a package
* The newest release is the release with the highest ID
*
- * @return integer release id
+ * @return int release id
*/
public function getNewestReleaseID() {
$result = db_query_params('SELECT MAX(release_id) AS release_id FROM frs_release WHERE package_id = $1',
@@ -576,7 +576,7 @@ class FRSPackage extends FFError {
/**
* createReleaseFilesAsZip - create the Zip Archive of the release
*
- * @param integer release id.
+ * @param int release id.
* @return bool true on success even if the php ZipArchive does not exist
*/
public function createReleaseFilesAsZip($release_id) {
@@ -614,7 +614,7 @@ class FRSPackage extends FFError {
/**
* sendNotice - Notifies of package actions
*
- * @param boolean true = new package (default value)
+ * @param bool true = new package (default value)
* @return bool
*/
function sendNotice($new = true) {
diff --git a/src/common/frs/FRSPackageFactory.class.php b/src/common/frs/FRSPackageFactory.class.php
index 7759f25..681372d 100644
--- a/src/common/frs/FRSPackageFactory.class.php
+++ b/src/common/frs/FRSPackageFactory.class.php
@@ -118,7 +118,7 @@ class FRSPackageFactory extends FFError {
/**
* getPermissionOfASpecificUser - get the max level of permission of the current user
*
- * @return integer the value of permission
+ * @return int the value of permission
* 0 = none
* 1 = read
* 2 = file
diff --git a/src/common/frs/FRSRelease.class.php b/src/common/frs/FRSRelease.class.php
index 1a08729..527c8f1 100644
--- a/src/common/frs/FRSRelease.class.php
+++ b/src/common/frs/FRSRelease.class.php
@@ -291,7 +291,7 @@ class FRSRelease extends FFObject {
/**
* getPreformatted - get the preformatted option of this release.
*
- * @return boolean preserve_formatting.
+ * @return bool preserve_formatting.
*/
function getPreformatted() {
return $this->data_array['preformatted'];
@@ -309,7 +309,7 @@ class FRSRelease extends FFObject {
/**
* sendNotice - the logic to send an email notice for a release.
*
- * @return boolean success.
+ * @return bool success.
*/
function sendNotice() {
$arr =& $this->FRSPackage->getMonitorIDs();
@@ -438,7 +438,7 @@ class FRSRelease extends FFObject {
* @param string The change log for the release.
* @param int Whether the notes/log are preformatted with \n chars (1) true (0) false.
* @param int The unix date of the release.
- * @return boolean success.
+ * @return bool success.
*/
function update($status, $name, $notes, $changes, $preformatted, $release_date) {
if (strlen($name) < 3) {
diff --git a/src/common/frs/include/frs_utils.php b/src/common/frs/include/frs_utils.php
index c08cca4..05acd30 100644
--- a/src/common/frs/include/frs_utils.php
+++ b/src/common/frs/include/frs_utils.php
@@ -73,7 +73,7 @@ function frs_show_processor_popup($name = 'processor_id', $checked_val = 'xzxz')
/**
* frs_show_release_popup - pop-up select box of packages:releases for this group
*
- * @param integer $group_id the project id
+ * @param int $group_id the project id
* @param string $name default value 'processor_id'
* @param string $checked_val default value 'xzxz'
* @return string html code
@@ -97,7 +97,7 @@ function frs_show_release_popup($group_id, $name = 'release_id', $checked_val =
/**
* frs_show_package_popup - pop-up select box of packages for this group
*
- * @param integer $group_id the project id
+ * @param int $group_id the project id
* @param string $name default value 'processor_id'
* @param string $checked_val default value 'xzxz'
* @return string html code
@@ -120,13 +120,13 @@ function frs_show_package_popup($group_id, $name = 'package_id', $checked_val =
* frs_add_file_from_form - helper to add a file from the qrs form which allows multiple possibilities to add a file.
*
* @param object $release the release object to which the file belongs
- * @param integer $type_id the file type
- * @param integer $processor_id the processor type
+ * @param int $type_id the file type
+ * @param int $processor_id the processor type
* @param string $release_date the release date
* @param array $userfile a new uploaded file
* @param string $ftp_filename a already uploaded file using ftp
* @param string $manual_filename a already uploaded file using manual upload
- * @param integer $docman_fileid a doc_id of a already uploaded file using docman
+ * @param int $docman_fileid a doc_id of a already uploaded file using docman
* @return bool|string true on success or string message on error
*/
function frs_add_file_from_form($release, $type_id, $processor_id, $release_date,
diff --git a/src/common/include/AuthPlugin.class.php b/src/common/include/AuthPlugin.class.php
index 458579e..104c29f 100644
--- a/src/common/include/AuthPlugin.class.php
+++ b/src/common/include/AuthPlugin.class.php
@@ -208,7 +208,7 @@ abstract class ForgeAuthPlugin extends Plugin {
* startSession - Start a new session for a user
*
* @param string $username
- * @return boolean
+ * @return bool
*/
function startSession($username) {
if ($this->isSufficient() || $this->isRequired()) {
@@ -235,7 +235,7 @@ abstract class ForgeAuthPlugin extends Plugin {
/**
* TODO: Enter description here ...
- * @return Ambigous <Ambigous, NULL, boolean>
+ * @return Ambigous <Ambigous, NULL, bool>
*/
public function isRequired() {
return forge_get_config('required', $this->name);
@@ -243,7 +243,7 @@ abstract class ForgeAuthPlugin extends Plugin {
/**
* TODO: Enter description here ...
- * @return Ambigous <Ambigous, NULL, boolean>
+ * @return Ambigous <Ambigous, NULL, bool>
*/
public function isSufficient() {
return forge_get_config('sufficient', $this->name);
@@ -252,7 +252,7 @@ abstract class ForgeAuthPlugin extends Plugin {
/**
* TODO: Enter description here ...
* @param unknown_type $event
- * @return boolean
+ * @return bool
*/
public function syncDataOn($event) {
$configval = forge_get_config('sync_data_on', $this->name);
diff --git a/src/common/include/Codendi_Request.class.php b/src/common/include/Codendi_Request.class.php
index e24ac73..37c2543 100644
--- a/src/common/include/Codendi_Request.class.php
+++ b/src/common/include/Codendi_Request.class.php
@@ -97,7 +97,7 @@
* Check if $variable exists in user submitted parameters.
*
* @param string $variable Name of the parameter.
- * @return boolean
+ * @return bool
*/
function exist($variable) {
return $this->_exist($variable, $this->params);
@@ -109,7 +109,7 @@
* @access private
* @param string $variable Name of the parameter.
* @param array $array
- * @return boolean
+ * @return bool
*/
function _exist($variable, $array) {
return isset($array[$variable]);
@@ -118,7 +118,7 @@
* Apply validator on submitted user value.
*
* @param Valid Validator to apply
- * @return boolean
+ * @return bool
*/
function valid(&$validator) {
$this->_validated_input[$validator->getKey()] = true;
@@ -129,7 +129,7 @@
* Apply validator on all values of a submitted user array.
*
* @param Valid Validator to apply
- * @return boolean
+ * @return bool
*/
function validArray(&$validator) {
$this->_validated_input[$validator->getKey()] = true;
@@ -173,7 +173,7 @@
*
* @param string $index Index in the user submitted values where the array stands.
* @param string $validator Validator to apply
- * @return boolean
+ * @return bool
*/
function validInArray($index, &$validator) {
$this->_validated_input[$index][$validator->getKey()] = true;
diff --git a/src/common/include/Group.class.php b/src/common/include/Group.class.php
index 27aa8e3..da3980f 100644
--- a/src/common/include/Group.class.php
+++ b/src/common/include/Group.class.php
@@ -1026,7 +1026,7 @@ class Group extends FFError {
/**
* enableAnonSCM - whether or not this group has opted to enable Anonymous SCM.
*
- * @return boolean enable_scm.
+ * @return bool enable_scm.
*/
function enableAnonSCM() {
$r = RoleAnonymous::getInstance();
@@ -2475,7 +2475,7 @@ class Group extends FFError {
/**
* getMembers - returns array of User objects for this project
*
- * @param boolean $onlyactive Only users with state active, or all users of group
+ * @param bool $onlyactive Only users with state active, or all users of group
* @return array of User objects for this group.
*/
function getMembers($onlyactive = true) {
@@ -3076,7 +3076,7 @@ class Group extends FFError {
* getUsers - Get the users of a group
*
* @param bool $onlylocal
- * @param boolean $onlyactive Only users with state active, or all users of group
+ * @param bool $onlyactive Only users with state active, or all users of group
* @return array user's objects.
*/
function getUsers($onlylocal = true, $onlyactive = true) {
@@ -3172,7 +3172,7 @@ class Group extends FFError {
/**
*
- * @param integer $unit_set_id the effort unit set id
+ * @param int $unit_set_id the effort unit set id
* @return bool
*/
function setEffortUnitSet($unit_set_id) {
@@ -3192,7 +3192,7 @@ class Group extends FFError {
/**
* getEffortUnitSet - Get the effort unit set id.
*
- * @return integer The id of the effort unit set.
+ * @return int The id of the effort unit set.
*/
function getEffortUnitSet() {
return $this->data_array['unit_set_id'];
diff --git a/src/common/include/GroupJoinRequest.class.php b/src/common/include/GroupJoinRequest.class.php
index 08b9277..0957925 100644
--- a/src/common/include/GroupJoinRequest.class.php
+++ b/src/common/include/GroupJoinRequest.class.php
@@ -91,7 +91,7 @@ class GroupJoinRequest extends FFError {
* @param int $user_id user_id.
* @param string $comments comments.
* @param bool $send_email whether to send an email to the admin(s)
- * @return boolean Success.
+ * @return bool Success.
*/
function create($user_id, $comments, $send_email = true) {
$v = new Validator();
@@ -150,7 +150,7 @@ class GroupJoinRequest extends FFError {
*
* @param int $group_id The group_id.
* @param int $user_id The user_id.
- * @return boolean success.
+ * @return bool success.
*/
function fetchData($group_id, $user_id) {
$res = db_query_params('SELECT * FROM group_join_request WHERE user_id=$1 AND group_id=$2',
@@ -213,7 +213,7 @@ class GroupJoinRequest extends FFError {
/**
* sendJoinNotice() - send mail notification to project admin when user requests to join the project
*
- * @return boolean true/false.
+ * @return bool true/false.
*/
function sendJoinNotice() {
$user =& session_get_user();
@@ -248,7 +248,7 @@ class GroupJoinRequest extends FFError {
/**
* reject() - reject the join and send a notification to the user
*
- * @return boolean success.
+ * @return bool success.
*/
function reject() {
$user = user_get_object($this->getUserId());
@@ -276,8 +276,8 @@ class GroupJoinRequest extends FFError {
/**
* delete() - delete this row from the database.
*
- * @param boolean $sure I'm Sure.
- * @return boolean true/false.
+ * @param bool $sure I'm Sure.
+ * @return bool true/false.
*/
function delete($sure) {
if (!$sure) {
diff --git a/src/common/include/HTTPRequest.class.php b/src/common/include/HTTPRequest.class.php
index 8eae533..537d8c9 100644
--- a/src/common/include/HTTPRequest.class.php
+++ b/src/common/include/HTTPRequest.class.php
@@ -45,7 +45,7 @@ class HTTPRequest extends Codendi_Request {
*
* This method is useful to test if the current request comes from a form.
*
- * @return boolean
+ * @return bool
*/
function isPost() {
if($_SERVER['REQUEST_METHOD'] == 'POST') {
@@ -58,7 +58,7 @@ class HTTPRequest extends Codendi_Request {
/**
* Return true if browser used to submit the request is netscape 4.
*
- * @return boolean
+ * @return bool
*/
function browserIsNetscape4() {
return browser_is_netscape4();
@@ -81,7 +81,7 @@ class HTTPRequest extends Codendi_Request {
* Validate file upload.
*
* @param Valid_File Validator for files.
- * @return Boolean
+ * @return bool
*/
function validFile(&$validator) {
if(is_a($validator, 'Valid_File')) {
diff --git a/src/common/include/Permission.class.php b/src/common/include/Permission.class.php
index 72ffd41..3cd7b03 100644
--- a/src/common/include/Permission.class.php
+++ b/src/common/include/Permission.class.php
@@ -111,7 +111,7 @@ class Permission extends FFError {
/**
* isSuperUser - whether the current user has site admin privilege.
*
- * @return boolean is_super_user.
+ * @return bool is_super_user.
*/
function isSuperUser() {
return forge_check_global_perm ('forge_admin');
@@ -120,7 +120,7 @@ class Permission extends FFError {
/**
* isForumAdmin - whether the current user has form admin perms.
*
- * @return boolean is_forum_admin.
+ * @return bool is_forum_admin.
*/
function isForumAdmin() {
return forge_check_perm ('forum_admin', $this->group_id);
@@ -129,7 +129,7 @@ class Permission extends FFError {
/**
* isDocEditor - whether the current user has form doc editor perms.
*
- * @return boolean is_doc_editor.
+ * @return bool is_doc_editor.
*/
function isDocEditor() {
return forge_check_perm('docman', $this->group_id, 'approve');
@@ -138,7 +138,7 @@ class Permission extends FFError {
/**
* isDocAdmin - whether the current user has form doc admin perms.
*
- * @return boolean is_doc_admin.
+ * @return bool is_doc_admin.
*/
function isDocAdmin() {
return forge_check_perm('docman', $this->group_id, 'admin');
@@ -147,7 +147,7 @@ class Permission extends FFError {
/**
* isReleaseTechnician - whether the current user has FRS admin perms.
*
- * @return boolean is_release_technician.
+ * @return bool is_release_technician.
*/
function isReleaseTechnician() {
return forge_check_perm('frs', $this->group_id, 'admin');
@@ -156,7 +156,7 @@ class Permission extends FFError {
/**
* isFRSAdmin - whether the current user has FRS admin perms.
*
- * @return boolean is_frs_admin.
+ * @return bool is_frs_admin.
*/
function isFRSAdmin() {
return forge_check_perm('frs_admin', $this->group_id, 'admin');
@@ -165,7 +165,7 @@ class Permission extends FFError {
/**
* isArtifactAdmin - whether the current user has artifact admin perms.
*
- * @return boolean is_artifact_admin.
+ * @return bool is_artifact_admin.
*/
function isArtifactAdmin() {
return forge_check_perm ('tracker_admin', $this->group_id);
@@ -174,7 +174,7 @@ class Permission extends FFError {
/**
* isPMAdmin - whether the current user has Tasks admin perms.
*
- * @return boolean is_projman_admin.
+ * @return bool is_projman_admin.
*/
function isPMAdmin() {
return forge_check_perm ('pm_admin', $this->group_id);
@@ -183,7 +183,7 @@ class Permission extends FFError {
/**
* isAdmin - User is an admin of the project or admin of the entire site.
*
- * @return boolean is_admin.
+ * @return bool is_admin.
*/
function isAdmin() {
return forge_check_perm ('project_admin', $this->group_id);
@@ -192,7 +192,7 @@ class Permission extends FFError {
/**
* isCVSReader - checks the cvs_flags field in user_group table.
*
- * @return boolean cvs_flags
+ * @return bool cvs_flags
*/
function isCVSReader() {
return forge_check_perm ('scm', $this->group_id, 'read');
@@ -201,7 +201,7 @@ class Permission extends FFError {
/**
* isCVSWriter - checks if the user has CVS write access.
*
- * @return boolean cvs_flags
+ * @return bool cvs_flags
*/
function isCVSWriter() {
return forge_check_perm ('scm', $this->group_id, 'write');
diff --git a/src/common/include/PluginManager.class.php b/src/common/include/PluginManager.class.php
index 4aa4616..9fa594f 100644
--- a/src/common/include/PluginManager.class.php
+++ b/src/common/include/PluginManager.class.php
@@ -225,7 +225,7 @@ class PluginManager extends FFError {
* @param string $hookname - name of the hook
* @param array $params - array of extra parameters
*
- * @return boolean, true if all returned true.
+ * @return bool, true if all returned true.
*/
function RunHooks($hookname, & $params) {
$result = true;
diff --git a/src/common/include/PluginPersistence.class.php b/src/common/include/PluginPersistence.class.php
index 2f420e0..37de553 100644
--- a/src/common/include/PluginPersistence.class.php
+++ b/src/common/include/PluginPersistence.class.php
@@ -33,7 +33,7 @@ class PluginPersistentStore extends FFError {
const persistence_table = 'plugins_persistence';
/**
- * @param integer $plugin_id
+ * @param int $plugin_id
*/
function __construct($plugin_id) {
$this->plugin_id = $plugin_id;
diff --git a/src/common/include/RBAC.php b/src/common/include/RBAC.php
index 267770a..d49ea3f 100644
--- a/src/common/include/RBAC.php
+++ b/src/common/include/RBAC.php
@@ -463,7 +463,7 @@ abstract class BaseRole extends FFError {
*
* @param string $section
* @param unknown_type $reference
- * @return number|boolean
+ * @return number|bool
*/
function getSetting($section, $reference) {
$value = $this->getSettingRaw($section, $reference);
@@ -621,8 +621,8 @@ abstract class BaseRole extends FFError {
* getVal - get a value out of the array of settings for this role.
*
* @param string $section The name of the role.
- * @param integer $ref_id The ref_id (ex: group_artifact_id, group_forum_id) for this item.
- * @return integer The value of this item.
+ * @param int $ref_id The ref_id (ex: group_artifact_id, group_forum_id) for this item.
+ * @return int The value of this item.
*/
function getVal($section, $ref_id) {
if (!$ref_id) {
@@ -807,9 +807,9 @@ abstract class BaseRole extends FFError {
*
* @param string $role_name The name of the role.
* @param array $data A multi-dimensional array of data in this format: $data['section_name']['ref_id']=$val
- * @param boolean $check_perms Perform permission checking
- * @param boolean $update_sys Update system users & groups membership
- * @return boolean True on success or false on failure.
+ * @param bool $check_perms Perform permission checking
+ * @param bool $update_sys Update system users & groups membership
+ * @return bool True on success or false on failure.
*/
function update($role_name,$data,$check_perms=true,$update_sys=true) {
global $SYS;
diff --git a/src/common/include/Role.class.php b/src/common/include/Role.class.php
index d1ac768..5fcfeb8 100644
--- a/src/common/include/Role.class.php
+++ b/src/common/include/Role.class.php
@@ -73,7 +73,7 @@ class Role extends RoleExplicit implements PFO_RoleExplicit {
* setName - set the name of this role.
*
* @param string $role_name The new name of this role.
- * @return boolean True if updated OK
+ * @return bool True if updated OK
*/
function setName($role_name) { // From the PFO spec
if ($role_name == '') {
@@ -115,7 +115,7 @@ class Role extends RoleExplicit implements PFO_RoleExplicit {
* isPublic - is this role public (accessible from projects
* other than its home project)?
*
- * @return boolean True if public
+ * @return bool True if public
*/
function isPublic() { // From the PFO spec
return $this->data_array['is_public'];
@@ -124,8 +124,8 @@ class Role extends RoleExplicit implements PFO_RoleExplicit {
/**
* setPublic - set the public flag for this role.
*
- * @param boolean $flag The new value of the flag.
- * @return boolean True if updated OK
+ * @param bool $flag The new value of the flag.
+ * @return bool True if updated OK
*/
function setPublic($flag) { // From the PFO spec
$res = db_query_params('UPDATE pfo_role SET is_public=$1 WHERE role_id=$2',
@@ -227,7 +227,7 @@ class Role extends RoleExplicit implements PFO_RoleExplicit {
/**
* TODO: Enter description here ...
* @param string $name
- * @return Ambiguous <number, boolean, contents>|boolean
+ * @return Ambiguous <number, bool, contents>|bool
*/
function createDefault($name) {
if ($this->Group == NULL) {
@@ -293,7 +293,7 @@ class Role extends RoleExplicit implements PFO_RoleExplicit {
/**
* delete - delete a role in the database.
*
- * @return boolean True on success or false on failure.
+ * @return bool True on success or false on failure.
*/
function delete() {
if ($this->Group == NULL) {
@@ -355,7 +355,7 @@ class Role extends RoleExplicit implements PFO_RoleExplicit {
* setUser -
*
* @param int User ID
- * @return boolean True on success or false on failure.
+ * @return bool True on success or false on failure.
*/
function setUser($user_id) {
if ($this->Group == NULL) {
diff --git a/src/common/include/User.class.php b/src/common/include/User.class.php
index c304053..1a172f9 100644
--- a/src/common/include/User.class.php
+++ b/src/common/include/User.class.php
@@ -515,8 +515,8 @@ class FFUser extends FFError {
*
* Remove the User from all his groups and set his status to D.
*
- * @param boolean $sure Confirmation of deletion.
- * @return boolean success or not
+ * @param bool $sure Confirmation of deletion.
+ * @return bool success or not
*/
function delete($sure) {
if (!$sure) {
@@ -664,7 +664,7 @@ class FFUser extends FFError {
* If an update occurred and you need to access the updated info.
*
* @param int $user_id the User ID data to be fetched
- * @return boolean success;
+ * @return bool success
*/
function fetchData($user_id) {
$res = db_query_params('SELECT * FROM users WHERE user_id=$1',
@@ -713,7 +713,7 @@ class FFUser extends FFError {
* setStatus - set this user's status.
*
* @param string $status Status - P, A, S, or D.
- * @return boolean success.
+ * @return bool success
*/
function setStatus($status) {
@@ -761,7 +761,7 @@ class FFUser extends FFError {
*
* Database field status of 'A' returns true.
*
- * @return boolean is_active.
+ * @return bool is_active.
*/
function isActive() {
if ($this->getStatus() == 'A') {
@@ -789,7 +789,7 @@ class FFUser extends FFError {
* S suspended
* D deleted
*
- * @return boolean success.
+ * @return bool success
*/
function setUnixStatus($status) {
global $SYS;
@@ -908,7 +908,7 @@ class FFUser extends FFError {
* setEmail - set a new email address, which must be confirmed.
*
* @param string $email The email address.
- * @return boolean success.
+ * @return bool success
*/
function setEmail($email) {
@@ -960,7 +960,7 @@ class FFUser extends FFError {
*
* @param string $email The email address.
* @param string $hash The email hash.
- * @return boolean success.
+ * @return bool success
*/
function setNewEmailAndHash($email, $hash = '') {
@@ -1005,8 +1005,8 @@ class FFUser extends FFError {
/**
* setRealName - set the user's real name.
*
- * @param string $realname
- * @return string boolean.
+ * @param string $realname
+ * @return bool
*/
function setRealName($realname) {
$res = db_query_params('UPDATE users SET realname=$1 WHERE user_id=$2',
@@ -1077,7 +1077,7 @@ class FFUser extends FFError {
* setShell - sets user's preferred shell.
*
* @param string $shell The users preferred shell.
- * @return boolean success.
+ * @return bool success
*/
function setShell($shell) {
global $SYS;
@@ -1230,7 +1230,7 @@ class FFUser extends FFError {
* addAuthorizedKey - add the SSH authorized key for the user.
*
* @param string $key
- * @return boolean success.
+ * @return bool success
*/
function addAuthorizedKey($key) {
$key = trim($key);
@@ -1285,7 +1285,7 @@ class FFUser extends FFError {
/**
* setLoggedIn($val) - Really only used by session code.
*
- * @param boolean $val The session value.
+ * @param bool $val The session value.
*/
function setLoggedIn($val = true) {
$this->is_logged_in = $val;
@@ -1298,7 +1298,7 @@ class FFUser extends FFError {
/**
* isLoggedIn - only used by session code.
*
- * @return boolean is_logged_in.
+ * @return bool is_logged_in.
*/
function isLoggedIn() {
return $this->is_logged_in;
@@ -1308,7 +1308,7 @@ class FFUser extends FFError {
* deletePreference - delete a preference for this user.
*
* @param string $preference_name The unique field name for this preference.
- * @return boolean success.
+ * @return bool success
*/
function deletePreference($preference_name) {
$preference_name = strtolower(trim($preference_name));
@@ -1323,7 +1323,7 @@ class FFUser extends FFError {
*
* @param string $preference_name The unique field name for this preference.
* @param string $value The value you are setting this preference to.
- * @return boolean success.
+ * @return bool success
*/
function setPreference($preference_name, $value) {
$preference_name = strtolower(trim($preference_name));
@@ -1401,7 +1401,7 @@ class FFUser extends FFError {
* setPasswd - Changes user's password.
*
* @param string $passwd The plaintext password.
- * @return boolean success.
+ * @return bool success
*/
function setPasswd($passwd) {
global $SYS;
@@ -1454,7 +1454,7 @@ class FFUser extends FFError {
* setUnixPasswd - Changes user's Unix-hashed password.
*
* @param string $unix The Unix-hashed password.
- * @return boolean success.
+ * @return bool success
*/
function setUnixPasswd($unix) {
global $SYS;
@@ -1487,7 +1487,7 @@ class FFUser extends FFError {
/**
* usesRatings - whether user participates in rating system.
*
- * @return boolean success.
+ * @return bool success
*/
function usesRatings() {
return !$this->data_array['block_ratings'];
@@ -1496,7 +1496,7 @@ class FFUser extends FFError {
/**
* usesTooltips - whether user enables or not tooltips.
*
- * @return boolean success.
+ * @return bool success
*/
function usesTooltips() {
return $this->data_array['tooltips'];
@@ -1529,7 +1529,7 @@ class FFUser extends FFError {
* usesPlugin - returns true if the user uses a particular plugin
*
* @param string $pluginname name of the plugin
- * @return boolean whether plugin is being used or not
+ * @return bool whether plugin is being used or not
*/
function usesPlugin($pluginname) {
$plugins_data = $this->getPlugins();
@@ -1545,7 +1545,7 @@ class FFUser extends FFError {
* setPluginUse - enables/disables plugins for the user
*
* @param string $pluginname name of the plugin
- * @param boolean $val the new state
+ * @param bool $val the new state
* @return string database result
*/
function setPluginUse($pluginname, $val = true) {
@@ -1578,7 +1578,7 @@ class FFUser extends FFError {
* getMailingsPrefs - Get activity status for one of the site mailings.
*
* @param string $mailing_id The id of mailing ('mail_va' for community mailings, 'mail_siteupdates' for site mailings)
- * @return boolean success.
+ * @return bool success
*/
function getMailingsPrefs($mailing_id) {
if ($mailing_id == 'va') {
@@ -1593,8 +1593,8 @@ class FFUser extends FFError {
/**
* unsubscribeFromMailings - Disable email notifications for user.
*
- * @param boolean $all If false, disable general site mailings, else - all.
- * @return boolean success.
+ * @param bool $all If false, disable general site mailings, else - all.
+ * @return bool success
*/
function unsubscribeFromMailings($all = false) {
$res2 = $res3 = true;
@@ -1714,7 +1714,7 @@ class FFUser extends FFError {
/**
* setAdminNotification - send an email to all admins (used in verify.php)
*
- * @return boolean True
+ * @return bool True
*/
function setAdminNotification() {
$admins = RBACEngine::getInstance()->getUsersByAllowedAction('forge_admin', -1);
@@ -1736,7 +1736,7 @@ Email: %3$s
* isEditable - verify if field name is editable
*
* @param string $fieldName Field name
- * @return boolean
+ * @return bool
*/
function isEditable($fieldName) {
if (!isset($this->data_array['uneditable'])) {
@@ -1761,7 +1761,7 @@ Email: %3$s
* isHidden - verify if field name is hidden
*
* @param string $fieldName Field name
- * @return boolean
+ * @return bool
*/
function isHidden($fieldName) {
if (!isset($this->data_array['hidden']))
@@ -1778,8 +1778,8 @@ Email: %3$s
/**
* setUneditable - set the list of uneditable fields of this user.
*
- * @param array $data array of uneditable field names
- * @return boolean.
+ * @param array $data array of uneditable field names
+ * @return bool
*/
function setUneditable($data) {
if (!is_array($data)) {
@@ -1802,7 +1802,7 @@ Email: %3$s
* setHidden - set the list of hidden fields of this user.
*
* @param array $data Array of hidden field names
- * @return boolean.
+ * @return bool
*/
function setHidden($data) {
if (!is_array($data)) {
diff --git a/src/common/include/Validator.class.php b/src/common/include/Validator.class.php
index 146458f..e215257 100644
--- a/src/common/include/Validator.class.php
+++ b/src/common/include/Validator.class.php
@@ -51,7 +51,7 @@ class Validator {
/**
* Returns true if no null fields have been checked so far
*
- * @return boolean - True if there are no null fields so far
+ * @return bool - True if there are no null fields so far
*/
function isClean() {
return count($this->badfields) == 0;
diff --git a/src/common/include/config.php b/src/common/include/config.php
index 8f7bf7e..dee68dd 100644
--- a/src/common/include/config.php
+++ b/src/common/include/config.php
@@ -159,7 +159,7 @@ if (!isset ($fusionforge_config)) {
* Get value of variable "name" in section "section"
* @param string $var
* @param string $section defaults to "core" if missing
- * @return mixed <NULL, boolean>
+ * @return mixed <NULL, bool>
*/
function forge_get_config ($var, $section = 'core') {
$c = FusionForgeConfig::get_instance () ;
diff --git a/src/common/include/database-pgsql.php b/src/common/include/database-pgsql.php
index 9c0a452..15fba40 100644
--- a/src/common/include/database-pgsql.php
+++ b/src/common/include/database-pgsql.php
@@ -556,7 +556,7 @@ function db_result($qhandle, $row, $field) {
*
* @param resource $qhandle Query result set handle.
* @param int $row Row number.
- * @return boolean True on success
+ * @return bool True on success
*/
function db_result_seek($qhandle, $row) {
return @pg_result_seek($qhandle, $row);
@@ -567,7 +567,7 @@ function db_result_seek($qhandle, $row) {
*
* @param resource $qhandle Query result set handle.
* @param int $row
- * @return boolean True on success
+ * @return bool True on success
*/
//TODO : remove the second param if no one uses it.
function db_result_reset($qhandle, $row = 0) {
diff --git a/src/common/include/forms.php b/src/common/include/forms.php
index 876f80a..7da4c17 100644
--- a/src/common/include/forms.php
+++ b/src/common/include/forms.php
@@ -52,7 +52,7 @@ function form_generate_key() {
* it updates the db.
*
* @param int $key The key.
- * @return boolean True if the given key is already used. False if not.
+ * @return bool True if the given key is already used. False if not.
*
*/
function form_key_is_valid($key) {
@@ -81,7 +81,7 @@ function form_key_is_valid($key) {
* form_release_key() - Releases the given key if it is already used. If the given key it's not in the db, it returns false.
*
* @param int $key The key.
- * @return boolean True if the given key is successfully released. False if not.
+ * @return bool True if the given key is successfully released. False if not.
*
*/
function form_release_key($key) {
diff --git a/src/common/include/system/pgsql.class.php b/src/common/include/system/pgsql.class.php
index 6c9c2de..73122a5 100644
--- a/src/common/include/system/pgsql.class.php
+++ b/src/common/include/system/pgsql.class.php
@@ -64,7 +64,7 @@ class pgsql extends System {
* sysUseUnixName() - Check if user/group used the unix_name
*
* @param string $unix_name The unix_name to check
- * @return boolean true if used/false is free
+ * @return bool true if used/false is free
*/
function sysUseUnixName($unix_name) {
$res1 = db_query_params('SELECT user_id FROM users
diff --git a/src/common/include/utils.php b/src/common/include/utils.php
index 0691e03..1a8447d 100644
--- a/src/common/include/utils.php
+++ b/src/common/include/utils.php
@@ -1634,7 +1634,7 @@ function util_save_messages() {
* @param string $path Path of the file to be created
* @param string $contents Contents of the file
*
- * @return boolean FALSE on error
+ * @return bool false on error
*/
function util_create_file_with_contents($path, $contents) {
if (file_exists($path) && !unlink($path)) {
@@ -1680,7 +1680,7 @@ function util_mkdtemp($suffix = '', $prefix = 'tmp') {
* @param string $username Unix user name
* @param function $function function to run (possibly anonymous)
* @param array $params parameters
- * @return boolean true on success, false on error
+ * @return bool true on success, false on error
*/
function util_sudo_effective_user($username, $function, $params=array()) {
$userinfo = posix_getpwnam($username);
diff --git a/src/common/mail/MailingList.class.php b/src/common/mail/MailingList.class.php
index 8de7b2f..5b042b0 100644
--- a/src/common/mail/MailingList.class.php
+++ b/src/common/mail/MailingList.class.php
@@ -294,7 +294,7 @@ class MailingList extends FFError {
/**
* isPublic - Is this mailing list open to the general public.
*
- * @return boolean is_public.
+ * @return bool is_public.
*/
function isPublic() {
return $this->dataArray['is_public'];
@@ -392,9 +392,9 @@ class MailingList extends FFError {
/**
* delete - permanently delete this mailing list
*
- * @param boolean $sure I'm Sure.
- * @param boolean $really_sure I'm Really Sure.
- * @return boolean success;
+ * @param bool $sure I'm Sure.
+ * @param bool $really_sure I'm Really Sure.
+ * @return bool success;
*/
function delete($sure,$really_sure) {
diff --git a/src/common/pm/ProjectCategory.class.php b/src/common/pm/ProjectCategory.class.php
index 2a1617e..78934d7 100644
--- a/src/common/pm/ProjectCategory.class.php
+++ b/src/common/pm/ProjectCategory.class.php
@@ -75,7 +75,7 @@ class ProjectCategory extends FFError {
* create - create a new item in the database.
*
* @param string $name Item name.
- * @return boolean success.
+ * @return bool success.
*/
function create($name) {
//
@@ -117,7 +117,7 @@ class ProjectCategory extends FFError {
* fetchData() - re-fetch the data for this ProjectCategory from the database.
*
* @param int $id ID of the category.
- * @return boolean success.
+ * @return bool success.
*/
function fetchData($id) {
$res = db_query_params ('SELECT * FROM project_category WHERE category_id=$1',
@@ -162,7 +162,7 @@ class ProjectCategory extends FFError {
* update - update a ProjectCategory.
*
* @param string $name Name of the category.
- * @return boolean success.
+ * @return bool success.
*/
function update($name) {
if (!forge_check_perm ('pm_admin', $this->ProjectGroup->Group->getID())) {
diff --git a/src/common/pm/ProjectGroup.class.php b/src/common/pm/ProjectGroup.class.php
index 0d75620..8a6c997 100644
--- a/src/common/pm/ProjectGroup.class.php
+++ b/src/common/pm/ProjectGroup.class.php
@@ -325,7 +325,7 @@ class ProjectGroup extends FFError {
* @param string $project_name The project name.
* @param string $description The project description.
* @param string $send_all_posts_to The email address to send new notifications to.
- * @return boolean success.
+ * @return bool success.
*/
function update($project_name, $description, $send_all_posts_to = '') {
if (strlen($project_name) < 3) {
diff --git a/src/common/pm/ProjectTask.class.php b/src/common/pm/ProjectTask.class.php
index 784e5ca..2445a27 100644
--- a/src/common/pm/ProjectTask.class.php
+++ b/src/common/pm/ProjectTask.class.php
@@ -131,7 +131,7 @@ class ProjectTask extends FFError {
* @param int $duration The duration of the task in days.
* @param int $parent_id The id of the parent task, if any.
* @param array $importData An array ('user' => user_id)
- * @return boolean success.
+ * @return bool success.
*/
function create($summary,$details,$priority,$hours,$start_date,$end_date,
$category_id,$percent_complete,&$assigned_arr,&$depend_arr,$duration=0,$parent_id=0, $importData = array()) {
@@ -218,7 +218,7 @@ class ProjectTask extends FFError {
* fetchData - re-fetch the data for this ProjectTask from the database.
*
* @param int $project_task_id The project_task_id.
- * @return boolean success.
+ * @return bool success.
*/
function fetchData($project_task_id) {
$res = db_query_params ('SELECT * FROM project_task_vw
@@ -448,7 +448,7 @@ class ProjectTask extends FFError {
* addRelatedArtifacts - take an array of artifact_id's and build relationships.
*
* @param array $art_array An array of artifact_id's to be attached to this task.
- * @return boolean success.
+ * @return bool success.
*/
function addRelatedArtifacts($art_array) {
if (!forge_check_perm ('pm', $this->ProjectGroup->getID(), 'manager')) {
@@ -479,7 +479,7 @@ class ProjectTask extends FFError {
* removeRelatedArtifacts - take an array of artifact_id's and delete relationships.
*
* @param array $art_array An array of artifact_id's to be removed from this task.
- * @return boolean success.
+ * @return bool success.
*/
function removeRelatedArtifacts($art_array) {
if (!forge_check_perm ('pm', $this->ProjectGroup->getID(), 'manager')) {
@@ -631,7 +631,7 @@ class ProjectTask extends FFError {
*
* @param string $message The message.
* @param array $importData Specific data for import (user id and time)
- * @return boolean success.
+ * @return bool success.
*/
function addMessage($message, $importData = array()) {
//prevent posting the same message
@@ -710,7 +710,7 @@ class ProjectTask extends FFError {
*
* @param int $depend_on_id The project_task_id you are dependent on.
* @param int $original_id The project_task_id you are checking circular dependencies for.
- * @return boolean success.
+ * @return bool success.
*/
function checkCircular($depend_on_id, $original_id) {
//for msproject users - ms project has more complex logic than gforge
@@ -741,7 +741,7 @@ class ProjectTask extends FFError {
* setDependentOn - takes an array of project_task_id's and builds dependencies.
*
* @param array $arr_ The array of project_task_id's.
- * @return boolean success.
+ * @return bool success.
*/
function setDependentOn(&$arr_) {
//
@@ -847,7 +847,7 @@ class ProjectTask extends FFError {
* setAssignedTo - takes an array of user_id's and builds assignments.
*
* @param array $arr The array of user_id's.
- * @return boolean success.
+ * @return bool success.
*/
function setAssignedTo(&$arr) {
$arr2 = $this->getAssignedTo();
diff --git a/src/common/pm/Validator.class.php b/src/common/pm/Validator.class.php
index 40541e9..491da84 100644
--- a/src/common/pm/Validator.class.php
+++ b/src/common/pm/Validator.class.php
@@ -53,7 +53,7 @@ class Validator {
/**
* Returns true if no null fields have been checked so far
*
- * @return boolean - True if there are no null fields so far
+ * @return bool - True if there are no null fields so far
*/
function isClean() {
return count($this->badfields) == 0;
diff --git a/src/common/reporting/ReportSetup.class.php b/src/common/reporting/ReportSetup.class.php
index ab8183c..b9dabb9 100644
--- a/src/common/reporting/ReportSetup.class.php
+++ b/src/common/reporting/ReportSetup.class.php
@@ -412,7 +412,7 @@ class ReportSetup extends Report {
* Add a row to the users_added_daily report table.
*
* @param int $day Day - the unix time of the beginning of the day.
- * @return boolean Success.
+ * @return bool Success.
*/
function users_added_daily($day) {
db_query_params ('DELETE FROM rep_users_added_daily WHERE day=$1',
@@ -431,7 +431,7 @@ class ReportSetup extends Report {
* Populate the users_added_daily report table.
*
* @param int $count
- * @return boolean Success.
+ * @return bool Success.
*/
function backfill_users_added_daily($count=10000) {
$today=mktime(0,0,0,date('m'),date('d')-1,date('Y'));
@@ -461,7 +461,7 @@ class ReportSetup extends Report {
* Add a row to the groups_added_daily report table.
*
* @param int $day Day - the unix time of the beginning of the day.
- * @return boolean Success.
+ * @return bool Success.
*/
function groups_added_daily($day) {
db_query_params ('DELETE FROM rep_groups_added_daily WHERE day=$1',
@@ -480,7 +480,7 @@ class ReportSetup extends Report {
* Populate the groups_added_daily report table.
*
* @param int $count
- * @return boolean Success.
+ * @return bool Success.
*/
function backfill_groups_added_daily($count=10000) {
$today=mktime(0,0,0,date('m'),date('d')-1,date('Y'));
@@ -510,7 +510,7 @@ class ReportSetup extends Report {
* Add a row to the users_added_weekly report table.
*
* @param int $week Week - the unix time of the beginning of the sunday for this week.
- * @return boolean Success.
+ * @return bool Success.
*/
function users_added_weekly($week) {
db_query_params ('DELETE FROM rep_users_added_weekly WHERE week=$1',
@@ -529,7 +529,7 @@ class ReportSetup extends Report {
* Populate the users_added_weekly report table.
*
* @param int $count
- * @return boolean Success.
+ * @return bool Success.
*/
function backfill_users_added_weekly($count=10000) {
@@ -549,7 +549,7 @@ class ReportSetup extends Report {
* Add a row to the groups_added_weekly report table.
*
* @param int $week Week - the unix time of the beginning of the sunday for this week.
- * @return boolean Success.
+ * @return bool Success.
*/
function groups_added_weekly($week) {
db_query_params ('DELETE FROM rep_groups_added_weekly WHERE week=$1',
@@ -568,7 +568,7 @@ class ReportSetup extends Report {
* Populate the users_added_weekly report table.
*
* @param int $count
- * @return boolean Success.
+ * @return bool Success.
*/
function backfill_groups_added_weekly($count=10000) {
@@ -589,7 +589,7 @@ class ReportSetup extends Report {
*
* @param int $month month_start - the unix time of the beginning of the month.
* @param int $end month_end - the unix time of the end of the month.
- * @return boolean Success.
+ * @return bool Success.
*/
function users_added_monthly($month,$end) {
db_query_params ('DELETE FROM rep_users_added_monthly WHERE month=$1',
@@ -608,7 +608,7 @@ class ReportSetup extends Report {
* Populate the users_added_monthly report table.
*
* @param int $count
- * @return boolean Success.
+ * @return bool Success.
*/
function backfill_users_added_monthly($count=10000) {
@@ -630,7 +630,7 @@ class ReportSetup extends Report {
*
* @param int $month month_start - the unix time of the beginning of the month.
* @param int $end month_end - the unix time of the end of the month.
- * @return boolean Success.
+ * @return bool Success.
*/
function groups_added_monthly($month,$end) {
db_query_params ('DELETE FROM rep_groups_added_monthly WHERE month=$1',
@@ -649,7 +649,7 @@ class ReportSetup extends Report {
* Populate the groups_added_monthly report table.
*
* @param int $count
- * @return boolean Success.
+ * @return bool Success.
*/
function backfill_groups_added_monthly($count=10000) {
@@ -672,7 +672,7 @@ class ReportSetup extends Report {
* Add a row to the users_cum_daily report table.
*
* @param int $day Day - the unix time of the beginning of the day.
- * @return boolean Success.
+ * @return bool Success.
*/
function users_cum_daily($day) {
db_query_params ('DELETE FROM rep_users_cum_daily WHERE day=$1',
@@ -690,7 +690,7 @@ class ReportSetup extends Report {
* Populate the users_cum_daily report table.
*
* @param int $count
- * @return boolean Success.
+ * @return bool Success.
*/
function backfill_users_cum_daily($count=10000) {
$today=mktime(0,0,0,date('m'),date('d')-1,date('Y'));
@@ -720,7 +720,7 @@ class ReportSetup extends Report {
* Add a row to the groups_cum_daily report table.
*
* @param int $day Day - the unix time of the beginning of the day.
- * @return boolean Success.
+ * @return bool Success.
*/
function groups_cum_daily($day) {
db_query_params ('DELETE FROM rep_groups_cum_daily WHERE day=$1',
@@ -738,7 +738,7 @@ class ReportSetup extends Report {
* Populate the groups_cum_daily report table.
*
* @param int $count
- * @return boolean Success.
+ * @return bool Success.
*/
function backfill_groups_cum_daily($count=10000) {
$today=mktime(0,0,0,date('m'),date('d')-1,date('Y'));
@@ -768,7 +768,7 @@ class ReportSetup extends Report {
* Add a row to the users_cum_weekly report table.
*
* @param int $week Week - the unix time of the beginning of the sunday for this week.
- * @return boolean Success.
+ * @return bool Success.
*/
function users_cum_weekly($week) {
db_query_params ('DELETE FROM rep_users_cum_weekly WHERE week=$1',
@@ -787,7 +787,7 @@ class ReportSetup extends Report {
* Populate the users_cum_weekly report table.
*
* @param int $count
- * @return boolean Success.
+ * @return bool Success.
*/
function backfill_users_cum_weekly($count=10000) {
@@ -807,7 +807,7 @@ class ReportSetup extends Report {
* Add a row to the groups_cum_weekly report table.
*
* @param int $week Week - the unix time of the beginning of the sunday for this week.
- * @return boolean Success.
+ * @return bool Success.
*/
function groups_cum_weekly($week) {
db_query_params ('DELETE FROM rep_groups_cum_weekly WHERE week=$1',
@@ -826,7 +826,7 @@ class ReportSetup extends Report {
* Populate the groups_cum_weekly report table.
*
* @param int $count
- * @return boolean Success.
+ * @return bool Success.
*/
function backfill_groups_cum_weekly($count=10000) {
@@ -847,7 +847,7 @@ class ReportSetup extends Report {
*
* @param int $month month_start - the unix time of the beginning of the month.
* @param int $end month_end - the unix time of the end of the month.
- * @return boolean Success.
+ * @return bool Success.
*/
function users_cum_monthly($month,$end) {
db_query_params ('DELETE FROM rep_users_cum_monthly WHERE month=$1',
@@ -865,7 +865,7 @@ class ReportSetup extends Report {
* Populate the users_cum_monthly report table.
*
* @param int $count
- * @return boolean Success.
+ * @return bool Success.
*/
function backfill_users_cum_monthly($count=10000) {
@@ -887,7 +887,7 @@ class ReportSetup extends Report {
*
* @param int $month month_start - the unix time of the beginning of the month.
* @param int $end month_end - the unix time of the end of the month.
- * @return boolean Success.
+ * @return bool Success.
*/
function groups_cum_monthly($month,$end) {
db_query_params ('DELETE FROM rep_groups_cum_monthly WHERE month=$1',
@@ -905,7 +905,7 @@ class ReportSetup extends Report {
* Populate the groups_cum_monthly report table.
*
* @param int $count
- * @return boolean Success.
+ * @return bool Success.
*/
function backfill_groups_cum_monthly($count=10000) {
@@ -928,7 +928,7 @@ class ReportSetup extends Report {
* Add a row to the user_act_daily report table.
*
* @param int $day Day - the unix time of the beginning of the day.
- * @return boolean Success.
+ * @return bool Success.
*/
function user_act_daily($day) {
db_query_params('DELETE FROM rep_user_act_daily WHERE day=$1',
@@ -1003,7 +1003,7 @@ class ReportSetup extends Report {
* Populate the user_act_daily report table.
*
* @param int $count
- * @return boolean Success.
+ * @return bool Success.
*/
function backfill_user_act_daily($count=10000) {
$today=mktime(0,0,0,date('m'),date('d')-1,date('Y'));
@@ -1033,7 +1033,7 @@ class ReportSetup extends Report {
* Add a row to the user_act_weekly report table.
*
* @param int $week Week - the unix time of the beginning of the sunday for this week.
- * @return boolean Success.
+ * @return bool Success.
*/
function user_act_weekly($week) {
db_query_params('DELETE FROM rep_user_act_weekly WHERE week=$1',
@@ -1061,7 +1061,7 @@ class ReportSetup extends Report {
* Populate the user_act_weekly report table.
*
* @param int $count
- * @return boolean Success.
+ * @return bool Success.
*/
function backfill_user_act_weekly($count=10000) {
@@ -1082,7 +1082,7 @@ class ReportSetup extends Report {
*
* @param int $month month_start - the unix time of the beginning of the month.
* @param int $end month_end - the unix time of the end of the month.
- * @return boolean Success.
+ * @return bool Success.
*/
function user_act_monthly($month,$end) {
db_query_params('DELETE FROM rep_user_act_monthly WHERE month=$1',
@@ -1105,7 +1105,7 @@ class ReportSetup extends Report {
* Populate the user_act_monthly report table.
*
* @param int $count
- * @return boolean Success.
+ * @return bool Success.
*/
function backfill_user_act_monthly($count=10000) {
@@ -1127,7 +1127,7 @@ class ReportSetup extends Report {
* Add a row to the group_act_daily report table.
*
* @param int $day Day - the unix time of the beginning of the day.
- * @return boolean Success.
+ * @return bool Success.
*/
function group_act_daily($day) {
db_query_params('DELETE FROM rep_group_act_daily WHERE day=$1',
@@ -1222,7 +1222,7 @@ class ReportSetup extends Report {
* Populate the group_act_daily report table.
*
* @param int $count
- * @return boolean Success.
+ * @return bool Success.
*/
function backfill_group_act_daily($count=10000) {
$today=mktime(0,0,0,date('m'),date('d')-1,date('Y'));
@@ -1252,7 +1252,7 @@ class ReportSetup extends Report {
* Add a row to the group_act_weekly report table.
*
* @param int $week Week - the unix time of the beginning of the sunday for this week.
- * @return boolean Success.
+ * @return bool Success.
*/
function group_act_weekly($week) {
db_query_params ('DELETE FROM rep_group_act_weekly WHERE week=$1',
@@ -1281,7 +1281,7 @@ class ReportSetup extends Report {
* Populate the group_act_weekly report table.
*
* @param int $count
- * @return boolean Success.
+ * @return bool Success.
*/
function backfill_group_act_weekly($count=10000) {
@@ -1302,7 +1302,7 @@ class ReportSetup extends Report {
*
* @param int $month month_start - the unix time of the beginning of the month.
* @param int $end month_end - the unix time of the end of the month.
- * @return boolean Success.
+ * @return bool Success.
*/
function group_act_monthly($month,$end) {
db_query_params('DELETE FROM rep_group_act_monthly WHERE month=$1',
@@ -1330,7 +1330,7 @@ class ReportSetup extends Report {
* Populate the group_act_monthly report table.
*
* @param int $count
- * @return boolean Success.
+ * @return bool Success.
*/
function backfill_group_act_monthly($count=10000) {
@@ -1350,7 +1350,7 @@ class ReportSetup extends Report {
* Add a row to the rep_time_category table.
*
* @param string $category_name The category name.
- * @return boolean Success.
+ * @return bool Success.
*/
function addTimeCode($category_name) {
return db_query_params ('INSERT INTO rep_time_category (category_name) VALUES ($1)',
@@ -1360,9 +1360,9 @@ class ReportSetup extends Report {
/**
* Update the rep_time_category table.
*
- * @param integer $time_code
+ * @param int $time_code
* @param string $category_name The category name.
- * @return boolean Success.
+ * @return bool Success.
*/
function updateTimeCode($time_code, $category_name) {
return db_query_params ('UPDATE rep_time_category SET category_name=$1 WHERE time_code=$2',
@@ -1374,7 +1374,7 @@ class ReportSetup extends Report {
* Add a row to the project_status table.
*
* @param string $status_name The Status name.
- * @return boolean Success.
+ * @return bool Success.
*/
function addStatusId($status_name) {
return db_query_params ('INSERT INTO project_status (status_name) VALUES ($1)',
@@ -1384,9 +1384,9 @@ class ReportSetup extends Report {
/**
* Update the project_status table.
*
- * @param integer $status_id
+ * @param int $status_id
* @param string $status_name The category name.
- * @return boolean Success.
+ * @return bool Success.
*/
function updateStatusID($status_id, $status_name) {
return db_query_params ('UPDATE project_status SET status_name=$1 WHERE status_id=$2',
diff --git a/src/common/reporting/TimeEntry.class.php b/src/common/reporting/TimeEntry.class.php
index 87ea356..26b7869 100644
--- a/src/common/reporting/TimeEntry.class.php
+++ b/src/common/reporting/TimeEntry.class.php
@@ -99,7 +99,7 @@ class TimeEntry extends FFError {
*
* @author Tony Bibbs <tony at geeklog.net>
* @access public
- * @return boolean Always false
+ * @return bool Always false
*
*/
function update()
@@ -116,7 +116,7 @@ class TimeEntry extends FFError {
* @param int $projectTaskId ID for the task which the time entry record belongs to.
* @param int $reportDate
* @param int $oldTimeCode ID of time code that was associated with time entry record.
- * @return boolean True if delete works, otherwise false)
+ * @return bool True if delete works, otherwise false)
*
*/
function delete($projectTaskId, $reportDate, $oldTimeCode)
diff --git a/src/common/search/ArtifactSearchQuery.class.php b/src/common/search/ArtifactSearchQuery.class.php
index 7b8f65c..42ee8ac 100644
--- a/src/common/search/ArtifactSearchQuery.class.php
+++ b/src/common/search/ArtifactSearchQuery.class.php
@@ -44,7 +44,7 @@ class ArtifactSearchQuery extends SearchQuery {
/**
* @param string $words words we are searching for
* @param int $offset offset
- * @param boolean $isExact if we want to search for all the words or if only one matching the query is sufficient
+ * @param bool $isExact if we want to search for all the words or if only one matching the query is sufficient
* @param int $groupId group id
* @param int $artifactId artifact id
*/
diff --git a/src/common/search/DocsSearchQuery.class.php b/src/common/search/DocsSearchQuery.class.php
index b8e4776..76832dc 100644
--- a/src/common/search/DocsSearchQuery.class.php
+++ b/src/common/search/DocsSearchQuery.class.php
@@ -39,7 +39,7 @@ class DocsSearchQuery extends SearchQuery {
/**
* flag if non public items are returned
*
- * @var boolean $showNonPublic
+ * @var bool $showNonPublic
*/
var $showNonPublic;
@@ -123,7 +123,7 @@ class DocsSearchQuery extends SearchQuery {
* getSections - returns the list of available doc groups
*
* @param $groupId int group id
- * @param $showNonPublic boolean if we should consider non public sections
+ * @param $showNonPublic bool if we should consider non public sections
* @return array
*/
static function getSections($groupId, $showNonPublic = false) {
diff --git a/src/common/search/ExportProjectSearchQuery.class.php b/src/common/search/ExportProjectSearchQuery.class.php
index 4e006c8..1f042b4 100644
--- a/src/common/search/ExportProjectSearchQuery.class.php
+++ b/src/common/search/ExportProjectSearchQuery.class.php
@@ -29,7 +29,7 @@ class ExportProjectSearchQuery extends SearchQuery {
/**
* @param string $words words we are searching for
* @param int $offset offset
- * @param boolean $isExact if we want to search for all the words or if only one matching the query is sufficient
+ * @param bool $isExact if we want to search for all the words or if only one matching the query is sufficient
*/
function __construct($words, $offset, $isExact) {
parent::__construct($words, $offset, $isExact, 200);
diff --git a/src/common/search/ForumSearchQuery.class.php b/src/common/search/ForumSearchQuery.class.php
index dc6a6b0..c7e7a29 100644
--- a/src/common/search/ForumSearchQuery.class.php
+++ b/src/common/search/ForumSearchQuery.class.php
@@ -43,7 +43,7 @@ class ForumSearchQuery extends SearchQuery {
/**
* @param string $words words we are searching for
* @param int $offset offset
- * @param boolean $isExact if we want to search for all the words or if only one matching the query is sufficient
+ * @param bool $isExact if we want to search for all the words or if only one matching the query is sufficient
* @param int $groupId group id
* @param int $forumId forum id
*/
diff --git a/src/common/search/ForumsSearchQuery.class.php b/src/common/search/ForumsSearchQuery.class.php
index 92b3611..0781623 100644
--- a/src/common/search/ForumsSearchQuery.class.php
+++ b/src/common/search/ForumsSearchQuery.class.php
@@ -29,17 +29,17 @@ require_once $gfcommon.'search/SearchQuery.class.php';
class ForumsSearchQuery extends SearchQuery {
/**
- * group id
- *
- * @var int $groupId
- */
+ * group id
+ *
+ * @var int $groupId
+ */
var $groupId;
/**
- * flag if non public items are returned
- *
- * @var boolean $showNonPublic
- */
+ * flag if non public items are returned
+ *
+ * @var bool $showNonPublic
+ */
var $showNonPublic;
/**
@@ -98,7 +98,7 @@ class ForumsSearchQuery extends SearchQuery {
* getSections - returns the list of available forums
*
* @param int $groupId group id
- * @param boolean $showNonPublic if we should consider non public sections
+ * @param bool $showNonPublic if we should consider non public sections
* @return array
*/
static function getSections($groupId, $showNonPublic = false) {
diff --git a/src/common/search/FrsSearchQuery.class.php b/src/common/search/FrsSearchQuery.class.php
index af9eebd..c3198f3 100644
--- a/src/common/search/FrsSearchQuery.class.php
+++ b/src/common/search/FrsSearchQuery.class.php
@@ -28,17 +28,17 @@ require_once $gfcommon.'search/SearchQuery.class.php';
class FrsSearchQuery extends SearchQuery {
/**
- * group id
- *
- * @var int $groupId
- */
+ * group id
+ *
+ * @var int $groupId
+ */
var $groupId;
/**
- * flag if non public items are returned
- *
- * @var boolean $showNonPublic
- */
+ * flag if non public items are returned
+ *
+ * @var bool $showNonPublic
+ */
var $showNonPublic;
/**
@@ -95,7 +95,7 @@ class FrsSearchQuery extends SearchQuery {
* getSections - returns the list of available forums
*
* @param int $groupId group id
- * @param boolean $showNonPublic if we should consider non public sections
+ * @param bool $showNonPublic if we should consider non public sections
* @return array
*/
static function getSections($groupId, $showNonPublic) {
diff --git a/src/common/search/NewsSearchQuery.class.php b/src/common/search/NewsSearchQuery.class.php
index 11b8b13..d20ed59 100644
--- a/src/common/search/NewsSearchQuery.class.php
+++ b/src/common/search/NewsSearchQuery.class.php
@@ -37,7 +37,7 @@ class NewsSearchQuery extends SearchQuery {
/**
* @param string $words words we are searching for
* @param int $offset offset
- * @param boolean $isExact if we want to search for all the words or if only one matching the query is sufficient
+ * @param bool $isExact if we want to search for all the words or if only one matching the query is sufficient
* @param int $groupId group id
*/
function __construct($words, $offset, $isExact, $groupId) {
diff --git a/src/common/search/SearchQuery.class.php b/src/common/search/SearchQuery.class.php
index e1db2a7..66d04ae 100644
--- a/src/common/search/SearchQuery.class.php
+++ b/src/common/search/SearchQuery.class.php
@@ -59,7 +59,7 @@ class SearchQuery extends FFError {
/**
* if we want to search for all the words or if only one is sufficient
*
- * @var boolean $isExact
+ * @var bool $isExact
*/
var $isExact = false;
/**
diff --git a/src/common/search/TasksSearchQuery.class.php b/src/common/search/TasksSearchQuery.class.php
index f4fa305..78790c1 100644
--- a/src/common/search/TasksSearchQuery.class.php
+++ b/src/common/search/TasksSearchQuery.class.php
@@ -28,17 +28,17 @@ require_once $gfcommon.'search/SearchQuery.class.php';
class TasksSearchQuery extends SearchQuery {
/**
- * group id
- *
- * @var int $groupId
- */
+ * group id
+ *
+ * @var int $groupId
+ */
var $groupId;
/**
- * flag if non public items are returned
- *
- * @var boolean $showNonPublic
- */
+ * flag if non public items are returned
+ *
+ * @var bool $showNonPublic
+ */
var $showNonPublic;
/**
@@ -100,7 +100,7 @@ class TasksSearchQuery extends SearchQuery {
* getSections - returns the list of available subprojects
*
* @param int $groupId group id
- * @param boolean $showNonPublic if we should consider non public sections
+ * @param bool $showNonPublic if we should consider non public sections
* @return array
*/
static function getSections($groupId, $showNonPublic = false) {
diff --git a/src/common/search/TrackersSearchQuery.class.php b/src/common/search/TrackersSearchQuery.class.php
index 3f2a6f3..2340f81 100644
--- a/src/common/search/TrackersSearchQuery.class.php
+++ b/src/common/search/TrackersSearchQuery.class.php
@@ -28,17 +28,17 @@ require_once $gfcommon.'search/SearchQuery.class.php';
class TrackersSearchQuery extends SearchQuery {
/**
- * group id
- *
- * @var int $groupId
- */
+ * group id
+ *
+ * @var int $groupId
+ */
var $groupId;
/**
- * flag if non public items are returned
- *
- * @var boolean $showNonPublic
- */
+ * flag if non public items are returned
+ *
+ * @var bool $showNonPublic
+ */
var $showNonPublic;
/**
@@ -99,7 +99,7 @@ class TrackersSearchQuery extends SearchQuery {
* getSections - returns the list of available trackers
*
* @param int $groupId group id
- * @param boolean $showNonPublic if we should consider non public sections
+ * @param bool $showNonPublic if we should consider non public sections
* @return array
*/
static function getSections($groupId, $showNonPublic = false) {
diff --git a/src/common/survey/Survey.class.php b/src/common/survey/Survey.class.php
index cc7696a..27da6f3 100644
--- a/src/common/survey/Survey.class.php
+++ b/src/common/survey/Survey.class.php
@@ -248,7 +248,7 @@ class Survey extends FFError {
* delete - use this function to delete this survey
* (We don't support delete yet)
*
- * @return boolean success.
+ * @return bool success.
*/
function delete() {
$group_id = $this->Group->GetID();
@@ -271,7 +271,7 @@ class Survey extends FFError {
* fetchData - re-fetch the data for this survey from the database.
*
* @param int $survey_id The survey_id.
- * @return boolean success.
+ * @return bool success.
*/
function fetchData($survey_id) {
$group_id = $this->Group->GetID();
@@ -468,7 +468,7 @@ class Survey extends FFError {
/**
* _fillSurveyQuestions - Get all Survey Questions using SurveyQuestionFactory
*
- * @return boolean success
+ * @return bool success
*/
function _fillSurveyQuestions() {
$sqf = new SurveyQuestionFactory($this->getGroup());
@@ -479,7 +479,7 @@ class Survey extends FFError {
* _isValidQuestionID - Check it is correct question id
*
* @param int $question_id question id
- * @return boolean true if it is valid question id
+ * @return bool true if it is valid question id
*/
function _isValidQuestionID($question_id) {
if (!$this->all_question_array || !is_array($this->all_question_array)) {
diff --git a/src/common/survey/SurveyQuestion.class.php b/src/common/survey/SurveyQuestion.class.php
index 84bb6ff..c8b6e4b 100644
--- a/src/common/survey/SurveyQuestion.class.php
+++ b/src/common/survey/SurveyQuestion.class.php
@@ -122,7 +122,7 @@ class SurveyQuestion extends FFError {
* 4: Comment Only
* 5: Text Field
* 6: None
- * @return boolean success.
+ * @return bool success.
*/
function update($question, $question_type = 1) {
if (strlen($question) < 3) {
@@ -151,7 +151,7 @@ class SurveyQuestion extends FFError {
/**
* delete - use this function to delete a survey question
*
- * @return boolean success.
+ * @return bool success.
*/
function delete() {
$group_id = $this->Group->GetID();
diff --git a/src/common/tracker/Artifact.class.php b/src/common/tracker/Artifact.class.php
index 9dc98ff..a68e21e 100644
--- a/src/common/tracker/Artifact.class.php
+++ b/src/common/tracker/Artifact.class.php
@@ -142,7 +142,7 @@ class Artifact extends FFObject {
/**
* Database result set of parent
*
- * @var integer|boolean $parent
+ * @var int|bool $parent
*/
var $parent;
diff --git a/src/common/tracker/ArtifactCanned.class.php b/src/common/tracker/ArtifactCanned.class.php
index 2c85bb3..a0373ba 100644
--- a/src/common/tracker/ArtifactCanned.class.php
+++ b/src/common/tracker/ArtifactCanned.class.php
@@ -114,7 +114,7 @@ class ArtifactCanned extends FFError {
* fetchData - re-fetch the data for this ArtifactCanned from the database.
*
* @param int $id The ID number.
- * @return boolean success.
+ * @return bool success.
*/
function fetchData($id) {
$res = db_query_params ('SELECT * FROM artifact_canned_responses WHERE id=$1',
@@ -169,7 +169,7 @@ class ArtifactCanned extends FFError {
*
* @param string $title Title of the message.
* @param string $body Body of the message.
- * @return boolean success.
+ * @return bool success.
*/
function update($title,$body) {
if (!forge_check_perm ('tracker_admin', $this->ArtifactType->Group->getID())) {
@@ -200,7 +200,7 @@ class ArtifactCanned extends FFError {
/**
* delete - delete an ArtifactCanned message.
*
- * @return boolean success.
+ * @return bool success.
*/
function delete() {
if (!forge_check_perm ('tracker_admin', $this->ArtifactType->Group->getID())) {
diff --git a/src/common/tracker/ArtifactExtraField.class.php b/src/common/tracker/ArtifactExtraField.class.php
index 127a07d..73c6035 100644
--- a/src/common/tracker/ArtifactExtraField.class.php
+++ b/src/common/tracker/ArtifactExtraField.class.php
@@ -275,7 +275,7 @@ class ArtifactExtraField extends FFError {
* fetchData - re-fetch the data for this ArtifactExtraField from the database.
*
* @param int $id ID of the Box.
- * @return boolean success.
+ * @return bool success.
*/
function fetchData($id) {
$this->id=$id;
@@ -446,7 +446,7 @@ class ArtifactExtraField extends FFError {
/**
* isRequired - whether this field is required or not.
*
- * @return boolean required.
+ * @return bool required.
*/
function isRequired() {
return $this->data_array['is_required'];
@@ -455,7 +455,7 @@ class ArtifactExtraField extends FFError {
/**
* isHiddenOnSubmit - whether this field is hidden on a new submission or not.
*
- * @return boolean required.
+ * @return bool required.
*/
function isHiddenOnSubmit() {
return $this->data_array['is_hidden_on_submit'];
@@ -464,7 +464,7 @@ class ArtifactExtraField extends FFError {
/**
* isDisabled - whether this field is disabled or not.
*
- * @return boolean required.
+ * @return bool required.
*/
function isDisabled() {
return $this->data_array['is_disabled'];
@@ -473,7 +473,7 @@ class ArtifactExtraField extends FFError {
/**
* isAutoAssign
*
- * @return boolean assign.
+ * @return bool assign.
*/
function isAutoAssign() {
if ($this->getArtifactType()->getAutoAssignField() == $this->getID()) {
@@ -487,7 +487,7 @@ class ArtifactExtraField extends FFError {
/**
* setAutoAssign - set this field that triggers auto-assignment rules.
*
- * @return boolean
+ * @return bool
*/
function setAutoAssign() {
return $this->getArtifactType()->setAutoAssignField($this->getID());
@@ -496,7 +496,7 @@ class ArtifactExtraField extends FFError {
/**
* unsetAutoAssign - unset this field that triggers auto-assignment rules.
*
- * @return boolean
+ * @return bool
*/
function unsetAutoAssign() {
return $this->getArtifactType()->setAutoAssignField(100);
@@ -505,8 +505,8 @@ class ArtifactExtraField extends FFError {
/**
* setDefaultValues - set default value(s) for this field.
*
- * @param string|integer|array $default default value, default id value, or array of default values.
- * @return boolean
+ * @param string|int|array $default default value, default id value, or array of default values.
+ * @return bool
*/
function setDefaultValues($default) {
$type = $this->getType();
@@ -613,7 +613,7 @@ class ArtifactExtraField extends FFError {
/**
* resetDefaultValues - reset default value(s) for this field.
*
- * @return boolean
+ * @return bool
*/
function resetDefaultValues() {
$result = db_query_params ('DELETE FROM artifact_extra_field_default WHERE extra_field_id = $1',
@@ -630,7 +630,7 @@ class ArtifactExtraField extends FFError {
/**
* getDefaultValues - Get default value, id of default value or list of id of default values for this extra field
*
- * @return string|integer|array
+ * @return string|int|array
*/
function getDefaultValues() {
$return = false;
@@ -737,7 +737,7 @@ class ArtifactExtraField extends FFError {
/**
* resetFormula - reset formula
*
- * @return boolean
+ * @return bool
*/
function resetFormula() {
$result = db_query_params ('DELETE FROM artifact_extra_field_formula WHERE extra_field_id = $1',
diff --git a/src/common/tracker/ArtifactExtraFieldElement.class.php b/src/common/tracker/ArtifactExtraFieldElement.class.php
index d29f08c..f5d13ce 100644
--- a/src/common/tracker/ArtifactExtraFieldElement.class.php
+++ b/src/common/tracker/ArtifactExtraFieldElement.class.php
@@ -187,7 +187,7 @@ class ArtifactExtraFieldElement extends FFError {
* fetchData - re-fetch the data for this ArtifactExtraFieldElement from the database.
*
* @param int $id ID of the Box.
- * @return boolean success.
+ * @return bool success.
*/
function fetchData($id) {
$res = db_query_params ('SELECT *, 0 AS is_default FROM artifact_extra_field_elements WHERE element_id=$1',
@@ -271,7 +271,7 @@ class ArtifactExtraFieldElement extends FFError {
/**
* getAutoAssignedUser - return id of the user witch issue is auto assign to.
*
- * @return integer user id.
+ * @return int user id.
*/
function getAutoAssignto() {
return $this->data_array['auto_assign_to'];
@@ -297,7 +297,7 @@ class ArtifactExtraFieldElement extends FFError {
/**
* isDefault - whether this field element is default value or not.
*
- * @return boolean
+ * @return bool
*/
function isDefault() {
return $this->data_array['is_default'];
@@ -553,7 +553,7 @@ class ArtifactExtraFieldElement extends FFError {
/**
* delete - delete the current value.
*
- * @return boolean success.
+ * @return bool success.
*/
function delete() {
if (!forge_check_perm ('tracker_admin', $this->ArtifactExtraField->ArtifactType->Group->getID())) {
diff --git a/src/common/tracker/ArtifactFile.class.php b/src/common/tracker/ArtifactFile.class.php
index 01c261b..9307c3c 100644
--- a/src/common/tracker/ArtifactFile.class.php
+++ b/src/common/tracker/ArtifactFile.class.php
@@ -188,7 +188,7 @@ class ArtifactFile extends FFError {
/**
* delete - delete this artifact file from the db.
*
- * @return boolean success.
+ * @return bool success.
*/
function delete() {
if (!forge_check_perm('tracker', $this->Artifact->ArtifactType->getID(), 'tech')) {
@@ -211,7 +211,7 @@ class ArtifactFile extends FFError {
* fetchData - re-fetch the data for this ArtifactFile from the database.
*
* @param int $id The file_id.
- * @return boolean success.
+ * @return bool success.
*/
function fetchData($id) {
$res = db_query_params ('SELECT * FROM artifact_file_user_vw WHERE id=$1',
diff --git a/src/common/tracker/ArtifactHistory.class.php b/src/common/tracker/ArtifactHistory.class.php
index 77c0cee..ea9eda5 100644
--- a/src/common/tracker/ArtifactHistory.class.php
+++ b/src/common/tracker/ArtifactHistory.class.php
@@ -72,7 +72,7 @@ class ArtifactHistory extends FFError {
* fetchData - re-fetch the data for this ArtifactHistory from the database.
*
* @param int $id ID of the category.
- * @return boolean success.
+ * @return bool success.
*/
function fetchData($id) {
$res = db_query_params ('SELECT * FROM artifact_history_user_vw WHERE id=$1',
diff --git a/src/common/tracker/ArtifactMessage.class.php b/src/common/tracker/ArtifactMessage.class.php
index 9f35ffe..0f13d12 100644
--- a/src/common/tracker/ArtifactMessage.class.php
+++ b/src/common/tracker/ArtifactMessage.class.php
@@ -141,7 +141,7 @@ class ArtifactMessage extends FFError {
* fetchData - re-fetch the data for this ArtifactMessage from the database.
*
* @param int $id ID of the category.
- * @return boolean success.
+ * @return bool success.
*/
function fetchData($id) {
$res = db_query_params ('SELECT * FROM artifact_message_user_vw WHERE id=$1',
diff --git a/src/common/tracker/ArtifactQuery.class.php b/src/common/tracker/ArtifactQuery.class.php
index c352c45..941a5c6 100644
--- a/src/common/tracker/ArtifactQuery.class.php
+++ b/src/common/tracker/ArtifactQuery.class.php
@@ -210,7 +210,7 @@ class ArtifactQuery extends FFError {
* fetchData - re-fetch the data for this ArtifactQuery from the database.
*
* @param int $id ID of saved query.
- * @return boolean success.
+ * @return bool success.
*/
function fetchData($id) {
$res = db_query_params ('SELECT * FROM artifact_query WHERE artifact_query_id=$1',
@@ -263,7 +263,7 @@ class ArtifactQuery extends FFError {
* @param string $description
* @param $last_modifier
* @param $followups
- * @return boolean True/false on success or not.
+ * @return bool True/false on success or not.
*/
function insertElements($id,$status,$submitter,$assignee,$moddaterange,$sort_col,$sort_ord,$extra_fields,$opendaterange,$closedaterange,$summary,$description,$followups,$last_modifier) {
$res = db_query_params ('DELETE FROM artifact_query_fields WHERE artifact_query_id=$1',
@@ -822,7 +822,7 @@ class ArtifactQuery extends FFError {
/**
* makeDefault - set this as the default query
*
- * @return boolean success.
+ * @return bool success.
*/
function makeDefault() {
if (!session_loggedin()) {
@@ -836,7 +836,7 @@ class ArtifactQuery extends FFError {
/**
* delete - delete query
*
- * @return boolean success.
+ * @return bool success.
*/
function delete() {
if (forge_check_perm ('tracker', $this->ArtifactType->getID(), 'manager')) {
diff --git a/src/common/tracker/ArtifactType.class.php b/src/common/tracker/ArtifactType.class.php
index 2241aa2..ca5e848 100644
--- a/src/common/tracker/ArtifactType.class.php
+++ b/src/common/tracker/ArtifactType.class.php
@@ -289,7 +289,7 @@ class ArtifactType extends FFError {
* fetchData - re-fetch the data for this ArtifactType from the database.
*
* @param int $artifact_type_id The artifact type ID.
- * @return boolean success.
+ * @return bool success.
*/
function fetchData($artifact_type_id) {
$this->voters = false;
@@ -366,7 +366,7 @@ class ArtifactType extends FFError {
/**
* emailAll - determine if we're supposed to email on every event.
*
- * @return boolean email_all.
+ * @return bool email_all.
*/
function emailAll() {
return $this->data_array['email_all_updates'];
@@ -467,7 +467,7 @@ class ArtifactType extends FFError {
* setCustomStatusField - set the extra_field_id of the field containing the custom status.
*
* @param int $extra_field_id The extra field id.
- * @return boolean success.
+ * @return bool success.
*/
function setCustomStatusField($extra_field_id) {
$res = db_query_params('UPDATE artifact_group_list SET custom_status_field=$1
@@ -491,7 +491,7 @@ class ArtifactType extends FFError {
* setAutoAssignField - set the extra_field_id of the field that triggers auto-assignment rules.
*
* @param int $extra_field_id The extra field id.
- * @return boolean success.
+ * @return bool success.
*/
function setAutoAssignField($extra_field_id) {
$res = db_query_params('UPDATE artifact_group_list SET auto_assign_field=$1
@@ -505,7 +505,7 @@ class ArtifactType extends FFError {
/**
* usesCustomStatuses - boolean
*
- * @return boolean use_custom_statues.
+ * @return bool use_custom_statues.
*/
function usesCustomStatuses() {
return $this->getCustomStatusField();
@@ -773,7 +773,7 @@ class ArtifactType extends FFError {
*
* @param int $clone_tracker_id id of the cloned tracker
* @param array $id_mappings array mapping between template objects and new project objects
- * @return boolean true/false on success
+ * @return bool true/false on success
*/
function cloneFieldsFrom($clone_tracker_id, $id_mappings = array()) {
$at = artifactType_get_object($clone_tracker_id);
@@ -1438,7 +1438,7 @@ class ArtifactType extends FFError {
* setBrowseList - set the list of columns in browse page.
*
* @param string $list string comma separated of ids of custom field and names of internal fields.
- * @return boolean success.
+ * @return bool success.
*/
function setBrowseList($list) {
$res = db_query_params('UPDATE artifact_group_list
@@ -1486,7 +1486,7 @@ class ArtifactType extends FFError {
/**
*
- * @param integer $unit_set_id the effort unit set id
+ * @param int $unit_set_id the effort unit set id
* @return bool
*/
function setEffortUnitSet($unit_set_id) {
@@ -1506,7 +1506,7 @@ class ArtifactType extends FFError {
/**
* getEffortUnitSet - Get the effort unit set id.
*
- * @return integer The id of the effort unit set.
+ * @return int The id of the effort unit set.
*/
function getEffortUnitSet() {
return $this->data_array['unit_set_id'];
diff --git a/src/common/tracker/ArtifactTypes.class.php b/src/common/tracker/ArtifactTypes.class.php
index 0ab642c..96b0e2d 100644
--- a/src/common/tracker/ArtifactTypes.class.php
+++ b/src/common/tracker/ArtifactTypes.class.php
@@ -62,7 +62,7 @@ class ArtifactTypes extends FFError {
/**
* createTrackers - creates all the standard trackers for a given Group.
*
- * @return boolean success.
+ * @return bool success.
*/
function createTrackers() {
diff --git a/src/common/tracker/Artifacts.class.php b/src/common/tracker/Artifacts.class.php
index a236295..9295ccb 100644
--- a/src/common/tracker/Artifacts.class.php
+++ b/src/common/tracker/Artifacts.class.php
@@ -75,7 +75,7 @@ class Artifacts extends FFError {
*
* Retrieves an array of artifact objects.
*
- * @param boolean $offset Database query offset.
+ * @param bool $offset Database query offset.
* @return array|bool An array of artifact objects on success / false on failure.
*/
function getArtifacts($offset=false) {
diff --git a/src/common/tracker/Effort.class.php b/src/common/tracker/Effort.class.php
index 66465ed..2d194cd 100644
--- a/src/common/tracker/Effort.class.php
+++ b/src/common/tracker/Effort.class.php
@@ -26,7 +26,7 @@ require_once $gfcommon.'tracker/EffortUnitFactory.class.php';
class Effort extends FFError {
/**
- * @var integer value
+ * @var int value
*/
private $value;
@@ -38,7 +38,7 @@ class Effort extends FFError {
/**
* Effort - Effort object constructor
*
- * @param integer
+ * @param int
* @param EffortUnit
*/
function __construct($value,$effortUnit) {
diff --git a/src/common/tracker/EffortUnitFactory.class.php b/src/common/tracker/EffortUnitFactory.class.php
index 98d7508..374c278 100644
--- a/src/common/tracker/EffortUnitFactory.class.php
+++ b/src/common/tracker/EffortUnitFactory.class.php
@@ -161,7 +161,7 @@ class EffortUnitFactory extends FFError {
* encodedToValue - return the value of an effort expressed in encoded unit.
*
* @param string $encoded encoded effort
- * @return integer the value of an effort expressed in encoded unit.
+ * @return int the value of an effort expressed in encoded unit.
*/
function encodedToValue($encoded){
$value = 0;
@@ -176,7 +176,7 @@ class EffortUnitFactory extends FFError {
* encodedToValueInBaseUnit - return the value of an effort expressed in base unit.
*
* @param string $encoded encoded effort
- * @return integer the value of an effort expressed in base unit.
+ * @return int the value of an effort expressed in base unit.
*/
function encodedToValueInBaseUnit($encoded){
$value = 0;
@@ -190,7 +190,7 @@ class EffortUnitFactory extends FFError {
* encodedToUnitId - return the unit id of an encoded effort.
*
* @param string $encoded encoded effort
- * @return integer the unit id of an encoded effort.
+ * @return int the unit id of an encoded effort.
*/
function encodedToUnitId($encoded) {
if (preg_match('/^(\d+)U(\d+)$/',$encoded,$matches)) {
diff --git a/src/common/valid/Rule.class.php b/src/common/valid/Rule.class.php
index 954bf53..bb3d645 100644
--- a/src/common/valid/Rule.class.php
+++ b/src/common/valid/Rule.class.php
@@ -331,7 +331,7 @@ class Rule_File extends Rule {
* Check file upload validity
*
* @param string $file
- * @return boolean Is file upload valid or not.
+ * @return bool Is file upload valid or not.
*/
function isValid($file) {
$ok = false;
diff --git a/src/common/widget/WidgetLayoutManager.class.php b/src/common/widget/WidgetLayoutManager.class.php
index d4506d1..ef67516 100644
--- a/src/common/widget/WidgetLayoutManager.class.php
+++ b/src/common/widget/WidgetLayoutManager.class.php
@@ -110,7 +110,7 @@ class WidgetLayoutManager {
*
* @param int $owner_id
* @param string $owner_type
- * @return boolean true if the user can update the layout (add/remove widget, collapse, set preferences, ...)
+ * @return bool true if the user can update the layout (add/remove widget, collapse, set preferences, ...)
*/
function _currentUserCanUpdateLayout($owner_id, $owner_type) {
$modify = false;
-----------------------------------------------------------------------
Summary of changes:
src/common/dao/include/DataAccessObject.class.php | 2 +-
src/common/docman/Document.class.php | 37 +++++-----
src/common/docman/DocumentFactory.class.php | 9 ++-
src/common/docman/DocumentGroup.class.php | 46 ++++++------
src/common/docman/DocumentManager.class.php | 6 +-
src/common/docman/DocumentVersion.class.php | 5 +-
src/common/docman/include/utils.php | 2 +-
src/common/forum/Forum.class.php | 12 ++--
src/common/forum/ForumFactory.class.php | 2 +-
src/common/forum/ForumMessage.class.php | 24 +++----
src/common/frs/FRSFile.class.php | 6 +-
src/common/frs/FRSPackage.class.php | 24 +++----
src/common/frs/FRSPackageFactory.class.php | 2 +-
src/common/frs/FRSRelease.class.php | 6 +-
src/common/frs/include/frs_utils.php | 10 +--
src/common/include/AuthPlugin.class.php | 8 +--
src/common/include/Codendi_Request.class.php | 10 +--
src/common/include/Group.class.php | 10 +--
src/common/include/GroupJoinRequest.class.php | 12 ++--
src/common/include/HTTPRequest.class.php | 6 +-
src/common/include/Permission.class.php | 22 +++---
src/common/include/PluginManager.class.php | 2 +-
src/common/include/PluginPersistence.class.php | 2 +-
src/common/include/RBAC.php | 12 ++--
src/common/include/Role.class.php | 14 ++--
src/common/include/User.class.php | 62 ++++++++--------
src/common/include/Validator.class.php | 2 +-
src/common/include/config.php | 2 +-
src/common/include/database-pgsql.php | 4 +-
src/common/include/forms.php | 4 +-
src/common/include/system/pgsql.class.php | 2 +-
src/common/include/utils.php | 4 +-
src/common/mail/MailingList.class.php | 8 +--
src/common/pm/ProjectCategory.class.php | 6 +-
src/common/pm/ProjectGroup.class.php | 2 +-
src/common/pm/ProjectTask.class.php | 16 ++---
src/common/pm/Validator.class.php | 2 +-
src/common/reporting/ReportSetup.class.php | 84 +++++++++++-----------
src/common/reporting/TimeEntry.class.php | 4 +-
src/common/search/ArtifactSearchQuery.class.php | 2 +-
src/common/search/DocsSearchQuery.class.php | 4 +-
.../search/ExportProjectSearchQuery.class.php | 2 +-
src/common/search/ForumSearchQuery.class.php | 2 +-
src/common/search/ForumsSearchQuery.class.php | 18 ++---
src/common/search/FrsSearchQuery.class.php | 18 ++---
src/common/search/NewsSearchQuery.class.php | 2 +-
src/common/search/SearchQuery.class.php | 2 +-
src/common/search/TasksSearchQuery.class.php | 18 ++---
src/common/search/TrackersSearchQuery.class.php | 18 ++---
src/common/survey/Survey.class.php | 8 +--
src/common/survey/SurveyQuestion.class.php | 4 +-
src/common/tracker/Artifact.class.php | 2 +-
src/common/tracker/ArtifactCanned.class.php | 6 +-
src/common/tracker/ArtifactExtraField.class.php | 24 +++----
.../tracker/ArtifactExtraFieldElement.class.php | 8 +--
src/common/tracker/ArtifactFile.class.php | 4 +-
src/common/tracker/ArtifactHistory.class.php | 2 +-
src/common/tracker/ArtifactMessage.class.php | 2 +-
src/common/tracker/ArtifactQuery.class.php | 8 +--
src/common/tracker/ArtifactType.class.php | 18 ++---
src/common/tracker/ArtifactTypes.class.php | 2 +-
src/common/tracker/Artifacts.class.php | 2 +-
src/common/tracker/Effort.class.php | 4 +-
src/common/tracker/EffortUnitFactory.class.php | 6 +-
src/common/valid/Rule.class.php | 2 +-
src/common/widget/WidgetLayoutManager.class.php | 2 +-
66 files changed, 338 insertions(+), 345 deletions(-)
hooks/post-receive
--
FusionForge
More information about the Fusionforge-commits
mailing list