SilverLeague\Console\Framework\Utility\ObjectUtilities

Complexity

Total Complexity

13

Size/Duplication

Total Lines	67
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getReflection()	0	8	2
A	getModuleName()	0	16	4
B	getModuleComposerConfiguration()	0	19	7

<?php

namespace SilverLeague\Console\Framework\Utility;

use ReflectionClass;
use ReflectionException;

/**
 * Utility methods for handling SilverStripe Objects
 *
 * @package silverstripe-console
 * @author  Robbie Averill <robbie@averill.co.nz>
 */
trait ObjectUtilities
{
    /**
     * Get a ReflectionClass from the given class name
     *
     * @param  string $className
     * @return ReflectionClass
     */
    public function getReflection($className)
    {
        try {
            return new ReflectionClass($className);
        } catch (ReflectionException $ex) {
            return false;
        }
    }

    /**
     * Given a class name, find and return which module it belongs to
     *
     * @param  string $className
     * @return string
     */
    public function getModuleName($className)
    {
        $class = $this->getReflection($className);
        if (!$class) {
            return '';
        }

        $relativePath = ltrim(substr($class->getFileName(), strlen(SILVERSTRIPE_ROOT_DIR)), '/');
        $folders = explode('/', $relativePath);
        if (empty($folder = array_shift($folders))) {
            return '';
        }

        $composerConfig = $this->getModuleComposerConfiguration($folder);
        return !empty($composerConfig['name']) ? $composerConfig['name'] : '';
    }

    /**
     * Given a folder name, load a possible composer.json configuration from inside it. This method will handle
     * the main project folder e.g. "mysite" by looking in the root folder rather than the folder itself.
     *
     * @param  string $folderName
     * @return array
     */
    public function getModuleComposerConfiguration($folderName)
    {
        global $project;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

        if (!empty($project) && $project === $folderName) {
            $folderName = '.';
        }

        $filePath = $folderName . '/composer.json';
        if (!file_exists($filePath) || !is_readable($filePath)) {
            return [];
        }

        $composerConfig = file_get_contents($filePath);
        if (!$composerConfig) {
            return [];
        }

        return json_decode($composerConfig, true) ?: [];
    }
}