UserSignature.php in Display Suite 8.4

Namespace

Drupal\ds\Plugin\DsField\User

File

src/Plugin/DsField/User/UserSignature.php

<?php

namespace Drupal\ds\Plugin\DsField\User;

use Drupal\ds\Plugin\DsField\Markup;

/**
 * Plugin that renders the user signature.
 *
 * @DsField(
 *   id = "user_signature",
 *   title = @Translation("User signature"),
 *   entity_type = "user",
 *   provider = "user"
 * )
 */
class UserSignature extends Markup {

  /**
   * {@inheritdoc}
   */
  public function key() {
    return 'signature';
  }

  /**
   * {@inheritdoc}
   */
  public function format() {
    return 'signature_format';
  }

  /**
   * {@inheritdoc}
   */
  public function isAllowed() {

    // Checks if user signatures are enabled.
    $user_signatures = \Drupal::config('user.settings')
      ->get('signatures');

    // We use this function to decide if we should show this field.
    // When user signatures are disabled we should ignore this.
    if (!empty($user_signatures)) {
      return TRUE;
    }
    else {
      return FALSE;
    }
  }

}

Classes

Name	Description
UserSignature	Plugin that renders the user signature.