|
@@ -16,149 +16,12 @@ use Composer\Package\LinkConstraint\LinkConstraintInterface;
|
|
|
use Composer\Repository\RepositoryInterface;
|
|
|
|
|
|
/**
|
|
|
+ * Defines package metadata that is not necessarily needed for solving and installing packages
|
|
|
+ *
|
|
|
* @author Nils Adermann <naderman@naderman.de>
|
|
|
*/
|
|
|
-interface PackageInterface
|
|
|
+interface PackageInterface extends CorePackageInterface
|
|
|
{
|
|
|
- /**
|
|
|
- * Returns the package's name without version info, thus not a unique identifier
|
|
|
- *
|
|
|
- * @return string package name
|
|
|
- */
|
|
|
- public function getName();
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns the package's pretty (i.e. with proper case) name
|
|
|
- *
|
|
|
- * @return string package name
|
|
|
- */
|
|
|
- public function getPrettyName();
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns a set of names that could refer to this package
|
|
|
- *
|
|
|
- * No version or release type information should be included in any of the
|
|
|
- * names. Provided or replaced package names need to be returned as well.
|
|
|
- *
|
|
|
- * @return array An array of strings referring to this package
|
|
|
- */
|
|
|
- public function getNames();
|
|
|
-
|
|
|
- /**
|
|
|
- * Allows the solver to set an id for this package to refer to it.
|
|
|
- *
|
|
|
- * @param int $id
|
|
|
- */
|
|
|
- public function setId($id);
|
|
|
-
|
|
|
- /**
|
|
|
- * Retrieves the package's id set through setId
|
|
|
- *
|
|
|
- * @return int The previously set package id
|
|
|
- */
|
|
|
- public function getId();
|
|
|
-
|
|
|
- /**
|
|
|
- * Checks if the package matches the given constraint directly or through
|
|
|
- * provided or replaced packages
|
|
|
- *
|
|
|
- * @param string $name Name of the package to be matched
|
|
|
- * @param LinkConstraintInterface $constraint The constraint to verify
|
|
|
- * @return bool Whether this package matches the name and constraint
|
|
|
- */
|
|
|
- public function matches($name, LinkConstraintInterface $constraint);
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns whether the package is a development virtual package or a concrete one
|
|
|
- *
|
|
|
- * @return bool
|
|
|
- */
|
|
|
- public function isDev();
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns the package type, e.g. library
|
|
|
- *
|
|
|
- * @return string The package type
|
|
|
- */
|
|
|
- public function getType();
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns the package targetDir property
|
|
|
- *
|
|
|
- * @return string The package targetDir
|
|
|
- */
|
|
|
- public function getTargetDir();
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns the package extra data
|
|
|
- *
|
|
|
- * @return array The package extra data
|
|
|
- */
|
|
|
- public function getExtra();
|
|
|
-
|
|
|
- /**
|
|
|
- * Sets source from which this package was installed (source/dist).
|
|
|
- *
|
|
|
- * @param string $type source/dist
|
|
|
- */
|
|
|
- public function setInstallationSource($type);
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns source from which this package was installed (source/dist).
|
|
|
- *
|
|
|
- * @param string $type source/dist
|
|
|
- */
|
|
|
- public function getInstallationSource();
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns the repository type of this package, e.g. git, svn
|
|
|
- *
|
|
|
- * @return string The repository type
|
|
|
- */
|
|
|
- public function getSourceType();
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns the repository url of this package, e.g. git://github.com/naderman/composer.git
|
|
|
- *
|
|
|
- * @return string The repository url
|
|
|
- */
|
|
|
- public function getSourceUrl();
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns the repository reference of this package, e.g. master, 1.0.0 or a commit hash for git
|
|
|
- *
|
|
|
- * @return string The repository reference
|
|
|
- */
|
|
|
- public function getSourceReference();
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns the type of the distribution archive of this version, e.g. zip, tarball
|
|
|
- *
|
|
|
- * @return string The repository type
|
|
|
- */
|
|
|
- public function getDistType();
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns the url of the distribution archive of this version
|
|
|
- *
|
|
|
- * @return string
|
|
|
- */
|
|
|
- public function getDistUrl();
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns the reference of the distribution archive of this version, e.g. master, 1.0.0 or a commit hash for git
|
|
|
- *
|
|
|
- * @return string
|
|
|
- */
|
|
|
- public function getDistReference();
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns the sha1 checksum for the distribution archive of this version
|
|
|
- *
|
|
|
- * @return string
|
|
|
- */
|
|
|
- public function getDistSha1Checksum();
|
|
|
-
|
|
|
/**
|
|
|
* Returns the scripts of this package
|
|
|
*
|
|
@@ -166,102 +29,6 @@ interface PackageInterface
|
|
|
*/
|
|
|
public function getScripts();
|
|
|
|
|
|
- /**
|
|
|
- * Returns the version of this package
|
|
|
- *
|
|
|
- * @return string version
|
|
|
- */
|
|
|
- public function getVersion();
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns the pretty (i.e. non-normalized) version string of this package
|
|
|
- *
|
|
|
- * @return string version
|
|
|
- */
|
|
|
- public function getPrettyVersion();
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns the stability of this package: one of (dev, alpha, beta, RC, stable)
|
|
|
- *
|
|
|
- * @return string
|
|
|
- */
|
|
|
- public function getStability();
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns the package license, e.g. MIT, BSD, GPL
|
|
|
- *
|
|
|
- * @return array The package licenses
|
|
|
- */
|
|
|
- public function getLicense();
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns a set of links to packages which need to be installed before
|
|
|
- * this package can be installed
|
|
|
- *
|
|
|
- * @return array An array of package links defining required packages
|
|
|
- */
|
|
|
- public function getRequires();
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns a set of links to packages which must not be installed at the
|
|
|
- * same time as this package
|
|
|
- *
|
|
|
- * @return array An array of package links defining conflicting packages
|
|
|
- */
|
|
|
- public function getConflicts();
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns a set of links to virtual packages that are provided through
|
|
|
- * this package
|
|
|
- *
|
|
|
- * @return array An array of package links defining provided packages
|
|
|
- */
|
|
|
- public function getProvides();
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns a set of links to packages which can alternatively be
|
|
|
- * satisfied by installing this package
|
|
|
- *
|
|
|
- * @return array An array of package links defining replaced packages
|
|
|
- */
|
|
|
- public function getReplaces();
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns a set of links to packages which are required to develop
|
|
|
- * this package. These are installed if in dev mode.
|
|
|
- *
|
|
|
- * @return array An array of package links defining packages required for development
|
|
|
- */
|
|
|
- public function getDevRequires();
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns a set of package names and reasons why they are useful in
|
|
|
- * combination with this package.
|
|
|
- *
|
|
|
- * @return array An array of package suggestions with descriptions
|
|
|
- */
|
|
|
- public function getSuggests();
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns an associative array of autoloading rules
|
|
|
- *
|
|
|
- * {"<type>": {"<namespace": "<directory>"}}
|
|
|
- *
|
|
|
- * Type is either "psr-0" or "pear". Namespaces are mapped to directories
|
|
|
- * for autoloading using the type specified.
|
|
|
- *
|
|
|
- * @return array Mapping of autoloading rules
|
|
|
- */
|
|
|
- public function getAutoload();
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns a list of directories which should get added to PHP's
|
|
|
- * include path.
|
|
|
- *
|
|
|
- * @return array
|
|
|
- */
|
|
|
- public function getIncludePaths();
|
|
|
-
|
|
|
/**
|
|
|
* Returns an array of repositories
|
|
|
*
|
|
@@ -272,18 +39,11 @@ interface PackageInterface
|
|
|
public function getRepositories();
|
|
|
|
|
|
/**
|
|
|
- * Stores a reference to the repository that owns the package
|
|
|
- *
|
|
|
- * @param RepositoryInterface $repository
|
|
|
- */
|
|
|
- public function setRepository(RepositoryInterface $repository);
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns a reference to the repository that owns the package
|
|
|
+ * Returns the package license, e.g. MIT, BSD, GPL
|
|
|
*
|
|
|
- * @return RepositoryInterface
|
|
|
+ * @return array The package licenses
|
|
|
*/
|
|
|
- public function getRepository();
|
|
|
+ public function getLicense();
|
|
|
|
|
|
/**
|
|
|
* Returns the release date of the package
|
|
@@ -306,13 +66,6 @@ interface PackageInterface
|
|
|
*/
|
|
|
public function getDescription();
|
|
|
|
|
|
- /**
|
|
|
- * Returns the package binaries
|
|
|
- *
|
|
|
- * @return array
|
|
|
- */
|
|
|
- public function getBinaries();
|
|
|
-
|
|
|
/**
|
|
|
* Returns the package homepage
|
|
|
*
|
|
@@ -329,41 +82,6 @@ interface PackageInterface
|
|
|
*/
|
|
|
public function getAuthors();
|
|
|
|
|
|
- /**
|
|
|
- * Returns a version this package should be aliased to
|
|
|
- *
|
|
|
- * @return string
|
|
|
- */
|
|
|
- public function getAlias();
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns a non-normalized version this package should be aliased to
|
|
|
- *
|
|
|
- * @return string
|
|
|
- */
|
|
|
- public function getPrettyAlias();
|
|
|
-
|
|
|
- /**
|
|
|
- * Returns package unique name, constructed from name and version.
|
|
|
- *
|
|
|
- * @return string
|
|
|
- */
|
|
|
- public function getUniqueName();
|
|
|
-
|
|
|
- /**
|
|
|
- * Converts the package into a readable and unique string
|
|
|
- *
|
|
|
- * @return string
|
|
|
- */
|
|
|
- public function __toString();
|
|
|
-
|
|
|
- /**
|
|
|
- * Converts the package into a pretty readable string
|
|
|
- *
|
|
|
- * @return string
|
|
|
- */
|
|
|
- public function getPrettyString();
|
|
|
-
|
|
|
/**
|
|
|
* Returns the support information
|
|
|
*
|