* * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Fxp\Composer\AssetPlugin\Converter; use Fxp\Composer\AssetPlugin\Type\AssetTypeInterface; /** * Abstract class for converter for asset package to composer package. * * @author François Pluchino */ abstract class AbstractPackageConverter implements PackageConverterInterface { /** * @var AssetTypeInterface */ protected $assetType; /** * Constructor. * * @param AssetTypeInterface $assetType */ public function __construct(AssetTypeInterface $assetType) { $this->assetType = $assetType; } /** * {@inheritdoc} */ public function convert(array $data, array &$vcsRepos = array()) { $keys = $this->getMapKeys(); $dependencies = $this->getMapDependencies(); $extras = $this->getMapExtras(); return $this->convertData($data, $keys, $dependencies, $extras, $vcsRepos); } /** * Converts the all keys (keys, dependencies and extra keys). * * @param array $asset The asset data * @param array $keys The map of asset key and composer key * @param array $dependencies The map of asset dependency key and composer dependency key * @param array $extras The map of asset key and composer extra key * @param array $vcsRepos The list of new vcs configs * * @return array The composer package converted */ protected function convertData(array $asset, array $keys, array $dependencies, array $extras, array &$vcsRepos = array()) { $composer = array(); foreach ($keys as $assetKey => $composerKey) { $this->convertKey($asset, $assetKey, $composer, $composerKey); } foreach ($dependencies as $assetKey => $composerKey) { $this->convertDependencies($asset, $assetKey, $composer, $composerKey, $vcsRepos); } foreach ($extras as $assetKey => $composerKey) { $this->convertExtraKey($asset, $assetKey, $composer, $composerKey); } return $composer; } /** * Converts the simple key of package. * * @param array $asset The asset data * @param string $assetKey The asset key * @param array $composer The composer data * @param string|array $composerKey The composer key or array with composer key name and closure * * @throws \InvalidArgumentException When the 'composerKey' argument of asset packager converter is not an string or an array with the composer key and closure */ protected function convertKey(array $asset, $assetKey, array &$composer, $composerKey) { if (is_array($composerKey)) { PackageUtil::convertArrayKey($asset, $assetKey, $composer, $composerKey); } else { PackageUtil::convertStringKey($asset, $assetKey, $composer, $composerKey); } } /** * Converts the extra key of package. * * @param array $asset The asset data * @param string $assetKey The asset extra key * @param array $composer The composer data * @param string|array $composerKey The composer extra key or array with composer extra key name and closure * @param string $extraKey The extra key name */ protected function convertExtraKey(array $asset, $assetKey, array &$composer, $composerKey, $extraKey = 'extra') { $extra = isset($composer[$extraKey]) ? $composer[$extraKey] : array(); $this->convertKey($asset, $assetKey, $extra, $composerKey); if (count($extra) > 0) { $composer[$extraKey] = $extra; } } /** * Converts simple key of package. * * @param array $asset The asset data * @param string $assetKey The asset key of dependencies * @param array $composer The composer data * @param string $composerKey The composer key of dependencies * @param array $vcsRepos The list of new vcs configs */ protected function convertDependencies(array $asset, $assetKey, array &$composer, $composerKey, array &$vcsRepos = array()) { if (isset($asset[$assetKey]) && is_array($asset[$assetKey])) { $newDependencies = array(); foreach ($asset[$assetKey] as $dependency => $version) { list($dependency, $version) = $this->convertDependency($dependency, $version, $vcsRepos, $composer); $version = $this->assetType->getVersionConverter()->convertRange($version); if (0 !== strpos($version, $dependency)) { $newDependencies[$this->assetType->getComposerVendorName().'/'.$dependency] = $version; } } $composer[$composerKey] = $newDependencies; } } /** * Convert the . * * @param string $dependency The dependency * @param string $version The version * @param array $vcsRepos The list of new vcs configs * @param array $composer The partial composer data * * @return string[] The new dependency and the new version */ protected function convertDependency($dependency, $version, array &$vcsRepos = array(), array $composer) { list($dependency, $version) = PackageUtil::checkUrlVersion($this->assetType, $dependency, $version, $vcsRepos, $composer); list($dependency, $version) = PackageUtil::checkAliasVersion($this->assetType, $dependency, $version); list($dependency, $version) = PackageUtil::convertDependencyVersion($this->assetType, $dependency, $version); return array($dependency, $version); } /** * {@inheritdoc} */ protected function getMapKeys() { return array(); } /** * Get the map conversion of dependencies. * * @return array */ protected function getMapDependencies() { return array( 'dependencies' => 'require', 'devDependencies' => 'require-dev', ); } /** * {@inheritdoc} */ protected function getMapExtras() { return array(); } }