Issue #2034979 by derhasi: Typehint Views field handler methods with ResultRow.

core/modules/aggregator/lib/Drupal/aggregator/Plugin/views/field/Category.php

@@ -59,11 +59,11 @@ public function buildOptionsForm(&$form, &$form_state) {
    *
    * @param string $data
    *   The XSS safe string for the link text.
-   * @param object $values
-   *   The values retrieved from the database.
+   * @param \Drupal\views\ResultRow $values
+   *   The values retrieved from a single row of a view's query result.
    *
-   * @return data
-   *   Returns string for the link text.
+   * @return string
+   *   Returns a string for the link text.
    */
   protected function renderLink($data, ResultRow $values) {
     $cid = $this->getValue($values, 'cid');

core/modules/aggregator/lib/Drupal/aggregator/Plugin/views/field/TitleLink.php

@@ -68,11 +68,11 @@ public function render(ResultRow $values) {
    *
    * @param string $data
    *   The XSS safe string for the link text.
-   * @param object $values
-   *   The values retrieved from the database.
+   * @param \Drupal\views\ResultRow $values
+   *   The values retrieved from a single row of a view's query result.
    *
-   * @return data
-   *   Returns string for the link text.
+   * @return string
+   *   Returns a string for the link text.
    */
   protected function renderLink($data, ResultRow $values) {
     $link = $this->getValue($values, 'link');

core/modules/comment/lib/Drupal/comment/Plugin/views/field/Comment.php

@@ -63,6 +63,17 @@ public function buildOptionsForm(&$form, &$form_state) {
     parent::buildOptionsForm($form, $form_state);
   }
 
+  /**
+   * Render whatever the data is as a link to the comment or its node.
+   *
+   * @param string $data
+   *   The XSS safe string for the link text.
+   * @param \Drupal\views\ResultRow $values
+   *   The values retrieved from a single row of a view's query result.
+   *
+   * @return string
+   *   Returns a string for the link text.
+   */
   protected function renderLink($data, ResultRow $values) {
     if (!empty($this->options['link_to_comment'])) {
       $this->options['alter']['make_link'] = TRUE;

core/modules/comment/lib/Drupal/comment/Plugin/views/field/Link.php

@@ -90,6 +90,17 @@ public function render(ResultRow $values) {
     return $this->renderLink($comment, $values);
   }
 
+  /**
+   * Prepares the link pointing to the comment or its node.
+   *
+   * @param \Drupal\Core\Entity\EntityInterface $data
+   *   The comment entity.
+   * @param \Drupal\views\ResultRow $values
+   *   The values retrieved from a single row of a view's query result.
+   *
+   * @return string
+   *   Returns a string for the link text.
+   */
   protected function renderLink($data, ResultRow $values) {
     $text = !empty($this->options['text']) ? $this->options['text'] : t('view');
     $comment = $data;

core/modules/comment/lib/Drupal/comment/Plugin/views/field/LinkApprove.php

@@ -24,6 +24,17 @@ public function access() {
     return user_access('administer comments');
   }
 
+  /**
+   * Prepares the link pointing for approving the comment.
+   *
+   * @param \Drupal\Core\Entity\EntityInterface $data
+   *   The comment entity.
+   * @param \Drupal\views\ResultRow $values
+   *   The values retrieved from a single row of a view's query result.
+   *
+   * @return string
+   *   Returns a string for the link text.
+   */
   protected function renderLink($data, ResultRow $values) {
     $status = $this->getValue($values, 'status');
 

core/modules/comment/lib/Drupal/comment/Plugin/views/field/LinkDelete.php

@@ -24,6 +24,17 @@ public function access() {
     return user_access('administer comments');
   }
 
+  /**
+   * Prepares the link for deleting the comment.
+   *
+   * @param \Drupal\Core\Entity\EntityInterface $data
+   *   The comment entity.
+   * @param \Drupal\views\ResultRow $values
+   *   The values retrieved from a single row of a view's query result.
+   *
+   * @return string
+   *   Returns a string for the link text.
+   */
   protected function renderLink($data, ResultRow $values) {
     $text = !empty($this->options['text']) ? $this->options['text'] : t('delete');
     $comment = $this->getEntity($values);

core/modules/comment/lib/Drupal/comment/Plugin/views/field/LinkEdit.php

@@ -37,6 +37,17 @@ public function buildOptionsForm(&$form, &$form_state) {
     );
   }
 
+  /**
+   * Prepare the link for editing the comment.
+   *
+   * @param \Drupal\Core\Entity\EntityInterface $data
+   *   The comment entity.
+   * @param \Drupal\views\ResultRow $values
+   *   The values retrieved from a single row of a view's query result.
+   *
+   * @return string
+   *   Returns a string for the link text.
+   */
   protected function renderLink($data, ResultRow $values) {
     parent::renderLink($data, $values);
     // Ensure user has access to edit this comment.

core/modules/comment/lib/Drupal/comment/Plugin/views/field/LinkReply.php

@@ -24,6 +24,17 @@ public function access() {
     return user_access('post comments');
   }
 
+  /**
+   * Prepare the link for replying to the comment.
+   *
+   * @param \Drupal\Core\Entity\EntityInterface $data
+   *   The comment entity.
+   * @param \Drupal\views\ResultRow $values
+   *   The values retrieved from a single row of a view's query result.
+   *
+   * @return string
+   *   Returns a string for the link text.
+   */
   protected function renderLink($data, ResultRow $values) {
     $text = !empty($this->options['text']) ? $this->options['text'] : t('reply');
     $comment = $this->getEntity($values);

core/modules/comment/lib/Drupal/comment/Plugin/views/field/NodeNewComments.php

@@ -127,6 +127,17 @@ public function preRender(&$values) {
     }
   }
 
+  /**
+   * Prepares the link to the first new comment.
+   *
+   * @param string $data
+   *   The XSS safe string for the link text.
+   * @param \Drupal\views\ResultRow $values
+   *   The values retrieved from a single row of a view's query result.
+   *
+   * @return string
+   *   Returns a string for the link text.
+   */
   protected function renderLink($data, ResultRow $values) {
     if (!empty($this->options['link_to_comment']) && $data !== NULL && $data !== '') {
       $node = entity_create('node', array(

core/modules/comment/lib/Drupal/comment/Plugin/views/field/Username.php

@@ -49,6 +49,17 @@ public function buildOptionsForm(&$form, &$form_state) {
     parent::buildOptionsForm($form, $form_state);
   }
 
+  /**
+   * Prepares link for the comment's author.
+   *
+   * @param string $data
+   *   The XSS safe string for the link text.
+   * @param \Drupal\views\ResultRow $values
+   *   The values retrieved from a single row of a view's query result.
+   *
+   * @return string
+   *   Returns a string for the link text.
+   */
   protected function renderLink($data, ResultRow $values) {
     if (!empty($this->options['link_to_user'])) {
       $account = entity_create('user', array());

core/modules/content_translation/lib/Drupal/content_translation/Plugin/views/field/TranslationLink.php

@@ -54,11 +54,11 @@ public function render(ResultRow $values) {
    *
    * @param \Drupal\Core\Entity\EntityInterface $entity
    *   The entity being rendered.
-   * @param \stdClass $values
+   * @param \Drupal\views\ResultRow $values
    *   The current row of the views result.
    *
    * @return string
-   *   The acutal rendered text (without the link) of this field.
+   *   The actual rendered text (without the link) of this field.
    */
   protected function renderLink(EntityInterface $entity, ResultRow $values) {
     if (content_translation_translate_access($entity)) {

core/modules/contextual/lib/Drupal/contextual/Plugin/views/field/ContextualLinks.php

@@ -68,6 +68,9 @@ public function preRender(&$values) {
    *
    * Renders the contextual fields.
    *
+   * @param \Drupal\views\ResultRow $values
+   *   The values retrieved from a single row of a view's query result.
+   *
    * @see contextual_preprocess()
    * @see contextual_contextual_links_view_alter()
    */

core/modules/file/lib/Drupal/file/Plugin/views/field/File.php

@@ -53,9 +53,15 @@ public function buildOptionsForm(&$form, &$form_state) {
   }
 
   /**
-   * Render whatever the data is as a link to the file.
+   * Prepares link to the file.
    *
-   * Data should be made XSS safe prior to calling this function.
+   * @param string $data
+   *   The XSS safe string for the link text.
+   * @param \Drupal\views\ResultRow $values
+   *   The values retrieved from a single row of a view's query result.
+   *
+   * @return string
+   *   Returns a string for the link text.
    */
   protected function renderLink($data, ResultRow $values) {
     if (!empty($this->options['link_to_file']) && $data !== NULL && $data !== '') {

core/modules/node/lib/Drupal/node/Plugin/views/field/Link.php

@@ -55,6 +55,17 @@ public function render(ResultRow $values) {
     }
   }
 
+  /**
+   * Prepares the link to the node.
+   *
+   * @param \Drupal\Core\Entity\EntityInterface $node
+   *   The node entity this field belongs to.
+   * @param ResultRow $values
+   *   The values retrieved from the view's result set.
+   *
+   * @return string
+   *   Returns a string for the link text.
+   */
   protected function renderLink($node, ResultRow $values) {
     if (node_access('view', $node)) {
       $this->options['alter']['make_link'] = TRUE;

core/modules/node/lib/Drupal/node/Plugin/views/field/LinkDelete.php

@@ -21,7 +21,15 @@
 class LinkDelete extends Link {
 
   /**
-   * Renders the link.
+   * Prepares the link to delete a node.
+   *
+   * @param \Drupal\Core\Entity\EntityInterface $node
+   *   The node entity this field belongs to.
+   * @param \Drupal\views\ResultRow $values
+   *   The values retrieved from the view's result set.
+   *
+   * @return string
+   *   Returns a string for the link text.
    */
   protected function renderLink($node, ResultRow $values) {
     // Ensure user has access to delete this node.

core/modules/node/lib/Drupal/node/Plugin/views/field/LinkEdit.php

@@ -21,7 +21,15 @@
 class LinkEdit extends Link {
 
   /**
-   * Renders the link.
+   * Prepares the link to the node.
+   *
+   * @param \Drupal\Core\Entity\EntityInterface $node
+   *   The node entity this field belongs to.
+   * @param ResultRow $values
+   *   The values retrieved from the view's result set.
+   *
+   * @return string
+   *   Returns a string for the link text.
    */
   protected function renderLink($node, ResultRow $values) {
     // Ensure user has access to edit this node.

core/modules/node/lib/Drupal/node/Plugin/views/field/Node.php

@@ -57,9 +57,15 @@ public function buildOptionsForm(&$form, &$form_state) {
   }
 
   /**
-   * Render whatever the data is as a link to the node.
+   * Prepares link to the node.
    *
-   * Data should be made XSS safe prior to calling this function.
+   * @param string $data
+   *   The XSS safe string for the link text.
+   * @param \Drupal\views\ResultRow $values
+   *   The values retrieved from a single row of a view's query result.
+   *
+   * @return string
+   *   Returns a string for the link text.
    */
   protected function renderLink($data, ResultRow $values) {
     if (!empty($this->options['link_to_node']) && !empty($this->additional_fields['nid'])) {

core/modules/node/lib/Drupal/node/Plugin/views/field/Revision.php

@@ -53,9 +53,15 @@ public function buildOptionsForm(&$form, &$form_state) {
   }
 
   /**
-   * Render whatever the data is as a link to the node.
+   * Prepares link to the node revision.
    *
-   * Data should be made XSS safe prior to calling this function.
+   * @param string $data
+   *   The XSS safe string for the link text.
+   * @param \Drupal\views\ResultRow $values
+   *   The values retrieved from a single row of a view's query result.
+   *
+   * @return string
+   *   Returns a string for the link text.
    */
   protected function renderLink($data, ResultRow $values) {
     if (!empty($this->options['link_to_node_revision']) && $data !== NULL && $data !== '') {

core/modules/node/lib/Drupal/node/Plugin/views/field/RevisionLink.php

@@ -35,6 +35,17 @@ public function access() {
     return user_access('view revisions') || user_access('administer nodes');
   }
 
+  /**
+   * Prepares the link to point to a node revision.
+   *
+   * @param \Drupal\Core\Entity\EntityInterface $data
+   *   The node revision entity this field belongs to.
+   * @param \Drupal\views\ResultRow $values
+   *   The values retrieved from the view's result set.
+   *
+   * @return string
+   *   Returns a string for the link text.
+   */
   protected function renderLink($data, ResultRow $values) {
     list($node, $vid) = $this->get_revision_entity($values, 'view');
     if (!isset($vid)) {

core/modules/node/lib/Drupal/node/Plugin/views/field/RevisionLinkDelete.php

@@ -24,6 +24,17 @@ public function access() {
     return user_access('delete revisions') || user_access('administer nodes');
   }
 
+  /**
+   * Prepares the link to delete a node revision.
+   *
+   * @param \Drupal\Core\Entity\EntityInterface $data
+   *   The node revision entity this field belongs to.
+   * @param \Drupal\views\ResultRow $values
+   *   The values retrieved from the view's result set.
+   *
+   * @return string
+   *   Returns a string for the link text.
+   */
   protected function renderLink($data, ResultRow $values) {
     list($node, $vid) = $this->get_revision_entity($values, 'delete');
     if (!isset($vid)) {