public static function Nodes::modifySimpleFieldValue in Hook Update Deploy Tools 8

Same name and namespace in other branches

7 src/Nodes.php \HookUpdateDeployTools\Nodes::modifySimpleFieldValue()

Programatically allows for the alteration of 'simple fields'.

These fields include: 'title', 'status', 'language', 'tnid', 'sticky', 'promote', 'comment', 'uid', 'translate'

Parameters

int $nid: The nid of the node.

string $field: The machine name of the simple field.

string $value: Value that you want to change to.

Return value

string Messsage indicating the field has been changed

Throws

\HudtException Calls the update a failure, preventing it from registering the update_N.

File

src/Nodes.php, line 36

Class

Nodes: Public method for changing nodes programatically.

Namespace

HookUpdateDeployTools

Code

public static function modifySimpleFieldValue($nid, $field, $value) {

  // t() might not be available during install, so get it reliably.
  $t = get_t();

  // Which fields are simple?
  $simple_fields = array(
    'title',
    'status',
    'language',
    'tnid',
    'sticky',
    'promote',
    'comment',
    'uid',
    'translate',
  );

  // Is it a simple field?
  if (in_array($field, $simple_fields)) {
    $node = node_load($nid);

    // Is there a node?
    if (!empty($node)) {

      // Does the field exist on the node?
      if (isset($node->{$field})) {

        // Set the field value.
        $node->{$field} = $value;

        // Save the node.
        $node = node_save($node);

        // Set the message.
        $variables = array(
          '!nid' => $node->nid,
          '!fieldname' => $field,
          '!value' => $value,
        );
        $message = "On Node !nid, the field value of '!fieldname' was changed to '!value'.";

        // Success, return the message.
        return Message::make($message, $variables, WATCHDOG_INFO);
      }
      else {

        // The field does not exist.
        $message = "The field '!fieldname' does not exist on the node !nid so it could not be altered.";
        $variables = array(
          '!fieldname' => $field,
          '!nid' => $nid,
        );
        Message::make($message, $variables, WATCHDOG_ERROR);
        throw new HudtException($message, $variables, WATCHDOG_ERROR, FALSE);
      }
    }
    else {

      // The node does not exist.
      $message = "The node '!nid' does not exist, so can not be updated.";
      $variables = array(
        '!nid' => $nid,
      );
      Message::make($message, $variables, WATCHDOG_ERROR);
      throw new HudtException($message, $variables, WATCHDOG_ERROR, FALSE);
    }
  }
  else {

    // The field is not a simple field so can not use this method.
    $message = "The field '!fieldname' is not a simple field and can not be changed by the method ::modifySimpleFieldValue.";
    $variables = array(
      '!fieldname' => $field,
    );
    Message::make($message, $variables, WATCHDOG_ERROR);
    throw new HudtException($message, $variables, WATCHDOG_ERROR, FALSE);
  }
}

You are here