DBObject _ApprovalScheme_ /** * An approval process associated to an object * Derive this class to implement an approval process * - A few abstract functions have to be defined to implement parallel and/or serialize approvals * - Advanced behavior can be implemented by overloading some of the methods (e.g. GetDisplayStatus to change the way it is displayed) * **/ application true autoincrement approval_scheme id finalclass %1$s %2$s obj_class false obj_key false obj_class started false ended true timeout true current_step 0 false ongoing accepted rejected status ongoing false last_error true abort_comment true abort_user_id User true DEL_MANUAL abort_date true label true steps false /** * Called when an object is entering a new state (or just created), and before it gets saved * The approval scheme should be prepared depending on the target object: * find the relevant approvers * perform parallel approval (several approvers in one step) * perform serialized approval (several steps) * tune the timeouts * Available helpers: * AddStep(aApprovers, iTimeoutSec, bApproveOnTimeout) * * @param object oObject The object concerned * @param string sReachingState The state that this object has just reached * @return null if no approval process is needed, an instance of ApprovalScheme otherwise */ true public OQLMenuNode

	public static function GetApprovalScheme($oObject, $sReachingState)
            {
            return null;
            }

/** * Called when the form is being created for a given approver * * @param string sContactClass The approver object class * @param string iContactId The approver object id * @return string The form body in HTML */ false public OQLMenuNode /** * Called when the approval is being completed with success * * @param object oObject The object being under approval process * @return void The object can be modified within this handler, it will be saved later on */ false public OQLMenuNode /** * Called when the approval is being completed with failure * * @param object oObject The object being under approval process * @return void The object can be modified within this handler, it will be saved later on */ false public OQLMenuNode /** * Optionaly override this verb to change the way object details are displayed * Appeared in Version 1.2 of the module * * @return void */ false public OQLMenuNode

IsLoginMandatoryToSeeObjectDetails($oApprover, $oObject))
		{
			require_once(APPROOT.'/application/loginwebpage.class.inc.php');
			LoginWebPage::DoLoginEx(); // Check user rights and prompt if needed
		}
		$oObject->DisplayBareProperties($oPage/*, $bEditMode = false*/);
	}]]>

/** * Optionaly override this verb to change the way the changes are tracked in the object history and in the case log (if the comment are copied there) * Appeared in Version 1.2 of the module * * @return void */ false public OQLMenuNode

Get('friendlyname'), $oApprover->Get('friendlyname'));
			}
			else
			{
				$sRes = Dict::Format('Approval:Rejected-On-behalf-of', $oSubstitute->Get('friendlyname'), $oApprover->Get('friendlyname'));
			}
		}
		else
		{
			if ($bApproved)
			{
				$sRes = Dict::Format('Approval:Approved-By', $oApprover->Get('friendlyname'));
			}
			else
			{
				$sRes = Dict::Format('Approval:Rejected-By', $oApprover->Get('friendlyname'));
			}
		}
		return $sRes;
	}]]>

/** * Optionaly override this verb to change the way working hours will be computed * Appeared in Version 1.1 of the module * * @return string Name of a class implementing the interface iWorkingTimeComputer */ false protected OQLMenuNode /** * Overridable helper to store the replier comment * Actually, it does record something even if the comment is left empty, which is the expected behavior */ false protected OQLMenuNode

Get('obj_class'), $sAttCode))
			{
				if ($oObject = MetaModel::GetObject($this->Get('obj_class'), $this->Get('obj_key'), false, true))
				{
					$value = $oObject->Get($sAttCode);
					$oAttDef = MetaModel::GetAttributeDef($this->Get('obj_class'), $sAttCode);
					if ($oAttDef instanceof AttributeCaseLog)
					{
						$sHtml = utils::TextToHtml($sComment);
						$value->AddLogEntry(''.$sIssuerInfo.'
'.$sHtml );
					}
					else
					{
						// Cumulate into the given (hopefully) text attribute
						$sDate = date(AttributeDateTime::GetFormat());
						$value .= "\n$sDate - ".$sIssuerInfo." :";
						$value .= "\n".$sComment;
					}
					$oObject->Set($sAttCode, $value);
					$oObject->DBUpdate();
				}
			}
		}
	}]]>

/** * Helper to make the URL to approve/reject the ticket */ false public OQLMenuNode

GetContactPassCode($sContactClass, $iContactId);
		if (is_null($sPassCode))
		{
			$sReplyUrl = null;
		}
		else
		{
			$sToken = $this->GetKey().'-'.$this->Get('current_step').'-'.$sContactClass.'-'.$iContactId.'-'.$sPassCode;
			$sReplyUrl = utils::GetAbsoluteUrlModulesRoot().'approval-base/approve.php?token='.$sToken;
			if ($bFromGUI)
			{
				$sReplyUrl .= '&from=object_details';
			}
		}
		return $sReplyUrl;
	}]]>

/** * Helper to determine if a given user is expected to give her answer */ false public OQLMenuNode

GetContactPassCode($sContactClass, $iContactId);
		return (!is_null($sPassCode));
	}	  	]]>

/** * Helper to make the URL to abort the process */ false public OQLMenuNode

GetKey();
		if ($bFromGUI)
		{
			$sAbortUrl .= '&from=object_details';
		}
		return $sAbortUrl;
	}	 	]]>

/** * Build and send the message for a given approver (can be a forwarded approval request) */ false public OQLMenuNode

MakeReplyUrl(get_class($oToPerson), $oToPerson->GetKey(), false);
		$sReplyLink = ''.Dict::S('Approval:Action-ApproveOrReject').'';

		$aContext = array(
			'this->object()' => $oObj,
			'approval_scheme->object()' => $this,
			'approval_step' => $this->Get('current_step') + 1,
			'approver->object()' => $oToPerson,
			'approver_type' => is_null($oSubstituteTo) ? 'main' : 'substitute',
			'approval_url' => $sReplyUrl,
			'approval_link' => $sReplyLink,
			'message_type' => $bReminder ? 'reminder' : 'initial',
		);
		if (!is_null($oSubstituteTo))
		{
			$aContext['on_behalf_of->object()'] = $oSubstituteTo;
		}

		IssueLog::Trace('SendApprovalRequest', 'notifications', [
		    'bReminder' => $bReminder,
		    'is_null($oSubstituteTo)' => is_null($oSubstituteTo),
        'email approver' => $aContext['approver->object()']->Get('email'),
      ]);

		$sClassList = implode("', '", MetaModel::EnumParentClasses(get_class($oObj), ENUM_PARENT_CLASSES_ALL));
		$oSet = new DBObjectSet(DBObjectSearch::FromOQL("SELECT TriggerOnApprovalRequest AS t WHERE t.target_class IN ('$sClassList')"));
		while ($oTrigger = $oSet->Fetch())
		{
			$oTrigger->DoActivate($aContext);
		}
	}]]>

/** * Overridable to determine the approver email address in a different way */ false public OQLMenuNode

 $oAttDef)
		{
			if ($oAttDef instanceof AttributeEmailAddress)
			{
				$sEmailAttCode = $sAttCode;
			}
		}
		$sAddress = $oApprover->Get($sEmailAttCode);
		return $sAddress;
	}]]>

/** * Overridable to disable the link to view more information on the object */ false public OQLMenuNode

 $oApprover->GetKey()));
		if ($oSet->Count() > 0)
		{
			// The approver has a login: show the link!
			return true;
		}
		else
		{
			return false;
		}
	}]]>

/** * Overridable to force the login when viewing object details */ false public OQLMenuNode

	public function IsLoginMandatoryToSeeObjectDetails($oApprover, $oObject)
            {
            return false;
            }

/** * Overridable to implement the abort feature * @param oUser (implicitely the current user if null) * Return true if the given user is allowed to abort */ false public OQLMenuNode

	public function IsAllowedToAbort($oUser = null)
            {
            return false;
            }

DBObject TriggerOnObject /** * Sent when an object enters the waiting for approval state * * @see ApprovalScheme::SendApprovalRequest * * @since 3.2.0 This class is now defined using XML instead of PHP */ core/cmdb,application,grant_by_profile false autoincrement priv_trigger_onapprovalrequest id both approvers substitutes target_approval_request both false

10 20 30 40

10 20 30 10 20