DMS::getStorageFolder() - Code Metrics - Inspection of "Merge pull request #229 from silverstripe/dependab..." - silverstripe/silverstripe-dms - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d4562c...6e7a7f )

by Garion

created 2020-11-17 03:23 UTC

DMS::getStorageFolder() A

↳ Parent: DMS

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php
class DMS extends SS_Object implements DMSInterface
{
    /**
     * Folder to store the documents in
     *
     * @config
     * @var string
     */
    private static $folder_name = 'assets/_dmsassets';

    /**
     * How many documents to store in a single folder. The square of this number is the maximum number of documents.
     *
     * The number should be a multiple of 10
     *
     * @config
     * @var int
     */
    private static $folder_size = 1000;

    /**
     * Singleton instance of a DMSInterface
     *
     * @var DMSInterface
     */
    private static $instance;

    /**
     * The shortcode handler key. Can be changed by user code.
     *
     * @config
     * @var string
     */
    private static $shortcode_handler_key = 'dms_document_link';

    /**
     * Factory method that returns an instance of the DMS. This could be any class that implements the DMSInterface.
     *
     * @return DMSInterface An instance of the Document Management System
     */
    public static function inst()
    {
        if (!self::$instance) {
            self::$instance = new static();

            $dmsPath = self::$instance->getStoragePath();

            if (!is_dir($dmsPath)) {
                self::$instance->createStorageFolder($dmsPath);
            }

            if (!file_exists($dmsPath . DIRECTORY_SEPARATOR . '.htaccess')) {
                // Restrict access to the storage folder
                copy(
                    BASE_PATH . DIRECTORY_SEPARATOR . DMS_DIR . DIRECTORY_SEPARATOR
                    . 'resources' . DIRECTORY_SEPARATOR . '.htaccess',
                    $dmsPath . DIRECTORY_SEPARATOR . '.htaccess'
                );

                copy(
                    BASE_PATH . DIRECTORY_SEPARATOR . DMS_DIR . DIRECTORY_SEPARATOR
                    . 'resources' . DIRECTORY_SEPARATOR . 'web.config',
                    $dmsPath . DIRECTORY_SEPARATOR . 'web.config'
                );
            }
        }
        return self::$instance;
    }

    /**
     * Get the storage path for DMS documents
     *
     * @return string
     */
    public function getStoragePath()
    {
        return BASE_PATH . DIRECTORY_SEPARATOR . $this->config()->get('folder_name');
    }

    /**
     * Gets a file path from either a File or a string
     *
     * @param  string|File $file
     * @return string
     * @throws FileNotFoundException If an unexpected value was provided, or the filename was null
     */
    public function transformFileToFilePath($file)
    {
        //confirm we have a file
        $filePath = null;
        if (is_string($file)) {
            $filePath = $file;
        } elseif (is_object($file) && $file->is_a("File")) {
            $filePath = $file->Filename;
        }

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

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            throw new FileNotFoundException();
        }

        return $filePath;
    }

    /**
     * Takes a File object or a String (path to a file) and copies it into the DMS. The original file remains unchanged.
     * When storing a document, sets the fields on the File has "tag" metadata.
     * @param  File|string $file File object, or String that is path to a file to store,
     *              e.g. "assets/documents/industry/supplied-v1-0.pdf"
     * @return DMSDocument
     */
    public function storeDocument($file)
    {
        $filePath = $this->transformFileToFilePath($file);

        // Create a new document and get its ID
        $doc = DMSDocument::create();
        $doc->write();
        $doc->storeDocument($filePath);

        return $doc;
    }

    /**
     * Returns a number of Document objects that match a full-text search of the Documents and their contents
     * (if contents is searchable and compatible search module is installed - e.g. FullTextSearch module)
     * @param $searchText String to search for
     * @param bool $showEmbargoed Boolean that specifies if embargoed documents should be included in results
     * @return DocumentInterface

     */
    public function getByFullTextSearch($searchText, $showEmbargoed = false)
    {
        // TODO: Implement getByFullTextSearch() method.
    }

    public function getByPage(SiteTree $page, $showEmbargoed = false)
    {
        /** @var ArrayList $documents */
        $documents = $page->getAllDocuments();

        if (!$showEmbargoed) {
            foreach ($documents as $document) {
                if ($document->isEmbargoed()) {
                    $documents->remove($document);
                }
            }
        }

        return $documents;
    }

    public function getDocumentSetsByPage(SiteTree $page)
    {
        return $page->getDocumentSets();
    }

    /**
     * Creates a storage folder for the given path
     *
     * @param  string $path Path to create a folder for
     * @return $this
     */
    public function createStorageFolder($path)
    {
        if (!is_dir($path)) {
            mkdir($path, 0777, true);
        }
        return $this;
    }

    /**
     * Calculates the storage path from a database DMSDocument ID
     *
     * @return int
     */
    public function getStorageFolder($id)
    {
        return intval($id / self::config()->get('folder_size'));
    }

    /**
     * Get the shortcode handler key
     *
     * @return string
     */
    public function getShortcodeHandlerKey()
    {
        return (string) Config::inst()->get('DMS', 'shortcode_handler_key');
    }
}


1			<?php
2			class DMS extends SS_Object implements DMSInterface
3			{
4			/**
5			* Folder to store the documents in
6			*
7			* @config
8			* @var string
9			*/
10			private static $folder_name = 'assets/_dmsassets';
11
12			/**
13			* How many documents to store in a single folder. The square of this number is the maximum number of documents.
14			*
15			* The number should be a multiple of 10
16			*
17			* @config
18			* @var int
19			*/
20			private static $folder_size = 1000;
21
22			/**
23			* Singleton instance of a DMSInterface
24			*
25			* @var DMSInterface
26			*/
27			private static $instance;
28
29			/**
30			* The shortcode handler key. Can be changed by user code.
31			*
32			* @config
33			* @var string
34			*/
35			private static $shortcode_handler_key = 'dms_document_link';
36
37			/**
38			* Factory method that returns an instance of the DMS. This could be any class that implements the DMSInterface.
39			*
40			* @return DMSInterface An instance of the Document Management System
41			*/
42			public static function inst()
43			{
44			if (!self::$instance) {
45			self::$instance = new static();
46
47			$dmsPath = self::$instance->getStoragePath();
48
49			if (!is_dir($dmsPath)) {
50			self::$instance->createStorageFolder($dmsPath);
51			}
52
53			if (!file_exists($dmsPath . DIRECTORY_SEPARATOR . '.htaccess')) {
54			// Restrict access to the storage folder
55			copy(
56			BASE_PATH . DIRECTORY_SEPARATOR . DMS_DIR . DIRECTORY_SEPARATOR
57			. 'resources' . DIRECTORY_SEPARATOR . '.htaccess',
58			$dmsPath . DIRECTORY_SEPARATOR . '.htaccess'
59			);
60
61			copy(
62			BASE_PATH . DIRECTORY_SEPARATOR . DMS_DIR . DIRECTORY_SEPARATOR
63			. 'resources' . DIRECTORY_SEPARATOR . 'web.config',
64			$dmsPath . DIRECTORY_SEPARATOR . 'web.config'
65			);
66			}
67			}
68			return self::$instance;
69			}
70
71			/**
72			* Get the storage path for DMS documents
73			*
74			* @return string
75			*/
76			public function getStoragePath()
77			{
78			return BASE_PATH . DIRECTORY_SEPARATOR . $this->config()->get('folder_name');
79			}
80
81			/**
82			* Gets a file path from either a File or a string
83			*
84			* @param string\|File $file
85			* @return string
86			* @throws FileNotFoundException If an unexpected value was provided, or the filename was null
87			*/
88			public function transformFileToFilePath($file)
89			{
90			//confirm we have a file
91			$filePath = null;
92			if (is_string($file)) {
93			$filePath = $file;
94			} elseif (is_object($file) && $file->is_a("File")) {
95			$filePath = $file->Filename;
96			}
97
98			if (!$filePath) {
			0 ignored issues – show Bug Best Practice introduced 2017-05-17 04:30 UTC by Report Bug Copy Issue Report The expression `$filePath` 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...
99			throw new FileNotFoundException();
100			}
101
102			return $filePath;
103			}
104
105			/**
106			* Takes a File object or a String (path to a file) and copies it into the DMS. The original file remains unchanged.
107			* When storing a document, sets the fields on the File has "tag" metadata.
108			* @param File\|string $file File object, or String that is path to a file to store,
109			* e.g. "assets/documents/industry/supplied-v1-0.pdf"
110			* @return DMSDocument
111			*/
112			public function storeDocument($file)
113			{
114			$filePath = $this->transformFileToFilePath($file);
115
116			// Create a new document and get its ID
117			$doc = DMSDocument::create();
118			$doc->write();
119			$doc->storeDocument($filePath);
120
121			return $doc;
122			}
123
124			/**
125			* Returns a number of Document objects that match a full-text search of the Documents and their contents
126			* (if contents is searchable and compatible search module is installed - e.g. FullTextSearch module)
127			* @param $searchText String to search for
128			* @param bool $showEmbargoed Boolean that specifies if embargoed documents should be included in results
129			* @return DocumentInterface
			0 ignored issues – show Documentation introduced 2017-05-01 04:05 UTC by Report Bug Copy Issue Report Should the return type not be `DocumentInterface\|null`? 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...
130			*/
131			public function getByFullTextSearch($searchText, $showEmbargoed = false)
132			{
133			// TODO: Implement getByFullTextSearch() method.
134			}
135
136			public function getByPage(SiteTree $page, $showEmbargoed = false)
137			{
138			/** @var ArrayList $documents */
139			$documents = $page->getAllDocuments();
140
141			if (!$showEmbargoed) {
142			foreach ($documents as $document) {
143			if ($document->isEmbargoed()) {
144			$documents->remove($document);
145			}
146			}
147			}
148
149			return $documents;
150			}
151
152			public function getDocumentSetsByPage(SiteTree $page)
153			{
154			return $page->getDocumentSets();
155			}
156
157			/**
158			* Creates a storage folder for the given path
159			*
160			* @param string $path Path to create a folder for
161			* @return $this
162			*/
163			public function createStorageFolder($path)
164			{
165			if (!is_dir($path)) {
166			mkdir($path, 0777, true);
167			}
168			return $this;
169			}
170
171			/**
172			* Calculates the storage path from a database DMSDocument ID
173			*
174			* @return int
175			*/
176			public function getStorageFolder($id)
177			{
178			return intval($id / self::config()->get('folder_size'));
179			}
180
181			/**
182			* Get the shortcode handler key
183			*
184			* @return string
185			*/
186			public function getShortcodeHandlerKey()
187			{
188			return (string) Config::inst()->get('DMS', 'shortcode_handler_key');
189			}
190			}
191

silverstripe / silverstripe-dms

Push — master ( d4562c...6e7a7f )

DMS::getStorageFolder() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like