Diviner Tech Docs DiffusionDoorkeeperCommitFeedStoryPublisher

final class DiffusionDoorkeeperCommitFeedStoryPublisher
Phorge Technical Documentation (Diffusion)

This class is not documented.

Tasks

Configuration

public function setRenderWithImpliedContext($render_with_implied_context) — Render story text using contextual language to identify the object the story is about, instead of the full object name. For example, without contextual language a story might render like this:
public function getRenderWithImpliedContext() — Determine if rendering should assume object context. For discussion, see @{method:setRenderWithImpliedContext}.

Other Methods

public function __get($name)
public function __set($name, $value)
public function current()
public function key()
public function next()
public function rewind()
public function valid()
private function throwOnAttemptedIteration()
public function getPhobjectClassConstant($key, $byte_limit) — Read the value of a class constant.
public function setFeedStory($feed_story)
public function getFeedStory()
public function setViewer($viewer)
public function getViewer()
public function canPublishStory($story, $object)
public function willPublishStory($commit)
public function getStoryText($object)
public function isStoryAboutObjectCreation($object)
public function isStoryAboutObjectClosure($object)
public function getOwnerPHID($object)
public function getActiveUserPHIDs($object)
public function getPassiveUserPHIDs($object)
public function getCCUserPHIDs($object)
public function getObjectTitle($object)
public function getObjectURI($object)
public function getObjectDescription($object)
public function isObjectClosed($object)
public function getResponsibilityTitle($object)
private function getAuditRequests()
private function getTitlePrefix($commit)

Methods

public function __get($name)
Inherited

This method is not documented.

Parameters

$name

Return

wild

public function __set($name, $value)
Inherited

This method is not documented.

Parameters

	$name
	$value

Return

wild

public function current()
Inherited

This method is not documented.

Return

wild

public function key()
Inherited

This method is not documented.

Return

wild

public function next()
Inherited

This method is not documented.

Return

wild

public function rewind()
Inherited

This method is not documented.

Return

wild

public function valid()
Inherited

This method is not documented.

Return

wild

private function throwOnAttemptedIteration()
Inherited

This method is not documented.

Return

wild

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

Phobject

Read the value of a class constant.

This is the same as just typing self::CONSTANTNAME, but throws a more useful message if the constant is not defined and allows the constant to be limited to a maximum length.

Parameters

string	$key	Name of the constant.
int\|null	$byte_limit	Maximum number of bytes permitted in the value.

Return

string

Value of the constant.

public function setRenderWithImpliedContext($render_with_implied_context)
Inherited

DoorkeeperFeedStoryPublisher

Render story text using contextual language to identify the object the story is about, instead of the full object name. For example, without contextual language a story might render like this:

alincoln created D123: Chop Wood for Log Cabin v2.0

With contextual language, it will render like this instead:

alincoln created this revision.

If the interface where the text will be displayed is specific to an individual object (like Asana tasks that represent one review or commit are), it's generally more natural to use language that assumes context. If the target context may show information about several objects (like JIRA issues which can have several linked revisions), it's generally more useful not to assume context.

Parameters

bool

$render_with_implied_context

True to assume object context when rendering.

Return

this

public function getRenderWithImpliedContext()
Inherited

DoorkeeperFeedStoryPublisher

Determine if rendering should assume object context. For discussion, see setRenderWithImpliedContext().

Return

bool	True if rendering should assume object context is implied.

public function setFeedStory($feed_story)
Inherited

This method is not documented.

Parameters

PhabricatorFeedStory

$feed_story

Return

wild

public function getFeedStory()
Inherited

This method is not documented.

Return

wild

public function setViewer($viewer)
Inherited

This method is not documented.

Parameters

PhabricatorUser

$viewer

Return

wild

public function getViewer()
Inherited

This method is not documented.

Return

wild

public function canPublishStory($story, $object)

This method is not documented.

Parameters

PhabricatorFeedStory	$story
	$object

Return

wild

public function willPublishStory($commit)

DoorkeeperFeedStoryPublisher

Hook for publishers to mutate the story object, particularly by loading and attaching additional data.

DiffusionDoorkeeperCommitFeedStoryPublisher

This method is not documented.

Parameters

$object

Return

wild

public function getStoryText($object)
Inherited

This method is not documented.

Parameters

$object

Return

wild

public function isStoryAboutObjectCreation($object)

This method is not documented.

Parameters

$object

Return

wild

public function isStoryAboutObjectClosure($object)

This method is not documented.

Parameters

$object

Return

wild

public function getOwnerPHID($object)

This method is not documented.

Parameters

$object

Return

wild

public function getActiveUserPHIDs($object)

This method is not documented.

Parameters

$object

Return

wild

public function getPassiveUserPHIDs($object)

This method is not documented.

Parameters

$object

Return

wild

public function getCCUserPHIDs($object)

This method is not documented.

Parameters

$object

Return

wild

public function getObjectTitle($object)

This method is not documented.

Parameters

$object

Return

wild

public function getObjectURI($object)

This method is not documented.

Parameters

$object

Return

wild

public function getObjectDescription($object)

This method is not documented.

Parameters

$object

Return

wild

public function isObjectClosed($object)

This method is not documented.

Parameters

$object

Return

wild

public function getResponsibilityTitle($object)

This method is not documented.

Parameters

$object

Return

wild

private function getAuditRequests()

This method is not documented.

Return

wild

private function getTitlePrefix($commit)

This method is not documented.

Parameters

PhabricatorRepositoryCommit

$commit

Return

wild

Defined: src/applications/diffusion/doorkeeper/DiffusionDoorkeeperCommitFeedStoryPublisher.php:3
Extends: PhobjectDoorkeeperFeedStoryPublisher

final class DiffusionDoorkeeperCommitFeedStoryPublisherPhorge Technical Documentation (Diffusion)

Tasks

Configuration

Other Methods

Methods

public function __get($name)Inherited

public function __set($name, $value)Inherited

public function current()Inherited

public function key()Inherited

public function next()Inherited

public function rewind()Inherited

public function valid()Inherited

private function throwOnAttemptedIteration()Inherited

public function getPhobjectClassConstant($key, $byte_limit)Inherited

public function setRenderWithImpliedContext($render_with_implied_context)Inherited

public function getRenderWithImpliedContext()Inherited

public function setFeedStory($feed_story)Inherited

public function getFeedStory()Inherited

public function setViewer($viewer)Inherited

public function getViewer()Inherited

public function canPublishStory($story, $object)

public function willPublishStory($commit)

public function getStoryText($object)Inherited

public function isStoryAboutObjectCreation($object)

public function isStoryAboutObjectClosure($object)

public function getOwnerPHID($object)

public function getActiveUserPHIDs($object)

public function getPassiveUserPHIDs($object)

public function getCCUserPHIDs($object)

public function getObjectTitle($object)

public function getObjectURI($object)

public function getObjectDescription($object)

public function isObjectClosed($object)

public function getResponsibilityTitle($object)

private function getAuditRequests()

private function getTitlePrefix($commit)

final class DiffusionDoorkeeperCommitFeedStoryPublisher
Phorge Technical Documentation (Diffusion)

public function __get($name)
Inherited

public function __set($name, $value)
Inherited

public function current()
Inherited

public function key()
Inherited

public function next()
Inherited

public function rewind()
Inherited

public function valid()
Inherited

private function throwOnAttemptedIteration()
Inherited

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

public function setRenderWithImpliedContext($render_with_implied_context)
Inherited

public function getRenderWithImpliedContext()
Inherited

public function setFeedStory($feed_story)
Inherited

public function getFeedStory()
Inherited

public function setViewer($viewer)
Inherited

public function getViewer()
Inherited

public function getStoryText($object)
Inherited