PopulateThemeSampleDataTask::createContactForm() - Code Metrics - silverstripe/cwp - Measure and Improve Code Quality continuously with Scrutinizer

PopulateThemeSampleDataTask::createContactForm() A
last analyzed 2021-06-10 01:33 UTC

↳ Parent: PopulateThemeSampleDataTask

Complexity

Conditions	2
Paths	2

Size

Total Lines	54
Code Lines	36

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	36
nc	2
nop	0
dl	0
loc	54
rs	9.344
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)
    {
        if (!class_exists(UserDefinedForm::class)) {
            return;
        }
        $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([
                'Title' => _t(
                    'SilverStripe\\UserForms\\Model\\EditableFormField\\EditableFormStep.TITLE_FIRST',
                    'First Page'
                )
            ]),
            EditableTextField::create([
                'Title' => 'Name',
                'Required' => true,
                'RightTitle' => 'Please enter your first and last name'
            ]),
            EditableEmailField::create([
                'Title' => Email::class,
                'Required' => true,
                'Placeholder' => '[email protected]'
            ]),
            EditableTextField::create([
                'Title' => 'Subject'
            ]),
            EditableTextField::create([
                'Title' => 'Message',
                'Required' => true,
                'Rows' => 5
            ])
        );

        foreach ($fields as $field) {
            $field->write();
            $form->Fields()->add($field);
            $field->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
        }

        $form->copyVersionToStage(Versioned::DRAFT, Versioned::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			if (!class_exists(UserDefinedForm::class)) {
33			return;
34			}
35			$this->handleContactForm();
36			}
37
38			/**
39			* Decide whether to create a contact user defined form, and call it to be be created if so
40			*
41			* @return $this
42			*/
43			protected function handleContactForm()
44			{
45			if (!$this->getContactFormExists()) {
46			$this->createContactForm();
47			}
48			return $this;
49			}
50
51			/**
52			* Determine whether a "contact us" userform exists yet
53			*
54			* @return bool
55			*/
56			protected function getContactFormExists()
57			{
58			$exists = false;
59			foreach (UserDefinedForm::get()->column('ID') as $formId) {
60			$count = Versioned::get_all_versions(UserDefinedForm::class, $formId)
61			->filter('URLSegment', 'contact')
62			->count();
63
64			if ($count >= 1) {
65			$exists = true;
66			break;
67			}
68			}
69			return $exists;
70			}
71
72			/**
73			* Create a "contact us" userform. Please note that this form does not have any recipients by default, so
74			* no emails will be sent. To add recipients - edit the page in the CMS and add a recipient via the "Recipients"
75			* tab.
76			*
77			* @return $this
78			*/
79			protected function createContactForm()
80			{
81			$form = UserDefinedForm::create(array(
82			'Title' => 'Contact',
83			'URLSegment' => 'contact',
84			'Content' => '<p>$UserDefinedForm</p>',
85			'SubmitButtonText' => 'Submit',
86			'ClearButtonText' => 'Clear',
87			'OnCompleteMessage' => "<p>Thanks, we've received your submission and will be in touch shortly.</p>",
88			'EnableLiveValidation' => true
89			));
90
91			$form->write();
92
93			// Add form fields
94			$fields = array(
95			EditableFormStep::create([
96			'Title' => _t(
97			'SilverStripe\\UserForms\\Model\\EditableFormField\\EditableFormStep.TITLE_FIRST',
98			'First Page'
99			)
100			]),
101			EditableTextField::create([
102			'Title' => 'Name',
103			'Required' => true,
104			'RightTitle' => 'Please enter your first and last name'
105			]),
106			EditableEmailField::create([
107			'Title' => Email::class,
108			'Required' => true,
109			'Placeholder' => '[email protected]'
110			]),
111			EditableTextField::create([
112			'Title' => 'Subject'
113			]),
114			EditableTextField::create([
115			'Title' => 'Message',
116			'Required' => true,
117			'Rows' => 5
118			])
119			);
120
121			foreach ($fields as $field) {
122			$field->write();
123			$form->Fields()->add($field);
124			$field->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
125			}
126
127			$form->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
128			$form->flushCache();
129
130			$this->output(' + Created "contact" UserDefinedForm page');
131
132			return $this;
133			}
134
135			/**
136			* Output a message either to the console or browser
137			*
138			* @param string $message
139			* @return $this
140			*/
141			protected function output($message)
142			{
143			if (Director::is_cli()) {
144			$message .= PHP_EOL;
145			} else {
146			$message = sprintf('<p>%s</p>', $message);
147			}
148			echo $message;
149
150			return $this;
151			}
152			}
153

silverstripe / cwp

PopulateThemeSampleDataTask::createContactForm() A last analyzed 2021-06-10 01:33 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

PopulateThemeSampleDataTask::createContactForm() A
last analyzed 2021-06-10 01:33 UTC