public-mirrors
/
composer
mirror of https://github.com/composer/composer
1
0
Fork 0
Code

Add deprecation notice for the event type hint rewrites, refs #5238

pull/5248/head
Jordi Boggiano 2016-04-24 15:48:48 +01:00
parent aabe21d84d
commit a67b127a1a
2 changed files with 32 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/articles/scripts.md
View File

@ -150,11 +150,13 @@ class MyClass
} }
``` ```
## Event classes
When an event is fired, your PHP callback receives as first argument a When an event is fired, your PHP callback receives as first argument a
`Composer\EventDispatcher\Event` object. This object has a `getName()` method `Composer\EventDispatcher\Event` object. This object has a `getName()` method
that lets you retrieve event name. that lets you retrieve the event name.
Depending on the script types (see list above) you will get various event Depending on the [script types](#event-names) you will get various event
subclasses containing various getters with relevant data and associated subclasses containing various getters with relevant data and associated
objects: objects:

28
src/Composer/EventDispatcher/EventDispatcher.php
View File

@ -262,6 +262,14 @@ class EventDispatcher
*/ */
protected function checkListenerExpectedEvent($target, Event $event) protected function checkListenerExpectedEvent($target, Event $event)
{ {
if (in_array($event->getName(), array(
'init',
'command',
'pre-file-download',
), true)) {
return $event;
}
try { try {
$reflected = new \ReflectionParameter($target, 0); $reflected = new \ReflectionParameter($target, 0);
} catch (\Exception $e) { } catch (\Exception $e) {
@ -278,11 +286,13 @@ class EventDispatcher
// BC support // BC support
if (!$event instanceof $expected && $expected === 'Composer\Script\CommandEvent') { if (!$event instanceof $expected && $expected === 'Composer\Script\CommandEvent') {
trigger_error('The callback '.$this->serializeCallback($target).' declared at '.$reflected->getDeclaringFunction()->getFileName().' accepts a '.$expected.' but '.$event->getName().' events use a '.get_class($event).' instance. Please adjust your type hint accordingly, see https://getcomposer.org/doc/articles/scripts.md#event-classes', E_USER_DEPRECATED);
$event = new \Composer\Script\CommandEvent( $event = new \Composer\Script\CommandEvent(
$event->getName(), $event->getComposer(), $event->getIO(), $event->isDevMode(), $event->getArguments() $event->getName(), $event->getComposer(), $event->getIO(), $event->isDevMode(), $event->getArguments()
); );
} }
if (!$event instanceof $expected && $expected === 'Composer\Script\PackageEvent') { if (!$event instanceof $expected && $expected === 'Composer\Script\PackageEvent') {
trigger_error('The callback '.$this->serializeCallback($target).' declared at '.$reflected->getDeclaringFunction()->getFileName().' accepts a '.$expected.' but '.$event->getName().' events use a '.get_class($event).' instance. Please adjust your type hint accordingly, see https://getcomposer.org/doc/articles/scripts.md#event-classes', E_USER_DEPRECATED);
$event = new \Composer\Script\PackageEvent( $event = new \Composer\Script\PackageEvent(
$event->getName(), $event->getComposer(), $event->getIO(), $event->isDevMode(), $event->getName(), $event->getComposer(), $event->getIO(), $event->isDevMode(),
$event->getPolicy(), $event->getPool(), $event->getInstalledRepo(), $event->getRequest(), $event->getPolicy(), $event->getPool(), $event->getInstalledRepo(), $event->getRequest(),
@ -290,6 +300,7 @@ class EventDispatcher
); );
} }
if (!$event instanceof $expected && $expected === 'Composer\Script\Event') { if (!$event instanceof $expected && $expected === 'Composer\Script\Event') {
trigger_error('The callback '.$this->serializeCallback($target).' declared at '.$reflected->getDeclaringFunction()->getFileName().' accepts a '.$expected.' but '.$event->getName().' events use a '.get_class($event).' instance. Please adjust your type hint accordingly, see https://getcomposer.org/doc/articles/scripts.md#event-classes', E_USER_DEPRECATED);
$event = new \Composer\Script\Event( $event = new \Composer\Script\Event(
$event->getName(), $event->getComposer(), $event->getIO(), $event->isDevMode(), $event->getName(), $event->getComposer(), $event->getIO(), $event->isDevMode(),
$event->getArguments(), $event->getFlags() $event->getArguments(), $event->getFlags()
@ -299,6 +310,23 @@ class EventDispatcher
return $event; return $event;
} }
private function serializeCallback($cb)
{
if (is_array($cb) && count($cb) === 2) {
if (is_object($cb[0])) {
$cb[0] = get_class($cb[0]);
}
if (is_string($cb[0]) && is_string($cb[1])) {
$cb = implode('::', $cb);
}
}
if (is_string($cb)) {
return $cb;
}
return var_export($cb, true);
}
/** /**
* Add a listener for a particular event * Add a listener for a particular event
* *