LifecycleEventArgs.php in Zircon Profile 8.0

Namespace

Doctrine\Common\Persistence\Event

File

vendor/doctrine/common/lib/Doctrine/Common/Persistence/Event/LifecycleEventArgs.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\EventArgs;
use Doctrine\Common\Persistence\ObjectManager;

/**
 * Lifecycle Events are triggered by the UnitOfWork during lifecycle transitions
 * of entities.
 *
 * @link   www.doctrine-project.org
 * @since  2.2
 * @author Roman Borschel <[e-mail]>
 * @author Benjamin Eberlei <[e-mail]>
 */
class LifecycleEventArgs extends EventArgs {

  /**
   * @var ObjectManager
   */
  private $objectManager;

  /**
   * @var object
   */
  private $object;

  /**
   * Constructor.
   *
   * @param object        $object
   * @param ObjectManager $objectManager
   */
  public function __construct($object, ObjectManager $objectManager) {
    $this->object = $object;
    $this->objectManager = $objectManager;
  }

  /**
   * Retrieves the associated entity.
   *
   * @deprecated
   *
   * @return object
   */
  public function getEntity() {
    return $this->object;
  }

  /**
   * Retrieves the associated object.
   *
   * @return object
   */
  public function getObject() {
    return $this->object;
  }

  /**
   * Retrieves the associated ObjectManager.
   *
   * @return ObjectManager
   */
  public function getObjectManager() {
    return $this->objectManager;
  }

}

Classes

Name	Description
LifecycleEventArgs	Lifecycle Events are triggered by the UnitOfWork during lifecycle transitions of entities.