Copyright Profiles

Use this page to create, edit, and remove copyright profiles.

In this topic:

Profiles Toolbar
Copyright Profile Page

Profiles Toolbar

Item	Tooltip and Shortcut	Description
	`Alt+Insert`	Add a new profile.
	`Alt+Delete`	Discard the selected profile.
	`Ctrl+D`	Open the Copy Copyright Profile dialog, where you can create a copy of the selected profile.
	Import	Import a file that contains a copyright notice definition. For more information, refer to Import a copyright profile.

Copyright Profile Page

Use this page to configure the selected profile: define the copyright notice to be generated and specify the keyword to detect copyright notices in comments.

Item

Description

Name

Use this text field to view or edit the name of the selected copyright profile.

Use this text area to view or edit the copyright notice to be generated. A copyright profile can contain an explicit plain text of the copyright notice or its definition through a Velocity template.

Currently, the following variables are available in the Velocity context:

Name	Type	Comment
`$today`	`DateInfo`	The current date and time.
`$file.fileName`	`String`	The name of the currently opened file where the notice is to be generated.
`$file.pathName`	`String`	The complete path and name of the currently opened file where the notice is to be generated.
`$file.className`	`String`	The name of the currently opened Java file where the notice is to be generated.
`$file.qualifiedClassName`	`String`	The fully qualified name of the currently opened file where the notice is to be generated.
`$file.lastModified`	`DateInfo`	The date and time when the current file was last changed.
`$project.name`	`String`	The name of the current project.
`$username`	`String`	The name of the current user.
`DateInfo` has the following properties:
`year`	`int`	The current year.
`month`	`int`	The current month (1-12).
`day`	`int`	The current date of month (1-31).
`hour`	`int`	The current hour (0-11).
`hour24`	`int`	The current hour (0-23).
`minute`	`int`	The current minute of the hour (0-59).
`second`	`int`	The current second of the minute (0-59).
`DateInfo` has the following method:
`format(String format)`	`String`	Date and time formats that are specified by date and time pattern strings. See java.text.SimpleDateFormat format options.

Validate

Click this button to check that the Velocity template has been specified correctly.

Regex to detect copyright in comments

Use this field to type, view, or edit the regular expression that will be used to find copyright notices in comments.

Note that this regular expression should match the copyright notice specified above. Otherwise instead of updating copyright notices, PhpStorm will insert new ones.

Allow replacing copyright if old copyright matches

Use this field to type or edit the regular expression pattern that will be recognized in the existing copyright notice and allow replacing it with the new one. For example, if you specify the following pattern for year indication: 20[0-1][0-6], updates will affect all the copyrights with the indications of years 2000-2006 and 2010-2016.

Note the difference between Regex to detect copyright in comments and Allow replacing copyright if old copyright matches. While the first setting is needed just to find copyright notices, the second one is used to decide whether a found copyright notice should be updated.

Last modified: 16 July 2024