Reduce memory usage by only loading packages that are actually needed, fixes #456
Jordi Boggiano
12 years ago
parent
f08c748658
commit
c8a685be6b
@ -0,0 +1,298 @@
|
||||
<?php
|
||||
|
||||
/*
|
||||
* This file is part of Composer.
|
||||
*
|
||||
* (c) Nils Adermann <naderman@naderman.de>
|
||||
* Jordi Boggiano <j.boggiano@seld.be>
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace Composer\Package;
|
||||
|
||||
use Composer\Package\LinkConstraint\LinkConstraintInterface;
|
||||
use Composer\Repository\RepositoryInterface;
|
||||
|
||||
/**
|
||||
* Defines the essential information a package has that is used during solving/installation
|
||||
*
|
||||
* @author Jordi Boggiano <j.boggiano@seld.be>
|
||||
*/
|
||||
interface 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();
|
||||
|
||||
/**
|
||||
* 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 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 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();
|
||||
|
||||
/**
|
||||
* 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
|
||||
*
|
||||
* @return RepositoryInterface
|
||||
*/
|
||||
public function getRepository();
|
||||
|
||||
/**
|
||||
* Returns the package binaries
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function getBinaries();
|
||||
|
||||
/**
|
||||
* 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();
|
||||
}
|
||||
@ -0,0 +1,49 @@
|
||||
<?php
|
||||
|
||||
/*
|
||||
* This file is part of Composer.
|
||||
*
|
||||
* (c) Nils Adermann <naderman@naderman.de>
|
||||
* Jordi Boggiano <j.boggiano@seld.be>
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace Composer\Package;
|
||||
|
||||
use Composer\Package\LinkConstraint\LinkConstraintInterface;
|
||||
use Composer\Repository\RepositoryInterface;
|
||||
|
||||
/**
|
||||
* Defines additional fields that are only needed for the root package
|
||||
*
|
||||
* @author Jordi Boggiano <j.boggiano@seld.be>
|
||||
*/
|
||||
interface RootPackageInterface extends PackageInterface
|
||||
{
|
||||
/**
|
||||
* Returns the minimum stability of the package
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getMinimumStability();
|
||||
|
||||
/**
|
||||
* Returns the stability flags to apply to dependencies
|
||||
*
|
||||
* array('foo/bar' => 'dev')
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function getStabilityFlags();
|
||||
|
||||
/**
|
||||
* Returns a set of package names and source references that must be enforced on them
|
||||
*
|
||||
* array('foo/bar' => 'abcd1234')
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function getReferences();
|
||||
}
|
||||
@ -0,0 +1,30 @@
|
||||
<?php
|
||||
|
||||
/*
|
||||
* This file is part of Composer.
|
||||
*
|
||||
* (c) Nils Adermann <naderman@naderman.de>
|
||||
* Jordi Boggiano <j.boggiano@seld.be>
|
||||
*
|
||||
* For the full copyright and license information, please view the LICENSE
|
||||
* file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace Composer\Repository;
|
||||
|
||||
use Composer\Package\PackageInterface;
|
||||
|
||||
/**
|
||||
* @author Jordi Boggiano <j.boggiano@seld.be>
|
||||
*/
|
||||
interface StreamableRepositoryInterface extends RepositoryInterface
|
||||
{
|
||||
/**
|
||||
* Return partial package data without loading them all to save on memory
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function getMinimalPackages();
|
||||
|
||||
public function loadPackage(array $data, $id);
|
||||
}
|
||||
Loading…
Reference in New Issue