Page MenuHomeClusterLabs Projects
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

Methods

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_contextTrue to assume object context when rendering.
Return
this

public function getRenderWithImpliedContext()

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

Return
boolTrue 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