JenkinsNotification.php
View Options

	<?php

	namespace Nasqueron\Notifications\Notifications;

	use Nasqueron\Notifications\Analyzers\Jenkins\JenkinsPayloadAnalyzer;

	/**
	* A Jenkins notification.
	*
	* This handles the JSON payloads sent by the following plugin:
	* https://wiki.jenkins-ci.org/display/JENKINS/Notification+Plugin
	*/
	class JenkinsNotification extends Notification {

	/**
	* @var \Nasqueron\Notifications\Analyzers\Jenkins\JenkinsPayloadAnalyzer
	*/
	private $analyzer = null;

	/**
	* Initializes a new instance of the JenkinsNotification class.
	*
	* @param string $project The project this message is for
	* @param mixed $payload The message fired by Jenkins notification plugin
	*/
	public function __construct (string $project, mixed $payload) {
	// Straightforward properties
	$this->service = "Jenkins";
	$this->project = $project;
	$this->rawContent = $payload;

	// Properties from the payload
	$this->group = $this->getGroup();
	$this->text = $this->getText();
	$this->link = $payload->build->full_url;
	$this->type = $this->getType();
	}

	/**
	* Gets the notification type.
	*/
	public function getType () : string {
	$build = $this->rawContent->build;

	$type = strtolower($build->phase);

	if (property_exists($build, 'status')) {
	$type .= '.';
	$type .= $build->status;
	}

	return strtolower($type);
	}

	/**
	* Gets the notification text. Intended to convey a short message
	* (thing Twitter or IRC).
	*/
	public function getText () : string {
	$name = $this->rawContent->name;

	$build = $this->rawContent->build;
	$phase = strtolower($build->phase);

	$text = "Jenkins job $name has been $phase";

	if (property_exists($build, 'status')) {
	$status = strtolower($build->status);
	$text .= ": $status";
	}

	return $text;
	}

	/**
	* Gets analyzer
	*/
	private function getAnalyzer () : JenkinsPayloadAnalyzer {
	if ($this->analyzer === null) {
	$this->analyzer = new JenkinsPayloadAnalyzer(
	$this->project,
	$this->rawContent
	);
	}
	return $this->analyzer;
	}

	/**
	* Gets the notification group.
	*/
	public function getGroup () : string {
	return $this->getAnalyzer()->getGroup();
	}

	/**
	* Indicates if we should handle this payload to trigger a notification.
	*
	* @return bool if false, this payload is to be ignored for notifications
	*/
	public function shouldNotify () : bool {
	return $this->getAnalyzer()->shouldNotify();
	}

	}

File Metadata

Mime Type: text/x-php
Expires: Sat, Oct 11, 22:37 (1 d, 16 h)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 3064207
Default Alt Text: JenkinsNotification.php (2 KB)

JenkinsNotification.php
No OneTemporary
Actions

JenkinsNotification.php
View Options

File Metadata

Event Timeline

JenkinsNotification.phpNo OneTemporaryActions

JenkinsNotification.phpView Options

File Metadata

Event Timeline

JenkinsNotification.php
No OneTemporary
Actions

JenkinsNotification.php
View Options