blob: e75242c9f83cf753426c1c8cc95f7bfd4c3979a7 [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>Content Assist</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("Concepts\nContent Assist");
addAvenueInfo("Concepts","php_support.htm","syntax_highlighting.htm");
}
document.write("<p style=\"text-align:left\"> ");
AddMasterBreadcrumbs("ide_help.htm", "", "&gt;", "Home", "pdt_table_of_contents.htm");
document.write("<a href=\"concepts.htm\">Concepts<\/a> &gt; Content Assist<\/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>Content Assist
</h1>
<p>The Content Assist feature enables the selection and insertion of existing
code elements to complete partially entered code.</p>
<p>A list of possible code elements is displayed in relevant locations
within your files according to the context of your cursor, which you can
then select to be automatically entered into your code.</p>
<p>Each type of code element will have a unique icon. See <a href="php_icons.htm">PHP
Icons</a> for a description of each of the icons.</p>
<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="php_file_icon.png" alt="php_file_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>PHP
File Include Call</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)</p></td>
</tr>
<tr style="vertical-align: top;">
<td style="width: 4.659%; padding-right: 10px;
padding-left: 10px;"><p><img src="package_icon.png" alt="package_icon.png" style="border: none;" width="17" height="17" border="0"></p></td>
<td style="width: 95.341%; padding-right: 10px;
padding-left: 10px;"><p>Packages</p></td>
</tr>
</table>
<p>&#160;</p>
<p>Content Assist works with the following elements: PHP Classes, Functions,
Variables, Constants, Keywords, Interfaces, attributes, values, nested
functions, names, syntax and include calls, as well as all user defined
Classes, Functions and Constants.</p>
<div>
<p class="Note">Note:</p>
<p class="NoteText">Content Assist
will also be available for JavaScript elements if JavaScript support was
enabled for the project. See <a href="enabling_javascript_support_in_php_projects.htm">Enabling
JavaScript Support in PHP Projects</a> for more information. </p>
</div>
<h3><a name="Content_Assist_in_PHPDoc_Block"></a>Content Assist in PHPDoc
Block</h3>
<p>Content Assist provides proposals for the PHPDoc tags:</p>
<ul type="disc">
<li>@return - A type description.</li>
<li>@see - Documents an association to another element.</li>
<li>@throws - Documents an exception thrown by a method. </li>
</ul>
<table cellspacing="0" width="100%">
<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-style: italic; color: #0000ff; 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-style: italic; color: #0000ff; font-size: 6pt;"><img src="txt_file_icon.png" alt="Usage Example" title="Usage Example" style="border: none;" width="28" height="41" border="0"></p></td>
<td style="width: 92.907%; padding-right: 10px; padding-left: 10px;"><p
style="font-weight: bold;">Example:</p>
<p style="font-weight: bold;"><img src="content_assist_in_phpdoc_block.png" alt="Function Parameter Hint" title="Content Assist in PHPDoc Block" style="border: none;" width="342" height="176" border="0"></p></td>
</tr>
<tr style="vertical-align: top;">
<td colspan="2" style="width: 100%; padding-right: 10px; padding-left: 10px;"><p>&#160;</p></td>
</tr>
</table>
<p>&#160;</p>
<h3><a name="Templated_Content_Assist"></a>Templated Content Assist</h3>
<p>Applying Content Assist proposals to the editor creates a templated
expression that provides argument completion according to the declaration
of the method. Templated Content Assist helps you edit your method parameters
quicker. </p>
<table cellspacing="0" width="100%">
<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-style: italic; color: #0000ff; 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-style: italic; color: #0000ff; font-size: 6pt;"><img src="txt_file_icon.png" alt="Usage Example" title="Usage Example" style="border: none;" width="28" height="41" border="0"></p></td>
<td style="width: 92.907%; padding-right: 10px; padding-left: 10px;"><p
style="font-weight: bold;">Example:</p>
<p style="font-weight: bold;"><img src="templated_content_assist.png" alt="Function Parameter Hint" title="Templated Content Assist" style="border: none;" width="342" height="56" border="0"></p></td>
</tr>
<tr style="vertical-align: top;">
<td colspan="2" style="width: 100%; padding-right: 10px; padding-left: 10px;"><p>&#160;</p></td>
</tr>
</table>
<p>&#160;</p>
<h3>Using elements within the same scope</h3>
<p>Elements within the same active project, file or function will be available
for use with Content Assist.</p>
<table cellspacing="0" width="100%">
<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-style: italic; color: #0000ff; font-size: 6pt;"><img src="txt_file_icon.png" alt="Usage Example" title="Usage Example" style="border: none;" width="28" height="41" border="0"></p></td>
<td style="width: 92.907%; padding-right: 10px; padding-left: 10px;"><p
style="font-weight: bold;">Examples:</p>
<ul type="square">
<li><p>Variables within a function will be added to the Content
Assist list when the cursor is within that function.</p></li>
<li><p>Elements defined within one file will be available in
the Content Assist menu in other files within the same project.</p></li>
</ul></td>
</tr>
</table>
<p>&#160;</p>
<h3><a name="Function_Parameter_Hints" id="Function_Parameter_Hints"></a>Function
Parameter Hints</h3>
<p>When entering a function call, a Function Parameter Hint box will be
displayed detailing the types of parameters which should be entered within
the parentheses of the function call.</p>
<table cellspacing="0" width="100%">
<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-style: italic; color: #0000ff; 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-style: italic; color: #0000ff; font-size: 6pt;"><img src="txt_file_icon.png" alt="Usage Example" title="Usage Example" style="border: none;" width="28" height="41" border="0"></p></td>
<td style="width: 92.907%; padding-right: 10px; padding-left: 10px;"><p
style="font-weight: bold;">Example:</p>
<p style="font-weight: bold;"><img src="code_assist_function_parameter.png" alt="Function Parameter Hint" title="Function Parameter Hint" style="border: none;" width="395" height="55" border="0"></p></td>
</tr>
<tr style="vertical-align: top;">
<td colspan="2" style="width: 100%; padding-right: 10px; padding-left: 10px;"><p>&#160;</p></td>
</tr>
</table>
<p>If the Function Parameter Hint box is not displayed automatically, place
your cursor between the parentheses and press <span style="font-weight: bold;"><b>Ctrl+Shift+Space</b></span>.</p>
<h3><a name="Class_Type_Hints" id="Class_Type_Hints"></a>Class Type Hints</h3>
<p>By using a comment you can assign a variable its exact class value.
This assignment will affect the content assist of this variable accordingly.</p>
<table cellspacing="0" width="100%">
<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-style: italic; color: #0000ff; 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-style: italic; color: #0000ff; font-size: 6pt;"><img src="txt_file_icon.png" alt="Usage Example" title="Usage Example" style="border: none;" width="28" height="41" border="0"></p></td>
<td style="width: 92.907%; padding-right: 10px; padding-left: 10px;"><p
style="font-weight: bold;">Example:</p>
<p style="font-weight: bold;"><img src="code_assist_class_type_hint_example.png" alt="code_assist_class_type_hint_example.png" style="border: none;" width="342" height="273" border="0"></p></td>
</tr>
<tr style="vertical-align: top;">
<td colspan="2" style="width: 100%; padding-right: 10px; padding-left: 10px;"><p
class="Note">Note: &#160;&#160;&#160;</p>
<p class="NoteText">Without the comment, content assist will not
be available for the function.</p></td>
</tr>
</table>
<p style="background-color: #7aa3d3;">By using a comment you can assign
a variable its exact class value. This assignment will affect the content
assist of this variable accordingly.</p>
<p style="background-color: #7aa3d3;">To assign a variable its class value
using a comment:</p>
<ol type="1">
<li class="p"><p style="background-color: #7aa3d3;">Create your function
and assign variables to it.</p></li>
<li class="p"><p style="background-color: #7aa3d3;">Enter a comment
in the form:</p></li>
</ol>
<p class="code" style="margin-left: 40px; background-color: #7aa3d3;">/*
@var $&quot;new variable&quot; &quot;Class name&quot; */</p>
<h3><a name="magic_members" id="magic_members"></a>Content Assist for Magic
Members</h3>
<p>PDT supports
Content Assist options for 'magic members'. These are properties and methods
which were declared using the @property or @method tags within <a href="phpdoc_comments.htm">PHP
DocBlock comments</a> rather than in the PHP script itself.</p>
<p>See <a href="http://manual.phpdoc.org/htmlsmartyconverter/php/phpdocumentor/tutorial_tags.property.pkg.html"
target="_blank">http://manual.phpdoc.org/HTMLSmartyConverter/PHP/phpDocumentor/tutorial_tags.property.pkg.html</a>
for more information on magic members.</p>
<table cellspacing="0" width="100%">
<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-style: italic; color: #0000ff; 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-style: italic; color: #0000ff; font-size: 6pt;"><img src="txt_file_icon.png" alt="Usage Example" title="Usage Example" style="border: none;" width="28" height="41" border="0"></p></td>
<td style="width: 92.907%; padding-right: 10px; padding-left: 10px;"><p
style="font-weight: bold;">Example:</p>
<p class="picture" align="left"><img src="magic_members_example.png" alt="magic_members_example.png" style="border: none;" width="480" height="335" border="0"></p></td>
</tr>
<tr style="vertical-align: top;">
<td colspan="2" style="width: 100%; padding-right: 10px; padding-left: 10px;"><p>&#160;</p></td>
</tr>
</table>
<h3><a name="camelcase" id="camelcase"></a>Camel Case Matches</h3>
<p>Content Assist supports camel case matches when entering code, which
displays Content Assist options based on an element's initials.</p>
<table cellspacing="0" width="100%">
<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-style: italic; color: #0000ff; 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-style: italic; color: #0000ff; font-size: 6pt;"><img src="txt_file_icon.png" alt="Usage Example" title="Usage Example" style="border: none;" width="28" height="41" border="0"></p></td>
<td style="width: 92.907%; padding-right: 10px; padding-left: 10px;"><p
style="font-weight: bold;">Example:</p>
<p style="font-weight: bold;"><img src="code_assist_cc_example.png" alt="code_assist_cc_example.png" style="border: none;" width="454" height="157" border="0"></p></td>
</tr>
<tr style="vertical-align: top;">
<td colspan="2" style="width: 100%; padding-right: 10px; padding-left: 10px;"><p
class="Note">Note: &#160;&#160;</p>
<p class="NoteText">Camel Case matching is case sensitive.</p></td>
</tr>
</table>
<h2><a name="Configuring_Code_Assist" id="Configuring_Code_Assist"></a>Configuring
Content Assist</h2>
<p>To configure PHP Content Assist options, go to the <a href="code_assist.htm">Content
Assist Preferences</a> page, accessible from <span style="font-weight: bold;"><b>Window
| Preferences | PHP | Editor | Content Assist</b></span>.</p>
<p>To configure JavaScript Content Assist options, go to the JavaScript
Content Assist Preferences page, accessible from <span style="font-weight: bold;"><b>Window
| Preferences | Web | JavaScript | Editor | Content Assist</b></span>.</p>
<table cellspacing="0" width="100%">
<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>&#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="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><a href="working_with_code_assist.htm">Working
with Content Assist</a></p>
<p><a href="using_code_assist.htm">Using
ContentAssist</a></p>
<p><a href="code_assist.htm">Content
Assist Preferences</a></p>
<p><a href="hover_support.htm">Hover
Support</a></p>
<p><a href="commenting_php_docblocks.htm">Commenting
PHP DocBlocks</a></p>
<p><a href="using_templates.htm">Using Templates</a>
</p></td>
</tr>
<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>&#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>