class application_manager in Apply for role 8

Application manager object used for performing any tasks relating to applications.

Hierarchy

class \Drupal\apply_for_role\application_manager

Expanded class hierarchy of application_manager

3 files declare their use of application_manager

ApplyForRoleApplicationForm.php in src/Form/ApplyForRoleApplicationForm.php
ApplyForRoleConfirmActionForm.php in src/Form/ApplyForRoleConfirmActionForm.php
apply_for_role_application_admin_page.php in src/Controller/apply_for_role_application_admin_page.php

File

src/application_manager.php, line 20: Contains two classes.

Namespace

Drupal\apply_for_role

View source

class application_manager {
  private $apply_for_role_config;
  public function __construct() {
    $this->apply_for_role_config = \Drupal::config('apply_for_role.settings');
  }

  /**
   * Helper function that gets all applications for all time.
   */
  public function get_all_applications() {
    $select = Database::getConnection()
      ->select('apply_for_role_applications', 'a')
      ->fields('a');

    // Make this return an array of application objects?
    $db_apps = $select
      ->execute()
      ->fetchAll(\PDO::FETCH_ASSOC);
    $user_applications = array();
    foreach ($db_apps as $db_app) {
      $user_applications[] = $this
        ->map_application_db_response_to_application($db_app);
    }
    return $user_applications;
  }

  /**
   * Helper function to get a singular application.
   * @param int $aid
   * @return object|bool
   *   Returns an application object or FALSE if no application
   */
  public function get_application($aid) {
    $select = Database::getConnection()
      ->select('apply_for_role_applications', 'a')
      ->fields('a');
    $select
      ->condition('a.aid', $aid);
    $db_app_data = $select
      ->execute()
      ->fetchAll(\PDO::FETCH_ASSOC);
    if (count($db_app_data) == 1) {
      return $this
        ->map_application_db_response_to_application($db_app_data[0]);
    }
    else {
      return FALSE;
    }
  }

  /**
   *
   * Helper function to get all applications for a user
   *
   * @param int $uid
   * @param int $status
   *   0 for never viewed, 1 for accepted, 2 for denied.
   * @return array
   *   An array of applications.
   */
  public function get_applications_for_user($uid, $status = null) {
    $select = Database::getConnection()
      ->select('apply_for_role_applications', 'a')
      ->fields('a');
    $select
      ->condition('a.uid', $uid);
    if (isset($status)) {
      $select
        ->condition('a.status', $status);
    }
    $db_apps = $select
      ->execute()
      ->fetchAll(\PDO::FETCH_ASSOC);
    $user_applications = array();
    foreach ($db_apps as $db_app) {
      $user_applications[] = $this
        ->map_application_db_response_to_application($db_app);
    }
    return $user_applications;
  }

  /**
   * Create an application.
   *
   * @param int $uid
   * @param array $rids
   */
  public function create_application($uid, $rids, $message = NULL) {
    Database::getConnection()
      ->insert('apply_for_role_applications')
      ->fields(array(
      'uid',
      'rids',
      'created',
      'message',
    ))
      ->values(array(
      $uid,
      Serialization\Json::encode($rids),
      time(),
      $message,
    ))
      ->execute();

    // Email admin on approval.
    if ($this->apply_for_role_config
      ->get('send_user_approval_email')) {
      if ($this->apply_for_role_config
        ->get('admin_email_addresses')) {
        $to = $this->apply_for_role_config
          ->get('admin_email_addresses');
      }
      else {

        // No users specificed, send to superadmin.
        // @TODO: Replace deprecated user_load function.
        $to = user_load(1)
          ->getEmail();
      }
      $subject = $this->apply_for_role_config
        ->get('admin_email_subject');
      $body = $this->apply_for_role_config
        ->get('admin_email_body');
      $replacements = array(
        '%URL' => \Drupal::request()
          ->getHost(),
        '%ROLE' => $this
          ->rids_to_text($rids),
      );
      $this
        ->send_email($to, $subject, $body, $replacements);
    }
  }

  /**
   * @param mixed $application
   *   Pass either an AID to load an application, or an actual application object.
   * @return bool
   */
  public function approve_application($application) {
    if (!is_object($application)) {
      $application = $this
        ->get_application($application);
    }

    // Check if the application has been denied/approved already, and do not proceed if so.
    if ($application
      ->get('status') != 0) {
      return FALSE;
    }
    else {
      $user = \Drupal::service('entity_type.manager')
        ->getStorage('user')
        ->load($application
        ->get('uid'));
      foreach ($application
        ->get('rids') as $role_to_add) {
        $user
          ->addRole($role_to_add);
      }
      $user
        ->save();
      if ($this->apply_for_role_config
        ->get('send_user_approval_email')) {

        // @TODO: Replace deprecated user_load function.
        $to = user_load($application
          ->get('uid'))
          ->getEmail();
        $subject = $this->apply_for_role_config
          ->get('send_user_approval_subject');
        $body = $this->apply_for_role_config
          ->get('send_user_approval_body');
        $replacements = array(
          '%URL' => \Drupal::request()
            ->getHost(),
          '%ROLE' => $this
            ->rids_to_text($application
            ->get('rids')),
        );
        $this
          ->send_email($to, $subject, $body, $replacements);
      }

      // Mark the application as approved.
      Database::getConnection()
        ->update('apply_for_role_applications')
        ->fields(array(
        'status' => 1,
      ))
        ->condition('aid', $application
        ->get('aid'))
        ->execute();
    }
  }

  /**
   * @param mixed $application
   *   Pass either an AID to load an application, or an actual application object.
   * @return bool
   */
  public function deny_application($application) {
    if (!is_object($application)) {
      $application = $this
        ->get_application($application);
    }

    // Check if the application has been denied/approved already, and do not proceed if so.
    if ($application
      ->get('status') != 0) {
      return FALSE;
    }
    else {
      if ($this->apply_for_role_config
        ->get('send_user_deny_email')) {

        // @TODO: Replace deprecated user_load function.
        $to = user_load($application
          ->get('uid'))
          ->getEmail();
        $subject = $this->apply_for_role_config
          ->get('send_user_deny_subject');
        $body = $this->apply_for_role_config
          ->get('send_user_deny_body');
        $replacements = array(
          '%URL' => \Drupal::request()
            ->getHost(),
          '%ROLE' => $this
            ->rids_to_text($application
            ->get('rids')),
        );
        $this
          ->send_email($to, $subject, $body, $replacements);
      }

      // Mark the application as approved.
      Database::getConnection()
        ->update('apply_for_role_applications')
        ->fields(array(
        'status' => 2,
      ))
        ->condition('aid', $application
        ->get('aid'))
        ->execute();
    }
  }

  /**
   * Converts an array of RID's into plain text for insertion into email.
   *
   * @param $rids
   * @return string
   */
  public function rids_to_text($rids) {
    $replacement_text = '';
    $first = TRUE;
    $last = count($rids);

    // Base zero count of last.
    $count = 0;

    // @TODO: Convert role_id to presentable non-machine name. For now this works.
    foreach ($rids as $role_id) {
      $count++;
      if ($first) {
        $replacement_text .= $role_id;
        $first = FALSE;
      }
      else {
        if ($count == $last) {
          $replacement_text .= ' and ' . $role_id;
        }
        else {
          $replacement_text .= ', ' . $role_id;
        }
      }
    }
    return $replacement_text;
  }

  /**
   * Returns a proper username for an application.
   */
  public function display_username_for_application($application) {
    $uid = $application
      ->get('uid');
    $account = \Drupal\user\Entity\User::load($uid);
    return $account
      ->getDisplayName() . ' (' . $uid . ')';
  }

  /**
   * Helper function to send a generic email to respective parties during application handling.
   */
  protected function send_email($to, $subject, $body, $replacements = array()) {
    $mailManager = \Drupal::service('plugin.manager.mail');
    $langcode = \Drupal::currentUser()
      ->getPreferredLangcode();
    foreach ($replacements as $replacement => $value) {
      $body = str_replace($replacement, $value, $body);
    }

    // Send email, capture result.
    $result = $mailManager
      ->mail('apply_for_role', 'apply_for_role', $to, $langcode, array(
      'to' => $to,
      'subject' => $subject,
      'body' => $body,
    ), NULL, TRUE);
  }

  /**
   * Take the db response, map it to an application object.
   *
   * @param array $db_app_array
   *   Array of values as returned from the database for an application.
   *
   * @return object apply_for_role_application
   *   A newly created application object.
   */
  protected function map_application_db_response_to_application($db_app_array) {
    return new apply_for_role_application($db_app_array['aid'], $db_app_array['uid'], Serialization\Json::decode($db_app_array['rids']), $db_app_array['status'], $db_app_array['created'], $db_app_array['message']);
  }

}

Members

Name	Modifiers	Type	Description
application_manager::$apply_for_role_config	private	property
application_manager::approve_application	public	function
application_manager::create_application	public	function	Create an application.
application_manager::deny_application	public	function
application_manager::display_username_for_application	public	function	Returns a proper username for an application.
application_manager::get_all_applications	public	function	Helper function that gets all applications for all time.
application_manager::get_application	public	function	Helper function to get a singular application.
application_manager::get_applications_for_user	public	function	Helper function to get all applications for a user
application_manager::map_application_db_response_to_application	protected	function	Take the db response, map it to an application object.
application_manager::rids_to_text	public	function	Converts an array of RID's into plain text for insertion into email.
application_manager::send_email	protected	function	Helper function to send a generic email to respective parties during application handling.
application_manager::__construct	public	function

You are here

class application_manager in Apply for role 8

Hierarchy

File

Namespace

Members

API Navigation