From ef427ec0df75a7b61fcc5fac0b203e70951e529c Mon Sep 17 00:00:00 2001 From: abraar Date: Tue, 1 Feb 2011 12:49:40 +0000 Subject: [PATCH] Changes done for PhpDoc --- workflow/engine/classes/class.ArrayPeer.php | 5 +- workflow/engine/classes/class.BasePeer.php | 5 +- workflow/engine/classes/class.Installer.php | 5 +- .../engine/classes/class.Installer_mssql.php | 3 +- workflow/engine/classes/class.archive.php | 12 +- workflow/engine/classes/class.calendar.php | 5 +- workflow/engine/classes/class.case.php | 5 +- workflow/engine/classes/class.cli.php | 4 + .../engine/classes/class.configuration.php | 5 +- workflow/engine/classes/class.dashboards.php | 5 +- workflow/engine/classes/class.dates.php | 7 +- .../engine/classes/class.dbConnections.php | 10 +- workflow/engine/classes/class.derivation.php | 5 +- .../engine/classes/class.dynaFormField.php | 6 +- .../engine/classes/class.dynaformEditor.php | 13 +- workflow/engine/classes/class.groupUser.php | 3 +- workflow/engine/classes/class.groups.php | 5 +- workflow/engine/classes/class.insert.php | 102 ------ .../engine/classes/class.javaBridgePM.php | 12 +- workflow/engine/classes/class.jrml.php | 5 +- workflow/engine/classes/class.languages.php | 5 +- workflow/engine/classes/class.net.php | 11 +- workflow/engine/classes/class.package.php | 266 --------------- workflow/engine/classes/class.plugin.php | 172 ++++++---- .../engine/classes/class.pluginRegistry.php | 21 +- workflow/engine/classes/class.pmFunctions.php | 7 +- workflow/engine/classes/class.pmScript.php | 5 +- workflow/engine/classes/class.popupMenu.php | 5 +- workflow/engine/classes/class.processMap.php | 8 +- workflow/engine/classes/class.processes.php | 5 +- workflow/engine/classes/class.propelTable.php | 11 +- .../engine/classes/class.replacementLogo.php | 13 +- workflow/engine/classes/class.report.php | 15 +- .../engine/classes/class.reportTables.php | 5 +- .../classes/class.serverConfiguration.php | 24 +- workflow/engine/classes/class.sessions.php | 7 +- workflow/engine/classes/class.smtp.php | 302 ------------------ workflow/engine/classes/class.spool.php | 5 +- workflow/engine/classes/class.system.php | 26 +- workflow/engine/classes/class.tasks.php | 6 +- workflow/engine/classes/class.toolBar.php | 9 +- .../engine/classes/class.triggerLibrary.php | 8 +- workflow/engine/classes/class.webdav.php | 6 +- workflow/engine/classes/class.wsBase.php | 13 +- workflow/engine/classes/class.wsResponse.php | 13 +- workflow/engine/classes/class.wsTools.php | 9 +- workflow/engine/classes/class.xmlDb.php | 8 +- .../engine/classes/class.xmlfield_Image.php | 10 +- .../engine/classes/class.xmlfield_InputPM.php | 7 +- workflow/engine/classes/class.xpdl.php | 13 +- 50 files changed, 339 insertions(+), 898 deletions(-) delete mode 100755 workflow/engine/classes/class.insert.php delete mode 100755 workflow/engine/classes/class.package.php delete mode 100755 workflow/engine/classes/class.smtp.php diff --git a/workflow/engine/classes/class.ArrayPeer.php b/workflow/engine/classes/class.ArrayPeer.php index 631bc9dea..0fce8932e 100644 --- a/workflow/engine/classes/class.ArrayPeer.php +++ b/workflow/engine/classes/class.ArrayPeer.php @@ -1,9 +1,10 @@ 2010-03-22 - * @package workflow.classes + * @package workflow.engine.classes */ require_once ( "classes/model/CalendarDefinition.php" ); diff --git a/workflow/engine/classes/class.case.php b/workflow/engine/classes/class.case.php index aa04145e5..1b2f7df84 100644 --- a/workflow/engine/classes/class.case.php +++ b/workflow/engine/classes/class.case.php @@ -2,6 +2,7 @@ /** * class.case.php + * @package workflow.engine.classes * * ProcessMaker Open Source Edition * Copyright (C) 2004 - 2008 Colosa Inc.23 @@ -21,8 +22,8 @@ * * For more information, contact Colosa Inc, 2566 Le Jeune Rd., * Coral Gables, FL, 33134, USA, or email info@colosa.com. - * /** - * @package workflow.classes + * + * @package workflow.engine.classes */ require_once ("classes/model/Application.php"); diff --git a/workflow/engine/classes/class.cli.php b/workflow/engine/classes/class.cli.php index 0c253ad38..5e3b283ef 100644 --- a/workflow/engine/classes/class.cli.php +++ b/workflow/engine/classes/class.cli.php @@ -1,6 +1,7 @@ */ +/** + * @package workflow.engine.classes + */ class CLI { public static $tasks = array(); public static $currentTask = NULL; diff --git a/workflow/engine/classes/class.configuration.php b/workflow/engine/classes/class.configuration.php index 3090d9f98..32e867c0a 100644 --- a/workflow/engine/classes/class.configuration.php +++ b/workflow/engine/classes/class.configuration.php @@ -1,9 +1,10 @@ - * @Description:This is a class for load all additional connections; if exist in a particular proccess - * @Date: 15-05-2008 + * Author: Erik Amaru Ortiz + * Description:This is a class for load all additional connections; if exist in a particular proccess + * Date: 15-05-2008 * * * class.dbConnections.php * * Email bugs/suggestions to erik@colosa.com - * - * @package workflow.classes + * */ require_once 'model/DbSource.php'; @@ -20,6 +19,7 @@ require_once 'model/Content.php'; * * * @copyright 2008 Colosa + * @package workflow.engine.classes * */ class dbConnections diff --git a/workflow/engine/classes/class.derivation.php b/workflow/engine/classes/class.derivation.php index b8bba4766..a8079bab2 100644 --- a/workflow/engine/classes/class.derivation.php +++ b/workflow/engine/classes/class.derivation.php @@ -1,9 +1,10 @@ - * @copyright Copyright (c) 2007, Ian K Armstrong - * @license http://www.opensource.org/licenses/gpl-3.0.html GNU Public License - * @link http://www.openmail.cc - * - * @category web_mail - * @subpackage send - * @filesource - * @version - * - * @file class.insert.php - * - */ - - require_once ( "classes/model/AppMessage.php" ); - -class insert -{ - private $db_spool; - private $status; - - /** - * construct of insert - * - * @param string $pPRO_UID - * @return void - */ - function __construct($db_spool=array()) - { - if(count($db_spool)>0) - $db_spool = $this->db_insert($db_spool); - - } - - /** - * returnStatus - * - * @return $this->status; - */ - public function returnStatus() - { - return $this->status; - - } - - /** - * db_insert - * - * @param array $db_spool - * @return string $sUID; - */ - public function db_insert($db_spool) - { - $sUID = G::generateUniqueID(); - $spool = new AppMessage(); - $spool->setAppMsgUid($sUID); - $spool->setMsgUid($db_spool['msg_uid']); - $spool->setAppUid($db_spool['app_uid']); - $spool->setDelIndex($db_spool['del_index']); - $spool->setAppMsgType($db_spool['app_msg_type']); - $spool->setAppMsgSubject($db_spool['app_msg_subject']); - $spool->setAppMsgFrom($db_spool['app_msg_from']); - $spool->setAppMsgTo($db_spool['app_msg_to']); - $spool->setAppMsgBody($db_spool['app_msg_body']); - $spool->setAppMsgDate(date('Y-m-d H:i:s')); - $spool->setAppMsgCc($db_spool['app_msg_cc']); - $spool->setAppMsgBcc($db_spool['app_msg_bcc']); - $spool->setappMsgAttach($db_spool['app_msg_attach']); - $spool->setAppMsgTemplate($db_spool['app_msg_template']); - $spool->setAppMsgStatus($db_spool['app_msg_status']); - - if(!$spool->validate()) { - $errors = $spool->getValidationFailures(); - $this->status = 'error'; - - foreach($errors as $key => $value) { - echo "Validation error - " . $value->getMessage($key) . "\n"; - } - } - else { - //echo "Saving - validation ok\n"; - $this->status = 'success'; - $spool->save(); - } - return $sUID; - - } - - - - -} // end of class - - - -?> diff --git a/workflow/engine/classes/class.javaBridgePM.php b/workflow/engine/classes/class.javaBridgePM.php index bbfdf2a47..c0164f102 100644 --- a/workflow/engine/classes/class.javaBridgePM.php +++ b/workflow/engine/classes/class.javaBridgePM.php @@ -1,10 +1,10 @@ * @copyright 2008 COLOSA */ diff --git a/workflow/engine/classes/class.languages.php b/workflow/engine/classes/class.languages.php index 6998383d4..9c4a1aa75 100644 --- a/workflow/engine/classes/class.languages.php +++ b/workflow/engine/classes/class.languages.php @@ -1,9 +1,10 @@ - * @copyright Copyright (c) 2007, Ian K Armstrong - * @license http://www.opensource.org/licenses/gpl-3.0.html GNU Public License - * @link http://www.openmail.cc - * - * @category web_mail - * @subpackage mail - * @filesource - * @version - * - * @file class.package.php - * - */ - -class package -{ - private $headers; - private $message; - private $charset; - private $emailboundary; - private $debug; - private $fileData; - private $max_line_length; - private $with_html; - - /** - * This function is the constructor of the package class - * @param array $fileData - * @return void - */ - function __construct($fileData=array()) - { - $this->fileData = array(); - $this->debug = 1; - $this->emailboundary = 'Part-'.md5(uniqid(microtime())); - $this->charset = 'UTF-8'; //'ISO-8859-1' - $this->headers = ''; - $this->message = ''; - $this->with_html = false; - $this->max_line_length = '70'; - - if(count($fileData)>0) { - $this->fileData = $fileData; - $this->addHeaders(); - $this->compileBody(); - } - - } - - /** - * This function returns the header - * @param - * @return string - */ - public function returnHeader() - { - return $this->headers; - - } - - /** - * This function returns the body - * @param - * @return string - */ - public function returnBody() - { - return $this->message; - - } - - /** - * This function returns an error - * @param string $error - * @return string - */ - private function returnErrors($error) - { - if($this->debug>0) return $error; - - } - - /** - * This function puts a headers (to, cc, etc) - * @param - * @return void - */ - private function addHeaders() - { - $header = ''; - - (strlen($this->fileData['from_name'])>0) - ? $header .= 'From: '."{$this->fileData['from_name']}".' <'."{$this->fileData['from_email']}>"."\r\n" - : $header .= 'From: '."<{$this->fileData['from_email']}>"."\r\n"; - - // to - if(strlen($this->fileData['to'])>0) - { - $to = "{$this->fileData['to']}"; - $header .= 'To: '.$to."\r\n"; - - } - - // cc - if(strlen($this->fileData['cc'])>0) - { - $cc = "{$this->fileData['cc']}"; - $header .= 'Cc: '.$cc."\r\n"; - - } - - $header .= 'X-Sender: '."{$this->fileData['from_email']}"."\r\n"; - $header .= 'Return-Path: <'."{$this->fileData['from_email']}".'>'."\r\n"; - $header .= 'Errors-To: '."{$this->fileData['from_email']}"."\r\n"; - $header .= 'Reply-To: '."{$this->fileData['from_email']}"."\r\n"; - - if(!empty($this->fileData['reference'])) - { - $header .= 'In-Reply-To: <'."{$this->fileData['reference']}".'>'."\r\n"; - $header .= 'References: <'."{$this->fileData['reference']}".'>'."\r\n"; - - } - - $header .= 'Message-Id: <'.md5(uniqid(rand())).':' - .str_replace(' ','_', "{$this->fileData['from_name']}") - .'@'."{$this->fileData['domain']}".'>'."\r\n"; - - $header .= 'X-Mailer: ProcessMaker '."\r\n"; - $header .= 'X-Priority: 3'."\r\n"; - $header .= 'Date: '."{$this->fileData['date']}"."\r\n"; - $header .= 'Subject: '."{$this->fileData['subject']}"."\r\n"; - $header .= 'MIME-Version: 1.0'."\r\n"; - - (count($this->fileData['attachments'])>0) - ? $header .= 'Content-Type: multipart/mixed; '."\r\n\t".'boundary="'.$this->emailboundary.'"'."\r\n" - : $header .= 'Content-Type: multipart/alternative; '."\r\n\t".'boundary="'.$this->emailboundary.'"'."\r\n"; - - $header .= 'This is a multi-part message in MIME format'."\r\n"; - - $this->headers = $header; - - } - - /** - * This function adds a file (to, cc, etc) - * @param string $data - * @return string - */ - private function addAttachment($data='') - { - $attach_this = ''; - - if(trim($data)!='') - { - list($file,$name,$type) = explode('|',$data); - - if(is_readable($file)) - { - // attachment header - $attachment_header = '--'.$this->emailboundary."\r\n"; - $attachment_header .= 'Content-type: '.$type.'; name="'.$name.'"'."\r\n"; - $attachment_header .= 'Content-transfer-encoding: base64'."\r\n"; - $attachment_header .= 'Content-disposition: attachment; filename="'.$name.'"'."\r\n\r\n"; - - // read, encode, chunk split - $file_content = file_get_contents($file); - $file_content = base64_encode($file_content); - $file_content = chunk_split($file_content,70); - - // add content and header - $attach_this = $attachment_header.$file_content."\r\n"; - - } else { $this->returnErrors($file.' not readable in addAttachment');} - - } else { $this->returnErrors('missing data in addAttachment');} - - return $attach_this; - - } - - /** - * This function fixs body - * @param string $data - * @return string - */ - private function fixbody() - { - $lines = array(); - $b = ''; - $body = "{$this->fileData['body']}"; - $body = str_replace("\r", "\n", str_replace("\r\n", "\n", $body)); - $lines = explode("\n", $body); - - foreach($lines as $line) - { - // wrap lines - $line = wordwrap($line, $this->max_line_length, "\r\n"); - - // leading dot problem - if(substr($line, 0,1) == '.') $line = '.' . $line; - - $b .= $line."\r\n"; - } - return $b; - - } - - /** - * This function compiles message - * @param - * @return void - */ - private function compileBody() - { - $comp = ''; - $body = $this->fixbody(); - - // text - $comp .= '--'.$this->emailboundary."\r\n"; - $comp .= 'Content-Type: text/plain; charset='.$this->charset."\r\n"; - $comp .= 'Content-Transfer-Encoding: 8bit'."\r\n\r\n"; - $comp .= "$body"."\r\n\r\n"; - - // html - if($this->with_html) - { - $temp = file_get_contents('template.html'); - $temp = str_replace("\n", "", str_replace("\r", "", $temp)); - - $comp .= '--'.$this->emailboundary."\r\n"; - $comp .= 'Content-Type: text/html; charset='.$this->charset."\r\n"; - $comp .= 'Content-Transfer-Encoding: 8bit'."\r\n\r\n"; - - $body = str_replace('[>content<]',"$body",$temp); - $comp .= "$body"."\r\n\r\n"; - - } - - // attachments - /* - if(count($this->fileData['attachments'])>0) - { - foreach($this->fileData['attachments'] as $data) - { - $comp .= $this->addAttachment($data); - - } - - }*/ - - $comp .= '--'.$this->emailboundary.'--'."\r\n"; - - $this->message = $comp; - - } - -} // end of class - - -?> diff --git a/workflow/engine/classes/class.plugin.php b/workflow/engine/classes/class.plugin.php index 8aeb32082..3529383fd 100644 --- a/workflow/engine/classes/class.plugin.php +++ b/workflow/engine/classes/class.plugin.php @@ -1,9 +1,10 @@ sFilename = $sFilename; } } +/** + * @package workflow.engine.classes + */ + class toolbarDetail { var $sNamespace; var $sToolbarId; var $sFilename; /** * This function is the constructor of the menuDetail class - * @param string $sNamespace - * @param string $sMenuId - * @param string $sFilename + * param string $sNamespace + * param string $sMenuId + * param string $sFilename * @return void */ function __construct( $sNamespace, $sToolbarId, $sFilename ) { @@ -77,6 +83,9 @@ class toolbarDetail { $this->sFilename = $sFilename; } } + /** + * @package workflow.engine.classes + */ class dashboardPage { var $sNamespace; var $sPage; @@ -84,8 +93,8 @@ class toolbarDetail { var $sIcon; /** * This function is the constructor of the dashboardPage class - * @param string $sNamespace - * @param string $sPage + * param string $sNamespace + * param string $sPage * @return void */ function __construct( $sNamespace, $sPage, $sName, $sIcon ) { @@ -96,13 +105,16 @@ class toolbarDetail { } } + /** + * @package workflow.engine.classes + */ class cssFile { var $sNamespace; var $sCssFile; /** * This function is the constructor of the dashboardPage class - * @param string $sNamespace - * @param string $sPage + * param string $sNamespace + * param string $sPage * @return void */ function __construct( $sNamespace, $sCssFile) { @@ -110,7 +122,9 @@ class cssFile { $this->sCssFile = $sCssFile; } } - + /** + * @package workflow.engine.classes + */ class triggerDetail { var $sNamespace; var $sTriggerId; @@ -118,9 +132,9 @@ class triggerDetail { /** * This function is the constructor of the triggerDetail class - * @param string $sNamespace - * @param string $sTriggerId - * @param string $sTriggerName + * param string $sNamespace + * param string $sTriggerId + * param string $sTriggerName * @return void */ function __construct( $sNamespace, $sTriggerId, $sTriggerName ) { @@ -129,7 +143,9 @@ class triggerDetail { $this->sTriggerName = $sTriggerName; } } - +/** + * @package workflow.engine.classes + */ class folderDetail { var $sNamespace; var $sFolderId; @@ -137,9 +153,9 @@ class folderDetail { /** * This function is the constructor of the folderDetail class - * @param string $sNamespace - * @param string $sFolderId - * @param string $sFolderName + * param string $sNamespace + * param string $sFolderId + * param string $sFolderName * @return void */ function __construct( $sNamespace, $sFolderId, $sFolderName ) { @@ -148,7 +164,9 @@ class folderDetail { $this->sFolderName = $sFolderName; } } - +/** + * @package workflow.engine.classes + */ class stepDetail { var $sNamespace; var $sStepId; @@ -158,11 +176,11 @@ class stepDetail { /** * This function is the constructor of the stepDetail class - * @param string $sNamespace - * @param string $sStepId - * @param string $sStepName - * @param string $sStepTitle - * @param string $sSetupStepPage + * param string $sNamespace + * param string $sStepId + * param string $sStepName + * param string $sStepTitle + * param string $sSetupStepPage * @return void */ function __construct( $sNamespace, $sStepId, $sStepName, $sStepTitle, $sSetupStepPage ) { @@ -173,7 +191,9 @@ class stepDetail { $this->sSetupStepPage = $sSetupStepPage; } } - +/** + * @package workflow.engine.classes + */ class redirectDetail { var $sNamespace; var $sRoleCode; @@ -181,9 +201,9 @@ class redirectDetail { /** * This function is the constructor of the redirectDetail class - * @param string $sNamespace - * @param string $sRoleCode - * @param string $sPathMethod + * param string $sNamespace + * param string $sRoleCode + * param string $sPathMethod * @return void */ function __construct( $sNamespace, $sRoleCode, $sPathMethod ) { @@ -192,7 +212,9 @@ class redirectDetail { $this->sPathMethod = $sPathMethod; } } - +/** + * @package workflow.engine.classes + */ class folderData { var $sProcessUid; var $sProcessTitle; @@ -204,13 +226,13 @@ class folderData { /** * This function is the constructor of the folderData class - * @param string $sProcessUid - * @param string $sProcessTitle - * @param string $sApplicationUid - * @param string $sApplicationTitle - * @param string $sUserUid - * @param string $sUserLogin - * @param string $sUserFullName + * param string $sProcessUid + * param string $sProcessTitle + * param string $sApplicationUid + * param string $sApplicationTitle + * param string $sUserUid + * param string $sUserLogin + * param string $sUserFullName * @return void */ function __construct( $sProcessUid, $sProcessTitle, $sApplicationUid, $sApplicationTitle, $sUserUid, $sUserLogin = '', $sUserFullName ='') { @@ -223,7 +245,9 @@ class folderData { $this->sUserFullName = $sUserFullName; } } - +/** + * @package workflow.engine.classes + */ class uploadDocumentData { var $sApplicationUid; var $sUserUid; @@ -235,12 +259,12 @@ class uploadDocumentData { /** * This function is the constructor of the uploadDocumentData class - * @param string $sApplicationUid - * @param string $sUserUid - * @param string $sFilename - * @param string $sFileTitle - * @param string $sDocumentUid - * @param integer $iVersion + * param string $sApplicationUid + * param string $sUserUid + * param string $sFilename + * param string $sFileTitle + * param string $sDocumentUid + * param integer $iVersion * @return void */ function __construct( $sApplicationUid, $sUserUid, $sFilename, $sFileTitle, $sDocumentUid, $iVersion = 1 ) { @@ -253,6 +277,9 @@ class uploadDocumentData { $this->iVersion = $iVersion; } } +/** + * @package workflow.engine.classes + */ class loginInfo { var $lName; var $lPassword; @@ -260,9 +287,9 @@ class loginInfo { /** * This function is the constructor of the loginInfo class - * @param string $lName - * @param string $lPassword - * @param string $lSession + * param string $lName + * param string $lPassword + * param string $lSession * @return void */ function __construct( $lName, $lPassword, $lSession ) { @@ -271,7 +298,9 @@ class loginInfo { $this->lSession = $lSession; } } - +/** + * @package workflow.engine.classes + */ class caseSchedulerPlugin { var $sNamespace; var $sActionId; @@ -282,12 +311,12 @@ class caseSchedulerPlugin { /** * This function is the constructor of the caseSchedulerPlugin class - * @param string $sNamespace - * @param string $sActionId - * @param string $sActionForm - * @param string $sActionSave - * @param string $sActionExecute - * $param string $sActionGetFields + * param string $sNamespace + * param string $sActionId + * param string $sActionForm + * param string $sActionSave + * param string $sActionExecute + * param string $sActionGetFields * @return void */ function __construct( $sNamespace, $sActionId, $sActionForm, $sActionSave, $sActionExecute, $sActionGetFields ) { @@ -299,6 +328,9 @@ class caseSchedulerPlugin { $this->sActionGetFields = $sActionGetFields; } } +/** + * @package workflow.engine.classes + */ class taskExtendedProperty { var $sNamespace; var $sPage; @@ -306,10 +338,10 @@ class taskExtendedProperty { var $sIcon; /** * This function is the constructor of the taskExtendedProperty class - * @param string $sNamespace - * @param string $sPage - * @param string $sName - * @param string $sIcon + * param string $sNamespace + * param string $sPage + * param string $sName + * param string $sIcon * @return void */ function __construct( $sNamespace, $sPage, $sName, $sIcon ) { @@ -319,7 +351,9 @@ class taskExtendedProperty { $this->sIcon = $sIcon; } } - +/** + * @package workflow.engine.classes + */ class PMPlugin { var $sNamespace; var $sClassName; @@ -357,7 +391,7 @@ class PMPlugin { /** * With this function we can register the dashboard - * @param + * param * @return void */ function registerDashboard( ) { @@ -368,7 +402,7 @@ class PMPlugin { /** * With this function we can register the report - * @param + * param * @return void */ function registerReport( ) { @@ -378,7 +412,7 @@ class PMPlugin { /** * With this function we can register the pm's function - * @param + * param * @return void */ function registerPmFunction( ) { @@ -388,7 +422,7 @@ class PMPlugin { /** * With this function we can set the company's logo - * @param + * param * @return void */ function setCompanyLogo( $filename ) { @@ -398,7 +432,7 @@ class PMPlugin { /** * With this function we can register the pm's function - * @param + * param * @return void */ function redirectLogin( $role, $pathMethod ) { @@ -418,7 +452,7 @@ class PMPlugin { /** * With this function we can register the steps - * @param + * param * @return void */ function registerStep($sStepId, $sStepName, $sStepTitle, $sSetupStepPage = '') { @@ -531,7 +565,7 @@ class PMPlugin { } /** * With this function we can register a Case Scheduler Plugin/Addon - * @param + * param * @return void */ function registerCaseSchedulerPlugin($sActionId, $sActionForm, $sActionSave, $sActionExecute, $sActionGetFields) { diff --git a/workflow/engine/classes/class.pluginRegistry.php b/workflow/engine/classes/class.pluginRegistry.php index a3e976b44..bfbe45e17 100644 --- a/workflow/engine/classes/class.pluginRegistry.php +++ b/workflow/engine/classes/class.pluginRegistry.php @@ -1,9 +1,10 @@ - * @package workflow.gulliver.system + * @author David S. Callizaya S. * * @access public - * @dependencies TemplatePower Form XmlForm + * @package workflow.gulliver.system + * dependencies TemplatePower Form XmlForm */ class propelTable @@ -197,7 +198,7 @@ class propelTable * Function setupFromXmlform * * @author David S. Callizaya S. - * @editedby Hugo Loza + * editedby Hugo Loza * @access public * @parameter string xmlForm * @return string diff --git a/workflow/engine/classes/class.replacementLogo.php b/workflow/engine/classes/class.replacementLogo.php index fd6cccba1..ce3bfeec1 100755 --- a/workflow/engine/classes/class.replacementLogo.php +++ b/workflow/engine/classes/class.replacementLogo.php @@ -1,9 +1,10 @@ pluginsA; @@ -317,9 +317,9 @@ class serverConf { return $sMySQLVersion; } - /** + /** * Will reset all the logins' count - * @param + * param * @return void */ function resetLogins() { diff --git a/workflow/engine/classes/class.sessions.php b/workflow/engine/classes/class.sessions.php index c21577489..23ad5d576 100644 --- a/workflow/engine/classes/class.sessions.php +++ b/workflow/engine/classes/class.sessions.php @@ -1,9 +1,10 @@ - * @copyright Copyright (c) 2007, Ian K Armstrong - * @license http://www.opensource.org/licenses/gpl-3.0.html GNU Public License - * @link http://www.openmail.cc - * - * @category web_mail - * @subpackage mail - * @filesource - * @version - * - * @file class.smtp.php - * - */ - - //------------------------------------------------------------- - // smtp authentication - //------------------------------------------------------------- - // setSmtpAuthentication($sAuth) - // setUsername($sName) - // setPassword($sPass) - //------------------------------------------------------------- - -class smtp -{ - private $mail_server; - private $port; - private $return_path; - private $envelope_to; - private $status; - private $headers; - private $body; - private $log; - private $with_auth; - private $username; - private $password; - - /** - * Function __construct - * Constructor of the class - * @return void - */ - function __construct() - { - $this->status = false; - $this->with_auth = false; // change to 'true' to use smtp authentication - $this->username = ''; // needed for smtp authentication - $this->password = ''; // needed for smtp authentication - $this->mail_server = @gethostbyaddr('127.0.0.1'); - $this->port = 25; - $this->return_path = ''; - $this->envelope_to = array(); - $this->headers = ''; - $this->body = ''; - $this->log = array(); - } - - /** - * Function setServer - * This sets the server used for sending mail - * @param string $sServer - * @return void - */ - public function setServer($sServer) - { - if(($sAux = @gethostbyaddr($sServer))) - $sServer = $sAux; - $this->mail_server = $sServer; - } - - /** - * Function setPort - * This sets the port used for sending mail - * @param string $iPort - * @return void - */ - public function setPort($iPort) - { - $this->port = ($iPort != '' ? (int)$iPort : 25); - } - - /** - * Function setReturnPath - * This function sets the return path - * @param string $sReturnPath - * @return void - */ - public function setReturnPath($sReturnPath) - { - $this->return_path = $sReturnPath; - } - - /** - * Function setHeaders - * This sets the headers of the mail to be sent - * @param string $sHeaders - * @return void - */ - public function setHeaders($sHeaders) - { - $this->headers = $sHeaders; - } - - /** - * Function setBody - * This sets the mail body - * @param string $sBody - * @return void - */ - public function setBody($sBody) - { - $this->body = $sBody; - } - - /** - * Function setSmtpAuthentication - * This function sets the Smtp Authentication - * @param string $sAuth - * @return void - */ - public function setSmtpAuthentication($sAuth) - { - $this->with_auth = $sAuth; - } - - /** - * Function setUsername - * This function sets the user name - * @param string $sName - * @return void - */ - public function setUsername($sName) - { - $this->username = $sName; - } - - /** - * Function setPassword - * This function sets the password - * @param string $sPass - * @return void - */ - public function setPassword($sPass) - { - $this->password = $sPass; - } - - /** - * Function returnErrors - * This Function returns errors - * @return void - */ - public function returnErrors() - { - return $this->log; - } - - /** - * Function returnStatus - * @return void - */ - public function returnStatus() - { - return $this->status; - } - - /** - * Function setEnvelopeTo - * @param string $env_to - * @return void - */ - public function setEnvelopeTo($env_to) - { - if(count($env_to)>0){ - foreach($env_to as $val){ - (false !== ($p = strpos($val,'<'))) - ? $this->envelope_to[] = trim(substr($val,$p)) - : $this->envelope_to[] = trim($val); - } - } - } - - /** - * Function sendMessage - * This function is responsible for sending the message - * @return boolean - */ - public function sendMessage() - { - // connect - $errno = $errstr = ''; - $cp = @fsockopen("$this->mail_server", $this->port, $errno, $errstr, 1); - if(!$cp){ - $this->log[] = 'Failed to make a connection'; - return false; - } - $res = fgets($cp,256); - if(substr($res,0,3) != '220'){ - $this->log[] = $res.' Failed to connect'; - fclose($cp); - return false; - } - if(false !== $this->with_auth){ - // say EHLO - works with SMTP and ESMTP servers - fputs($cp, 'EHLO '."$this->mail_server\r\n"); - $res = fgets($cp,256); - if(substr($res,0,3) != '250'){ - $this->log[] = $res.' Failed to say EHLO'; - fclose($cp); - return false; - } - // Request Authentication - fputs($cp, 'AUTH LOGIN'."\r\n"); - $res = fgets($cp,256); - if(substr($res,0,3) != '334'){ - $this->log[] = $res.' Auth Login Failed'; - fclose($cp); - return false; - } - // Send Username - fputs($cp, base64_encode($this->username)."\r\n"); - $res = fgets($cp,256); - if(substr($res,0,3) != '334'){ - $this->log[] = $res.' Username failed'; - fclose($cp); - return false; - } - // Send Password - fputs($cp, base64_encode($this->password)."\r\n"); - $res = fgets($cp,256); - if(substr($res,0,3) != '235'){ - $this->log[] = $res.' Password failed'; - fclose($cp); - return false; - } - } - else{// without smtp authentication - // say HELO - fputs($cp, 'HELO '."$this->mail_server\r\n"); - $res = fgets($cp,256); - if(substr($res,0,3) != '250'){ - $this->log[] = $res.' Failed to say HELO'; - fclose($cp); - return false; - } - } - // mail from - fputs($cp, 'MAIL FROM: '."$this->return_path\r\n"); - $res = fgets($cp,256); - if(substr($res,0,3) != '250'){ - $this->log[] = $res.' MAIL FROM failed'; - fclose($cp); - return false; - } - // mail to - foreach($this->envelope_to as $val){ - fputs($cp, 'RCPT TO: '."$val\r\n"); - $res = fgets($cp,256); - if(substr($res,0,3) != '250'){ - $this->log[] = $res.' RCPT TO failed'; - fclose($cp); - return false; - } - } - // data - fputs($cp, 'DATA'."\r\n"); - $res = fgets($cp,256); - if(substr($res,0,3) != '354'){ - $this->log[] = $res.' DATA failed'; - fclose($cp); - return false; - } - // send headers - fputs($cp, "$this->headers\r\n"); - // send body - fputs($cp, "$this->body\r\n"); - // end of message - fputs($cp, "\r\n.\r\n"); - $res = fgets($cp,256); - if(substr($res,0,3) != '250'){ - $this->log[] = $res. ' Message failed'; - fclose($cp); - return false; - } - // quit - fputs($cp, 'QUIT'."\r\n"); - $res = fgets($cp,256); - if(substr($res,0,3) != '221'){ - $this->log[] = $res.' QUIT failed'; - fclose($cp); - return false; - } - fclose($cp); - $this->status = true; - } -} // end of class -?> \ No newline at end of file diff --git a/workflow/engine/classes/class.spool.php b/workflow/engine/classes/class.spool.php index 1bd543d96..8fafa19a0 100755 --- a/workflow/engine/classes/class.spool.php +++ b/workflow/engine/classes/class.spool.php @@ -1,9 +1,10 @@ - * @date May 12th, 2010 + * author Erik A.O. + * date May 12th, 2010 + * @package workflow.engine.classes * */ @@ -47,7 +47,7 @@ class System { /** * List currently installed plugins * - * @param + * param * @return array with the names of the plugins */ public static function getPlugins() { @@ -86,7 +86,7 @@ class System { /** * Get system information * - * @param + * param * @return array with system information */ public static function getSysInfo() { @@ -190,7 +190,7 @@ class System { * * @name verifyFileForUpgrade * - * @param + * param * @return boolean */ function verifyFileForUpgrade() @@ -214,7 +214,7 @@ class System { * * @name getUpgradedFilesList * - * @param + * param * @return void */ function getUpgradedFilesList() @@ -244,7 +244,7 @@ class System { * * @name verifyForBootstrapUpgrade * - * @param + * param * @return boolean */ function verifyForBootstrapUpgrade() @@ -264,7 +264,7 @@ class System { * * @name upgrade * - * @param + * param * @return array */ function upgrade() @@ -571,7 +571,7 @@ class System { * * @name cleanupUpgradeDirectory * - * @param + * param * @return array */ function cleanupUpgradeDirectory() diff --git a/workflow/engine/classes/class.tasks.php b/workflow/engine/classes/class.tasks.php index d2897b28d..43f1c6b25 100644 --- a/workflow/engine/classes/class.tasks.php +++ b/workflow/engine/classes/class.tasks.php @@ -1,6 +1,7 @@ * - * This class Helps registering and implementing Wizard for Triggers - * @package workflow.ProcessMaker + * This class Helps registering and implementing Wizard for Triggers */ G::LoadThirdParty ( 'html2ps_pdf/classes', 'include' ); G::LoadThirdParty ( 'html2ps_pdf/classes/org/active-link/doc', 'PHPClass' ); + /** + * @package workflow.engine.ProcessMaker + */ + class triggerLibrary { private $_aTriggerClasses_ = array (); diff --git a/workflow/engine/classes/class.webdav.php b/workflow/engine/classes/class.webdav.php index f35f01a23..9f6c496ed 100644 --- a/workflow/engine/classes/class.webdav.php +++ b/workflow/engine/classes/class.webdav.php @@ -1,4 +1,8 @@ - * @Last Modify comment(26.06.2008): the session expired verification was removed from here to soap class + * Last Modify: 26.06.2008 10:05:00 + * Last modify by: Erik Amaru Ortiz + * Last Modify comment(26.06.2008): the session expired verification was removed from here to soap class + * @package workflow.engine.classes */ class wsBase diff --git a/workflow/engine/classes/class.wsResponse.php b/workflow/engine/classes/class.wsResponse.php index 55605b969..22e814bf3 100644 --- a/workflow/engine/classes/class.wsResponse.php +++ b/workflow/engine/classes/class.wsResponse.php @@ -1,9 +1,10 @@