cas.post_update.php in CAS 2.x

Post-update functions for CAS module.

File

cas.post_update.php

<?php

/**
 * @file
 * Post-update functions for CAS module.
 */

/**
 * Add prevent normal login and restrict password management error messages.
 */
function cas_post_update_8001() {
  \Drupal::configFactory()
    ->getEditable('cas.settings')
    ->set('error_handling.message_prevent_normal_login', 'This account must log in using <a href="[cas:login-url]">CAS</a>.')
    ->set('error_handling.message_restrict_password_management', 'The requested account is associated with CAS and its password cannot be managed from this website.')
    ->save();
}

/**
 * Set default value for new gateway method config option.
 */
function cas_post_update_8002() {
  $casConfig = \Drupal::configFactory()
    ->getEditable('cas.settings');

  // We need to migrate away from the single config var we had for indicating
  // how CAS gateway operated into the new config settings.
  $oldGatewaySetting = $casConfig
    ->get('gateway.check_frequency');

  // This value was used to indicate CAS gateway was enabled and should check
  // every page request. We use a -1 recheck time to indicate that.
  if ($oldGatewaySetting === 0) {
    $enabled = TRUE;
    $recheckTime = -1;
  }
  elseif ($oldGatewaySetting === -1) {
    $enabled = TRUE;
    $recheckTime = 720;
  }
  else {
    $enabled = FALSE;
    $recheckTime = 720;
  }
  $casConfig
    ->set('gateway.method', 'server_side')
    ->set('gateway.recheck_time', $recheckTime)
    ->set('gateway.enabled', $enabled)
    ->clear('gateway.check_frequency')
    ->save();
}

Functions

Name	Description
cas_post_update_8001	Add prevent normal login and restrict password management error messages.
cas_post_update_8002	Set default value for new gateway method config option.