PhpStorm 9.0.0 Help

ProjectScope

Content Root

On this page:

Basics

In the terms of PhpStorm, content is a collection of files with which you are currently working, possibly organized in a hierarchy of subfolders. The folder which is the highest in this hierarchy is called content root folder or content root (shown as folder) for short. A project has at least one content root folder, by default it is the project folder itself.

Having several content roots enables you to work with files from several directories that do not have a common immediate parent. This is helpful when you use some static contents, for example, icons. You can just save them all in a folder and then specify this folder as an extra content root in several projects.

Types of content roots

By default, all the files in a content root folder are involved in indexing, searching, parsing, code completion, etc. To change this status, folders within a content root can be assigned to the following categories:

  • Source roots (or source folders; shown as rootSource).

    This is the root for namespaces used in your project.

    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.

  • Test source roots (or test source folders; shown as rootTest).
  • Excluded roots (marked as rootExcluded) are ones that PhpStorm "partially ignores".

    These roots contain files and folders ignored by PhpStorm when indexing, searching, parsing, watching etc.

    Excluded roots are not visible to PhpStorm. Usually, one would like to exclude temporary build folders, generated output, logs, and other project output. Excluding the unnecessary paths is a good way to significantly improve performance.

  • Resource roots (or resource folders; marked as rootResource).

    By assigning a folder to this category, you tell PhpStorm that files in it and in its subfolders can be referenced relative to this folder instead of specifying full paths to them.

See Also

Last modified: 25 July 2015