From 8e79a3766d32a54401837131941d40aec453cb88 Mon Sep 17 00:00:00 2001 From: nevvermind Date: Sat, 30 May 2015 01:38:14 +0100 Subject: [PATCH] Added phpdocs + change to yoda comparison --- src/Composer/Package/Link.php | 49 ++++++++++++++++++++++++--- src/Composer/Plugin/PluginManager.php | 6 ++-- 2 files changed, 47 insertions(+), 8 deletions(-) diff --git a/src/Composer/Package/Link.php b/src/Composer/Package/Link.php index 5aba8b119..e09f163eb 100644 --- a/src/Composer/Package/Link.php +++ b/src/Composer/Package/Link.php @@ -21,20 +21,39 @@ use Composer\Package\LinkConstraint\LinkConstraintInterface; */ class Link { + /** + * @var string + */ protected $source; + + /** + * @var string + */ protected $target; + + /** + * @var LinkConstraintInterface|null + */ protected $constraint; + + /** + * @var string + */ protected $description; + + /** + * @var string|null + */ protected $prettyConstraint; /** * Creates a new package link. * - * @param string $source - * @param string $target - * @param LinkConstraintInterface $constraint Constraint applying to the target of this link - * @param string $description Used to create a descriptive string representation - * @param string $prettyConstraint + * @param string $source + * @param string $target + * @param LinkConstraintInterface|null $constraint Constraint applying to the target of this link + * @param string $description Used to create a descriptive string representation + * @param string|null $prettyConstraint */ public function __construct($source, $target, LinkConstraintInterface $constraint = null, $description = 'relates to', $prettyConstraint = null) { @@ -45,21 +64,34 @@ class Link $this->prettyConstraint = $prettyConstraint; } + /** + * @return string + */ public function getSource() { return $this->source; } + /** + * @return string + */ public function getTarget() { return $this->target; } + /** + * @return LinkConstraintInterface|null + */ public function getConstraint() { return $this->constraint; } + /** + * @throws \UnexpectedValueException If no pretty constraint was provided + * @return string + */ public function getPrettyConstraint() { if (null === $this->prettyConstraint) { @@ -69,11 +101,18 @@ class Link return $this->prettyConstraint; } + /** + * @return string + */ public function __toString() { return $this->source.' '.$this->description.' '.$this->target.' ('.$this->constraint.')'; } + /** + * @param PackageInterface $sourcePackage + * @return string + */ public function getPrettyString(PackageInterface $sourcePackage) { return $sourcePackage->getPrettyString().' '.$this->description.' '.$this->target.' '.$this->constraint->getPrettyString().''; diff --git a/src/Composer/Plugin/PluginManager.php b/src/Composer/Plugin/PluginManager.php index 6bf5d4cf5..14021dc45 100644 --- a/src/Composer/Plugin/PluginManager.php +++ b/src/Composer/Plugin/PluginManager.php @@ -113,14 +113,14 @@ class PluginManager */ public function loadRepository(RepositoryInterface $repo) { - foreach ($repo->getPackages() as $package) { + foreach ($repo->getPackages() as $package) { /** @var PackageInterface $package */ if ($package instanceof AliasPackage) { continue; } if ('composer-plugin' === $package->getType()) { $requiresComposer = null; - foreach ($package->getRequires() as $link) { - if ($link->getTarget() == 'composer-plugin-api') { + foreach ($package->getRequires() as $link) { /** @var Link $link */ + if ('composer-plugin-api' === $link->getTarget()) { $requiresComposer = $link->getConstraint(); } }