cweagans\Composer\PatchEvent Class Reference

Inheritance diagram for cweagans\Composer\PatchEvent:

Collaboration diagram for cweagans\Composer\PatchEvent:

Public Member Functions
	__construct ($eventName, PackageInterface $package, $url, $description)
	Constructs a PatchEvent object. More...
	getPackage ()
	Returns the package that is patched. More...
	getUrl ()
	Returns the url of the patch. More...
	getDescription ()
	Returns the description of the patch. More...

Protected Attributes
	$package
	$url
	$description

Detailed Description

Definition at line 13 of file PatchEvent.php.

Constructor & Destructor Documentation

__construct()

cweagans\Composer\PatchEvent::__construct	(		$eventName,
		PackageInterface	$package,
			$url,
			$description
	)

Constructs a PatchEvent object.

Parameters

string	$eventName
PackageInterface	$package
string	$url
string	$description

Definition at line 36 of file PatchEvent.php.

References cweagans\Composer\PatchEvent\$description, and cweagans\Composer\PatchEvent\$url.

                                                                                         {
    parent::__construct($eventName);
    $this->package = $package;
    $this->url = $url;
    $this->description = $description;
  }

Member Function Documentation

getDescription()

cweagans\Composer\PatchEvent::getDescription

(

)

Returns the description of the patch.

Returns

string

Definition at line 66 of file PatchEvent.php.

References cweagans\Composer\PatchEvent\$description.

                                   {
    return $this->description;
  }

getPackage()

cweagans\Composer\PatchEvent::getPackage

(

)

Returns the package that is patched.

Returns

PackageInterface

Definition at line 48 of file PatchEvent.php.

References cweagans\Composer\PatchEvent\$package.

                               {
    return $this->package;
  }

getUrl()

cweagans\Composer\PatchEvent::getUrl

(

)

Returns the url of the patch.

Returns

string

Definition at line 57 of file PatchEvent.php.

References cweagans\Composer\PatchEvent\$url.

                           {
    return $this->url;
  }

Field Documentation

$description

string cweagans\Composer\PatchEvent::$description

protected

Definition at line 26 of file PatchEvent.php.

Referenced by cweagans\Composer\PatchEvent\__construct(), and cweagans\Composer\PatchEvent\getDescription().

$package

PackageInterface cweagans\Composer\PatchEvent::$package

protected

Definition at line 18 of file PatchEvent.php.

Referenced by cweagans\Composer\PatchEvent\getPackage().

$url

string cweagans\Composer\PatchEvent::$url

protected

Definition at line 22 of file PatchEvent.php.

Referenced by cweagans\Composer\PatchEvent\__construct(), and cweagans\Composer\PatchEvent\getUrl().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/cweagans/composer-patches/src/PatchEvent.php