PhpStorm 6.0.1 Web Help

File | Settings | Project Settings | File Colors - Manage Scopes...

Edit | Find | Find Usages

Edit | Find | Find In Path

Code | Inspect Code...

browseButton.png

PhpStorm | Preferences | Settings | Project Settings | File Colors - Manage Scopes...

Edit | Find | Find Usages

Edit | Find | Find In Path

Code | Inspect Code...

browseButton.png

A scope is a set of files to which various operations apply. Using this dialog, you can define scopes for the various PhpStorm actions, for example, Find Usages, or Code Inspection.

In this section:

Main toolbar

ItemTooltipDescription
addAdd scope
Click this button to add a new local or shared scope.
deleteDelete
Click this button to delete the selected scope from the list.
copyCopy configuration
Click this button to create a copy of the selected scope.
mainToolbarSaveSave asClick this button to have the selected local scope saved as shared or a selected shared scope as local.
arrowUp arrowDownMove Up/Move DownUse these buttons to move the scopes up and down in the list.

Scopes configuration controls

Scopes are defined in the following modes:

  • Manually, by specifying file masks in the Pattern text box.
  • By selecting files and folders and clicking the buttons Include, Include Recursively, Exclude, and Exclude Recursively. Based on the inclusion/exclusion, PhpStorm creates an expression and displays it in the Pattern. However, this approach does not allow for including/excluding specific files within folders based on file masks.

ItemDescription
NameIn this text box, specify the scope name.
PatternIn this text box, specify the pattern to define the current scope using the script-like language described in the Scope Language Syntax Reference subsection. The following elements and structures are used:
  1. The file: modifier. The element is mandatory.
  2. The * asterisk to denote any symbol in a file name or file extension.
  3. Logical operators AND (&&), OR (||), and NOT (!).
Type or edit the pattern manually or choose the desired files in the Project Tree View - PhpStorm will generate the corresponding pattern.

Warning

Storing empty or incorrect patterns is not allowed. In such cases, you will be prompted with the Syntax Error warning.

Examples:
  • file:*.php||file:*.twig - include all PHP and Twig files.
  • file^*php&&!file:*test*.php - include all PHP files except those that contain the character string test in their names.
  • file:www/wp-content/themes/my-site-child//*.php||file:www/wp-content/themes/my-site-child//*.css||file:www/wp-content/themes/my-site-child//*.js||file:www/wp-content/plugins/my-site//*.php||file:www/wp-content/plugins/my-site//*.css||file:www/wp-content/plugins/my-site//*.js - include all .PHP, .CSS, and .JS files from the theme and plugin of the WordPress website.
  • file:*.js||file:*.coffee - include all JavaScript and CoffeeScript files.
  • file:*js&&!file:*.min.* - include all JavaScript files except those that were generated through minification, which is indicated by the min extension.
IncludeClick this button to have the selected element included in the scope. The corresponding expression is automatically generated and added to the expression in the Pattern text box.

Tip

If the current element is a folder, the nested subfolders are ignored.

Include RecursivelyClick this button to have the selected folder included in the scope, together with the nested subfolders. The corresponding expression is automatically generated and added to the expression in the Pattern text box.
ExcludeClick this button to have the selected element excluded from the scope. The corresponding expression is automatically added to the Pattern. If the current element is a folder, the nested subfolders are ignored.
Exclude RecursivelyClick this button to have the selected folder excluded from the scope, together with the nested subfolders. The corresponding expression is automatically added to the Pattern field.

Scope toolbar

ItemTooltipDescription
Project tree viewThe tree view contains all the files available in your project. In the view, select the desired files to be included in the current scope and have the scope definition pattern generated automatically. The message on the toolbar shows the total number of available files and the number of files included in the scope. See also the color legend below. Use the toolbar buttons described below to change the view presentation.
showFilesShow FilesIf this button is pressed, source files are displayed explicitly in the tree view. Otherwise they are hidden.
commonfilterShow Included OnlyWhen the button is pressed, the tree shows only the elements that are included in the scope.

Legend of the project tree view

ItemDescription
Green Folders and files included in scope.
BlackFolders and files excluded from scope.
Blue Folders that contain both excluded and included files and subfolders.

See Also

Concepts:

Reference:

Web Resources: