Diviner Tech Docs DoorkeeperFeedStoryPublisher

abstract class DoorkeeperFeedStoryPublisher
Phorge Technical Documentation (Doorkeeper)

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()
abstract public function canPublishStory($story, $object)
public function willPublishStory($object) — Hook for publishers to mutate the story object, particularly by loading and attaching additional data.
public function getStoryText($object)
abstract public function isStoryAboutObjectCreation($object)
abstract public function isStoryAboutObjectClosure($object)
abstract public function getOwnerPHID($object)
abstract public function getActiveUserPHIDs($object)
abstract public function getPassiveUserPHIDs($object)
abstract public function getCCUserPHIDs($object)
abstract public function getObjectTitle($object)
abstract public function getObjectURI($object)
abstract public function getObjectDescription($object)
abstract public function isObjectClosed($object)
abstract public function getResponsibilityTitle($object)

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)

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()

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)

This method is not documented.

Parameters

PhabricatorFeedStory

$feed_story

Return

wild

public function getFeedStory()

This method is not documented.

Return

wild

public function setViewer($viewer)

This method is not documented.

Parameters

PhabricatorUser

$viewer

Return

wild

public function getViewer()

This method is not documented.

Return

wild

abstract public function canPublishStory($story, $object)

This method is not documented.

Parameters

PhabricatorFeedStory	$story
	$object

Return

wild

public function willPublishStory($object)

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

Parameters

$object

Return

wild

public function getStoryText($object)

This method is not documented.

Parameters

$object

Return

wild

abstract public function isStoryAboutObjectCreation($object)

This method is not documented.

Parameters

$object

Return

wild

abstract public function isStoryAboutObjectClosure($object)

This method is not documented.

Parameters

$object

Return

wild

abstract public function getOwnerPHID($object)

This method is not documented.

Parameters

$object

Return

wild

abstract public function getActiveUserPHIDs($object)

This method is not documented.

Parameters

$object

Return

wild

abstract public function getPassiveUserPHIDs($object)

This method is not documented.

Parameters

$object

Return

wild

abstract public function getCCUserPHIDs($object)

This method is not documented.

Parameters

$object

Return

wild

abstract public function getObjectTitle($object)

This method is not documented.

Parameters

$object

Return

wild

abstract public function getObjectURI($object)

This method is not documented.

Parameters

$object

Return

wild

abstract public function getObjectDescription($object)

This method is not documented.

Parameters

$object

Return

wild

abstract public function isObjectClosed($object)

This method is not documented.

Parameters

$object

Return

wild

abstract public function getResponsibilityTitle($object)

This method is not documented.

Parameters

$object

Return

wild

Defined: src/applications/doorkeeper/engine/DoorkeeperFeedStoryPublisher.php:6
Extends: Phobject

abstract class DoorkeeperFeedStoryPublisherPhorge Technical Documentation (Doorkeeper)

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)

public function getRenderWithImpliedContext()

public function setFeedStory($feed_story)

public function getFeedStory()

public function setViewer($viewer)

public function getViewer()

abstract public function canPublishStory($story, $object)

public function willPublishStory($object)

public function getStoryText($object)

abstract public function isStoryAboutObjectCreation($object)

abstract public function isStoryAboutObjectClosure($object)

abstract public function getOwnerPHID($object)

abstract public function getActiveUserPHIDs($object)

abstract public function getPassiveUserPHIDs($object)

abstract public function getCCUserPHIDs($object)

abstract public function getObjectTitle($object)

abstract public function getObjectURI($object)

abstract public function getObjectDescription($object)

abstract public function isObjectClosed($object)

abstract public function getResponsibilityTitle($object)

abstract class DoorkeeperFeedStoryPublisher
Phorge Technical Documentation (Doorkeeper)

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