[ Index ]

PHP Cross Reference of Phabricator

title

Body

[close]

/src/applications/subscriptions/interface/ -> PhabricatorSubscribableInterface.php (summary)

(no description)

File Size: 55 lines (2 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

PhabricatorSubscribableInterface:: (3 methods):
  isAutomaticallySubscribed()
  shouldShowSubscribersProperty()
  shouldAllowSubscription()


Interface: PhabricatorSubscribableInterface  - X-Ref

isAutomaticallySubscribed($phid)   X-Ref
Return true to indicate that the given PHID is automatically subscribed
to the object (for example, they are the author or in some other way
irrevocably a subscriber). This will, e.g., cause the UI to render
"Automatically Subscribed" instead of "Subscribe".

param: PHID  PHID (presumably a user) to test for automatic subscription.
return: bool True if the object/user is automatically subscribed.

shouldShowSubscribersProperty()   X-Ref
Return `true` to indicate that "Subscribers:" should be shown when
rendering property lists for this object, or `false` to omit the property.

return: bool True to show the "Subscribers:" property.

shouldAllowSubscription($phid)   X-Ref
Return `true` to indicate that the "Subscribe" action should be shown and
enabled when rendering action lists for this object, or `false` to omit
the action.

param: phid  Viewing or acting user PHID.
return: bool  True to allow the user to subscribe.



Generated: Sun Nov 30 09:20:46 2014 Cross-referenced by PHPXref 0.7.1