Working with Content Assist

The purpose of this tutorial is to teach you how to use PDT 's Content Assist function in order to write code quickly, easily, and accurately.

Contents:

Purpose and Usage
Activating Content Assist
Making Content Assist Elements Available Within the Same Scope
Function Parameter Hints
Class Type Hints
Configuring Content Assist

Purpose and Usage

The Content Assist feature enables the selection and insertion of existing code elements to complete partially entered code.

A list of possible code elements appears 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.

Each type of code element will have a unique icon:

	Reserved PHP Words
	Functions
	Templates
	Classes
	Interfaces
	Constants
	Variables (public)

Content Assist works with the following elements: PHP Classes, Functions, Variables, Constants, Keywords, Interfaces, Attributes, Values, Nested Functions, Names and Syntax, as well as all user defined Classes, Functions, and Constants.

Note:

Content Assist works with both PHP and HTML.

Activating Content Assist

By default, the Content Assist options will be automatically displayed once the first few characters of the code have been entered.

The following procedure demonstrates using Content Assist:

Create a new PHP File called 'File1'.

On the line beneath the opening PHP tag, type "def".

pri Code Asisst Box

Double-click the first define function from the Code Completion window -or- select it and press Enter.

"define()" appears on the edit line.

Note:

If the Content Assist window does not open automatically, place your cursor at the required location and press Ctrl+Space.
To enable the Content Assist window to open automatically, go to the Content Assist Preferences page, accessed from Window | Preferences | PHP | Editor | Content Assist and mark the 'Enable auto-activation' checkbox.

Function Parameter Hints

When entering a function call, a Function Parameter Hint box will be displayed detailing the types of parameters that should be entered within the parentheses of the function call.

The following procedure demonstrates using the Function Parameter Hint feature:

Place your cursor between the parentheses of the above function call: "define()"
Press Ctrl+Shift+Space.

A function parameter hint box will be displayed indicating the types of parameters that should be inserted between the parentheses.

Parameter Hint

Making Content Assist Elements Available Within the Same Scope

Added Code - Available within the same function and file

Elements within the same scope (e.g. within the same project, file or function) will be available for use with Content Assist.

Variables belonging to different scopes are not available to each other via Content Assist.

The following procedure demonstrates using Content Assist for inserting elements within the same function and file:

Edit your PHP File ('File1') so that it contains the following code:

<?php

define('continent','africa');

$control = '';

$mail = 'int@eclipse.org';

function media() {

$music = '';

$messenger = '';

$ /*--------- Location_1*/

}

$ /* ---------Location_2*/

Place the cursor at the "$" marked by "Location_1". This is within function "media".
Type the letter "m". The Content Assist window will be displayed with the variables "$messenger" and "$music", which were defined within the function.
Note that the variable $mail (not within the scope of "media()" ) is not available.
Next, place the cursor at the "$" marked by "Location_2".
Type the letter "m". The Content Assist window will be displayed with the variable $mail, which is within the same file.
Note that media's variables - $music and $messenger - are not within the function 'media' and so are not displayed.
Select 'mail' from the Content Assist window to insert it into the script.

Added Code - Available Within the Same Project

Code elements defined in one file are also available for use by other files within the same project.

The following steps demonstrate using Content Assist for inserting elements within the same project:

Within the same project as "File1", create a new PHP file called "File2".
On the line beneath the opening PHP tag, type "def" and press Ctrl+Space to activate Content Assist. Double-click one of the define options.
Between the parentheses, type "cont" and press Ctrl+Space to activate Content Assist. The element 'continent', defined in "File1", will be available.
Double-click 'continent' to enter it into your code.

When the element is highlighted, Content Assist displays the original location of the code element, its value ('africa') and all other information available.

Element Information

Class Type Hints

By using a comment you can assign a variable its exact class value. This assignment will affect the content assist of this variable accordingly.

To see and trial this feature:

Create a new PHP file with the following code:

<?php

function getClass() {

return new Test();

}

class Test {

function printValues($a, $b) {

echo "Values: $a, $b";

}

/* @var $myVar Test */

$myVar = getClass();

$myVar->

Place your cursor after '$myVar->' (on the line above the closing PHP tag) and press Ctrl+Space to activate Content Assist. Content Assist will open with the function defined in 'Test' class (printValues($a, $b)). Double click it to enter it into your code.

Note:

Without the comment, Content Assist will not be available for the function.

Configuring Content Assist

Content Assist options can be configured through the Content Assist Preferences page, accessible from Window | Preferences | PHP | Editor | Content Assist.