magros / laravel-model-encryption

src/EncryptModel.php

<?php

namespace Magros\Encryptable;

use Illuminate\Console\Command;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Str;

class EncryptModel extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'encryptable:encryptModel {model}';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Encrypt models rows';

    private $attributes = [];
    private $model;

    /**
     * Execute the console command.
     *
     * @return mixed
     * @throws \Exception
     */
    public function handle()
    {
        $class = $this->argument('model');
        $this->model = $this->guardClass($class);
        $this->attributes = $this->model->getEncryptableAttributes();
        $table = $this->model->getTable();
        $total = $this->model->where('encrypted', 0)->count();
        $this->model::$enableEncryption = false;

        if($total > 0){
            $this->comment($total.' records will be encrypted');

Are you sure $total of type Illuminate\Database\Eloquent\Builder|integer|mixed can be used in concatenation?

            $bar = $this->output->createProgressBar($total);

It seems like $total can also be of type Illuminate\Database\Eloquent\Builder; however, parameter $max of Symfony\Component\Console\Style\SymfonyStyle::createProgressBar() does only seem to accept integer, maybe add an additional type check?

            $bar->setFormat('%current%/%max% [%bar%] %percent:3s%% %elapsed:6s%/%estimated:-6s% %memory:6s%');

            $records =  $this->model->orderBy('id', 'asc')->where('encrypted', 0)->get();
            foreach ($records as $record) {
                $record->timestamps = false;
                $attributes = $this->getEncryptedAttributes($record);
                DB::table($table)->where('id', $record->id)->update($attributes);
                $bar->advance();
                $record = null;

The assignment to $record is dead and can be removed.

                $attributes = null;

The assignment to $attributes is dead and can be removed.

            }
            $bar->finish();
        }

        $this->comment('Finished encryption');
    }

    private function getEncryptedAttributes($record)
    {
        $encryptedFields = ['encrypted' => 1];

        foreach ($this->attributes as $attribute) {
            $raw = $record->{$attribute};
            if (!Str::contains($raw, $record->encrypter()->getPrefix())) {
                $encryptedFields[$attribute] = $this->model->encryptAttribute($raw);
            }
        }
        return $encryptedFields;
    }

    private function validateHasEncryptedColumn($model)
    {
        $table = $model->getTable();
        if (! Schema::hasColumn($table, 'encrypted')) {
            $this->comment('Creating encrypted column');
            Schema::table($table, function (Blueprint $table) {
                $table->tinyInteger('encrypted')->default(0);
            });
        }
    }

    /**
     * @param $class
     * @return Model
     * @throws \Exception
     */
    public function guardClass($class)
    {
        if (!class_exists($class))
            throw new \Exception("Class {$class} does not exists");
        $model = new $class();
        $this->validateHasEncryptedColumn($model);
        return $model;
    }
}