FileSystemModelTrait::getAttachments() - Code Metrics - Inspection of "Allow app to determine accesability of images" - bakaphp/canvas-core - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#318)

by Maximo

created 2020-03-10 11:54 UTC

FileSystemModelTrait::getAttachments() B

↳ Parent: FileSystemModelTrait

Complexity

Conditions	5
Paths	8

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	30

Importance

Changes

Metric	Value
cc	5
nc	8
nop	1
dl	0
loc	41
ccs	0
cts	25
cp	0
crap	30
rs	8.9528
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Canvas\Traits;

use Canvas\Models\SystemModules;
use Canvas\Models\FileSystem;
use RuntimeException;
use Canvas\Models\FileSystemEntities;
use Canvas\Dto\Files;
use Canvas\Mapper\FileMapper;
use Phalcon\Mvc\Model\ResultsetInterface;

/**
 * Trait ResponseTrait.
 *
 * @package Canvas\Traits
 *
 * @property Users $user
 * @property AppsPlans $appPlan
 * @property CompanyBranches $branches
 * @property Companies $company
 * @property UserCompanyApps $app
 * @property \Phalcon\Di $di
 *
 */
trait FileSystemModelTrait
{
    public $uploadedFiles = [];

    /**
     * Associated the list of uploaded files to this entity.
     *
     * call on the after saves
     *
     * @return void

     */
    protected function associateFileSystem(): bool

    {
        if (!empty($this->uploadedFiles) && is_array($this->uploadedFiles)) {
            foreach ($this->uploadedFiles as $file) {
                if (!isset($file['filesystem_id'])) {
                    continue;
                }

                if ($fileSystem = FileSystem::getById($file['filesystem_id'])) {
                    $this->attach([[
                        'id' => $file['id'] ?: 0,
                        'file' => $fileSystem,
                        'field_name' => $file['field_name'] ?? ''
                    ]]);
                }
            }
        }

        return true;
    }

    /**
     * Over write, because of the phalcon events.
     *
     * @param array data
     * @param array whiteList
     * @return boolean
     */
    public function update($data = null, $whiteList = null): bool

    {
        //associate uploaded files
        if (isset($data['files'])) {
            if (!empty($data['files'])) {
                /**
                 * @todo for now lets delete them all and updated them
                 * look for a better solution later, this can since we are not using transactions
                 */
                $this->deleteFiles();

                $this->uploadedFiles = $data['files'];
            } else {
                $this->deleteFiles();
            }
        }

        return parent::update($data, $whiteList);
    }

    /**
     * Inserts or updates a model instance. Returning true on success or false otherwise.
     *
     *<code>
     * // Creating a new robot
     * $robot = new Robots();
     *
     * $robot->type = "mechanical";
     * $robot->name = "Astro Boy";
     * $robot->year = 1952;
     *
     * $robot->save();
     *
     * // Updating a robot name
     * $robot = Robots::findFirst("id = 100");
     *
     * $robot->name = "Biomass";
     *
     * $robot->save();
     *</code>
     *
     * @param array data
     * @param array whiteList
     * @return boolean
     */
    public function save($data = null, $whiteList = null): bool

    {
        //associate uploaded files
        if (isset($data['files'])) {
            if (!empty($data['files'])) {
                $this->uploadedFiles = $data['files'];
            }
        }

        return parent::save($data, $whiteList);
    }

    /**
     * Delete all the files from a module.
     *
     * @return bool
     */
    public function deleteFiles(): bool

    {
        $systemModule = SystemModules::getSystemModuleByModelName(self::class);


        if ($files = FileSystemEntities::getAllByEntityId($this->getId(), $systemModule)) {
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $files->update([], function ($file) {
                $file->softDelete();
            });
        }

        return true;
    }

    /**
     * Given the ID delete the file from this entity.
     *
     * @param integer $id
     * @return bool
     */
    public function deleteFile(int $id)

    {
        $systemModule = SystemModules::getSystemModuleByModelName(self::class);


        $file = FileSystemEntities::findFirstOrFail([
            'contidions' => 'id = ?0 AND entity_id = ?1 AND system_modules_id = ?2 AND is_deleted = ?3',
            'bind' => [$id, $this->getId(), $systemModule->getId(), 0]
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        ]);

        if ($file) {
            $file->softDelete();
        }

        return false;
    }

    /**
     * Given the array of files we will attch this files to the files.
     * [
     *  'file' => $file,
     *  'file_name' => 'dfadfa'
     * ];.
     *
     * @param array $files
     * @return void

     */
    public function attach(array $files): bool

    {
        $systemModule = SystemModules::getSystemModuleByModelName(self::class);


        foreach ($files as $file) {
            //im looking for the file inside an array
            if (!isset($file['file'])) {
                continue;
            }

            if (!$file['file'] instanceof FileSystem) {
                throw new RuntimeException('Cant attach a none Filesytem to this entity');
            }

            $fileSystemEntities = null;
            //check if we are updating the attachment
            if ($id = (int) $file['id']) {
                $fileSystemEntities = FileSystemEntities::getByIdWithSystemModule($id, $systemModule);
            }

            //new attachment
            if (!is_object($fileSystemEntities)) {
                $fileSystemEntities = new FileSystemEntities();
                $fileSystemEntities->system_modules_id = $systemModule->getId();
                $fileSystemEntities->companies_id = $file['file']->companies_id;
                $fileSystemEntities->entity_id = $this->getId();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                $fileSystemEntities->created_at = $file['file']->created_at;
            }

            $fileSystemEntities->filesystem_id = $file['file']->getId();
            $fileSystemEntities->field_name = $file['field_name'] ?? null;
            $fileSystemEntities->is_deleted = 0;
            $fileSystemEntities->saveOrFail();

            if (!is_null($this->filesNewAttachedPath())) {
                $file['file']->move($this->filesNewAttachedPath());
            }
        }

        return true;
    }

    /**
     * Get all the files attach for the given module.
     *
     * @param string $fileType filter the files by their type

     * @return array

     */
    public function getAttachments(string $fileType = null) : ResultsetInterface
    {
        $systemModule = SystemModules::getSystemModuleByModelName(self::class);

        $appPublicImages = (bool) $this->di->getApp()->get('public_images');

        $bindParams = [
            $systemModule->getId(),
            $this->getId(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            0,
        ];

        //do we allow images by entity to be public to anybody accessing it directly by the entity?
        if ($appPublicImages) {
            $fileTypeSql = !is_null($fileType) ? 'AND f.file_type = ?3' : null;

            $condition = 'system_modules_id = ?0 AND entity_id = ?1 AND is_deleted = ?2
            AND filesystem_id IN (SELECT f.id from \Canvas\Models\FileSystem f WHERE
                f.is_deleted = ?2 ' . $fileTypeSql . '
            )';
        } else {
            $fileTypeSql = !is_null($fileType) ? 'AND f.file_type = ?4' : null;
            $bindParams[] = $this->di->getUserData()->currentCompanyId();

            $condition = 'system_modules_id = ?0 AND entity_id = ?1 AND is_deleted = ?2 and companies_id = ?3
            AND filesystem_id IN (SELECT f.id from \Canvas\Models\FileSystem f WHERE
                f.is_deleted = ?2 AND f.companies_id = ?3 ' . $fileTypeSql . '
            )';
        }

        /**
          * We can also filter the attachements by its file type.
          */
        if ($fileTypeSql) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $bindParams[] = $fileType;
        }

        return FileSystemEntities::find([
            'conditions' => $condition,
            'bind' => $bindParams
        ]);
    }

    /**
     * Overwrite the relationship of the filesystem to return the attachment structure
     * to the given user.
     *
     * @deprecated version 0.2
     * @return array
     */
    public function getFilesystem(): array
    {
        return $this->getFiles();
    }

    /**
     * Overwrite the relationship of the filesystem to return the attachment structure
     * to the given user.
     *
     * @return array
     */
    public function getFiles(string $fileType = null): array
    {
        $systemModule = SystemModules::getSystemModuleByModelName(self::class);


        $attachments = $this->getAttachments($fileType);

        $fileMapper = new FileMapper($this->getId(), $systemModule->getId());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        //add a mapper
        $this->di->getDtoConfig()
            ->registerMapping(FileSystemEntities::class, Files::class)
            ->useCustomMapper($fileMapper);

        return $this->di->getMapper()->mapMultiple($attachments, Files::class);
    }

    /**
     * Get a file by its fieldname.
     *
     * @todo this will be a performance issue in the futur look for better ways to handle this
     * when a company has over 1k images
     *
     * @deprecated version 0.2
     * @param string $name
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return void
     */
    public function getAttachmentByName(string $fieldName)
    {
        $systemModule = SystemModules::getSystemModuleByModelName(self::class);

        $appPublicImages = (bool) $this->di->getApp()->get('public_images');

        $bind = [
            $systemModule->getId(),
            $this->getId(),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            0,
            $fieldName,
        ];

        //do we allow images by entity to be public to anybody accessing it directly by the entity?
        if ($appPublicImages) {
            $condition = 'system_modules_id = ?0 AND entity_id = ?1 AND is_deleted = ?2 and field_name = ?3 
            AND filesystem_id IN (SELECT f.id from \Canvas\Models\FileSystem f WHERE
                f.is_deleted = ?2
            )';
        } else {
            $bind[] = $this->di->getUserData()->currentCompanyId();
            $condition = 'system_modules_id = ?0 AND entity_id = ?1 AND is_deleted = ?2 and field_name = ?3 and companies_id = ?4
            AND filesystem_id IN (SELECT f.id from \Canvas\Models\FileSystem f WHERE
                f.is_deleted = ?2 AND f.companies_id = ?4
            )';
        }

        return FileSystemEntities::findFirst([
            'conditions' => $condition,
            'bind' => $bind
        ]);
    }

    /**
     * Undocumented function.
     *
     * @param string $fieldName
     * @return string|null
     */
    public function getFileByName(string $fieldName): ?object
    {
        $systemModule = SystemModules::getSystemModuleByModelName(self::class);


        $fileEntity = $this->getAttachmentByName($fieldName);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

        if ($fileEntity) {
            $fileMapper = new FileMapper($this->getId(), $systemModule->getId());
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

            //add a mapper
            $this->di->getDtoConfig()
                ->registerMapping(FileSystemEntities::class, Files::class)
                ->useCustomMapper($fileMapper);

            /**
             * @todo create a mapper for entity so we dont have to look for the relationship?
             */
            return $this->di->getMapper()->map($fileEntity, Files::class);
        }

        return null;
    }

    /**
     * Given this entity define a new path.
     *
     * @param string $path
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return string

     */
    protected function filesNewAttachedPath(): ?string
    {
        return null;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Canvas\Traits;
6
7			use Canvas\Models\SystemModules;
8			use Canvas\Models\FileSystem;
9			use RuntimeException;
10			use Canvas\Models\FileSystemEntities;
11			use Canvas\Dto\Files;
12			use Canvas\Mapper\FileMapper;
13			use Phalcon\Mvc\Model\ResultsetInterface;
14
15			/**
16			* Trait ResponseTrait.
17			*
18			* @package Canvas\Traits
19			*
20			* @property Users $user
21			* @property AppsPlans $appPlan
22			* @property CompanyBranches $branches
23			* @property Companies $company
24			* @property UserCompanyApps $app
25			* @property \Phalcon\Di $di
26			*
27			*/
28			trait FileSystemModelTrait
29			{
30			public $uploadedFiles = [];
31
32			/**
33			* Associated the list of uploaded files to this entity.
34			*
35			* call on the after saves
36			*
37			* @return void
			0 ignored issues – show Documentation introduced 2019-09-18 14:29 UTC by Report Bug Copy Issue Report Should the return type not be `boolean`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
38			*/
39			protected function associateFileSystem(): bool

bakaphp / canvas-core

Pull Request — master (#318)

FileSystemModelTrait::getAttachments() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like