class PxcmsInstaller

Hierarchy

class \Composer\Installers\BaseInstaller
- class \Composer\Installers\PxcmsInstaller extends \Composer\Installers\BaseInstaller

Expanded class hierarchy of PxcmsInstaller

File

vendor/composer/installers/src/Composer/Installers/PxcmsInstaller.php, line 5

Namespace

View source

class PxcmsInstaller extends BaseInstaller {
    
    /** @var array<string, string> */
    protected $locations = array(
        'module' => 'app/Modules/{$name}/',
        'theme' => 'themes/{$name}/',
    );
    
    /**
     * Format package name.
     */
    public function inflectPackageVars(array $vars) : array {
        if ($vars['type'] === 'pxcms-module') {
            return $this->inflectModuleVars($vars);
        }
        if ($vars['type'] === 'pxcms-theme') {
            return $this->inflectThemeVars($vars);
        }
        return $vars;
    }
    
    /**
     * For package type pxcms-module, cut off a trailing '-plugin' if present.
     *
     * @param array<string, string> $vars
     * @return array<string, string>
     */
    protected function inflectModuleVars(array $vars) : array {
        $vars['name'] = str_replace('pxcms-', '', $vars['name']);
        // strip out pxcms- just incase (legacy)
        $vars['name'] = str_replace('module-', '', $vars['name']);
        // strip out module-
        $vars['name'] = $this->pregReplace('/-module$/', '', $vars['name']);
        // strip out -module
        $vars['name'] = str_replace('-', '_', $vars['name']);
        // make -'s be _'s
        $vars['name'] = ucwords($vars['name']);
        // make module name camelcased
        return $vars;
    }
    
    /**
     * For package type pxcms-module, cut off a trailing '-plugin' if present.
     *
     * @param array<string, string> $vars
     * @return array<string, string>
     */
    protected function inflectThemeVars(array $vars) : array {
        $vars['name'] = str_replace('pxcms-', '', $vars['name']);
        // strip out pxcms- just incase (legacy)
        $vars['name'] = str_replace('theme-', '', $vars['name']);
        // strip out theme-
        $vars['name'] = $this->pregReplace('/-theme$/', '', $vars['name']);
        // strip out -theme
        $vars['name'] = str_replace('-', '_', $vars['name']);
        // make -'s be _'s
        $vars['name'] = ucwords($vars['name']);
        // make module name camelcased
        return $vars;
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
BaseInstaller::$composer	protected	property	@var Composer
BaseInstaller::$io	protected	property	@var IOInterface
BaseInstaller::$package	protected	property	@var PackageInterface
BaseInstaller::getInstallPath	public	function	Return the install path based on package type.		2
BaseInstaller::getLocations	public	function	Gets the installer's locations		2
BaseInstaller::mapCustomInstallPaths	protected	function	Search through a passed paths array for a custom install path.
BaseInstaller::pregReplace	protected	function
BaseInstaller::templatePath	protected	function	Replace vars in a path		1
BaseInstaller::__construct	public	function	Initializes base installer.
PxcmsInstaller::$locations	protected	property	@var array<string, string>	Overrides BaseInstaller::$locations
PxcmsInstaller::inflectModuleVars	protected	function	For package type pxcms-module, cut off a trailing '-plugin' if present.
PxcmsInstaller::inflectPackageVars	public	function	Format package name.	Overrides BaseInstaller::inflectPackageVars
PxcmsInstaller::inflectThemeVars	protected	function	For package type pxcms-module, cut off a trailing '-plugin' if present.