Skip to content

Commit 3dd7290

Browse files
committed
Review feedback changes
1 parent 68a9060 commit 3dd7290

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

plugins/CoreHome/EntityDuplicator/DuplicateRequestResponse.php

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ class DuplicateRequestResponse
4040

4141
/**
4242
* @var array Optional array containing the data required for the event to be posted on success. If set, the event
43-
* to record the activity will be triggered when the getResponseArray method is called.
43+
* will be triggered when the getResponseArray method is called.
4444
*
4545
* @see self::setRequestDataForEvent()
4646
* @see self::getResponseArray()
@@ -169,21 +169,18 @@ private function getCurrentState(): array
169169
}
170170

171171
/**
172-
* If the correct class exists, instantiate it with the provided arguments so that it can post the event to record
173-
* the activity log when the response array is built.
172+
* Set the arguments to be used while posting the event when the response array is built. This is used by plugins
173+
* which use this class while generating the response to a duplication request.
174174
*
175175
* @param string $entityTypeTranslation Translation key for the name of the type of entity. E.g. Goals_Goal,
176-
* Heatmaps_Heatmap, etc.
177-
* @param string $entityName The name of the entity being copied. E.g. 'Goal that does thing' or
178-
* 'Home page heatmap'. This will be used in conjunction with the entity type translation to describe the entity
179-
* being copied.
176+
* Heatmaps_Heatmap, etc.
177+
* @param string $entityName The name of the entity being copied. E.g. 'Goal that does thing' or'Home page heatmap'.
180178
* @param int|null $idEntity The ID of the entity being copied. E.g. 2 or 900. It's optional since some entities
181-
* might only have a string identifier which should be provided as the entityName. If provided, this will be used in
182-
* conjunction with the entity type translation and entity name to describe the entity being copied.
179+
* might only have a string identifier which should be provided as the entityName.
183180
* @param int|null $idSite ID of the source site. It's optional in case the entity being copied is not site scoped,
184-
* like a system-wide configuration.
181+
* like a system-wide configuration.
185182
* @param array|null $idDestinationSites IDs of the destination sites. This is optional for the same reason as
186-
* idSite but also because it doesn't need to be provided if the only destination site is the source site (idSite).
183+
* idSite but also since it doesn't need to be provided if the only destination site is the source site (idSite).
187184
* @param array|null $additionalData Optional array of additional data relating to the entity being copied.
188185
*
189186
* @return void

0 commit comments

Comments
 (0)