Templates Preferences

The Templates Preferences page allows you to create, edit, delete, import and export templates.

Templates are shortcuts used to insert a pre-defined framework of code. The purpose is to save time and reduce the potential for errors in standard, repetitive code units. Once a template is inserted, you can complete the code quickly using manual and automated code entry methods.

To insert a template into your code, enter the first few letters of its name and press Ctrl+Space to activate the Content Assist function and open the content assist list. Select the required template from the list. Templates are marked with a icon. For more on using the content assist function, see Working with Content Assist.

The Templates Preferences page is accessed from Window | Preferences | PHP | Editor | Templates.

Template Preferences Page

To remove a template from the list of available options, unmark its checkbox in the list.

To edit an existing template, select it from the list and click Edit.

Creating a new Template

This procedure describes how to create a new template to be added to the template list.

Instructions on how to complete a procedure

To create a new template:

Click New.
The New Template dialog will open.

New Template Dialog

Enter the template's details:

Name - A short name to identify the template (e.g. 'while' for a template for a while loop).
Context - The code context when the template will be available (PHP, PHPDoc, New PHP, BIRT or Zend Framework). E.g. PHP templates will only be available for use when writing PHP code.
Description - A short description of the template's code.
Pattern - The pattern is the actual code string that will be inserted into the editor whenever this template is selected.
Use the Insert Variable button to select from a list of common variables.

Click OK.

Your template will be added to the list and will be available from the Content Assist in the relevant context.

Exporting and Importing Templates

Zend Studio enables you to export and import Templates, created within XML files in the following format:

<?xml version="1.0" encoding="UTF-8" ?>
<templates>
	<template autoinsert="true" context="php" 
 	deleted="false" description="description" enabled="true" 
 	name="for">
	for($$i = 0; $$i < 1; $$i++){ }
</template>

Instructions on how to complete a procedure

To import a template:

Click Import to open the Import Template's browser.
Select the location to import the relevant XML file containing the template information.
Click Open.

The templates contained in the template.xml file will be imported into the list of Templates.

Instructions on how to complete a procedure

To export a template:

Select the template(s) for export from the Template list.
Click Export to open the Export Template's dialog.
Select the location to save the XML file to.
Click Save.

An XML file will be created with the template information.

Note:

If you selected more than one template to export, all of them will be present in the exported XML file. Each of the original Templates is bounded by: < template > </template>