PreUpdateEventArgs.php in Plug 7

Namespace

Doctrine\Common\Persistence\Event

File

lib/doctrine/common/lib/Doctrine/Common/Persistence/Event/PreUpdateEventArgs.php

<?php

/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license. For more information, see
 * <http://www.doctrine-project.org>.
 */
namespace Doctrine\Common\Persistence\Event;

use Doctrine\Common\Persistence\ObjectManager;

/**
 * Class that holds event arguments for a preUpdate event.
 *
 * @author Guilherme Blanco <[e-mail]>
 * @author Roman Borschel <[e-mail]>
 * @author Benjamin Eberlei <[e-mail]>
 * @since  2.2
 */
class PreUpdateEventArgs extends LifecycleEventArgs {

  /**
   * @var array
   */
  private $entityChangeSet;

  /**
   * Constructor.
   *
   * @param object        $entity
   * @param ObjectManager $objectManager
   * @param array         $changeSet
   */
  public function __construct($entity, ObjectManager $objectManager, array &$changeSet) {
    parent::__construct($entity, $objectManager);
    $this->entityChangeSet =& $changeSet;
  }

  /**
   * Retrieves the entity changeset.
   *
   * @return array
   */
  public function getEntityChangeSet() {
    return $this->entityChangeSet;
  }

  /**
   * Checks if field has a changeset.
   *
   * @param string $field
   *
   * @return boolean
   */
  public function hasChangedField($field) {
    return isset($this->entityChangeSet[$field]);
  }

  /**
   * Gets the old value of the changeset of the changed field.
   *
   * @param string $field
   *
   * @return mixed
   */
  public function getOldValue($field) {
    $this
      ->assertValidField($field);
    return $this->entityChangeSet[$field][0];
  }

  /**
   * Gets the new value of the changeset of the changed field.
   *
   * @param string $field
   *
   * @return mixed
   */
  public function getNewValue($field) {
    $this
      ->assertValidField($field);
    return $this->entityChangeSet[$field][1];
  }

  /**
   * Sets the new value of this field.
   *
   * @param string $field
   * @param mixed  $value
   *
   * @return void
   */
  public function setNewValue($field, $value) {
    $this
      ->assertValidField($field);
    $this->entityChangeSet[$field][1] = $value;
  }

  /**
   * Asserts the field exists in changeset.
   *
   * @param string $field
   *
   * @return void
   *
   * @throws \InvalidArgumentException
   */
  private function assertValidField($field) {
    if (!isset($this->entityChangeSet[$field])) {
      throw new \InvalidArgumentException(sprintf('Field "%s" is not a valid field of the entity "%s" in PreUpdateEventArgs.', $field, get_class($this
        ->getEntity())));
    }
  }

}

Classes

Name	Description
PreUpdateEventArgs	Class that holds event arguments for a preUpdate event.