Configuring Folders Within a Content Root
In this section:
Within a content root, PhpStorm can distinguish between the folders that contain source code, and the ones to be ignored while searching, parsing, watching etc. To do so, you can mark any folder below a content root as a source folder, or as excluded so it becomes invisible for PhpStorm.
Within a content root, PhpStorm can distinguish between Source folders, Resource Root folders, Test Source code, and Excluded folders.
The folder marked as Source is hte root folder for all the PHP namespaces in the current project.
Files under a folder marked as Resource Root can be referenced relative to this folder. Excluded folders are not involved in indexing and therefore they are ignored while searching, parsing, watching etc.
To invoke this distinction, you can mark any folder below a content root as Source, Resource Root, Test, or Excluded.
You can assign a folder to a category in two different ways:
- Using the Directories page of the Settings / Preferences Dialog.
- Using the context menu of a folder in the Project tool window.
To mark directories under the content root:
- Open the Settings / Preferences Dialog by choosing for Windows and Linux or for OS X. Click the Directories node.
- In the Directories page, click the desired content root. The directories under this content root are displayed as a tree view in the right-hand pane.
Select the directory you want to mark and do one of the following:
- To have PhpStorm consider the contents of the selected folder as unit tests, click the Tests toolbar button or choose Test Sources on the context menu of the selection.
To have PhpStorm consider the selected folder as the root for namespaces used in your project,
click the Sources toolbar button
o choose Sources on the context menu of the selection.
Based on this setting, PhpStorm suggests you the proper folder name when you want to create a new namespace under another parent namespace during creation or moving a PHP class, that is, when you are actually creating or moving a PHP class to a non-existing namespace under another parent namespace. If no Sources folder is specified, you will have to type the proper folder manually.
Appointing a Sources folder is not mandatory but this helps you keep your project structure in compliance with the PSR0 and PSR4 standards. See Configuring PHP Namespaces in a Project for details.
- To have PhpStorm ignore the selected directory during indexing, parsing, code completion, etc., click the Excluded toolbar button or choose Excluded on the context menu of the selection.
- To enable PhpStorm to complete relative paths to resources under the selected folder, click the Resource Root toolbar button or choose Resource Root on the context menu of the selection.
To mark directories using the context menu:
- Right-click the desired directory in the Project Tool Window.
- On the context menu, point to Mark Directory As node.
- Choose Mark as <directory status>.
To return a folder to its regular status, do one of the following
- On the Directories page of the Settings / Preferences Dialog:
- In the Project Tool Window, right-click the desired directory, point to Mark Directory As node, and then choose Unmark as <directory status>.