Outline View

The Outline view displays all PHP elements and element types in the current active file. The elements are grouped according to type and are displayed in a tree-like browser.

See PHP Icons for a description of the icons displayed in the Outline view.

view_php_outline.png

Features

Reserved PHP Words
Functions
Templates
Classes
Interfaces
Constants
Variables (public)
Namespaces (PHP 5.3 only)
Use Statements (PHP 5.3 only)

Note:

Toggle the link to Editor on/off using the Link with Editor button link_with_editor_icon.png.

The View enables you to add PHPdoc blocks and, if available, Getters and Setters to any PHP element:

To generate a PHP DocBlock :

  1. Right-click the element in Outline view.
  2. Select Source | Add PHP Doc .

The relevant PHP DocBlock or Getter/Setter will be created above the code for the selected element in the editor.

Outline View Toolbar Commands

IconNameDescription
Collapse AllCollapses the list of elements
SortSorts the list alphabetically
Show GroupsIf selected, elements will be displayed in Groups (include files, constants, classes, functions)
Link with EditorIf selected, elements will immediately be displayed in the editor when single-clicked. If unselected, elements will be displayed in the editor when they are double-clicked.

Outline View Menu Commands

The view's menu can be accessed through the view menu icon menu_icon.png.

outline_view_menu.png

IconNameDescription
Link with EditorIf selected, elements will immediately be displayed in the editor when single-clicked. If unselected, elements will be displayed in the editor when they are double-clicked.
Show AttributesIf selected, element attributes will be displayed. These are defined by the element's PHP Doc Block.
PHP/HTML selectionToggles the view to display PHP or HTML elements.

Note:

The Outline View is displayed by default as part of the PHP Perspective. To manually open the view, go to Window | Show View | Other | PHP Tools | Outline.