RemoteFileModalExtension::getOwner() - Code Metrics - Inspection of "Pulls/4.0/309 insert update media button label" - silverstripe/silverstripe-asset-admin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#499)

unknown

created 2017-06-09 04:18 UTC

RemoteFileModalExtension::getOwner() A

↳ Parent: RemoteFileModalExtension

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	0
loc	6
rs	9.4285
c	1
b	0
f	0
cc	1
eloc	3
nc	1
nop	0

<?php

namespace SilverStripe\AssetAdmin\Extensions;

use Embed\Exceptions\InvalidUrlException;
use SilverStripe\Admin\LeftAndMain;
use SilverStripe\Admin\ModalController;
use SilverStripe\AssetAdmin\Forms\RemoteFileFormFactory;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Control\HTTPResponse;
use SilverStripe\Core\Convert;
use SilverStripe\Core\Extension;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\Form;
use SilverStripe\Forms\Schema\FormSchema;
use SilverStripe\ORM\ValidationResult;

/**
 * Decorates ModalController with an insert-oembed modal
 * @see ModalController
 */
class RemoteFileModalExtension extends Extension
{
    private static $allowed_actions = array(

        'remoteCreateForm',
        'remoteEditForm',
        'remoteEditFormSchema',
    );

    /**
     * @return ModalController
     */
    public function getOwner()
    {
        /** @var ModalController $owner */
        $owner = $this->owner;
        return $owner;
    }

    /**
     * @return HTTPRequest
     */
    protected function getRequest()
    {
        return $this->getOwner()->getController()->getRequest();
    }

    /**
     * @return FormSchema
     */
    protected function getFormSchema()
    {
        return FormSchema::singleton();
    }

    /**
     * Form for creating a new OEmbed object in the WYSIWYG, used by the InsertEmbedModal component
     *
     * @return Form
     */
    public function remoteCreateForm()
    {
        return Injector::inst()->get(RemoteFileFormFactory::class)
            ->getForm(
                $this->getOwner(),
                'remoteCreateForm',
                ['type' => 'create']
            );
    }

    /**
     * Form for editing a OEmbed object in the WYSIWYG, used by the InsertEmbedModal component
     *
     * @return Form
     */
    public function remoteEditForm()
    {
        $url = $this->getRequest()->requestVar('embedurl');
        $form = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $form = Injector::inst()->get(RemoteFileFormFactory::class)
            ->getForm(
                $this->getOwner(),
                'remoteEditForm',
                ['type' => 'edit', 'url' => $url]
            );
        return $form;
    }

    /**
     * Capture the schema handling process, as there is validation done to the URL provided before form is generated
     *
     * @param HTTPRequest $request
     * @return HTTPResponse
     */
    public function remoteEditFormSchema(HTTPRequest $request)
    {
        $schemaID = $request->getURL();
        try {
            $form = $this->remoteEditForm();
            return $this->getSchemaResponse($schemaID, $form);
        } catch (InvalidUrlException $exception) {
            $errors = ValidationResult::create()
                ->addError($exception->getMessage());
            // @todo - Don't create dummy form (pass $form = null)
            $form = Form::create(null, 'Form', FieldList::create(), FieldList::create());
            $code = $exception->getCode();

            if ($code < 300) {
                $code = 500;
            }

            return $this
                ->getSchemaResponse($schemaID, $form, $errors)
                ->setStatusCode($code);
        }
    }

    /**
     * Generate schema for the given form based on the X-Formschema-Request header value
     *
     * @todo de-dupe this logic with LeftAndMain::getSchemaResponse()
     *
     * @param string $schemaID ID for this schema. Required.
     * @param Form $form Required for 'state' or 'schema' response
     * @param ValidationResult $errors Required for 'error' response
     * @param array $extraData Any extra data to be merged with the schema response
     * @return HTTPResponse
     */
    protected function getSchemaResponse($schemaID, $form = null, ValidationResult $errors = null, $extraData = [])
    {
        $parts = $this->getRequest()->getHeader(LeftAndMain::SCHEMA_HEADER);
        $data = $this
            ->getFormSchema()
            ->getMultipartSchema($parts, $schemaID, $form, $errors);

        if ($extraData) {

            $data = array_merge($data, $extraData);
        }

        $response = new HTTPResponse(Convert::raw2json($data));
        $response->addHeader('Content-Type', 'application/json');
        return $response;
    }
}


1			<?php
2
3			namespace SilverStripe\AssetAdmin\Extensions;
4
5			use Embed\Exceptions\InvalidUrlException;
6			use SilverStripe\Admin\LeftAndMain;
7			use SilverStripe\Admin\ModalController;
8			use SilverStripe\AssetAdmin\Forms\RemoteFileFormFactory;
9			use SilverStripe\Control\HTTPRequest;
10			use SilverStripe\Control\HTTPResponse;
11			use SilverStripe\Core\Convert;
12			use SilverStripe\Core\Extension;
13			use SilverStripe\Core\Injector\Injector;
14			use SilverStripe\Forms\FieldList;
15			use SilverStripe\Forms\Form;
16			use SilverStripe\Forms\Schema\FormSchema;
17			use SilverStripe\ORM\ValidationResult;
18
19			/**
20			* Decorates ModalController with an insert-oembed modal
21			* @see ModalController
22			*/
23			class RemoteFileModalExtension extends Extension
24			{
25			private static $allowed_actions = array(
			0 ignored issues – show Comprehensibility introduced 2016-05-01 20:50 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2016-05-01 20:50 UTC by Report Bug Copy Issue Report The property `$allowed_actions` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
26			'remoteCreateForm',
27			'remoteEditForm',
28			'remoteEditFormSchema',
29			);
30
31			/**
32			* @return ModalController
33			*/
34			public function getOwner()
35			{
36			/** @var ModalController $owner */
37			$owner = $this->owner;
38			return $owner;
39			}
40
41			/**
42			* @return HTTPRequest
43			*/
44			protected function getRequest()
45			{
46			return $this->getOwner()->getController()->getRequest();
47			}
48
49			/**
50			* @return FormSchema
51			*/
52			protected function getFormSchema()
53			{
54			return FormSchema::singleton();
55			}
56
57			/**
58			* Form for creating a new OEmbed object in the WYSIWYG, used by the InsertEmbedModal component
59			*
60			* @return Form
61			*/
62			public function remoteCreateForm()
63			{
64			return Injector::inst()->get(RemoteFileFormFactory::class)
65			->getForm(
66			$this->getOwner(),
67			'remoteCreateForm',
68			['type' => 'create']
69			);
70			}
71
72			/**
73			* Form for editing a OEmbed object in the WYSIWYG, used by the InsertEmbedModal component
74			*
75			* @return Form
76			*/
77			public function remoteEditForm()
78			{
79			$url = $this->getRequest()->requestVar('embedurl');
80			$form = null;
			0 ignored issues – show Unused Code introduced 2017-03-21 22:50 UTC by Report Bug Copy Issue Report `$form` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
81			$form = Injector::inst()->get(RemoteFileFormFactory::class)
82			->getForm(
83			$this->getOwner(),
84			'remoteEditForm',
85			['type' => 'edit', 'url' => $url]
86			);
87			return $form;
88			}
89
90			/**
91			* Capture the schema handling process, as there is validation done to the URL provided before form is generated
92			*
93			* @param HTTPRequest $request
94			* @return HTTPResponse
95			*/
96			public function remoteEditFormSchema(HTTPRequest $request)
97			{
98			$schemaID = $request->getURL();
99			try {
100			$form = $this->remoteEditForm();
101			return $this->getSchemaResponse($schemaID, $form);
102			} catch (InvalidUrlException $exception) {
103			$errors = ValidationResult::create()
104			->addError($exception->getMessage());
105			// @todo - Don't create dummy form (pass $form = null)
106			$form = Form::create(null, 'Form', FieldList::create(), FieldList::create());
107			$code = $exception->getCode();
108
109			if ($code < 300) {
110			$code = 500;
111			}
112
113			return $this
114			->getSchemaResponse($schemaID, $form, $errors)
115			->setStatusCode($code);
116			}
117			}
118
119			/**
120			* Generate schema for the given form based on the X-Formschema-Request header value
121			*
122			* @todo de-dupe this logic with LeftAndMain::getSchemaResponse()
123			*
124			* @param string $schemaID ID for this schema. Required.
125			* @param Form $form Required for 'state' or 'schema' response
126			* @param ValidationResult $errors Required for 'error' response
127			* @param array $extraData Any extra data to be merged with the schema response
128			* @return HTTPResponse
129			*/
130			protected function getSchemaResponse($schemaID, $form = null, ValidationResult $errors = null, $extraData = [])
131			{
132			$parts = $this->getRequest()->getHeader(LeftAndMain::SCHEMA_HEADER);
133			$data = $this
134			->getFormSchema()
135			->getMultipartSchema($parts, $schemaID, $form, $errors);
136
137			if ($extraData) {
			0 ignored issues – show Bug Best Practice introduced 2017-05-26 06:51 UTC by Report Bug Copy Issue Report The expression `$extraData` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
138			$data = array_merge($data, $extraData);
139			}
140
141			$response = new HTTPResponse(Convert::raw2json($data));
142			$response->addHeader('Content-Type', 'application/json');
143			return $response;
144			}
145			}
146

silverstripe / silverstripe-asset-admin

Pull Request — master (#499)

RemoteFileModalExtension::getOwner() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like