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

code_assist_triangle.png

Reserved PHP Words

code_assist_circle.png

Functions

template_icon.png

Templates

classes_icon.png

Classes

interfaces_icon.png

Interfaces

constants_icon.png

Constants

variables_icon.png

Variables (public)

namespace_icon.png

Namespaces (PHP 5.3 only)

use_statement_icon.png

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.

 

 

Instructions on how to complete a procedure

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

Icon

Name

Description

collapse_all_icon.png

Collapse All

Collapses the list of elements

sort_icon.png

Sort

Sorts the list alphabetically

show_groups_icon.png

Show Groups

If selected, elements will be displayed in Groups (include files, constants, classes, functions)

link_with_editor_icon.png

Link with Editor

If 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

 

Icon

Name

Description

link_with_editor_icon.png

Link with Editor

If 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_attributes_icon.png

Show Attributes

If selected, element attributes will be displayed. These are defined by the element's PHP Doc Block.

outline_view_php_html.png

PHP/HTML selection

Toggles 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.

 

 

link_icon.png

Related Links:

PHP Perspective
PHP Explorer view

PHP Functions View

PHP Project Outline View