Issues in LegacyForm.php - New Issues - Inspection of "Release candidate 2020-06-01 "Hogfather" RC2" - splitbrain/dokuwiki - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — stable ( 017e16...b83837 )

unknown

created 2020-06-03 13:51 UTC

inc/Form/LegacyForm.php (1 issue)

Labels

Deprecated Code 1

Severity

Minor 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
namespace dokuwiki\Form;

/**
 * Class LegacyForm
 *
 * Provides a compatibility layer to the old Doku_Form API
 *
 * This can be used to work with the modern API on forms provided by old events for
 * example. When you start new forms, just use Form\Form
 *
 * @package dokuwiki\Form
 */
class LegacyForm extends Form {

    /**
     * Creates a new modern form from an old legacy Doku_Form
     *
     * @param \Doku_Form $oldform
     */
    public function __construct(\Doku_Form $oldform) {
        parent::__construct($oldform->params);

        $this->hidden = $oldform->_hidden;

        foreach($oldform->_content as $element) {
            list($ctl, $attr) = $this->parseLegacyAttr($element);

            if(is_array($element)) {
                switch($ctl['elem']) {
                    case 'wikitext':
                        $this->addTextarea('wikitext')
                             ->attrs($attr)
                             ->id('wiki__text')
                             ->val($ctl['text'])
                             ->addClass($ctl['class']);
                        break;
                    case 'textfield':
                        $this->addTextInput($ctl['name'], $ctl['text'])
                             ->attrs($attr)
                             ->id($ctl['id'])
                             ->addClass($ctl['class']);
                        break;
                    case 'passwordfield':
                        $this->addPasswordInput($ctl['name'], $ctl['text'])
                             ->attrs($attr)
                             ->id($ctl['id'])
                             ->addClass($ctl['class']);
                        break;
                    case 'checkboxfield':
                        $this->addCheckbox($ctl['name'], $ctl['text'])
                             ->attrs($attr)
                             ->id($ctl['id'])
                             ->addClass($ctl['class']);
                        break;
                    case 'radiofield':
                        $this->addRadioButton($ctl['name'], $ctl['text'])
                             ->attrs($attr)
                             ->id($ctl['id'])
                             ->addClass($ctl['class']);
                        break;
                    case 'tag':
                        $this->addTag($ctl['tag'])
                             ->attrs($attr)
                             ->attr('name', $ctl['name'])
                             ->id($ctl['id'])
                             ->addClass($ctl['class']);
                        break;
                    case 'opentag':
                        $this->addTagOpen($ctl['tag'])
                             ->attrs($attr)
                             ->attr('name', $ctl['name'])
                             ->id($ctl['id'])
                             ->addClass($ctl['class']);
                        break;
                    case 'closetag':
                        $this->addTagClose($ctl['tag']);
                        break;
                    case 'openfieldset':
                        $this->addFieldsetOpen($ctl['legend'])
                            ->attrs($attr)
                            ->attr('name', $ctl['name'])
                            ->id($ctl['id'])
                            ->addClass($ctl['class']);
                        break;
                    case 'closefieldset':
                        $this->addFieldsetClose();
                        break;
                    case 'button':
                    case 'field':
                    case 'fieldright':
                    case 'filefield':
                    case 'menufield':
                    case 'listboxfield':
                        throw new \UnexpectedValueException('Unsupported legacy field ' . $ctl['elem']);
                        break;
                    default:
                        throw new \UnexpectedValueException('Unknown legacy field ' . $ctl['elem']);

                }
            } else {
                $this->addHTML($element);
            }
        }

    }

    /**
     * Parses out what is the elements attributes and what is control info
     *
     * @param array $legacy
     * @return array
     */
    protected function parseLegacyAttr($legacy) {
        $attributes = array();
        $control = array();

        foreach($legacy as $key => $val) {
            if($key[0] == '_') {
                $control[substr($key, 1)] = $val;
            } elseif($key == 'name') {
                $control[$key] = $val;
            } elseif($key == 'id') {
                $control[$key] = $val;
            } else {
                $attributes[$key] = $val;
            }
        }

        return array($control, $attributes);
    }

    /**
     * Translates our types to the legacy types
     *
     * @param string $type
     * @return string
     */
    protected function legacyType($type) {
        static $types = array(
            'text' => 'textfield',
            'password' => 'passwordfield',
            'checkbox' => 'checkboxfield',
            'radio' => 'radiofield',
            'tagopen' => 'opentag',
            'tagclose' => 'closetag',
            'fieldsetopen' => 'openfieldset',
            'fieldsetclose' => 'closefieldset',
        );
        if(isset($types[$type])) return $types[$type];
        return $type;
    }

    /**
     * Creates an old legacy form from this modern form's data
     *
     * @return \Doku_Form
     */
    public function toLegacy() {
        $this->balanceFieldsets();

        $legacy = new \Doku_Form($this->attrs());

        $legacy->_hidden = $this->hidden;
        foreach($this->elements as $element) {
            if(is_a($element, 'dokuwiki\Form\HTMLElement')) {
                $legacy->_content[] = $element->toHTML();
            } elseif(is_a($element, 'dokuwiki\Form\InputElement')) {
                /** @var InputElement $element */
                $data = $element->attrs();
                $data['_elem'] = $this->legacyType($element->getType());
                $label = $element->getLabel();
                if($label) {
                    $data['_class'] = $label->attr('class');
                }
                $legacy->_content[] = $data;
            }
        }

        return $legacy;
    }
}


1			<?php
2			namespace dokuwiki\Form;
3
4			/**
5			* Class LegacyForm
6			*
7			* Provides a compatibility layer to the old Doku_Form API
8			*
9			* This can be used to work with the modern API on forms provided by old events for
10			* example. When you start new forms, just use Form\Form
11			*
12			* @package dokuwiki\Form
13			*/
14			class LegacyForm extends Form {
15
16			/**
17			* Creates a new modern form from an old legacy Doku_Form
18			*
19			* @param \Doku_Form $oldform
20			*/
21			public function __construct(\Doku_Form $oldform) {
22			parent::__construct($oldform->params);
23
24			$this->hidden = $oldform->_hidden;
25
26			foreach($oldform->_content as $element) {
27			list($ctl, $attr) = $this->parseLegacyAttr($element);
28
29			if(is_array($element)) {
30			switch($ctl['elem']) {
31			case 'wikitext':
32			$this->addTextarea('wikitext')
33			->attrs($attr)
34			->id('wiki__text')
35			->val($ctl['text'])
36			->addClass($ctl['class']);
37			break;
38			case 'textfield':
39			$this->addTextInput($ctl['name'], $ctl['text'])
40			->attrs($attr)
41			->id($ctl['id'])
42			->addClass($ctl['class']);
43			break;
44			case 'passwordfield':
45			$this->addPasswordInput($ctl['name'], $ctl['text'])
46			->attrs($attr)
47			->id($ctl['id'])
48			->addClass($ctl['class']);
49			break;
50			case 'checkboxfield':
51			$this->addCheckbox($ctl['name'], $ctl['text'])
52			->attrs($attr)
53			->id($ctl['id'])
54			->addClass($ctl['class']);
55			break;
56			case 'radiofield':
57			$this->addRadioButton($ctl['name'], $ctl['text'])
58			->attrs($attr)
59			->id($ctl['id'])
60			->addClass($ctl['class']);
61			break;
62			case 'tag':
63			$this->addTag($ctl['tag'])
64			->attrs($attr)
65			->attr('name', $ctl['name'])
66			->id($ctl['id'])
67			->addClass($ctl['class']);
68			break;
69			case 'opentag':
70			$this->addTagOpen($ctl['tag'])
71			->attrs($attr)
72			->attr('name', $ctl['name'])
73			->id($ctl['id'])
74			->addClass($ctl['class']);
75			break;
76			case 'closetag':
77			$this->addTagClose($ctl['tag']);
78			break;
79			case 'openfieldset':
80			$this->addFieldsetOpen($ctl['legend'])
81			->attrs($attr)
82			->attr('name', $ctl['name'])
83			->id($ctl['id'])
84			->addClass($ctl['class']);
85			break;
86			case 'closefieldset':
87			$this->addFieldsetClose();
88			break;
89			case 'button':
90			case 'field':
91			case 'fieldright':
92			case 'filefield':
93			case 'menufield':
94			case 'listboxfield':
95			throw new \UnexpectedValueException('Unsupported legacy field ' . $ctl['elem']);
96			break;
97			default:
98			throw new \UnexpectedValueException('Unknown legacy field ' . $ctl['elem']);
99
100			}
101			} else {
102			$this->addHTML($element);
103			}
104			}
105
106			}
107
108			/**
109			* Parses out what is the elements attributes and what is control info
110			*
111			* @param array $legacy
112			* @return array
113			*/
114			protected function parseLegacyAttr($legacy) {
115			$attributes = array();
116			$control = array();
117
118			foreach($legacy as $key => $val) {
119			if($key[0] == '_') {
120			$control[substr($key, 1)] = $val;
121			} elseif($key == 'name') {
122			$control[$key] = $val;
123			} elseif($key == 'id') {
124			$control[$key] = $val;
125			} else {
126			$attributes[$key] = $val;
127			}
128			}
129
130			return array($control, $attributes);
131			}
132
133			/**
134			* Translates our types to the legacy types
135			*
136			* @param string $type
137			* @return string
138			*/
139			protected function legacyType($type) {
140			static $types = array(
141			'text' => 'textfield',
142			'password' => 'passwordfield',
143			'checkbox' => 'checkboxfield',
144			'radio' => 'radiofield',
145			'tagopen' => 'opentag',
146			'tagclose' => 'closetag',
147			'fieldsetopen' => 'openfieldset',
148			'fieldsetclose' => 'closefieldset',
149			);
150			if(isset($types[$type])) return $types[$type];
151			return $type;
152			}
153
154			/**
155			* Creates an old legacy form from this modern form's data
156			*
157			* @return \Doku_Form
158			*/
159			public function toLegacy() {
160			$this->balanceFieldsets();
161
162			$legacy = new \Doku_Form($this->attrs());
			0 ignored issues – show Deprecated Code introduced 2019-07-14 19:13 UTC by Report Bug Copy Issue Report Show Similar Issues like this The class `Doku_Form` has been deprecated with message: 2019-07-14 This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
163			$legacy->_hidden = $this->hidden;
164			foreach($this->elements as $element) {
165			if(is_a($element, 'dokuwiki\Form\HTMLElement')) {
166			$legacy->_content[] = $element->toHTML();
167			} elseif(is_a($element, 'dokuwiki\Form\InputElement')) {
168			/** @var InputElement $element */
169			$data = $element->attrs();
170			$data['_elem'] = $this->legacyType($element->getType());
171			$label = $element->getLabel();
172			if($label) {
173			$data['_class'] = $label->attr('class');
174			}
175			$legacy->_content[] = $data;
176			}
177			}
178
179			return $legacy;
180			}
181			}
182

splitbrain / dokuwiki

Push — stable ( 017e16...b83837 )

inc/Form/LegacyForm.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like