Inspecting Files

The File Inspector displays information pertaining to the active file. Toggling to another open file automatically updates the File Inspector display to reflect the information in the new active file.

The File Inspector displays the following active file components:

	Constants
	Class; constants, variables, functions, Super Classes (Extends) and the interfaces implements
	Functions included in the file
	Include files
	Soap Clients

File Inspector

The File Inspector lists components in a hierarchical tree. This tree can be expanded and collapsed to help view information. Inspector icons appear next to each item to indicate if it is a constant, class member, variable, member function or an included file.

Inspector Toolbar Options:

	Grouped - Group by type (class, Function.)
	Sort by Name - List items alphabetically (as opposed to their order in the file)
	Link to Editor - activates and disables the "Goto to source" option (see below)

Basic file inspection operations:

	Go to source - Double-click on the tree node to automatically navigate to the statement in the active file or select the option from the right-click menu.
	Add description - to automatically insert a DocBlock, right click the tree node and select "Add Description" from the right click menu or manually insert a DocBlock using /**.
	Soap Client Support - Double-click on the tree node to automatically navigate to the Soap Client in the active file.
	Goto WSDL file - Use the right click menu to open the linked WSDL file in the editor.
	List all include files - View all include files and open them in the editor using the right click menu.

Note:

DocBlocks are used for adding descriptions into the code. DocBlocks also adds the DocBlock's short description to the Tooltip of items listed in the file inspector.