DNDeployment::getCommitMessage PHP Method

getCommitMessage() public method

Gets the commit message.
public getCommitMessage ( ) : string | null
return string | null
    public function getCommitMessage()
    {
        $commit = $this->getCommit();
        if ($commit) {
            try {
                return Convert::raw2xml($this->Environment()->getCommitMessage($commit));
            } catch (Gitonomy\Git\Exception\ReferenceNotFoundException $e) {
                return null;
            }
        }
        return null;
    }

Usage Example

コード例 #1
0
 /**
  * Return data about a single deployment for use in API response.
  * @param \DNDeployment $deployment
  * @return array
  */
 public function getDeploymentData(\DNDeployment $deployment)
 {
     if (empty(self::$_cache_current_build[$deployment->EnvironmentID])) {
         self::$_cache_current_build[$deployment->EnvironmentID] = $deployment->Environment()->CurrentBuild();
     }
     $environment = $deployment->Environment();
     $project = $environment->Project();
     $deployerData = $this->getStackMemberData($project, $deployment->DeployerID);
     $approverData = $this->getStackMemberData($project, $deployment->ApproverID);
     $started = null;
     $startedNice = null;
     $startedAgo = null;
     // we check first, before we do a expensive ->Nice() and ->Ago()
     if (!$deployment->DeployStarted) {
         $started = $deployment->Created;
         $startedNice = $deployment->obj('Created')->Nice();
         $startedAgo = $deployment->obj('Created')->Ago();
     } else {
         $started = $deployment->DeployStarted;
         $startedNice = $deployment->obj('DeployStarted')->Nice();
         $startedAgo = $deployment->obj('DeployStarted')->Ago();
     }
     $isCurrentBuild = self::$_cache_current_build[$deployment->EnvironmentID] ? $deployment->ID === self::$_cache_current_build[$deployment->EnvironmentID]->ID : false;
     $supportedOptions = $environment->getSupportedOptions();
     $setOptions = $deployment->getDeploymentStrategy() ? $deployment->getDeploymentStrategy()->getOptions() : [];
     $options = [];
     foreach ($supportedOptions as $option) {
         if (!isset($setOptions[$option->getName()])) {
             continue;
         }
         if ($setOptions[$option->getName()] === 'true' || $setOptions[$option->getName()] === true) {
             $options[$option->getName()] = true;
         }
     }
     $tags = [];
     try {
         $tags = $deployment->getTags()->toArray();
     } catch (\Exception $e) {
         // gitonomy exception
     }
     $type = 'full';
     if ($deployment->getDeploymentStrategy()->getActionCode() === 'fast') {
         $type = 'code-only';
     }
     return ['id' => $deployment->ID, 'date_created' => $deployment->Created, 'date_created_nice' => $deployment->obj('Created')->Nice(), 'date_created_ago' => $deployment->obj('Created')->Ago(), 'date_started' => $started, 'date_started_nice' => $startedNice, 'date_started_ago' => $startedAgo, 'date_requested' => $deployment->DeployRequested, 'date_requested_nice' => $deployment->obj('DeployRequested')->Nice(), 'date_requested_ago' => $deployment->obj('DeployRequested')->Ago(), 'date_updated' => $deployment->LastEdited, 'date_updated_nice' => $deployment->obj('LastEdited')->Nice(), 'date_updated_ago' => $deployment->obj('LastEdited')->Ago(), 'title' => $deployment->Title, 'summary' => $deployment->Summary, 'ref_type' => $deployment->RefType, 'ref_name' => $deployment->RefName, 'rejected_reason' => $deployment->RejectedReason ?: '', 'tags' => $tags, 'changes' => $deployment->getDeploymentStrategy()->getChanges(), 'deployment_type' => $type, 'deployment_estimate' => $deployment->getDeploymentStrategy()->getEstimatedTime(), 'sha' => $deployment->SHA, 'short_sha' => substr($deployment->SHA, 0, 7), 'options' => $options, 'commit_subject' => $deployment->getCommitSubjectMessage(), 'commit_message' => $deployment->getCommitMessage(), 'commit_url' => $deployment->getCommitURL(), 'deployer' => $deployerData, 'approver_id' => $deployment->ApproverID ?: '', 'approver' => $approverData, 'state' => $deployment->State, 'is_current_build' => $isCurrentBuild, 'dirty' => false];
 }