LoaderButler::getClassNameFromFile() - Code Metrics - Inspection of "update all containers to adapt the new Port/Ship s..." - Porto-SAP/Hello-API - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( dc322e...438d0e )

by Mahmoud

created 2017-02-17 21:06 UTC

LoaderButler::getClassNameFromFile() B

↳ Parent: LoaderButler

Complexity

Conditions	5
Paths	3

Size

Total Lines	20
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	20
rs	8.8571
c	0
b	0
f	0
cc	5
eloc	12
nc	3
nop	1

<?php

namespace App\Ship\Engine\Butlers;

use Illuminate\Support\Facades\Config;
use Illuminate\Support\Facades\File;

/**
 * Class LoaderButler
 *
 * Helper Class to serve the Components loaders only.
 *
 * @author  Mahmoud Zalt  <[email protected]>
 */
class LoaderButler
{

    /**
     * Get the containers namespace value from the containers config file
     *
     * @return  string
     */
    public function getContainersNamespace()
    {
        return Config::get('hello.containers.namespace');
    }

    /**
     * Get the containers names
     *
     * @return  array
     */
    public function getContainersNames()
    {
        $containersNames = [];

        foreach ($this->getContainersPaths() as $containersPath) {
            $containersNames[] = basename($containersPath);
        }

        return $containersNames;
    }

    /**
     * Get the port folders names
     *
     * @return  array
     */
    public function getShipFoldersNames()
    {
        $portFoldersNames = [];

        foreach ($this->getShipPath() as $portFoldersPath) {
            $portFoldersNames[] = basename($portFoldersPath);
        }

        return $portFoldersNames;
    }

    /**
     * get containers directories paths
     *
     * @return  mixed
     */
    public function getContainersPaths()
    {
        $containersPaths = File::directories(app_path('Containers'));

        // TODO: preparing some code to implement the Ships concept to Shipo

//        // Search for Ships "_SHIP" of Containers

//        foreach ($containersPaths as $containersPath) {
//
//            if (preg_match('/_SHIP/',$containersPath)){
//
//                // append the Ship directories to the Containers directory, since it will contain containers
//                $shipContainers = File::directories($containersPath);
//                $containersPaths = array_merge($containersPaths, $shipContainers);
//            }
//        }

        return $containersPaths;
    }

    /**
     * @return  mixed
     */
    public function getShipPath()
    {
        return File::directories(app_path('Ship'));
    }

    /**
     * build and return an object of a class from its file path
     *
     * @param $filePathName
     *
     * @return  mixed
     */
    public function getClassObjectFromFile($filePathName)
    {
        $classString = $this->getClassFullNameFromFile($filePathName);

        $object = new $classString;

        return $object;
    }

    /**
     * get the full name (name \ namespace) of a class from its file path
     * result example: (string) "I\Am\The\Namespace\Of\This\Class"
     *
     * @param $filePathName
     *
     * @return  string
     */
    public function getClassFullNameFromFile($filePathName)
    {
        return $this->getClassNamespaceFromFile($filePathName) . '\\' . $this->getClassNameFromFile($filePathName);
    }

    /**
     * get the class namespace form file path using token
     *
     * @param $filePathName
     *
     * @return  null|string
     */
    protected function getClassNamespaceFromFile($filePathName)
    {
        $src = file_get_contents($filePathName);

        $tokens = token_get_all($src);
        $count = count($tokens);
        $i = 0;
        $namespace = '';
        $namespace_ok = false;
        while ($i < $count) {
            $token = $tokens[$i];
            if (is_array($token) && $token[0] === T_NAMESPACE) {
                // Found namespace declaration
                while (++$i < $count) {
                    if ($tokens[$i] === ';') {
                        $namespace_ok = true;
                        $namespace = trim($namespace);
                        break;
                    }
                    $namespace .= is_array($tokens[$i]) ? $tokens[$i][1] : $tokens[$i];
                }
                break;
            }
            $i++;
        }
        if (!$namespace_ok) {
            return null;
        } else {
            return $namespace;
        }
    }

    /**
     * get the class name form file path using token
     *
     * @param $filePathName
     *
     * @return  mixed
     */
    protected function getClassNameFromFile($filePathName)
    {
        $php_code = file_get_contents($filePathName);

        $classes = array();
        $tokens = token_get_all($php_code);
        $count = count($tokens);
        for ($i = 2; $i < $count; $i++) {
            if ($tokens[$i - 2][0] == T_CLASS
                && $tokens[$i - 1][0] == T_WHITESPACE
                && $tokens[$i][0] == T_STRING
            ) {

                $class_name = $tokens[$i][1];
                $classes[] = $class_name;
            }
        }

        return $classes[0];
    }

}


1			<?php
2
3			namespace App\Ship\Engine\Butlers;
4
5			use Illuminate\Support\Facades\Config;
6			use Illuminate\Support\Facades\File;
7
8			/**
9			* Class LoaderButler
10			*
11			* Helper Class to serve the Components loaders only.
12			*
13			* @author Mahmoud Zalt <[email protected]>
14			*/
15			class LoaderButler
16			{
17
18			/**
19			* Get the containers namespace value from the containers config file
20			*
21			* @return string
22			*/
23			public function getContainersNamespace()
24			{
25			return Config::get('hello.containers.namespace');
26			}
27
28			/**
29			* Get the containers names
30			*
31			* @return array
32			*/
33			public function getContainersNames()
34			{
35			$containersNames = [];
36
37			foreach ($this->getContainersPaths() as $containersPath) {
38			$containersNames[] = basename($containersPath);
39			}
40
41			return $containersNames;
42			}
43
44			/**
45			* Get the port folders names
46			*
47			* @return array
48			*/
49			public function getShipFoldersNames()
50			{
51			$portFoldersNames = [];
52
53			foreach ($this->getShipPath() as $portFoldersPath) {
54			$portFoldersNames[] = basename($portFoldersPath);
55			}
56
57			return $portFoldersNames;
58			}
59
60			/**
61			* get containers directories paths
62			*
63			* @return mixed
64			*/
65			public function getContainersPaths()
66			{
67			$containersPaths = File::directories(app_path('Containers'));
68
69			// TODO: preparing some code to implement the Ships concept to Shipo
70
71			// // Search for Ships "_SHIP" of Containers
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-08-18 02:45 UTC by Report Bug Copy Issue Report `49%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
72			// foreach ($containersPaths as $containersPath) {
73			//
74			// if (preg_match('/_SHIP/',$containersPath)){
75			//
76			// // append the Ship directories to the Containers directory, since it will contain containers
77			// $shipContainers = File::directories($containersPath);
78			// $containersPaths = array_merge($containersPaths, $shipContainers);
79			// }
80			// }
81
82			return $containersPaths;
83			}
84
85			/**
86			* @return mixed
87			*/
88			public function getShipPath()
89			{
90			return File::directories(app_path('Ship'));
91			}
92
93			/**
94			* build and return an object of a class from its file path
95			*
96			* @param $filePathName
97			*
98			* @return mixed
99			*/
100			public function getClassObjectFromFile($filePathName)
101			{
102			$classString = $this->getClassFullNameFromFile($filePathName);
103
104			$object = new $classString;
105
106			return $object;
107			}
108
109			/**
110			* get the full name (name \ namespace) of a class from its file path
111			* result example: (string) "I\Am\The\Namespace\Of\This\Class"
112			*
113			* @param $filePathName
114			*
115			* @return string
116			*/
117			public function getClassFullNameFromFile($filePathName)
118			{
119			return $this->getClassNamespaceFromFile($filePathName) . '\\' . $this->getClassNameFromFile($filePathName);
120			}
121
122			/**
123			* get the class namespace form file path using token
124			*
125			* @param $filePathName
126			*
127			* @return null\|string
128			*/
129			protected function getClassNamespaceFromFile($filePathName)
130			{
131			$src = file_get_contents($filePathName);
132
133			$tokens = token_get_all($src);
134			$count = count($tokens);
135			$i = 0;
136			$namespace = '';
137			$namespace_ok = false;
138			while ($i < $count) {
139			$token = $tokens[$i];
140			if (is_array($token) && $token[0] === T_NAMESPACE) {
141			// Found namespace declaration
142			while (++$i < $count) {
143			if ($tokens[$i] === ';') {
144			$namespace_ok = true;
145			$namespace = trim($namespace);
146			break;
147			}
148			$namespace .= is_array($tokens[$i]) ? $tokens[$i][1] : $tokens[$i];
149			}
150			break;
151			}
152			$i++;
153			}
154			if (!$namespace_ok) {
155			return null;
156			} else {
157			return $namespace;
158			}
159			}
160
161			/**
162			* get the class name form file path using token
163			*
164			* @param $filePathName
165			*
166			* @return mixed
167			*/
168			protected function getClassNameFromFile($filePathName)
169			{
170			$php_code = file_get_contents($filePathName);
171
172			$classes = array();
173			$tokens = token_get_all($php_code);
174			$count = count($tokens);
175			for ($i = 2; $i < $count; $i++) {
176			if ($tokens[$i - 2][0] == T_CLASS
177			&& $tokens[$i - 1][0] == T_WHITESPACE
178			&& $tokens[$i][0] == T_STRING
179			) {
180
181			$class_name = $tokens[$i][1];
182			$classes[] = $class_name;
183			}
184			}
185
186			return $classes[0];
187			}
188
189			}
190

Porto-SAP / Hello-API

Push — master ( dc322e...438d0e )

LoaderButler::getClassNameFromFile() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like