PhpStorm 8.0.0 Web Help

File | Settings | Appearance and Behavior | Scopes


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 Inspections.

In this section:

Main toolbar

Item Tooltip Description
add Add scope
InsertInsertInsertInsertInsertInsertInsertInsertInsertInsertInsert
Click this button to add a new local or shared scope.
delete Delete
DeleteDeleteDeleteDeleteDelete or Ctrl+DDeleteDeleteDeleteDelete, Backspace or Command BackspaceDelete, Backspace or Command BackspaceDelete, Backspace or Command Backspace
Click this button to delete the selected scope from the list.
copy Copy configuration
Ctrl+DCtrl+DCtrl+DCtrl+DMeta+DCtrl+DCtrl+D, Ctrl+Shift+Down or Ctrl+Shift+UpCtrl+DCommand DCommand DCommand D
Click this button to create a copy of the selected scope.
mainToolbarSave Save as Click this button to have the selected local scope saved as shared or a selected shared scope as local.
arrowUp arrowDown Move Up/Move Down Use these buttons to move the scopes up and down in the list.

If some file is included into several scopes, the order of the scopes becomes important: PhpStorm uses the color of the uppermost scope (shown in the Scopes settings page) to highlight such file. Of course, you can change the order of the scopes, and thus the resulted highlighting.

.

Scope configuration controls

Item Description
Name In this text box, specify the scope name.
Pattern In this text box, specify the pattern that defines the current scope. The following elements and structures can be 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 (!).

For more information, see Scope Language Syntax Reference.

Type or edit the pattern manually or choose the desired files in the Project Tree View - PhpStorm will generate the corresponding pattern automatically.

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.
Include Click 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 Recursively Click 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.
Exclude Click 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 Recursively Click 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

Item Tooltip Description
Project tree view The 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.
showFiles Show Files If this button is pressed, source files are displayed explicitly in the tree view. When the files are shown, they can be selected for exclusion/inclusion into a pattern.

scope_pattern

If this button is not pressed, the files are hidden.

commonfilter Show Included Only When the button is pressed, the tree shows only the elements that are included in the scope.

Legend of the project tree view

Item Description
Green Folders and files included in scope.
Black Folders and files excluded from scope.
Blue Folders that contain both excluded and included files and subfolders.

See Also

Concepts:

Reference:

Web Resources: