concord_module_id()

Complexity

Conditions	6
Paths	8

Size

Total Lines	21
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	1	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	concord()	0	3	1

<?php

declare(strict_types=1);

/**
 * Contains the Concord helper functions
 *
 * @copyright   Copyright (c) 2016 Attila Fulop
 * @author      Attila Fulop
 * @license     MIT
 * @since       2016-09-25
 *
 */
use Illuminate\Support\Arr;
use Illuminate\Support\Str;
use Konekt\Concord\Contracts\Concord;
use Konekt\Concord\Contracts\Module;

/**
 * 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 = Arr::except($parts, 0);
    }
    // Remove last part if empty ie. ends to \
    if (empty($parts[count($parts) - 1])) {
        $parts = Arr::except($parts, count($parts) - 1);
    }

    array_walk($parts, function (&$part) {
        $part = Str::snake($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 = Str::studly($part);
    });

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

/**
 * 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');

The expression return app('concord') also could return the type Illuminate\Contracts\Foundation\Application which is incompatible with the documented return type Konekt\Concord\Contracts\Concord.

}

/**
 * Returns the classname shortened (no namespace, base class name only, snake_case
 *
 * @param string $classname
 *
 * @return string
 */
function shorten($classname)
{
    return Str::snake(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)) {
        return new $class($value);
    }
}

function is_a_concord_module_class(string $class): bool
{
    return in_array(Module::class, class_implements($class));
}

function is_not_a_concord_module_class(string $class): bool
{
    return !is_a_concord_module_class($class);
}