Update comments in token classes
authorMatthew Wire <mjw@mjwconsult.co.uk>
Wed, 3 Mar 2021 11:00:33 +0000 (11:00 +0000)
committerMatthew Wire <mjw@mjwconsult.co.uk>
Wed, 3 Mar 2021 11:01:42 +0000 (11:01 +0000)
CRM/Activity/Tokens.php
CRM/Core/TokenTrait.php
Civi/Token/AbstractTokenSubscriber.php

index 1eb294330273b477d39307f26dad90f4568145de..66663dd7c497b0ebc4fc502136b50935862e698c 100644 (file)
@@ -125,7 +125,18 @@ class CRM_Activity_Tokens extends AbstractTokenSubscriber {
   }
 
   /**
-   * @inheritDoc
+   * Evaluate the content of a single token.
+   *
+   * @param \Civi\Token\TokenRow $row
+   *   The record for which we want token values.
+   * @param string $entity
+   *   The name of the token entity.
+   * @param string $field
+   *   The name of the token field.
+   * @param mixed $prefetch
+   *   Any data that was returned by the prefetch().
+   *
+   * @throws \CRM_Core_Exception
    */
   public function evaluateToken(TokenRow $row, $entity, $field, $prefetch = NULL) {
     // maps token name to api field
index e861915be46f31c9a2e8d090bb156d6f9177a576..356bdc7fd09828905aa28769869cc89b18aff77a 100644 (file)
@@ -19,7 +19,11 @@ trait CRM_Core_TokenTrait {
   }
 
   /**
-   * @inheritDoc
+   * Check if the token processor is active.
+   *
+   * @param \Civi\Token\TokenProcessor $processor
+   *
+   * @return bool
    */
   public function checkActive(TokenProcessor $processor) {
     return in_array($this->getEntityContextSchema(), $processor->context['schema']) ||
index 024f855b3eeb68fc661557ad17a2e20578134eee..ce9b63be684fc7ac37229368aefd08c052c434cf 100644 (file)
@@ -186,7 +186,6 @@ abstract class AbstractTokenSubscriber implements EventSubscriberInterface {
    *   The name of the token field.
    * @param mixed $prefetch
    *   Any data that was returned by the prefetch().
-   * @return mixed
    */
   abstract public function evaluateToken(TokenRow $row, $entity, $field, $prefetch = NULL);