ConfigForm::addDropbox() - Code Metrics - Inspection of "Upgraded for Omeka S v3 compatibility" - HBLL-Collection-Development/omeka-s-any-cloud - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#21)

unknown

created 2020-12-29 20:54 UTC

ConfigForm::addDropbox() A

↳ Parent: ConfigForm

Complexity

Conditions	1
Paths	1

Size

Total Lines	21
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	1	Features	0

Metric	Value
cc	1
eloc	15
c	3
b	1
f	0
nc	1
nop	0
dl	0
loc	21
rs	9.7666

<?php

namespace AnyCloud\Form;

use Laminas\Form\Element;
filter:
    dependency_paths: ["lib/*"]
use Laminas\Form\Fieldset;
filter:
    dependency_paths: ["lib/*"]
use Laminas\Form\Form;
filter:
    dependency_paths: ["lib/*"]

class ConfigForm extends Form
{
    protected $globalSettings;

    /**
     * Initialize the configuration form.
     */
    public function init(): void
    {
        $this->addAdapter();
        $this->addS3('aws', 'Amazon S3 Storage');
        $this->addAzure();
        $this->addGoogle();
        $this->addS3('wasabi', 'Wasabi Cloud Storage', 'Wasabi');
        $this->addS3('digital_ocean', 'DigitalOcean Spaces', 'DigitalOcean');
        $this->addS3('scaleway', 'Scaleway Object Storage', 'Scaleway');
        $this->addRackspace();
        $this->addDropbox();
    }

    /**
     * Set configuration settings.
     */
    public function setGlobalSettings($globalSettings): void
    {
        $this->globalSettings = $globalSettings;
    }

    /**
     * Add adapter drop-down options to configuration form.
     */
    private function addAdapter(): void
    {
        $this->add([
            'name'    => 'anycloud_adapter',
            'type'    => Fieldset::class,
            'options' => [
                'label' => 'Any Cloud Adapter',
            ],
            'attributes' => [
                'id' => 'adapter-fieldset',
            ],
        ]);
        $adapterFieldset = $this->get('anycloud_adapter');
        $adapterFieldset->add([
            'name'    => 'adapter',
            'type'    => Element\Select::class,
filter:
    dependency_paths: ["lib/*"]
            'options' => [
                'label'         => 'Cloud Service Adapter: ',
                'value_options' => [
                    'default'       => 'Omeka Default (local server)',
                    'aws'           => 'Amazon S3 Storage',
                    'azure'         => 'Microsoft Azure Storage',
                    'google'        => 'Google Cloud Storage',
                    'wasabi'        => 'Wasabi Cloud Storage',
                    'digital_ocean' => 'DigitalOcean Spaces',
                    'scaleway'      => 'Scaleway Object Storage',
                    'rackspace'     => 'Rackspace Files',
                    'dropbox'       => 'Dropbox',
                ],
            ],
            'attributes' => [
                'id' => 'adapter',
            ],
        ]);
    }

    /**
     * Add any Amazon S3-based storage adapter.
     *
     * @param string      $id    ID used to identify adapter
     * @param string      $name  Full name of adapter
     * @param string|null $label Abbreviated name used for form labels
     */
    private function addS3($id, $name, $label = null): void
    {
        $label = $label === null ? $label : $label.' ';
        $this->add([
            'name'    => 'anycloud_'.$id,
            'type'    => Fieldset::class,
            'options' => [
                'label' => $name,
            ],
            'attributes' => [
                'class' => $id.' fieldset',
            ],
        ]);
        $awsFieldset = $this->get('anycloud_'.$id);
        $awsFieldset->add([
            'name'    => $id.'_key',
            'type'    => Element\Text::class,
filter:
    dependency_paths: ["lib/*"]
            'options' => [
                'label' => $label.'AWS Key',
            ],
            'attributes' => [
                'id' => $id.'_key',
            ],
        ]);
        $awsFieldset->add([
            'name'    => $id.'_secret_key',
            'type'    => Element\Text::class,
            'options' => [
                'label' => $label.'AWS Secret Key',
            ],
            'attributes' => [
                'id'   => $id.'_secret_key',
                'cols' => '100',
            ],
        ]);
        $awsFieldset->add([
            'name'    => $id.'_bucket',
            'type'    => Element\Text::class,
            'options' => [
                'label' => $label.'AWS Bucket',
            ],
            'attributes' => [
                'id' => $id.'_bucket',
            ],
        ]);
        $awsFieldset->add([
            'name'    => $id.'_region',
            'type'    => Element\Text::class,
            'options' => [
                'label' => $label.'AWS Region',
            ],
            'attributes' => [
                'id' => $id.'_region',
            ],
        ]);
        $awsFieldset->add([
            'name'    => $id.'_endpoint',
            'type'    => Element\Text::class,
            'options' => [
                'label' => $label.'AWS Endpoint',
                'info'  => 'Can usually leave blank unless you have a custom endpoint set up. See https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region',
            ],
            'attributes' => [
                'id' => $id.'_endpoint',
            ],
        ]);
    }

    /**
     * Add Microsoft Azure Storage options to configuration form.
     */
    private function addAzure(): void
    {
        $this->add([
            'name'    => 'anycloud_azure',
            'type'    => Fieldset::class,
            'options' => [
                'label' => 'Microsoft Azure Storage',
            ],
            'attributes' => [
                'class' => 'azure fieldset',
            ],
        ]);
        $azureFieldset = $this->get('anycloud_azure');
        $azureFieldset->add([
            'name'    => 'azure_account_name',
            'type'    => Element\Text::class,
            'options' => [
                'label' => 'Azure Account Name',
            ],
            'attributes' => [
                'id' => 'azure_account_name',
            ],
        ]);
        $azureFieldset->add([
            'name'    => 'azure_account_key',
            'type'    => Element\Text::class,
            'options' => [
                'label' => 'Azure Account Key',
            ],
            'attributes' => [
                'id' => 'azure_account_key',
            ],
        ]);
        $azureFieldset->add([
            'name'    => 'azure_container_name',
            'type'    => Element\Text::class,
            'options' => [
                'label' => 'Azure Container Name',
            ],
            'attributes' => [
                'id' => 'azure_container_name',
            ],
        ]);
        $azureFieldset->add([
            'name'    => 'azure_endpoint',
            'type'    => Element\Text::class,
            'options' => [
                'label' => 'Azure Endpoint',
                'info'  => 'Can usually leave blank unless you have a custom endpoint set up',
            ],
            'attributes' => [
                'id' => 'azure_endpoint',
            ],
        ]);
    }

    /**
     * Add Google Cloud Storage options to configuration form.
     */
    private function addGoogle(): void
    {
        $this->add([
            'name'    => 'anycloud_google',
            'type'    => Fieldset::class,
            'options' => [
                'label' => 'Google Cloud Storage',
            ],
            'attributes' => [
                'class' => 'google fieldset',
            ],
        ]);
        $googleFieldset = $this->get('anycloud_google');
        $googleFieldset->add([
            'name'    => 'google_project_id',
            'type'    => Element\Text::class,
            'options' => [
                'label' => 'Google Project ID',
            ],
            'attributes' => [
                'id' => 'google_project_id',
            ],
        ]);
        $googleFieldset->add([
            'name'    => 'google_bucket_name',
            'type'    => Element\Text::class,
            'options' => [
                'label' => 'Google Bucket Name',
            ],
            'attributes' => [
                'id' => 'google_bucket_name',
            ],
        ]);
        $googleFieldset->add([
            'name'    => 'google_credentials_path',
            'type'    => Element\Text::class,
            'options' => [
                'label' => 'Google Credentials Path',
                'info'  => 'Replace {CONFIG} with the name of your Google credentials file stored at the listed path',
                'value' => '/src/Service/File/Adapter/Google/{CONFIG}.json',
            ],
            'attributes' => [
                'id' => 'google_credentials_path',
            ],
        ]);
        $googleFieldset->add([
            'name'    => 'google_storage_uri',
            'type'    => Element\Text::class,
            'options' => [
                'label' => 'Google Storage URI',
                'info'  => 'You can usually leave this as the default unless you have tweaked other settings',
                'value' => 'https://storage.googleapis.com',
            ],
            'attributes' => [
                'id' => 'google_storage_uri',
            ],
        ]);
    }

    /**
     * Add Rackspace Files options to configuration form.
     */
    private function addRackspace(): void
    {
        $this->add([
            'name'    => 'anycloud_rackspace',
            'type'    => Fieldset::class,
            'options' => [
                'label' => 'Rackspace Files',
            ],
            'attributes' => [
                'class' => 'rackspace fieldset',
            ],
        ]);
        $rackspaceFieldset = $this->get('anycloud_rackspace');
        $rackspaceFieldset->add([
            'name'    => 'rackspace_identity_endpoint',
            'type'    => Element\Text::class,
            'options' => [
                'label' => 'Rackspace Identity Endpoint',
                'info'  => 'Valid options include “US_IDENTITY_ENDPOINT” and “UK_IDENTITY_ENDPOINT”',
            ],
            'attributes' => [
                'id' => 'rackspace_identity_endpoint',
            ],
        ]);
        $rackspaceFieldset->add([
            'name'    => 'rackspace_username',
            'type'    => Element\Text::class,
            'options' => [
                'label' => 'Rackspace Username',
            ],
            'attributes' => [
                'id' => 'rackspace_username',
            ],
        ]);
        $rackspaceFieldset->add([
            'name'    => 'rackspace_password',
            'type'    => Element\Text::class,
            'options' => [
                'label' => 'Rackspace Password',
            ],
            'attributes' => [
                'id' => 'rackspace_password',
            ],
        ]);
        $rackspaceFieldset->add([
            'name'    => 'rackspace_container',
            'type'    => Element\Text::class,
            'options' => [
                'label' => 'Rackspace Container Name',
            ],
            'attributes' => [
                'id' => 'rackspace_container',
            ],
        ]);
        $rackspaceFieldset->add([
            'name'    => 'rackspace_region',
            'type'    => Element\Text::class,
            'options' => [
                'label' => 'Rackspace Region',
            ],
            'attributes' => [
                'id' => 'rackspace_region',
            ],
        ]);
    }

    /**
     * Add Dropbox options to configuration form.
     */
    private function addDropbox(): void
    {
        $this->add([
            'name'    => 'anycloud_dropbox',
            'type'    => Fieldset::class,
            'options' => [
                'label' => 'Dropbox',
            ],
            'attributes' => [
                'class' => 'dropbox fieldset',
            ],
        ]);
        $dropboxFieldset = $this->get('anycloud_dropbox');
        $dropboxFieldset->add([
            'name'    => 'dropbox_access_token',
            'type'    => Element\Text::class,
            'options' => [
                'label' => 'Dropbox Access Token',
            ],
            'attributes' => [
                'id' => 'dropbox_access_token',
            ],
        ]);
    }
}


1			<?php
2
3			namespace AnyCloud\Form;
4
5			use Laminas\Form\Element;
			0 ignored issues – show Bug introduced 2020-12-29 20:52 UTC by Report Bug Copy Issue Report The type `Laminas\Form\Element` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
6			use Laminas\Form\Fieldset;
			0 ignored issues – show Bug introduced 2020-12-29 20:52 UTC by Report Bug Copy Issue Report The type `Laminas\Form\Fieldset` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
7			use Laminas\Form\Form;
			0 ignored issues – show Bug introduced 2020-12-29 20:52 UTC by Report Bug Copy Issue Report The type `Laminas\Form\Form` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
8
9			class ConfigForm extends Form
10			{
11			protected $globalSettings;
12
13			/**
14			* Initialize the configuration form.
15			*/
16			public function init(): void
17			{
18			$this->addAdapter();
19			$this->addS3('aws', 'Amazon S3 Storage');
20			$this->addAzure();
21			$this->addGoogle();
22			$this->addS3('wasabi', 'Wasabi Cloud Storage', 'Wasabi');
23			$this->addS3('digital_ocean', 'DigitalOcean Spaces', 'DigitalOcean');
24			$this->addS3('scaleway', 'Scaleway Object Storage', 'Scaleway');
25			$this->addRackspace();
26			$this->addDropbox();
27			}
28
29			/**
30			* Set configuration settings.
31			*/
32			public function setGlobalSettings($globalSettings): void
33			{
34			$this->globalSettings = $globalSettings;
35			}
36
37			/**
38			* Add adapter drop-down options to configuration form.
39			*/
40			private function addAdapter(): void
41			{
42			$this->add([
43			'name' => 'anycloud_adapter',
44			'type' => Fieldset::class,
45			'options' => [
46			'label' => 'Any Cloud Adapter',
47			],
48			'attributes' => [
49			'id' => 'adapter-fieldset',
50			],
51			]);
52			$adapterFieldset = $this->get('anycloud_adapter');
53			$adapterFieldset->add([
54			'name' => 'adapter',
55			'type' => Element\Select::class,
			0 ignored issues – show Bug introduced 2020-12-29 20:52 UTC by Report Bug Copy Issue Report The type `Laminas\Form\Element\Select` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
56			'options' => [
57			'label' => 'Cloud Service Adapter: ',
58			'value_options' => [
59			'default' => 'Omeka Default (local server)',
60			'aws' => 'Amazon S3 Storage',
61			'azure' => 'Microsoft Azure Storage',
62			'google' => 'Google Cloud Storage',
63			'wasabi' => 'Wasabi Cloud Storage',
64			'digital_ocean' => 'DigitalOcean Spaces',
65			'scaleway' => 'Scaleway Object Storage',
66			'rackspace' => 'Rackspace Files',
67			'dropbox' => 'Dropbox',
68			],
69			],
70			'attributes' => [
71			'id' => 'adapter',
72			],
73			]);
74			}
75
76			/**
77			* Add any Amazon S3-based storage adapter.
78			*
79			* @param string $id ID used to identify adapter
80			* @param string $name Full name of adapter
81			* @param string\|null $label Abbreviated name used for form labels
82			*/
83			private function addS3($id, $name, $label = null): void
84			{
85			$label = $label === null ? $label : $label.' ';
86			$this->add([
87			'name' => 'anycloud_'.$id,
88			'type' => Fieldset::class,
89			'options' => [
90			'label' => $name,
91			],
92			'attributes' => [
93			'class' => $id.' fieldset',
94			],
95			]);
96			$awsFieldset = $this->get('anycloud_'.$id);
97			$awsFieldset->add([
98			'name' => $id.'_key',
99			'type' => Element\Text::class,
			0 ignored issues – show Bug introduced 2020-12-29 20:52 UTC by Report Bug Copy Issue Report The type `Laminas\Form\Element\Text` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
100			'options' => [
101			'label' => $label.'AWS Key',
102			],
103			'attributes' => [
104			'id' => $id.'_key',
105			],
106			]);
107			$awsFieldset->add([
108			'name' => $id.'_secret_key',
109			'type' => Element\Text::class,
110			'options' => [
111			'label' => $label.'AWS Secret Key',
112			],
113			'attributes' => [
114			'id' => $id.'_secret_key',
115			'cols' => '100',
116			],
117			]);
118			$awsFieldset->add([
119			'name' => $id.'_bucket',
120			'type' => Element\Text::class,
121			'options' => [
122			'label' => $label.'AWS Bucket',
123			],
124			'attributes' => [
125			'id' => $id.'_bucket',
126			],
127			]);
128			$awsFieldset->add([
129			'name' => $id.'_region',
130			'type' => Element\Text::class,
131			'options' => [
132			'label' => $label.'AWS Region',
133			],
134			'attributes' => [
135			'id' => $id.'_region',
136			],
137			]);
138			$awsFieldset->add([
139			'name' => $id.'_endpoint',
140			'type' => Element\Text::class,
141			'options' => [
142			'label' => $label.'AWS Endpoint',
143			'info' => 'Can usually leave blank unless you have a custom endpoint set up. See https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region',
144			],
145			'attributes' => [
146			'id' => $id.'_endpoint',
147			],
148			]);
149			}
150
151			/**
152			* Add Microsoft Azure Storage options to configuration form.
153			*/
154			private function addAzure(): void
155			{
156			$this->add([
157			'name' => 'anycloud_azure',
158			'type' => Fieldset::class,
159			'options' => [
160			'label' => 'Microsoft Azure Storage',
161			],
162			'attributes' => [
163			'class' => 'azure fieldset',
164			],
165			]);
166			$azureFieldset = $this->get('anycloud_azure');
167			$azureFieldset->add([
168			'name' => 'azure_account_name',
169			'type' => Element\Text::class,
170			'options' => [
171			'label' => 'Azure Account Name',
172			],
173			'attributes' => [
174			'id' => 'azure_account_name',
175			],
176			]);
177			$azureFieldset->add([
178			'name' => 'azure_account_key',
179			'type' => Element\Text::class,
180			'options' => [
181			'label' => 'Azure Account Key',
182			],
183			'attributes' => [
184			'id' => 'azure_account_key',
185			],
186			]);
187			$azureFieldset->add([
188			'name' => 'azure_container_name',
189			'type' => Element\Text::class,
190			'options' => [
191			'label' => 'Azure Container Name',
192			],
193			'attributes' => [
194			'id' => 'azure_container_name',
195			],
196			]);
197			$azureFieldset->add([
198			'name' => 'azure_endpoint',
199			'type' => Element\Text::class,
200			'options' => [
201			'label' => 'Azure Endpoint',
202			'info' => 'Can usually leave blank unless you have a custom endpoint set up',
203			],
204			'attributes' => [
205			'id' => 'azure_endpoint',
206			],
207			]);
208			}
209
210			/**
211			* Add Google Cloud Storage options to configuration form.
212			*/
213			private function addGoogle(): void
214			{
215			$this->add([
216			'name' => 'anycloud_google',
217			'type' => Fieldset::class,
218			'options' => [
219			'label' => 'Google Cloud Storage',
220			],
221			'attributes' => [
222			'class' => 'google fieldset',
223			],
224			]);
225			$googleFieldset = $this->get('anycloud_google');
226			$googleFieldset->add([
227			'name' => 'google_project_id',
228			'type' => Element\Text::class,
229			'options' => [
230			'label' => 'Google Project ID',
231			],
232			'attributes' => [
233			'id' => 'google_project_id',
234			],
235			]);
236			$googleFieldset->add([
237			'name' => 'google_bucket_name',
238			'type' => Element\Text::class,
239			'options' => [
240			'label' => 'Google Bucket Name',
241			],
242			'attributes' => [
243			'id' => 'google_bucket_name',
244			],
245			]);
246			$googleFieldset->add([
247			'name' => 'google_credentials_path',
248			'type' => Element\Text::class,
249			'options' => [
250			'label' => 'Google Credentials Path',
251			'info' => 'Replace {CONFIG} with the name of your Google credentials file stored at the listed path',
252			'value' => '/src/Service/File/Adapter/Google/{CONFIG}.json',
253			],
254			'attributes' => [
255			'id' => 'google_credentials_path',
256			],
257			]);
258			$googleFieldset->add([
259			'name' => 'google_storage_uri',
260			'type' => Element\Text::class,
261			'options' => [
262			'label' => 'Google Storage URI',
263			'info' => 'You can usually leave this as the default unless you have tweaked other settings',
264			'value' => 'https://storage.googleapis.com',
265			],
266			'attributes' => [
267			'id' => 'google_storage_uri',
268			],
269			]);
270			}
271
272			/**
273			* Add Rackspace Files options to configuration form.
274			*/
275			private function addRackspace(): void
276			{
277			$this->add([
278			'name' => 'anycloud_rackspace',
279			'type' => Fieldset::class,
280			'options' => [
281			'label' => 'Rackspace Files',
282			],
283			'attributes' => [
284			'class' => 'rackspace fieldset',
285			],
286			]);
287			$rackspaceFieldset = $this->get('anycloud_rackspace');
288			$rackspaceFieldset->add([
289			'name' => 'rackspace_identity_endpoint',
290			'type' => Element\Text::class,
291			'options' => [
292			'label' => 'Rackspace Identity Endpoint',
293			'info' => 'Valid options include “US_IDENTITY_ENDPOINT” and “UK_IDENTITY_ENDPOINT”',
294			],
295			'attributes' => [
296			'id' => 'rackspace_identity_endpoint',
297			],
298			]);
299			$rackspaceFieldset->add([
300			'name' => 'rackspace_username',
301			'type' => Element\Text::class,
302			'options' => [
303			'label' => 'Rackspace Username',
304			],
305			'attributes' => [
306			'id' => 'rackspace_username',
307			],
308			]);
309			$rackspaceFieldset->add([
310			'name' => 'rackspace_password',
311			'type' => Element\Text::class,
312			'options' => [
313			'label' => 'Rackspace Password',
314			],
315			'attributes' => [
316			'id' => 'rackspace_password',
317			],
318			]);
319			$rackspaceFieldset->add([
320			'name' => 'rackspace_container',
321			'type' => Element\Text::class,
322			'options' => [
323			'label' => 'Rackspace Container Name',
324			],
325			'attributes' => [
326			'id' => 'rackspace_container',
327			],
328			]);
329			$rackspaceFieldset->add([
330			'name' => 'rackspace_region',
331			'type' => Element\Text::class,
332			'options' => [
333			'label' => 'Rackspace Region',
334			],
335			'attributes' => [
336			'id' => 'rackspace_region',
337			],
338			]);
339			}
340
341			/**
342			* Add Dropbox options to configuration form.
343			*/
344			private function addDropbox(): void
345			{
346			$this->add([
347			'name' => 'anycloud_dropbox',
348			'type' => Fieldset::class,
349			'options' => [
350			'label' => 'Dropbox',
351			],
352			'attributes' => [
353			'class' => 'dropbox fieldset',
354			],
355			]);
356			$dropboxFieldset = $this->get('anycloud_dropbox');
357			$dropboxFieldset->add([
358			'name' => 'dropbox_access_token',
359			'type' => Element\Text::class,
360			'options' => [
361			'label' => 'Dropbox Access Token',
362			],
363			'attributes' => [
364			'id' => 'dropbox_access_token',
365			],
366			]);
367			}
368			}
369

HBLL-Collection-Development / omeka-s-any-cloud

Pull Request — master (#21)

ConfigForm::addDropbox() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like