Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing use statement #9699

Merged
merged 2 commits into from
Apr 30, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
44 changes: 32 additions & 12 deletions docs/en/reference/events.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,9 @@ array of events it should be subscribed to.
.. code-block:: php

<?php
class TestEventSubscriber implements \Doctrine\Common\EventSubscriber
use Doctrine\Common\EventSubscriber;

class TestEventSubscriber implements EventSubscriber
{
public $preFooInvoked = false;

Expand Down Expand Up @@ -211,7 +213,6 @@ specific to a particular entity class's lifecycle.
.. code-block:: attribute

<?php

use Doctrine\DBAL\Types\Types;
use Doctrine\Persistence\Event\LifecycleEventArgs;

Expand Down Expand Up @@ -245,7 +246,6 @@ specific to a particular entity class's lifecycle.
.. code-block:: annotation

<?php

use Doctrine\Persistence\Event\LifecycleEventArgs;

/**
Expand Down Expand Up @@ -504,7 +504,6 @@ result in an infinite loop.
.. code-block:: php

<?php

use Doctrine\ORM\Event\PreFlushEventArgs;

class PreFlushExampleListener
Expand Down Expand Up @@ -590,7 +589,6 @@ This event is not a lifecycle callback.
.. code-block:: php

<?php

use Doctrine\ORM\Event\PostFlushEventArgs;

class PostFlushExampleListener
Expand Down Expand Up @@ -637,6 +635,8 @@ A simple example for this event looks like:
.. code-block:: php

<?php
use Doctrine\ORM\Event\PreUpdateEventArgs;

class NeverAliceOnlyBobListener
{
public function preUpdate(PreUpdateEventArgs $eventArgs)
Expand All @@ -656,6 +656,8 @@ lifecycle callback when there are expensive validations to call:
.. code-block:: php

<?php
use Doctrine\ORM\Event\PreUpdateEventArgs;

class ValidCreditCardListener
{
public function preUpdate(PreUpdateEventArgs $eventArgs)
Expand Down Expand Up @@ -807,6 +809,8 @@ An ``Entity Listener`` could be any class, by default it should be a class with
.. code-block:: php

<?php
use Doctrine\ORM\Event\PreUpdateEventArgs;

class UserListener
{
public function preUpdate(User $user, PreUpdateEventArgs $event)
Expand All @@ -823,6 +827,10 @@ you need to map the listener method using the event type mapping:
.. code-block:: php

<?php
use Doctrine\ORM\Event\LifecycleEventArgs;
use Doctrine\ORM\Event\PreUpdateEventArgs;
use Doctrine\ORM\Event\PreFlushEventArgs;

class UserListener
{
/** @PrePersist */
Expand Down Expand Up @@ -907,6 +915,8 @@ Specifying an entity listener instance :
.. code-block:: php

<?php
use Doctrine\ORM\Event\PreUpdateEventArgs;

// User.php

/** @Entity @EntityListeners({"UserListener"}) */
Expand All @@ -933,12 +943,14 @@ Specifying an entity listener instance :
$listener = $container->get('user_listener');
$em->getConfiguration()->getEntityListenerResolver()->register($listener);

Implementing your own resolver :
Implementing your own resolver:

.. code-block:: php

<?php
class MyEntityListenerResolver extends \Doctrine\ORM\Mapping\DefaultEntityListenerResolver
use Doctrine\ORM\Mapping\DefaultEntityListenerResolver;

class MyEntityListenerResolver extends DefaultEntityListenerResolver
{
public function __construct($container)
{
Expand Down Expand Up @@ -972,13 +984,15 @@ This event is not a lifecycle callback.
.. code-block:: php

<?php
use Doctrine\ORM\Event\LoadClassMetadataEventArgs;

$test = new TestEventListener();
$evm = $em->getEventManager();
$evm->addEventListener(Doctrine\ORM\Events::loadClassMetadata, $test);

class TestEventListener
{
public function loadClassMetadata(\Doctrine\ORM\Event\LoadClassMetadataEventArgs $eventArgs)
public function loadClassMetadata(LoadClassMetadataEventArgs $eventArgs)
{
$classMetadata = $eventArgs->getClassMetadata();
$fieldMapping = array(
Expand Down Expand Up @@ -1011,13 +1025,16 @@ instance and class metadata.
.. code-block:: php

<?php
use Doctrine\ORM\Tools\ToolEvents;
use Doctrine\ORM\Tools\Event\GenerateSchemaTableEventArgs;

$test = new TestEventListener();
$evm = $em->getEventManager();
$evm->addEventListener(\Doctrine\ORM\Tools\ToolEvents::postGenerateSchemaTable, $test);
$evm->addEventListener(ToolEvents::postGenerateSchemaTable, $test);

class TestEventListener
{
public function postGenerateSchemaTable(\Doctrine\ORM\Tools\Event\GenerateSchemaTableEventArgs $eventArgs)
public function postGenerateSchemaTable(GenerateSchemaTableEventArgs $eventArgs)
{
$classMetadata = $eventArgs->getClassMetadata();
$schema = $eventArgs->getSchema();
Expand All @@ -1035,13 +1052,16 @@ and the EntityManager.
.. code-block:: php

<?php
use Doctrine\ORM\Tools\ToolEvents;
use Doctrine\ORM\Tools\Event\GenerateSchemaEventArgs;

$test = new TestEventListener();
$evm = $em->getEventManager();
$evm->addEventListener(\Doctrine\ORM\Tools\ToolEvents::postGenerateSchema, $test);
$evm->addEventListener(ToolEvents::postGenerateSchema, $test);

class TestEventListener
{
public function postGenerateSchema(\Doctrine\ORM\Tools\Event\GenerateSchemaEventArgs $eventArgs)
public function postGenerateSchema(GenerateSchemaEventArgs $eventArgs)
{
$schema = $eventArgs->getSchema();
$em = $eventArgs->getEntityManager();
Expand Down