concord_module_id() - Code Metrics - Inspection of "Added form request types doc + base request type (..." - artkonekt/concord - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 517bd8...f7cc98 )

by Attila

created 2018-01-17 09:38 UTC

concord_module_id() B

↳ Parent: Project

Complexity

Conditions	6
Paths	8

Size

Total Lines	21
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	0
loc	21
c	1
b	0
f	0
rs	8.7624
cc	6
eloc	13
nc	8
nop	2

<?php
/**
 * Contains the Concord helper functions
 *
 * @copyright   Copyright (c) 2016 Attila Fulop
 * @author      Attila Fulop
 * @license     MIT
 * @since       2016-09-25
 *
 */
use Konekt\Concord\Contracts\Concord;

/**
 * Converts a fully qualified classname to a string (backslashes to dots, parts to snake case)
 *
 * Eg.: '\App\Services\BamBamService' -> 'app.services.bam_bam_service'
 *
 * @param string    $classname
 *
 * @return string
 */
function classpath_to_slug($classname)
{
    $parts = explode('\\', $classname);
    // Remove first part if empty ie. begins with \
    if (empty($parts[0])) {
        $parts = array_except($parts, 0);
    }
    // Remove last part if empty ie. ends to \
    if (empty($parts[count($parts) - 1])) {
        $parts = array_except($parts, count($parts) - 1);
    }

    array_walk($parts, function (&$part) {
        $part = snake_case($part);
    });

    return implode('.', $parts);
}

/**
 * Counterpart of classpath_to_str, that converts the string back to a fully qualified classname
 *
 * Eg.: 'app.services.bam_bam_service' -> '\App\Services\BamBamService'
 *
 * @see classpath_to_str()
 *
 * @param string    $str
 *
 * @return string
 */
function slug_to_classpath($str)
{
    $parts = explode('.', $str);

    array_walk($parts, function (&$part) {
        $part = studly_case($part);
    });

    return implode('\\', $parts);
}

/**
 * Returns a standard module name based on the module provider's classname
 *
 * Eg.: '\Vendor\Module\Providers\ModuleServiceProvider' -> 'vendor.module'
 *      'App\Modules\Billing' -> 'billing'
 *
 * @param string $classname
 * @param null|\Konekt\Concord\Contracts\Convention   $convention
 *
 * @return string
 */
function concord_module_id($classname, $convention = null)
{
    $convention    = $convention ?: concord()->getConvention();
    $modulesFolder = $convention->modulesFolder();
    // Check if '\Modules\' is part of the namespace
    $p = strrpos($classname, "\\$modulesFolder\\");
    // if no \Modules\, but starts with 'Modules\' that's also a match
    $p = false === $p ? strpos($classname, "$modulesFolder\\") : $p;

    if (false !== $p) {

        $parts           = explode('\\', substr($classname, $p + strlen($modulesFolder) + 1));
        $vendorAndModule = empty($parts[0]) ? array_only($parts, 1) : array_only($parts, 0);
    } else {
        $parts           = explode('\\', $classname);
        $vendorAndModule = empty($parts[0]) ? array_only($parts, [1,2]) : array_only($parts, [0,1]);
    }

    array_walk($vendorAndModule, function (&$part) {
        $part = snake_case($part);
    });

    return implode('.', $vendorAndModule);
}

/**
 * Shortcut function for returning helper instances by their name
 *
 * @param string    $name       The name of the helper
 * @param array     $arguments  Optional arguments to pass to the helper class
 *
 * @return object|null
 */
function helper($name, $arguments = [])
{
    return concord()->helper($name, $arguments);
}

/**
 * Returns the concord instance
 *
 * @return Concord
 */
function concord()
{
    return app('concord');
}

/**
 * Returns the classname shortened (no namespace, base class name only, snake_case
 *
 * @param string $classname
 *
 * @return string
 */
function shorten($classname)
{
    return snake_case(class_basename($classname));
}


/**
 * Shorthand function for returning an enum object by it's short name
 *
 * @param string    $shortname  The short name of the enum
 * @param mixed     $value      The value to create the enum with
 *
 * @return \Konekt\Enum\Enum
 */
function enum($shortname, $value = null)
{
    $abstract = concord()->short($shortname);
    if ($abstract && $class = concord()->enum($abstract)) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
        return new $class($value);
    }
}


1			<?php
2			/**
3			* Contains the Concord helper functions
4			*
5			* @copyright Copyright (c) 2016 Attila Fulop
6			* @author Attila Fulop
7			* @license MIT
8			* @since 2016-09-25
9			*
10			*/
11			use Konekt\Concord\Contracts\Concord;
12
13			/**
14			* Converts a fully qualified classname to a string (backslashes to dots, parts to snake case)
15			*
16			* Eg.: '\App\Services\BamBamService' -> 'app.services.bam_bam_service'
17			*
18			* @param string $classname
19			*
20			* @return string
21			*/
22			function classpath_to_slug($classname)
23			{
24			$parts = explode('\\', $classname);
25			// Remove first part if empty ie. begins with \
26			if (empty($parts[0])) {
27			$parts = array_except($parts, 0);
28			}
29			// Remove last part if empty ie. ends to \
30			if (empty($parts[count($parts) - 1])) {
31			$parts = array_except($parts, count($parts) - 1);
32			}
33
34			array_walk($parts, function (&$part) {
35			$part = snake_case($part);
36			});
37
38			return implode('.', $parts);
39			}
40
41			/**
42			* Counterpart of classpath_to_str, that converts the string back to a fully qualified classname
43			*
44			* Eg.: 'app.services.bam_bam_service' -> '\App\Services\BamBamService'
45			*
46			* @see classpath_to_str()
47			*
48			* @param string $str
49			*
50			* @return string
51			*/
52			function slug_to_classpath($str)
53			{
54			$parts = explode('.', $str);
55
56			array_walk($parts, function (&$part) {
57			$part = studly_case($part);
58			});
59
60			return implode('\\', $parts);
61			}
62
63			/**
64			* Returns a standard module name based on the module provider's classname
65			*
66			* Eg.: '\Vendor\Module\Providers\ModuleServiceProvider' -> 'vendor.module'
67			* 'App\Modules\Billing' -> 'billing'
68			*
69			* @param string $classname
70			* @param null\|\Konekt\Concord\Contracts\Convention $convention
71			*
72			* @return string
73			*/
74			function concord_module_id($classname, $convention = null)
75			{
76			$convention = $convention ?: concord()->getConvention();
77			$modulesFolder = $convention->modulesFolder();
78			// Check if '\Modules\' is part of the namespace
79			$p = strrpos($classname, "\\$modulesFolder\\");
80			// if no \Modules\, but starts with 'Modules\' that's also a match
81			$p = false === $p ? strpos($classname, "$modulesFolder\\") : $p;
			0 ignored issues – show introduced 2018-01-14 10:49 UTC by Report Bug Copy Issue Report The condition `false === $p` can never be `true`. Loading history...
82			if (false !== $p) {
			0 ignored issues – show introduced 2018-01-14 10:49 UTC by Report Bug Copy Issue Report The condition `false !== $p` can never be `false`. Loading history...
83			$parts = explode('\\', substr($classname, $p + strlen($modulesFolder) + 1));
84			$vendorAndModule = empty($parts[0]) ? array_only($parts, 1) : array_only($parts, 0);
85			} else {
86			$parts = explode('\\', $classname);
87			$vendorAndModule = empty($parts[0]) ? array_only($parts, [1,2]) : array_only($parts, [0,1]);
88			}
89
90			array_walk($vendorAndModule, function (&$part) {
91			$part = snake_case($part);
92			});
93
94			return implode('.', $vendorAndModule);
95			}
96
97			/**
98			* Shortcut function for returning helper instances by their name
99			*
100			* @param string $name The name of the helper
101			* @param array $arguments Optional arguments to pass to the helper class
102			*
103			* @return object\|null
104			*/
105			function helper($name, $arguments = [])
106			{
107			return concord()->helper($name, $arguments);
108			}
109
110			/**
111			* Returns the concord instance
112			*
113			* @return Concord
114			*/
115			function concord()
116			{
117			return app('concord');
118			}
119
120			/**
121			* Returns the classname shortened (no namespace, base class name only, snake_case
122			*
123			* @param string $classname
124			*
125			* @return string
126			*/
127			function shorten($classname)
128			{
129			return snake_case(class_basename($classname));
130			}
131
132
133			/**
134			* Shorthand function for returning an enum object by it's short name
135			*
136			* @param string $shortname The short name of the enum
137			* @param mixed $value The value to create the enum with
138			*
139			* @return \Konekt\Enum\Enum
140			*/
141			function enum($shortname, $value = null)
142			{
143			$abstract = concord()->short($shortname);
144			if ($abstract && $class = concord()->enum($abstract)) {
			0 ignored issues – show Bug Best Practice introduced 2017-10-04 11:54 UTC by Report Bug Copy Issue Report The expression `$abstract` of type `null\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
145			return new $class($value);
146			}
147			}
148

artkonekt / concord

Push — master ( 517bd8...f7cc98 )

concord_module_id() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like