PhabricatorStory.php
No OneTemporary
Actions

Size

6 KB

Referenced Files

None

Subscribers

None

PhabricatorStory.php
View Options

	<?php

	namespace Nasqueron\Notifications\Phabricator;

	class PhabricatorStory {

	///
	/// Properties
	///

	/**
	* The Phabricator main URL
	*
	* @var string
	*/
	public $instance;

	/**
	* The unique identifier Phabricator assigns to each story
	*
	* @var int
	*/
	public $id;

	/**
	* Type of story (e.g. PhabricatorApplicationTransactionFeedStory)
	*
	* @var string
	*/
	public $type;

	/**
	* @var array
	*/
	public $data;

	/**
	* The person logged to Phabricator and triggering the event
	*
	* @var string
	*/
	public $authorPHID;

	/**
	* A short English textual description of the event
	*
	* @var string
	*/
	public $text;

	/**
	* The unixtime the event occured
	*
	* @var int
	*/
	public $epoch;

	/**
	* The projects attached to this story.
	*
	* When there is no project, [].
	* When not yet queried, null.
	*
	* @var string[]\|null
	*/
	private $projects = null;

	///
	/// Constructors
	///

	/**
	* Initializes a new instance of the Phabricator story class
	*
	* @param string $instance The Phabricator main URL, without trailing slash
	*/
	public function __construct ($instance) {
	$this->instance = $instance;
	}

	/**
	* Initializes a new instance of PhabricatorStory from an array.
	*
	* This is intended to parse the feed.hooks payloads.
	*
	* @param string $phabricatorURL The Phabricator URL (e.g. http://secure.phabricator.com)
	* @param string $payload The data submitted by Phabricator
	* @return PhabricatorStory
	*/
	public static function loadFromArray ($phabricatorURL, $payload) {
	$instance = new self($phabricatorURL);

	foreach ($payload as $key => $value) {
	$property = self::mapPhabricatorFeedKey($key);
	$instance->$property = $value;
	}

	return $instance;
	}

	///
	/// Helper methods
	///

	/**
	* Gets object type (e.g. TASK for PHID-TASK-l34fw5wievp6n6rnvpuk)
	*
	* @return string The object type, as a 4 letters string (e.g. 'TASK')
	*/
	public function getObjectType () {
	return substr($this->data['objectPHID'], 5, 4);
	}

	/**
	* Gets the identifier of the projets related to this task
	*
	* return string[] The list of project PHIDs
	*/
	public function getProjectsPHIDs () {
	$objectPHID = $this->data['objectPHID'];
	$objectType = $this->getObjectType();

	switch ($objectType) {
	case 'DREV':
	return $this->getItemProjectsPHIDs(
	'repository.query',
	$this->getRepositoryPHID('differential.query')
	);

	case 'TASK':
	return $this->getItemProjectsPHIDs(
	'maniphest.query',
	$objectPHID
	);

	case 'CMIT':
	return $this->getItemProjectsPHIDs(
	'repository.query',
	$this->getRepositoryPHID('diffusion.querycommits')
	);

	case 'PSTE':
	return $this->getItemProjectsPHIDsThroughApplicationSearch(
	'paste.search',
	$objectPHID
	);

	default:
	return [];
	}
	}

	/**
	* Gets the PHID of a repository
	*
	* @param string $method The API method to call (e.g. differential.query)
	* @return string The repository PHID or "" if not found
	*/
	public function getRepositoryPHID ($method) {
	$objectPHID = $this->data['objectPHID'];

	$api = PhabricatorAPI::forInstance($this->instance);
	$reply = $api->call(
	$method,
	[ 'phids[0]' => $objectPHID ]
	);

	return PhabricatorAPI::getFirstResult($reply)->repositoryPHID;
	}

	/**
	* Gets the projects for a specific item
	*
	* @param string $method The API method to call (e.g. differential.query)
	* @param string $objectPHID The object PHID to pass as method parameter
	* @return string[] The list of project PHIDs
	*/
	public function getItemProjectsPHIDs ($method, $objectPHID) {
	if (!$objectPHID) {
	return [];
	}

	$api = PhabricatorAPI::forInstance($this->instance);
	$reply = $api->call(
	$method,
	[ 'phids[0]' => $objectPHID ]
	);

	return PhabricatorAPI::getFirstResult($reply)->projectPHIDs;
	}

	/**
	* Gets the project for a specific item, using the new ApplicationSearch.
	*
	* This is a transitional method: when every Phabricator will have been
	* migrated from info (generation 1) or query (generation 2) to search
	* (generation 3), we'll rename it to getItemProjectsPHIDs and overwrite it.
	*/
	protected function getItemProjectsPHIDsThroughApplicationSearch ($method, $objectPHID) {
	if (!$objectPHID) {
	return [];
	}

	$api = PhabricatorAPI::forInstance($this->instance);
	$reply = $api->call(
	$method,
	[
	'constraints[phids][0]' => $objectPHID,
	'attachments[projects]' => 1
	]
	);

	return PhabricatorAPI::getFirstResult($reply)->attachments->projects->projectPHIDs;
	}

	/**
	* Gets the list of the projects associated to the story
	*
	* @return string[] The list of project PHIDs
	*/
	public function getProjects () {
	if ($this->projects === null) {
	$this->attachProjects();
	}
	return $this->projects;
	}

	/**
	* Queries the list of the projects associated to the story
	* and attached it to the projects property.
	*/
	public function attachProjects () {
	$this->projects = [];

	$PHIDs = $this->getProjectsPHIDs();

	if (count($PHIDs) == 0) {
	// No project is attached to the story's object
	return;
	}

	$map = ProjectsMap::load($this->instance);
	foreach ($PHIDs as $PHID) {
	$this->projects[] = $map->getProjectName($PHID);
	}
	}

	///
	/// Static helper methods
	///

	/**
	* Maps a field of the API reply to a property of the PhabricatorStory class
	*
	* @param string $key The field of the API reply
	* @return string The property's name
	*/
	public static function mapPhabricatorFeedKey ($key) {
	if ($key == "storyID") {
	return "id";
	}

	if (starts_with($key, "story")) {
	$key = substr($key, 5);
	$key[0] = strtolower($key[0]); // lowercase
	}

	return $key;
	}

	}

File Metadata

Mime Type: text/x-php
Expires: Thu, Jun 26, 05:12 (1 d, 19 h)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 2720028
Default Alt Text: PhabricatorStory.php (6 KB)

PhabricatorStory.phpNo OneTemporaryActions

PhabricatorStory.phpView Options

File Metadata

Event Timeline

PhabricatorStory.php
No OneTemporary
Actions

PhabricatorStory.php
View Options