User Guide

Zend Studio 8.x

By Zend Technologies, Inc

Zend Studio 8 User Guide

PHPPdf EXAMPLE

Disclaimer

The information in this document is subject to change without notice and does not represent a commitment on the part of Zend Technologies Ltd. No part of this manual may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying, recording, or information storage and retrieval systems, for any purpose other than the purchaser’s personal use, without the written permission of Zend Technologies Ltd.

All trademarks mentioned in this document, belong to their respective owners.
© 1999-2010 Zend Technologies Ltd. All rights reserved.

Zend Studio 8.0 User Guide issued October 2010.

Product Version: 8.x
DN: ZS-UG-281010-08-19

What's New in Zend Studio 8.x

The following new features are available in Zend Studio 8.0:

Ajax Tools
The Internal Web Browser
JavaScript Libraries
Debugging JavaScript
Remote Server Support
VMware Workstation Integration

To see What's New in previous versions of Zend Studio go to the Zend Studio What's New section of the Zend website.

Mac OS X

If you are running your Zend Studio on Mac OS X be aware that some Menu items may be labeled differently. This difference in labeling does not change the procedure. For a list of the alternate labels, see the table below.

Windows	Mac OS X
Help \| About Zend Studio	Zend Studio \| About Zend Studio
Window \| Preferences	Zend Studio \| Preferences

Debbuging

By creating a debug launch configuration in Zend Studio 8.x, you can easily rerun the debug session with the settings specified by clicking the arrow next to the debug button on the toolbar and selecting your launch configuration.

To debug a PHP script using Zend Studio's internal debugger:

Zend Studio 5.x	Zend Studio 8.x
Open the Preferences window by selecting Tools \| Preferences from the main menu. Select the Debug tab. From the Debug Server Configuration area of the Debug tab, select 'internal'' from the Debug Mode category. Click Apply and OK. In the main toolbar, click Go to start the Debugger. -or- from the Menu Bar select Debug \| Go.	Click the arrow next to the debug button on the toolbar and select Debug As \| PHP Script. -Or- In PHP Explorer view, right-click the required file and select Debug As \| PHP Script.

See Locally Debugging a PHP Script for more information.

Open the Preferences window by selecting Tools | Preferences from the main menu.
Select the Debug tab.
From the Debug Server Configuration area of the Debug tab, select 'server' from the Debug Mode category.
Enter the URL of the server on which you want to Debug your files.
Click Apply and OK.
In Zend Studio’s main toolbar, click Run to start the Debugger.

Click the arrow next to the debug button on the toolbar and select Debug Configurations... -or- In PHP Explorer view, right-click and select Debug as | Debug Configurations...
A Debug dialog will open.
Double-click the PHP Script option to create a new debug configuration and enter a name for it.
Select the PHP Web Server option under the Debugger Location category and select your server from the list.
Under PHP File, click Browse and select your file.
Click Apply and Debug.

The next time you want to run this debug session, click the arrow next to the debug button on the toolbar and select your launch configuration.

See Remotely Debugging a PHP Script for more information.

Locally Debugging a PHP Script

This procedure describes how to debug a PHP Script from your workspace using an internal PHP Executable.

To locally debug a PHP Script:

Set breakpoints at the relevant places in the file that you would like to debug by double-clicking the vertical marker bar to the left of the editor.
Save the file.
Click the arrow next to the debug button on the toolbar and select Debug Configurations... -or- select Run | Debug Configurations....A Debug dialog will open.
Double-click the PHP Script option to create a new debug configuration.
Enter a name for the new configuration.
Ensure that the "PHP Executable" option is selected under the Debugger Location category and s elect the required PHP executable.
Select the Zend Debugger from the PHP Debbuger list.
Enter your PHP file in the "PHP File" text field, or click Browse and select your file
Marking the "Breakpoint" checkbox will result in the debugging process pausing at the first line of code.
If necessary, you can add arguments in the PHP Script Arguments tab to simulate command line inputs.
Click Apply and then Debug.
Click Yes if asked whether to open the PHP Debug Perspective.

A number of views will open with relevant debug information.
See the Running and Analyzing Debugger results topic for more information on the outcome of a debugging process.

If the file contains 'include' or 'require' calls to files which are not contained within the project, you must add them to the project's Include Path in order to simulate your production environment.

Creating a PHPDoc

This procedure describes how to create a PHPDoc from your PHP files.

To create a PHPDoc:

Right-click the project from which you would like the PHPDoc to be generated and select Generate PHP Doc -or- go to Project | Generate PHPDoc -or- press Alt+D. The PHPDoc Generation dialog will open.

PHPDoc Generation dialog 1
If you have previously created PHPDoc settings which you would like to apply, mark the checkbox. To create a settings configuration, see point 8.
Ensure that the required project, destination for the PHPDoc and PHP Executable are selected.
Click Next.

PHPDoc Generation dialog 2
Choose the style for your PHPDoc from the 'Converter Type' drop-down list. This will affect the layout and format of your PHPDoc.
Select which basic options you want to apply: (Refer to the phpDoc Manual online at http://www.phpdoc.org for complete descriptions of the options.)
- Parse @acess private and @internal
- Generate highlighted source code
- JavaDoc-compliant description parsing
- PEAR package repository parsing
- Descend into hidden directories
Enter the following fields: (Refer to the phpDoc Manual online at http://www.phpdoc.org for complete descriptions of the options.)
- Default package name
- Default category name
- Custom tags (if required)
- Ignore tags (if required)
- Examples directories path (if required)
To save these settings so that they can be reused when creating new PHPDocs, mark the 'Save the settings of this PHPDoc export in an ini file" checkbox and specify where the ini file should be saved.
Ensure the 'Open generated documentation in browser checkbox is marked to view your PHPDoc once created.
Click Finish.A Running PHPDocumentor dialog will appear.

Your PHPDoc will be automatically created and will be opened in a browser. By default, your phpdoc is created as an index.html file in a folder entitled 'docs' in the root of you Workspace. (e.g. C:\Documents and Settings\bob\Zend\workspaces\DefaultWorkspace\docs\index.html).

Index

Absolute...................................................142

Access Rules ...........................................525

action .......................................................315

Activating Tunneling ................................348

add.......................... 441, 465, 507, 508, 510

Add ..................................................514, 520

add comment ...........................................510

Add CVS Repository..................................40

add JavaScript library ..............507, 508, 514

add JavaScript library folder ....................520

add jQuery JavaScript library ..................507

add JSDoc comment ...............................510

add library ................................160, 508, 512

add library folder ......................................520

Adding an SVN Repository........................48

Ajax. 176, 533, 539, 545, 552, 555, 637, 748

Ajax DOM inspector view ........................539

ajax tool ...................................................637

ajax tools................. 176, 533, 552, 555, 748

Allowed Host............................................336

amf...........................................................200

amf file .................................................... 200

Analyzer .................................................. 124

analyzing JavaScript code .............. 160, 512

Appearance preferences ........................ 675

attribute DOM.......................................... 539

Auto Detection Port......................... 221, 345

Average Own Time ................................... 68

Bookmarks .............................................. 115

Bookmarks view...................................... 115

bottlenecks................................................ 68

Boundry Maker........................................ 104

box model ............................................... 555

box model tab ......................................... 555

bracket .................................................... 109

brackets .................................................. 107

Breakpoint....................................... 141, 629

breakpoints ............................... 55, 133, 605

Breakpoints view............................. 605, 629

browser ........................................... 537, 545

browser console...................................... 545

Browser Console View............................ 545

browser internal ...................... 176, 533, 750

Browser Output view............................... 611

browser preferences ............................... 750

Browser Toolbar...................................... 147

browser web............................................ 750

Build Path................................................ 143

Build Path JavaScript.............................. 478

Called Parameters .................................. 607

Calls Count ............................................... 68

Check Out................................................255

Checking Out Projects.........................40, 48

class.........................................................508

Class Type Hints........................................35

classes.....................................................507

Code Analyzer .........................................124

Code Assist..................................35, 96, 222

Code Assist preferences .........................705

Code Coverage Preferences ...................677

Code Coverage Summary .........................68

code elements .........................................222

Code Folding ...................................112, 228

Code Gallery........... 163, 415, 416, 417, 419

Code Gallery preferences........................679

code JavaScript .......................................510

Code snippet........... 163, 415, 416, 417, 419

code trace ................................619, 620, 739

code tracer perspective ...........................619

code tracing ............ 153, 199, 619, 620, 739

code tracing integrate ..............................153

code tracing Zend Server ........................153

colors .......................................................104

comment ..................................................245

comment add ...........................................510

comment JSDoc ......................................510

Commenting ............................................113

Commenting Code...................................113

Comments ...............................................113

communication port .................................148

Communication Settings..........................148

communication tunnel......................221, 345

compare...................................................249

compare node..........................................539

computed styles.......................................555

Concurrent Versions System.............40, 126

Conditional Breakpoints...........................141

Configure Include Paths ..........................371

Connecting to a Database ...................... 299

Connection Profile........... 297, 439, 441, 446

console browser...................................... 545

Content Assist 160, 507, 508, 510, 512, 514, 520

Content Assist JavaScript....................... 478

Controller ........................................ 128, 269

Cookie............................................. 221, 345

Covered Lines........................................... 68

create .............................................. 448, 572

css........................................................... 555

css properties.......................................... 555

css rules.................................................. 555

css value ................................................. 555

Current Working Directory ...................... 142

custom machine...................................... 572

custom virtual machine ........................... 572

CVS................................... 40, 126, 252, 253

CVS connection ...................... 252, 255, 259

CVS perspective ..................................... 253

CVS Repository ................ 40, 253, 255, 259

CVS Repository Exploring ...................... 253

CVS Repository Exploring Perspective . 126, 255

Windows	Mac OS X
Help \| About Zend Studio	Zend Studio \| About Zend Studio
Window \| Preferences	Zend Studio \| Preferences