Backpack\CRUD\app\Console\Commands\AddMenuContent

Complexity

Total Complexity

7

Size/Duplication

Total Lines	89
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	handle()	0	35	4
A	__construct()	0	3	1
A	getLastLineNumberThatContains()	0	11	2

<?php

namespace Backpack\CRUD\app\Console\Commands;

use Illuminate\Console\Command;
use Illuminate\Support\Facades\Storage;

class AddMenuContent extends Command
{
    use \Backpack\CRUD\app\Console\Commands\Traits\PrettyCommandOutput;

The trait Backpack\CRUD\app\Console\Commands\Traits\PrettyCommandOutput requires some properties which are not provided by Backpack\CRUD\app\Console\Commands\AddMenuContent: $progressBar, $statusColor, $status

    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'backpack:add-menu-content
                                {code : HTML/PHP code that shows menu items. Use either single quotes or double quotes. Never both. }';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Add HTML/PHP code to the Backpack menu_items file';

    /**
     * Create a new command instance.
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Execute the console command.
     *
     * @return mixed
     */
    public function handle()
    {
        $path = 'resources/views/vendor/backpack/ui/inc/menu_items.blade.php';
        $disk_name = config('backpack.base.root_disk_name');
        $disk = Storage::disk($disk_name);
        $code = $this->argument('code');

        $this->progressBlock("Adding menu entry to <fg=blue>$path</>");

        // Validate file exists
        if (! $disk->exists($path)) {
            $this->errorProgressBlock();
            $this->note('The menu_items file does not exist. Make sure Backpack is properly installed.', 'red');

            return;
        }

        $contents = $disk->get($path);
        $file_lines = file($disk->path($path), FILE_IGNORE_NEW_LINES);

        // Validate the entry already exists
        if ($this->getLastLineNumberThatContains($code, $file_lines)) {

It seems like $code can also be of type array; however, parameter $needle of Backpack\CRUD\app\Console\Commands\AddMenuContent::getLastLineNumberThatContains() does only seem to accept string, maybe add an additional type check?

            $this->closeProgressBlock('Already existed', 'yellow');

            return;
        }

        if (! $disk->put($path, $contents.PHP_EOL.$code)) {
            $this->errorProgressBlock();
            $this->note('Could not write to menu_items file.', 'red');

            return;
        }

        $this->closeProgressBlock();
    }

    /**
     * Parse the given file stream and return the line number where a string is found.
     *
     * @param  string  $needle  The string that's being searched for.
     * @param  array  $haystack  The file where the search is being performed.
     * @return bool|int The last line number where the string was found. Or false.
     */
    private function getLastLineNumberThatContains($needle, $haystack)
    {
        $matchingLines = array_filter($haystack, function ($k) use ($needle) {
            return strpos($k, $needle) !== false;
        });

        if ($matchingLines) {

The expression $matchingLines of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

            return array_key_last($matchingLines);

The expression return array_key_last($matchingLines) also could return the type string which is incompatible with the documented return type boolean|integer.

        }

        return false;
    }
}