DefaultGridFSRepository::prepareMetadataOptions() - Code Metrics - Inspection of "[WIP] [2.0] Add GridFS implementation on top of mo..." - doctrine/mongodb-odm - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1790)

by Andreas

created 2018-05-13 13:36 UTC

DefaultGridFSRepository::prepareMetadataOptions() A

↳ Parent: DefaultGridFSRepository

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	4
nc	2
nop	1

<?php

declare(strict_types=1);

namespace Doctrine\ODM\MongoDB\Repository;

use Doctrine\ODM\MongoDB\DocumentNotFoundException;
use Doctrine\ODM\MongoDB\MongoDBException;
use MongoDB\GridFS\Bucket;
use MongoDB\GridFS\Exception\FileNotFoundException;
use const PATHINFO_BASENAME;
use function fclose;
use function fopen;
use function pathinfo;

class DefaultGridFSRepository extends DocumentRepository implements GridFSRepository
{
    public function downloadToStream($id, $destination): void
    {
        try {
            $this->getDocumentBucket()->downloadToStream($this->class->getDatabaseIdentifierValue($id), $destination);
        } catch (FileNotFoundException $e) {

            throw DocumentNotFoundException::documentNotFound($this->getClassName(), $id);
        }
    }

    public function openUploadStream(string $filename, $metadata = null)
    {
        $options = $this->prepareMetadataOptions($metadata);

        return $this->getDocumentBucket()->openUploadStream($filename, $options);
    }

    public function uploadFromStream($filename, $source, $metadata = null)
    {
        $options = $this->prepareMetadataOptions($metadata);

        $id = $this->getDocumentBucket()->uploadFromStream($filename, $source, $options);

        // TODO: apply primary read preference

        return $this->find($id);
    }

    public function uploadFromFile(string $source, ?string $filename = null, $metadata = null)
    {
        $resource = fopen($source, 'r');
        if (! $resource) {
            throw MongoDBException::cannotReadGridFSSourceFile($source);
        }

        if (! $filename) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $filename = pathinfo($source, PATHINFO_BASENAME);
        }

        try {
            return $this->uploadFromStream($filename, $resource, $metadata);
        } finally {
            fclose($resource);
        }
    }

    private function getDocumentBucket(): Bucket
    {
        return $this->dm->getDocumentBucket($this->documentName);
    }

    /**
     * @param object|null $metadata
     */
    private function prepareMetadataOptions($metadata = null): array
    {
        if ($metadata === null) {
            return [];
        }

        return ['metadata' => (object) $this->uow->getPersistenceBuilder()->prepareInsertData($metadata)];
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Doctrine\ODM\MongoDB\Repository;
6
7			use Doctrine\ODM\MongoDB\DocumentNotFoundException;
8			use Doctrine\ODM\MongoDB\MongoDBException;
9			use MongoDB\GridFS\Bucket;
10			use MongoDB\GridFS\Exception\FileNotFoundException;
11			use const PATHINFO_BASENAME;
12			use function fclose;
13			use function fopen;
14			use function pathinfo;
15
16			class DefaultGridFSRepository extends DocumentRepository implements GridFSRepository
17			{
18			public function downloadToStream($id, $destination): void
19			{
20			try {
21			$this->getDocumentBucket()->downloadToStream($this->class->getDatabaseIdentifierValue($id), $destination);
22			} catch (FileNotFoundException $e) {
			0 ignored issues – show Bug introduced 2018-05-13 10:37 UTC by Report Bug Copy Issue Report The class `MongoDB\GridFS\Exception\FileNotFoundException` does not exist. Did you forget a USE statement, or did you not list all dependencies? Scrutinizer analyzes your `composer.json`/`composer.lock` file if available to determine the classes, and functions that are defined by your dependencies. It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis. Loading history...
23			throw DocumentNotFoundException::documentNotFound($this->getClassName(), $id);
24			}
25			}
26
27			public function openUploadStream(string $filename, $metadata = null)
28			{
29			$options = $this->prepareMetadataOptions($metadata);
30
31			return $this->getDocumentBucket()->openUploadStream($filename, $options);
32			}
33
34			public function uploadFromStream($filename, $source, $metadata = null)
35			{
36			$options = $this->prepareMetadataOptions($metadata);
37
38			$id = $this->getDocumentBucket()->uploadFromStream($filename, $source, $options);
39
40			// TODO: apply primary read preference
41
42			return $this->find($id);
43			}
44
45			public function uploadFromFile(string $source, ?string $filename = null, $metadata = null)
46			{
47			$resource = fopen($source, 'r');
48			if (! $resource) {
49			throw MongoDBException::cannotReadGridFSSourceFile($source);
50			}
51
52			if (! $filename) {
			0 ignored issues – show Bug Best Practice introduced 2018-05-13 13:57 UTC by Report Bug Copy Issue Report The expression `$filename` of type `string\|null` is loosely compared to `false`; 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...
53			$filename = pathinfo($source, PATHINFO_BASENAME);
54			}
55
56			try {
57			return $this->uploadFromStream($filename, $resource, $metadata);
58			} finally {
59			fclose($resource);
60			}
61			}
62
63			private function getDocumentBucket(): Bucket
64			{
65			return $this->dm->getDocumentBucket($this->documentName);
66			}
67
68			/**
69			* @param object\|null $metadata
70			*/
71			private function prepareMetadataOptions($metadata = null): array
72			{
73			if ($metadata === null) {
74			return [];
75			}
76
77			return ['metadata' => (object) $this->uow->getPersistenceBuilder()->prepareInsertData($metadata)];
78			}
79			}
80

doctrine / mongodb-odm

Pull Request — master (#1790)

DefaultGridFSRepository::prepareMetadataOptions() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like