Page MenuHomePhorge
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

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$keyName of the constant.
int|null$byte_limitMaximum number of bytes permitted in the value.
Return
stringValue 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_contextTrue 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
boolTrue 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