Skip to content

Commit

Permalink
Update phpdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
Dominic Tubach committed Feb 13, 2024
1 parent 7080100 commit 6cd1a59
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@

/**
* Abstract implementation that assumes that internal and external fields are
* the same. Create, delete, and update are allowed by default. (Delete and
* the same. (getRemoteFields() and convertToRemoteValues() can be reimplemented
* if necessary.) Create, delete, and update are allowed by default. (Delete and
* update is limited to those entities that are not filtered via getFilter()).
*
* @codeCoverageIgnore
Expand Down
14 changes: 9 additions & 5 deletions Civi/RemoteTools/EntityProfile/RemoteEntityProfileInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -33,20 +33,24 @@
* ->addTag(MyRemoteEntityProfile::SERVICE_TAG);
*
* Instead of the constants mentioned above the values can be provided as tag
* attributes with lower cased constant name as key.
* attributes of the service with lower cased constant name as key.
*
* Additionally, a custom handler class might be specified with the constant
* HANDLER_CLASS (or lower cased as tag attribute). The constructor must have an
* argument named $profile. All other arguments have to be autowireable.
*
* This class shall not be implemented directly, but AbstractRemoteEntityProfile
* or AbstractRemoteEntityProfileDecorator should be extended instead.
* This class shall not be implemented directly, but AbstractRemoteEntityProfile,
* AbstractReadOnlyRemoteEntityProfile, or AbstractRemoteEntityProfileDecorator
* should be extended instead.
*
* Please note: With special where conditions it is possible to find out values
* of not exposed fields. (Via implicit joins even of referenced entities.)
* Most methods have a parameter named $contactId. This contains the remote
* contact ID resolved to a CiviCRM contact ID or NULL if no remote contact ID
* was given.
*
* @see \Civi\RemoteTools\Api4\AbstractRemoteEntity
* @see \Civi\RemoteTools\EntityProfile\AbstractRemoteEntityProfile
* @see \Civi\RemoteTools\EntityProfile\AbstractReadOnlyRemoteEntityProfile
* @see \Civi\RemoteTools\EntityProfile\Traits\ConstProfileMetadataTrait
*/
interface RemoteEntityProfileInterface {

Expand Down

0 comments on commit 6cd1a59

Please sign in to comment.