PopulateThemeSampleDataTask::createContactForm() - Code Metrics - Inspection of "FIX Update syntax, get tests passing" - silverstripe/cwp - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#13)

by Robbie

created 2017-12-21 23:29 UTC

PopulateThemeSampleDataTask::createContactForm() A

↳ Parent: PopulateThemeSampleDataTask

Complexity

Conditions	2
Paths	2

Size

Total Lines	51
Code Lines	34

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	34
nc	2
nop	0
dl	0
loc	51
rs	9.4109
c	0
b	0
f	0

How to fix Long Method

<?php

namespace CWP\CWP\Tasks;

use SilverStripe\Control\Director;
use SilverStripe\Control\Email\Email;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Dev\BuildTask;
use SilverStripe\UserForms\Model\EditableFormField\EditableEmailField;
filter:
    dependency_paths: ["lib/*"]
use SilverStripe\UserForms\Model\EditableFormField\EditableFormStep;
filter:
    dependency_paths: ["lib/*"]
use SilverStripe\UserForms\Model\EditableFormField\EditableTextField;
filter:
    dependency_paths: ["lib/*"]
use SilverStripe\UserForms\Model\UserDefinedForm;
filter:
    dependency_paths: ["lib/*"]
use SilverStripe\Versioned\Versioned;

/**
 * Used to populate sample data when installing the starter or Wātea theme
 */
class PopulateThemeSampleDataTask extends BuildTask
{
    protected $title = 'Populate sample data for theme demo';

    protected $description = 'Populates some sample data for showcasing the functionality of the '
        . 'starter and Wātea themes';

    /**
     * A series of method calls to create sample data
     *
     * @param HTTPRequest $request
     */
    public function run($request)
    {
        $this->handleContactForm();
    }

    /**
     * Decide whether to create a contact user defined form, and call it to be be created if so
     *
     * @return $this
     */
    protected function handleContactForm()
    {
        if (!$this->getContactFormExists()) {
            $this->createContactForm();
        }
        return $this;
    }

    /**
     * Determine whether a "contact us" userform exists yet
     *
     * @return bool
     */
    protected function getContactFormExists()
    {
        $exists = false;
        foreach (UserDefinedForm::get()->column('ID') as $formId) {
            $count = Versioned::get_all_versions(UserDefinedForm::class, $formId)
                ->filter('URLSegment', 'contact')
                ->count();

            if ($count >= 1) {
                $exists = true;
                break;
            }
        }
        return $exists;
    }

    /**
     * Create a "contact us" userform. Please note that this form does not have any recipients by default, so
     * no emails will be sent. To add recipients - edit the page in the CMS and add a recipient via the "Recipients"
     * tab.
     *
     * @return $this
     */
    protected function createContactForm()
    {
        $form = UserDefinedForm::create(array(
            'Title' => 'Contact',
            'URLSegment' => 'contact',
            'Content' => '<p>$UserDefinedForm</p>',
            'SubmitButtonText' => 'Submit',
            'ClearButtonText' => 'Clear',
            'OnCompleteMessage' => "<p>Thanks, we've received your submission and will be in touch shortly.</p>",
            'EnableLiveValidation' => true
        ));

        $form->write();

        // Add form fields
        $fields = array(
            EditableFormStep::create(array(
                'Title' => _t('EditableFormStep.TITLE_FIRST', 'First Page')
            )),
            EditableTextField::create(array(
                'Title' => 'Name',
                'Required' => true,
                'RightTitle' => 'Please enter your first and last name'
            )),
            EditableEmailField::create(array(
                'Title' => Email::class,
                'Required' => true,
                'Placeholder' => '[email protected]'
            )),
            EditableTextField::create(array(
                'Title' => 'Subject'
            )),
            EditableTextField::create(array(
                'Title' => 'Message',
                'Required' => true,
                'Rows' => 5
            ))
        );

        foreach ($fields as $field) {
            $field->write();
            $form->Fields()->add($field);
            $field->publish('Stage', 'Live');
        }

        $form->publish('Stage', 'Live');
        $form->flushCache();

        $this->output(' + Created "contact" UserDefinedForm page');

        return $this;
    }

    /**
     * Output a message either to the console or browser
     *
     * @param  string $message
     * @return $this
     */
    protected function output($message)
    {
        if (Director::is_cli()) {
            $message .= PHP_EOL;
        } else {
            $message = sprintf('<p>%s</p>', $message);
        }
        echo $message;

        return $this;
    }
}


1			<?php
2
3			namespace CWP\CWP\Tasks;
4
5			use SilverStripe\Control\Director;
6			use SilverStripe\Control\Email\Email;
7			use SilverStripe\Control\HTTPRequest;
8			use SilverStripe\Dev\BuildTask;
9			use SilverStripe\UserForms\Model\EditableFormField\EditableEmailField;
			0 ignored issues – show Bug introduced 2017-12-21 23:06 UTC by Report Bug Copy Issue Report The type `SilverStripe\UserForms\M...ield\EditableEmailField` 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...
10			use SilverStripe\UserForms\Model\EditableFormField\EditableFormStep;
			0 ignored issues – show Bug introduced 2017-12-21 23:06 UTC by Report Bug Copy Issue Report The type `SilverStripe\UserForms\M...mField\EditableFormStep` 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...
11			use SilverStripe\UserForms\Model\EditableFormField\EditableTextField;
			0 ignored issues – show Bug introduced 2017-12-21 23:06 UTC by Report Bug Copy Issue Report The type `SilverStripe\UserForms\M...Field\EditableTextField` 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...
12			use SilverStripe\UserForms\Model\UserDefinedForm;
			0 ignored issues – show Bug introduced 2017-12-21 23:06 UTC by Report Bug Copy Issue Report The type `SilverStripe\UserForms\Model\UserDefinedForm` 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...
13			use SilverStripe\Versioned\Versioned;
14
15			/**
16			* Used to populate sample data when installing the starter or Wātea theme
17			*/
18			class PopulateThemeSampleDataTask extends BuildTask
19			{
20			protected $title = 'Populate sample data for theme demo';
21
22			protected $description = 'Populates some sample data for showcasing the functionality of the '
23			. 'starter and Wātea themes';
24
25			/**
26			* A series of method calls to create sample data
27			*
28			* @param HTTPRequest $request
29			*/
30			public function run($request)
31			{
32			$this->handleContactForm();
33			}
34
35			/**
36			* Decide whether to create a contact user defined form, and call it to be be created if so
37			*
38			* @return $this
39			*/
40			protected function handleContactForm()
41			{
42			if (!$this->getContactFormExists()) {
43			$this->createContactForm();
44			}
45			return $this;
46			}
47
48			/**
49			* Determine whether a "contact us" userform exists yet
50			*
51			* @return bool
52			*/
53			protected function getContactFormExists()
54			{
55			$exists = false;
56			foreach (UserDefinedForm::get()->column('ID') as $formId) {
57			$count = Versioned::get_all_versions(UserDefinedForm::class, $formId)
58			->filter('URLSegment', 'contact')
59			->count();
60
61			if ($count >= 1) {
62			$exists = true;
63			break;
64			}
65			}
66			return $exists;
67			}
68
69			/**
70			* Create a "contact us" userform. Please note that this form does not have any recipients by default, so
71			* no emails will be sent. To add recipients - edit the page in the CMS and add a recipient via the "Recipients"
72			* tab.
73			*
74			* @return $this
75			*/
76			protected function createContactForm()
77			{
78			$form = UserDefinedForm::create(array(
79			'Title' => 'Contact',
80			'URLSegment' => 'contact',
81			'Content' => '<p>$UserDefinedForm</p>',
82			'SubmitButtonText' => 'Submit',
83			'ClearButtonText' => 'Clear',
84			'OnCompleteMessage' => "<p>Thanks, we've received your submission and will be in touch shortly.</p>",
85			'EnableLiveValidation' => true
86			));
87
88			$form->write();
89
90			// Add form fields
91			$fields = array(
92			EditableFormStep::create(array(
93			'Title' => _t('EditableFormStep.TITLE_FIRST', 'First Page')
94			)),
95			EditableTextField::create(array(
96			'Title' => 'Name',
97			'Required' => true,
98			'RightTitle' => 'Please enter your first and last name'
99			)),
100			EditableEmailField::create(array(
101			'Title' => Email::class,
102			'Required' => true,
103			'Placeholder' => '[email protected]'
104			)),
105			EditableTextField::create(array(
106			'Title' => 'Subject'
107			)),
108			EditableTextField::create(array(
109			'Title' => 'Message',
110			'Required' => true,
111			'Rows' => 5
112			))
113			);
114
115			foreach ($fields as $field) {
116			$field->write();
117			$form->Fields()->add($field);
118			$field->publish('Stage', 'Live');
119			}
120
121			$form->publish('Stage', 'Live');
122			$form->flushCache();
123
124			$this->output(' + Created "contact" UserDefinedForm page');
125
126			return $this;
127			}
128
129			/**
130			* Output a message either to the console or browser
131			*
132			* @param string $message
133			* @return $this
134			*/
135			protected function output($message)
136			{
137			if (Director::is_cli()) {
138			$message .= PHP_EOL;
139			} else {
140			$message = sprintf('<p>%s</p>', $message);
141			}
142			echo $message;
143
144			return $this;
145			}
146			}
147

silverstripe / cwp

Pull Request — master (#13)

PopulateThemeSampleDataTask::createContactForm() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like