Copyright

A profile allows you to define a copyright text that you can later insert across the project or add to specific files only.

1. Press CtrlAlt0S to open the IDE settings and then select Editor | Copyright | Copyright Profiles.

2. To configure the default profile for all newly created projects, select File | New Projects Setup | Settings for New Projects.

3. Click and name the new profile.

4. Enter the copyright notice text.

   You can enter plain text, or configure a Velocity template. For the template, use variables, and click Validate to make sure that it is configured correctly.

   

Once the profile is configured, you can select the scope of files to which you want to add the text or set this profile as the default profile for all files in the project that are not included to any scope.

Select the scope of files to which you want to add the configured copyright text:

1. Press CtrlAlt0S to open the IDE settings and then select Editor | Copyright.

2. Click (or press AltInsert), and select an existing shared scope from the list.

   You can define a new scope if necessary. Click the Select Scopes to add scopes or modify existing ones link in the lower part of the page.

3. From the Copyright list, select the profile that you want to link with the scope.

4. Click Apply to save the changes and close the dialog.

   

After that you can add the copyright to the necessary files.

The settings of the default profile will be applied to files that are not explicitly included in any scope covered by a profile.

1. Press CtrlAlt0S to open the IDE settings and then select Editor | Copyright.

2. From the Default project copyright list, select the profile you want to use as the default profile.

3. Click Apply to save the changes and close the dialog.

   After that you can add the copyright to the necessary files.

By default, the IDE pastes a block comment before other comments with a prefix in each line and adds a blank line after the block.

You can change the default format for all files or for each file type separately:

1. Press CtrlAlt0S to open the IDE settings and then select Editor | Copyright | Formatting.

2. On this page, you can configure the formatting for all types of files.

   To change the formatting for a specific file type, select it under the Formatting node.

3. Configure the formatting options. Use the preview section to make sure that the new formatting looks as intended.

   

PhpStorm stores copyright profiles in .idea/copyright in .xml files. If you want to use a profile in another project, copy the .xml file with the profile settings to a different location and then import it:

1. Press CtrlAlt0S to open the IDE settings and then select Editor | Copyright | Copyright Profiles.

2. Click and in the dialog that opens, select the .xml file containing the profile that you want to use.

3. Change the name of the profile if necessary and click OK.

   If the settings are imported successfully, you will see a confirmation popup.

   

• To insert the text in a single file, open it in the editor, press AltInsert, and select Copyright from the popup.

• To insert the text into a group of files, right-click a node in the Project tool window, and select Update Copyright. You will be prompted to select in which scope you want to update the notice.

  A node may include files that belong to different scopes. In this case, copyright notices will be generated according to the assigned profiles.

  If a node contains a file that doesn't belong to any scope, the IDE will assign the default profile to it.

1. Press CtrlAlt0S to open the IDE settings and then select Editor | Copyright | Copyright Profiles.

2. Select the necessary profile and edit the copyright text.

3. In the Regex to detect copyright in comments field, specify a regular expression that will be used to find existing copyright notices in files.

   The IDE will use this expression to identify the copyright comment among other comments. For example, such comments normally contain the word Copyright.

4. In the Allow replacing copyright if old copyright matches field, specify a regular expression that the IDE will use to search for the files in which the copyright text should be updated.

   For example, if you want to update the copyright text in all files that contain years 2000-2006 and 2010-2016 in their copyright, specify 20[0-1][0-6].

5. Click Apply to save the changes and close the dialog.

6. In the Project (Alt01) tool window, right-click the node for which you want to update the text, and select Update Copyright.

You can configure the IDE to update copyright notices every time the IDE saves your changes.

1. Press CtrlAlt0S to open the IDE settings and then select Tools | Actions on Save.

2. Select the Update copyright notice checkbox.

   The checkbox is available if you have configured at least one copyright profile and specified a scope of files to which this profile is applied.

   If you haven't configured a profile yet, click the Configure… link.

   When the profile is configured, return to Tools | Actions on Save and enable the Update copyright notice checkbox.

3. Click Apply to save the changes and close the dialog.

For more information about actions that you can enable on save, refer to Trigger actions when saving changes.