[ Index ]

PHP Cross Reference of Phabricator

title

Body

[close]

/src/applications/base/ -> PhabricatorApplication.php (summary)

(no description)

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

Defines 45 functions

  getApplicationGroups()
  getName()
  getShortDescription()
  isInstalled()
  isPrototype()
  isUnlisted()
  isLaunchable()
  isPinnedByDefault()
  isFirstParty()
  canUninstall()
  getPHID()
  getTypeaheadURI()
  getBaseURI()
  getApplicationURI()
  getIconURI()
  getIconName()
  getApplicationOrder()
  getApplicationGroup()
  getTitleGlyph()
  getHelpURI()
  getOverview()
  getEventListeners()
  getRemarkupRules()
  getRoutes()
  getFactObjectsForAnalysis()
  loadStatus()
  getFlavorText()
  buildMainMenuItems()
  buildMainMenuExtraNodes()
  getQuickCreateItems()
  getByClass()
  getAllApplications()
  getAllInstalledApplications()
  isClassInstalled()
  isClassInstalledForViewer()
  getCapabilities()
  getPolicy()
  hasAutomaticCapability()
  describeAutomaticCapability()
  getCustomCapabilities()
  getCustomPolicySetting()
  getCustomCapabilitySpecification()
  getCapabilityLabel()
  isCapabilityEditable()
  getCapabilityCaption()

Functions
Functions that are not part of a class:

getApplicationGroups()   X-Ref


getName()   X-Ref
TODO: This should be abstract, but is not for historical reasons.


getShortDescription()   X-Ref
No description

isInstalled()   X-Ref
No description

isPrototype()   X-Ref
No description

isUnlisted()   X-Ref
Return `true` if this application should never appear in application lists
in the UI. Primarily intended for unit test applications or other
pseudo-applications.

Few applications should be unlisted. For most applications, use
@{method:isLaunchable} to hide them from main launch views instead.

return: bool True to remove application from UI lists.

isLaunchable()   X-Ref
Return `true` if this application is a normal application with a base
URI and a web interface.

Launchable applications can be pinned to the home page, and show up in the
"Launcher" view of the Applications application. Making an application
unlauncahble prevents pinning and hides it from this view.

Usually, an application should be marked unlaunchable if:

- it is available on every page anyway (like search); or
- it does not have a web interface (like subscriptions); or
- it is still pre-release and being intentionally buried.

To hide applications more completely, use @{method:isUnlisted}.

return: bool True if the application is launchable.

isPinnedByDefault(PhabricatorUser $viewer)   X-Ref
Return `true` if this application should be pinned by default.

Users who have not yet set preferences see a default list of applications.

param: PhabricatorUser User viewing the pinned application list.
return: bool True if this application should be pinned by default.

isFirstParty()   X-Ref
Returns true if an application is first-party (developed by Phacility)
and false otherwise.

return: bool True if this application is developed by Phacility.

canUninstall()   X-Ref
No description

getPHID()   X-Ref
No description

getTypeaheadURI()   X-Ref
No description

getBaseURI()   X-Ref
No description

getApplicationURI($path = '')   X-Ref
No description

getIconURI()   X-Ref
No description

getIconName()   X-Ref
No description

getApplicationOrder()   X-Ref
No description

getApplicationGroup()   X-Ref
No description

getTitleGlyph()   X-Ref
No description

getHelpURI()   X-Ref
No description

getOverview()   X-Ref
No description

getEventListeners()   X-Ref
No description

getRemarkupRules()   X-Ref
No description

getRoutes()   X-Ref
No description

getFactObjectsForAnalysis()   X-Ref
No description

loadStatus(PhabricatorUser $user)   X-Ref
Render status elements (like "3 Waiting Reviews") for application list
views. These provide a way to alert users to new or pending action items
in applications.

param: PhabricatorUser Viewing user.
return: list<PhabricatorApplicationStatusView> Application status elements.

getFlavorText()   X-Ref
You can provide an optional piece of flavor text for the application. This
is currently rendered in application launch views if the application has no
status elements.

return: string|null Flavor text.

buildMainMenuItems(PhabricatorUser $user,PhabricatorController $controller = null)   X-Ref
Build items for the main menu.

param: PhabricatorUser    The viewing user.
param: AphrontController  The current controller. May be null for special
return: list<PHUIListItemView> List of menu items.

buildMainMenuExtraNodes(PhabricatorUser $viewer,PhabricatorController $controller = null)   X-Ref
Build extra items for the main menu. Generally, this is used to render
static dropdowns.

param: PhabricatorUser    The viewing user.
param: AphrontController  The current controller. May be null for special
return: view               List of menu items.

getQuickCreateItems(PhabricatorUser $viewer)   X-Ref
Build items for the "quick create" menu.

param: PhabricatorUser         The viewing user.
return: list<PHUIListItemView>  List of menu items.

getByClass($class_name)   X-Ref
No description

getAllApplications()   X-Ref
No description

getAllInstalledApplications()   X-Ref
No description

isClassInstalled($class)   X-Ref
Determine if an application is installed, by application class name.

To check if an application is installed //and// available to a particular
viewer, user @{method:isClassInstalledForViewer}.

param: string  Application class name.
return: bool   True if the class is installed.

isClassInstalledForViewer($class,PhabricatorUser $viewer)   X-Ref
Determine if an application is installed and available to a viewer, by
application class name.

To check if an application is installed at all, use
@{method:isClassInstalled}.

param: string Application class name.
param: PhabricatorUser Viewing user.
return: bool True if the class is installed for the viewer.

getCapabilities()   X-Ref
No description

getPolicy($capability)   X-Ref
No description

hasAutomaticCapability($capability, PhabricatorUser $viewer)   X-Ref
No description

describeAutomaticCapability($capability)   X-Ref
No description

getCustomCapabilities()   X-Ref
No description

getCustomPolicySetting($capability)   X-Ref
No description

getCustomCapabilitySpecification($capability)   X-Ref
No description

getCapabilityLabel($capability)   X-Ref
No description

isCapabilityEditable($capability)   X-Ref
No description

getCapabilityCaption($capability)   X-Ref
No description



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