class AcsfVariablesCommands in Acquia Cloud Site Factory Connector 8.2

Provides drush commands for the acsf_variables module.

Hierarchy

• class \Drupal\acsf_variables\Commands\AcsfVariablesCommands extends \Drush\Commands\DrushCommands

1 string reference to 'AcsfVariablesCommands'

drush.services.yml in acsf_variables/drush.services.yml

acsf_variables/drush.services.yml

1 service uses AcsfVariablesCommands

acsf_variables.commands in acsf_variables/drush.services.yml

\Drupal\acsf_variables\Commands\AcsfVariablesCommands

File

acsf_variables/src/Commands/AcsfVariablesCommands.php, line 12

Namespace

Drupal\acsf_variables\Commands

class AcsfVariablesCommands extends DrushCommands {

  /**
   * Retrieves a named ACSF variable.
   *
   * @param string $name
   *   The name of the variable to retrieve.
   * @param array $options
   *   The command options supplied to the executed command.
   *
   * @return \Consolidation\OutputFormatters\StructuredData\PropertyList
   *   ProperyList of the variable.
   *
   * @throws \Drupal\acsf\AcsfException
   *   If the variable does not exist with the provided name or the
   *   acsf_variables module isn't enabled.
   * @throws \InvalidArgumentException
   *   If one or more arguments are missing or invalid.
   *
   * @command acsf-vget
   * @option exact Only retrieve the exact variable name specified.
   */
  public function vget($name, array $options = [
    'exact' => FALSE,
  ]) {
    if (!\Drupal::moduleHandler()
      ->moduleExists('acsf_variables')) {
      throw new AcsfException(dt('The acsf_variables module must be enabled.'));
    }
    if (empty($name)) {
      throw new \InvalidArgumentException(dt('You must provide the name of the variable to retrieve as the first argument.'));
    }
    $exact = $options['exact'];
    if ($exact) {
      if (($value = \Drupal::service('acsf.variable_storage')
        ->get($name)) && !is_null($value)) {
        $variables[$name] = $value;
      }
    }
    else {
      $variables = \Drupal::service('acsf.variable_storage')
        ->getMatch($name);
    }
    if (!empty($variables)) {
      return new PropertyList($variables);
    }
    else {
      throw new AcsfException(dt('@name not found.', [
        '@name' => $name,
      ]));
    }
  }

  /**
   * Sets a named ACSF variable with an optional group.
   *
   * @param string $name
   *   The name of the variable to set.
   * @param mixed $value
   *   The value of the variable to set.
   * @param array $options
   *   The command options supplied to the executed command.
   *
   * @throws \Drupal\acsf\AcsfException
   *   If the variable does not exist with the provided name or the
   *   acsf_variables module isn't enabled.
   * @throws \InvalidArgumentException
   *   If one or more arguments are missing or invalid.
   *
   * @command acsf-vset
   * @option group An optional group name for the variable.
   */
  public function vset($name, $value, array $options = [
    'group' => NULL,
  ]) {
    if (!\Drupal::moduleHandler()
      ->moduleExists('acsf_variables')) {
      throw new AcsfException(dt('The acsf_variables module must be enabled.'));
    }
    if (empty($name)) {
      throw new \InvalidArgumentException(dt('You must provide the name of the variable to set as the first argument.'));
    }
    if (empty($value)) {
      throw new \InvalidArgumentException(dt('You must provide the value of the variable to set as the second argument.'));
    }
    if (\Drupal::service('acsf.variable_storage')
      ->set($name, $value, $options['group'])) {
      $this
        ->output()
        ->writeln(dt('@name was set to !value', [
        '@name' => $name,
        '!value' => $value,
      ]));
    }
    else {
      throw new AcsfException(dt('The @name variable could not be set.'));
    }
  }

  /**
   * Retrieves a group of variables.
   *
   * @param string $group
   *   The group name of the variable to retrieve.
   *
   * @return \Consolidation\OutputFormatters\StructuredData\PropertyList
   *   PropertyList of the variables.
   *
   * @throws \Drupal\acsf\AcsfException
   *   If the variable does not exist with the provided name or the
   *   acsf_variables module isn't enabled.
   * @throws \InvalidArgumentException
   *   If the argument is missing or invalid.
   *
   * @command acsf-vget-group
   */
  public function vgetGroup($group) {
    if (!\Drupal::moduleHandler()
      ->moduleExists('acsf_variables')) {
      throw new AcsfException(dt('The acsf_variables module must be enabled.'));
    }
    if (empty($group)) {
      throw new \InvalidArgumentException(dt('You must provide the group name of the variables to retrieve as the first argument.'));
    }
    if ($data = \Drupal::service('acsf.variable_storage')
      ->getGroup($group)) {
      return new PropertyList($data);
    }
    else {
      throw new AcsfException(dt('@group group not found.', [
        '@group' => $group,
      ]));
    }
  }

  /**
   * Deletes a named variable.
   *
   * @param string $name
   *   The name of the variable to delete.
   *
   * @throws \Drupal\acsf\AcsfException
   *   If the variable does not exist with the provided name or the
   *   acsf_variables module isn't enabled.
   * @throws \InvalidArgumentException
   *   If the argument is missing or invalid.
   *
   * @command acsf-vdel
   */
  public function vdel($name) {
    if (!\Drupal::moduleHandler()
      ->moduleExists('acsf_variables')) {
      throw new AcsfException(dt('The acsf_variables module must be enabled.'));
    }
    if (empty($name)) {
      throw new \InvalidArgumentException(dt('You must provide the name of the variable to delete as the first argument.'));
    }
    $storage = \Drupal::service('acsf.variable_storage');
    if ($variable = $storage
      ->get($name)) {
      if ($storage
        ->delete($name)) {
        $this
          ->output()
          ->writeln(dt('@name was deleted.', [
          '@name' => $name,
        ]));
      }
      else {
        throw new AcsfException(dt('Unable to delete the @name variable.', [
          '@name' => $name,
        ]));
      }
    }
    else {
      throw new AcsfException(dt('@name not found.', [
        '@name' => $name,
      ]));
    }
  }

  /**
   * Retrieves info about a site.
   *
   * @return \Consolidation\OutputFormatters\StructuredData\PropertyList
   *   The site info list in var_export format.
   *
   * @command acsf-info
   */
  public function info() {
    $data = \Drupal::service('acsf.variable_storage')
      ->get('acsf_site_info', []);
    return new PropertyList($data);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AcsfVariablesCommands::info	public	function	Retrieves info about a site.
AcsfVariablesCommands::vdel	public	function	Deletes a named variable.
AcsfVariablesCommands::vget	public	function	Retrieves a named ACSF variable.
AcsfVariablesCommands::vgetGroup	public	function	Retrieves a group of variables.
AcsfVariablesCommands::vset	public	function	Sets a named ACSF variable with an optional group.