blob: 5d95e56233b761e5286428a6bcd380ff63495325 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="generator" content="Adobe RoboHelp 8">
<title>Outline View</title>
<link rel="StyleSheet" href="default.css" type="text/css">
<style type="text/css">
<!--
body { border-left-style:None;
border-right-style:None;
border-bottom-style:None;
background-color:Transparent;
border-top-style:None; }
-->
</style>
<style type="text/css">
<!--
body { border-left-style:None;
border-right-style:None;
border-bottom-style:None;
background-color:Transparent;
border-top-style:None; }
-->
</style>
<script type="text/javascript" language="JavaScript">
//<![CDATA[
function reDo() {
if (innerWidth != origWidth || innerHeight != origHeight)
location.reload();
}
if ((parseInt(navigator.appVersion) == 4) && (navigator.appName == "Netscape")) {
origWidth = innerWidth;
origHeight = innerHeight;
onresize = reDo;
}
onerror = null;
//]]>
</script>
<style type="text/css">
<!--
div.WebHelpPopupMenu { position:absolute;
left:0px;
top:0px;
z-index:4;
visibility:hidden; }
p.WebHelpNavBar { text-align:right; }
-->
</style>
<script type="text/javascript" language="javascript1.2" src="whmsg.js"></script>
<script type="text/javascript" language="javascript" src="whver.js"></script>
<script type="text/javascript" language="javascript1.2" src="whproxy.js"></script>
<script type="text/javascript" language="javascript1.2" src="whutils.js"></script>
<script type="text/javascript" language="javascript1.2" src="whlang.js"></script>
<script type="text/javascript" language="javascript1.2" src="whtopic.js"></script>
<script type="text/javascript" language="javascript1.2">//<![CDATA[
<!--
if (window.gbWhTopic)
{
var strUrl = document.location.href;
var bc = 0;
var n = strUrl.toLowerCase().indexOf("bc-");
if(n != -1)
{
document.location.href = strUrl.substring(0, n);
bc = strUrl.substring(n+3);
}
if (window.setRelStartPage)
{
addTocInfo("Reference\nPHP Perspectives and Views\nPHP Perspective\nOutline View");
addAvenueInfo("Reference","php_explorer_view.htm","type_hierarchy_view.htm");
}
document.write("<p style=\"text-align:left\"> ");
AddMasterBreadcrumbs("ide_help.htm", "", "&gt;", "Home", "pdt_table_of_contents.htm");
document.write("<a href=\"reference.htm\">Reference<\/a> &gt; <a href=\"php_perspectives_and_views.htm\">PHP Perspectives and Views<\/a> &gt; <a href=\"php_perspective_views.htm\">PHP Perspective<\/a> &gt; Outline View<\/p>");
if (window.setRelStartPage)
{
setRelStartPage("ide_help.htm");
autoSync(0);
sendSyncInfo();
sendAveInfoOut();
}
}
else
if (window.gbIE4)
document.location.reload();
//-->
//]]></script>
</head>
<body leftmargin="5" topmargin="5" rightmargin="5" bottommargin="5"><script type="text/javascript" language="javascript1.2">//<![CDATA[
<!--
if (window.writeIntopicBar)
writeIntopicBar(4);
//-->
//]]></script>
<div style="width: 100%; position: relative;" id="header">
<p align="right"><a
title="Documentation Survey" href="http://spreadsheets.google.com/viewform?formkey=dC1scEswTjFia2tDQ3Y5TVJBbkNQcWc6MQ">Documentation
Survey</a>
| <a href="javascript:crlf=&quot;&quot;;h=location.href;t=document.title;e = &quot;&quot; + (window.getSelection ? window.getSelection() : document.getSelection ? document.getSelection() : document.selection.createRange().text); if (e!=null) location=&quot;mailto:documentation@zend.com&quot; + &quot;?Subject= Feedback on PDT for page &quot; + escape(t) + &quot;&amp;Body=&quot; + escape(e).replace(/ /g, &quot;+&quot;) + crlf + &quot; &quot;; void 0"><span
style="background-color: #ffffff;">Submit Documentation</span><span
style="background-color: #ffffff;"> Feedback</span></a><span
style="background-color: #ffffff;"></span><span style="background-color: #ffffff;">
</span><span style="background-color: #ffffff;">|
</span><span
style="background-color: #ffffff;"><a title="View Latest Version and Get PDF Online"
href="http://www.zend.com/en/resources/zend-documentation/"
target="_blank">View Latest
Version and Get PDF Online</a></span></p>
</div>
<h1>Outline View
</h1>
<p>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.</p>
<p>See <a href="php_icons.htm">PHP Icons</a> for a description of the icons
displayed in the Outline view.</p>
<p class="picture"><img src="view_php_outline.png" alt="view_php_outline.png" style="border: none;" width="231" height="372" border="0"></p>
<h4>Features</h4>
<ul type="square">
<li><p>The Outline View is updated interactively according to changes
made in the files.</p></li>
<li><p>Each type of PHP element is represented by a unique icon:</p></li>
</ul>
<table cellspacing="0" width="100%">
<col style="width: 4.659%;">
<col style="width: 95.341%;">
<tr style="vertical-align: top;">
<td style="width: 4.659%; padding-right: 10px; padding-left: 10px;"><p><img src="code_assist_triangle.png" alt="code_assist_triangle.png" style="border: none;" width="15" height="13" border="0"></p></td>
<td style="width: 95.341%; padding-right: 10px; padding-left: 10px;"><p>Reserved
PHP Words</p></td>
</tr>
<tr style="vertical-align: top;">
<td style="width: 4.659%; padding-right: 10px; padding-left: 10px;"><p><img src="code_assist_circle.png" alt="code_assist_circle.png" style="border: none;" width="12" height="12" border="0"></p></td>
<td style="width: 95.341%; padding-right: 10px; padding-left: 10px;"><p>Functions</p></td>
</tr>
<tr style="vertical-align: top;">
<td style="width: 4.659%; padding-right: 10px; padding-left: 10px;"><p><img src="template_icon.png" alt="template_icon.png" style="border: none;" width="17" height="20" border="0"></p></td>
<td style="width: 95.341%; padding-right: 10px; padding-left: 10px;"><p>Templates</p></td>
</tr>
<tr style="vertical-align: top;">
<td style="width: 4.659%; padding-right: 10px; padding-left: 10px;"><p><img src="classes_icon.png" alt="classes_icon.png" style="border: none;" width="19" height="18" border="0"></p></td>
<td style="width: 95.341%; padding-right: 10px; padding-left: 10px;"><p>Classes</p></td>
</tr>
<tr style="vertical-align: top;">
<td style="width: 4.659%; padding-right: 10px; padding-left: 10px;"><p><img src="interfaces_icon.png" alt="interfaces_icon.png" style="border: none;" width="18" height="17" border="0"></p></td>
<td style="width: 95.341%; padding-right: 10px; padding-left: 10px;"><p>Interfaces</p></td>
</tr>
<tr style="vertical-align: top;">
<td style="width: 4.659%; padding-right: 10px; padding-left: 10px;"><p><img src="constants_icon.png" alt="constants_icon.png" style="border: none;" width="16" height="19" border="0"></p></td>
<td style="width: 95.341%; padding-right: 10px; padding-left: 10px;"><p>Constants</p></td>
</tr>
<tr style="vertical-align: top;">
<td style="width: 4.659%; padding-right: 10px; padding-left: 10px;"><p><img src="variables_icon.png" alt="variables_icon.png" style="border: none;" width="16" height="14" border="0"></p></td>
<td style="width: 95.341%; padding-right: 10px; padding-left: 10px;"><p>Variables
(public)</p></td>
</tr>
<tr style="vertical-align: top;">
<td style="width: 4.659%; padding-right: 10px; padding-left: 10px;"><p><img src="namespace_icon.png" alt="namespace_icon.png" style="border: none;" width="17" height="19" border="0"></p></td>
<td style="width: 95.341%; padding-right: 10px; padding-left: 10px;"><p>Namespaces
(PHP 5.3 only)</p></td>
</tr>
<tr style="vertical-align: top;">
<td style="width: 4.659%; padding-right: 10px; padding-left: 10px;"><p><img src="use_statement_icon.png" alt="use_statement_icon.png" style="border: none;" width="15" height="15" border="0"></p></td>
<td style="width: 95.341%; padding-right: 10px; padding-left: 10px;"><p>Use
Statements (PHP 5.3 only)</p></td>
</tr>
</table>
<ul type="square">
<li><p>The Outline view is integrated with the Editor. Therefore, if
you select a PHP element in the view, the Editor will jump to the
element's declaration in the file in which it is declared.</p></li>
</ul>
<p class="Note" style="margin-left: 40px;">Note:</p>
<p class="NoteText" style="margin-left: 40px;">Toggle the link to Editor
on/off using the Link with Editor button <img src="link_with_editor_icon.png" alt="link_with_editor_icon.png" style="border: none;" width="23" height="21" border="0">.</p>
<ul type="square">
<li><p>The View enables you to add PHPdoc blocks and, if available,
Getters and Setters to any PHP element:</p></li>
</ul>
<table style="margin-left: 40px; left: 0px; top: 1056px;" cellspacing="0"
width="874">
<col style="width: 7.093%;">
<col style="width: 92.907%;">
<tr style="vertical-align: top;">
<td style="width: 7.093%; padding-right: 10px; padding-left: 10px;"><p
style="font-size: 6pt;">&#160;</p></td>
<td style="width: 92.907%; padding-right: 10px; padding-left: 10px;"><p
style="font-weight: bold;">&#160;</p></td>
</tr>
<tr style="vertical-align: top;">
<td style="width: 7.093%; padding-right: 10px; padding-left: 10px;"><p
style="font-size: 6pt;"><img src="ref_icon.png" alt="Instructions on how to complete a procedure" title="Instructions on how to complete a procedure" style="border: none;" width="28" height="33" border="0"></p></td>
<td style="width: 92.907%; padding-right: 10px; padding-left: 10px;"><p
style="font-weight: bold;">To generate a PHP DocBlock :</p>
<ol type="1">
<li class="p" style="margin-left: -20px;"><p>Right-click the
element in Outline view.</p></li>
<li class="p" style="margin-left: -20px;"><p>Select Source
| Add PHP Doc .</p></li>
</ol></td>
</tr>
<tr style="vertical-align: top;">
<td colspan="2" style="width: 100%; padding-right: 10px; padding-left: 10px;"><p>The
relevant PHP DocBlock or Getter/Setter will be created above the
code for the selected element in the editor.</p></td>
</tr>
</table>
<p class="Strong">Outline View Toolbar Commands</p>
<table cellspacing="0" width="100%">
<col style="width: 5.755%;">
<col style="width: 18.447%;">
<col style="width: 75.721%;">
<tr style="vertical-align: top;">
<td style="border: Solid 1px #000000; width: 5.755%; padding-right: 10px;
padding-left: 10px;"><p style="font-weight: bold;">Icon</p></td>
<td style="border-top: Solid 1px #000000; border-right: Solid 1px #000000;
border-bottom: Solid 1px #000000; width: 18.447%; padding-right: 10px;
padding-left: 10px;"><p style="font-weight: bold;">Name</p></td>
<td style="border-top: Solid 1px #000000; border-right: Solid 1px #000000;
border-bottom: Solid 1px #000000; width: 75.721%; padding-right: 10px;
padding-left: 10px;"><p style="font-weight: bold;">Description</p></td>
</tr>
<tr style="vertical-align: top;">
<td style="border-left: Solid 1px #000000; border-right: Solid 1px #000000;
border-bottom: Solid 1px #000000; width: 5.755%; padding-right: 10px;
padding-left: 10px;"><p><img src="collapse_all_icon.png" alt="collapse_all_icon.png" style="border: none;" width="21" height="23" border="0"></p></td>
<td style="border-right: Solid 1px #000000; border-bottom: Solid 1px #000000;
width: 18.447%; padding-right: 10px; padding-left: 10px;"><p>Collapse
All</p></td>
<td style="border-right: Solid 1px #000000; border-bottom: Solid 1px #000000;
width: 75.721%; padding-right: 10px; padding-left: 10px;"><p>Collapses
the list of elements</p></td>
</tr>
<tr style="vertical-align: top;">
<td style="border-left: Solid 1px #000000; border-right: Solid 1px #000000;
border-bottom: Solid 1px #000000; width: 5.755%; padding-right: 10px;
padding-left: 10px;"><p><img src="sort_icon.png" alt="sort_icon.png" style="border: none;" width="28" height="23" border="0"></p></td>
<td style="border-right: Solid 1px #000000; border-bottom: Solid 1px #000000;
width: 18.447%; padding-right: 10px; padding-left: 10px;"><p>Sort</p></td>
<td style="border-right: Solid 1px #000000; border-bottom: Solid 1px #000000;
width: 75.721%; padding-right: 10px; padding-left: 10px;"><p>Sorts
the list alphabetically</p></td>
</tr>
<tr style="vertical-align: top;">
<td style="border-left: Solid 1px #000000; border-right: Solid 1px #000000;
border-bottom: Solid 1px #000000; width: 5.755%; padding-right: 10px;
padding-left: 10px;"><p><img src="show_groups_icon.png" alt="show_groups_icon.png" style="border: none;" width="21" height="23" border="0"></p></td>
<td style="border-right: Solid 1px #000000; border-bottom: Solid 1px #000000;
width: 18.447%; padding-right: 10px; padding-left: 10px;"><p>Show
Groups</p></td>
<td style="border-right: Solid 1px #000000; border-bottom: Solid 1px #000000;
width: 75.721%; padding-right: 10px; padding-left: 10px;"><p>If
selected, elements will be displayed in Groups (include files,
constants, classes, functions)</p></td>
</tr>
<tr style="vertical-align: top;">
<td style="border-left: Solid 1px #000000; border-right: Solid 1px #000000;
border-bottom: Solid 1px #000000; width: 5.755%; padding-right: 10px;
padding-left: 10px;"><p><img src="link_with_editor_icon.png" alt="link_with_editor_icon.png" style="border: none;" width="23" height="21" border="0"></p></td>
<td style="border-right: Solid 1px #000000; border-bottom: Solid 1px #000000;
width: 18.447%; padding-right: 10px; padding-left: 10px;"><p>Link
with Editor</p></td>
<td style="border-right: Solid 1px #000000; border-bottom: Solid 1px #000000;
width: 75.721%; padding-right: 10px; padding-left: 10px;"><p>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.</p></td>
</tr>
</table>
<p class="Strong">Outline View Menu Commands</p>
<p>The view's menu can be accessed through the view menu icon <img src="menu_icon.png" alt="menu_icon.png" style="border: none;" width="17" height="16" border="0">.</p>
<p>&#160;</p>
<p><img src="outline_view_menu.png" alt="outline_view_menu.png" style="border: none;" width="142" height="80" border="0"></p>
<p>&#160;</p>
<table cellspacing="0" width="100%">
<col style="width: 5.755%;">
<col style="width: 15.112%;">
<col style="width: 79.133%;">
<tr style="vertical-align: top;">
<td style="border: Solid 1px #000000; width: 5.755%; padding-right: 10px;
padding-left: 10px;"><p style="font-weight: bold;">Icon</p></td>
<td style="border-top: Solid 1px #000000; border-right: Solid 1px #000000;
border-bottom: Solid 1px #000000; width: 15.112%; padding-right: 10px;
padding-left: 10px;"><p style="font-weight: bold;">Name</p></td>
<td style="border-top: Solid 1px #000000; border-right: Solid 1px #000000;
border-bottom: Solid 1px #000000; width: 79.133%; padding-right: 10px;
padding-left: 10px;"><p style="font-weight: bold;">Description</p></td>
</tr>
<tr style="vertical-align: top;">
<td style="border-left: Solid 1px #000000; border-right: Solid 1px #000000;
border-bottom: Solid 1px #000000; width: 5.755%; padding-right: 10px;
padding-left: 10px;"><p><img src="link_with_editor_icon.png" alt="link_with_editor_icon.png" style="border: none;" width="23" height="21" border="0"></p></td>
<td style="border-right: Solid 1px #000000; border-bottom: Solid 1px #000000;
width: 15.112%; padding-right: 10px; padding-left: 10px;"><p>Link
with Editor</p></td>
<td style="border-right: Solid 1px #000000; border-bottom: Solid 1px #000000;
width: 79.133%; padding-right: 10px; padding-left: 10px;"><p>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.</p></td>
</tr>
<tr style="vertical-align: top;">
<td style="border-left: Solid 1px #000000; border-right: Solid 1px #000000;
border-bottom: Solid 1px #000000; width: 5.755%; padding-right: 10px;
padding-left: 10px;"><p><img src="show_attributes_icon.png" alt="show_attributes_icon.png" style="border: none;" width="20" height="19" border="0"></p></td>
<td style="border-right: Solid 1px #000000; border-bottom: Solid 1px #000000;
width: 15.112%; padding-right: 10px; padding-left: 10px;"><p>Show
Attributes</p></td>
<td style="border-right: Solid 1px #000000; border-bottom: Solid 1px #000000;
width: 79.133%; padding-right: 10px; padding-left: 10px;"><p>If
selected, element attributes will be displayed. These are defined
by the element's <a href="phpdoc_comments.htm">PHP Doc Block</a>.</p></td>
</tr>
<tr style="vertical-align: top;">
<td style="border-left: Solid 1px #000000; border-right: Solid 1px #000000;
border-bottom: Solid 1px #000000; width: 5.755%; padding-right: 10px;
padding-left: 10px;"><p><img src="outline_view_php_html.png" alt="outline_view_php_html.png" style="border: none;" width="67" height="36" border="0"></p></td>
<td style="border-right: Solid 1px #000000; border-bottom: Solid 1px #000000;
width: 15.112%; padding-right: 10px; padding-left: 10px;"><p>PHP/HTML
selection</p></td>
<td style="border-right: Solid 1px #000000; border-bottom: Solid 1px #000000;
width: 79.133%; padding-right: 10px; padding-left: 10px;"><p>Toggles
the view to display PHP or HTML elements.</p></td>
</tr>
</table>
<p class="Note">Note:</p>
<p class="NoteText">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.</p>
<table cellspacing="0" width="100%">
<col style="width: 7.093%;">
<col style="width: 92.907%;">
<tr style="vertical-align: top;
height: 16px;">
<td style="width: 7.093%; padding-right: 10px;
padding-left: 10px;"><p
style="font-size: 6pt;">&#160;</p></td>
<td style="width: 92.907%;
padding-right: 10px; padding-left: 10px;"><p>&#160;</p></td>
</tr>
<tr style="vertical-align: top;
height: 35px;">
<td style="width: 7.093%; padding-right: 10px;
padding-left: 10px;"><p
style="font-size: 6pt;"><img src="link_icon.png" alt="link_icon.png" style="border: none;" width="32" height="40" border="0"> </p></td>
<td style="width: 92.907%;
padding-right: 10px; padding-left: 10px;"><p
style="font-weight: bold;">Related Links:</p>
<p style="font-weight: normal;"><a href="php_perspective_views.htm"><span
style="font-weight: normal;">PHP Perspective</span>
</a><a href="php_explorer_view.htm"><br>
PHP Explorer view</a></p>
<p style="font-weight: normal;"><a href="php_functions_view.htm">PHP
Functions View</a></p>
<p style="font-weight: normal;"><a href="project_outline_view.htm">PHP
Project Outline View</a></p>
</td>
</tr>
<tr style="vertical-align: top;
height: 19px;">
<td style="width: 7.093%; padding-right: 10px;
padding-left: 10px;"><p
style="font-size: 6pt;">&#160;</p></td>
<td style="width: 92.907%;
padding-right: 10px; padding-left: 10px;"><p>&#160;</p></td>
</tr>
</table>
<div style="width: 100%; position: relative;" id="footer">
<p style="text-decoration: underline; "
align="center">PHP Development
Tools</p>
</div>
<script type="text/javascript" language="javascript1.2">//<![CDATA[
<!--
if (window.writeIntopicBar)
writeIntopicBar(0);
highlightSearch();
//-->
//]]></script>
</body>
</html>