FieldGroup::getName() - Code Metrics - Inspection of "Merge pull request #5776 from open-sausages/pulls/..." - silverstripe/silverstripe-framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d19955...af891e )

by Sam

created 2016-07-15 05:06 UTC

FieldGroup::getName() B

↳ Parent: FieldGroup

Complexity

Conditions	5
Paths	7

Size

Total Lines	17
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	5
eloc	11
c	1
b	0
f	0
nc	7
nop	0
dl	0
loc	17
rs	8.8571

<?php
/**
 * Lets you include a nested group of fields inside a template.
 * This control gives you more flexibility over form layout.
 *
 * Note: the child fields within a field group aren't rendered using FieldHolder().  Instead,
 * SmallFieldHolder() is called, which just prefixes $Field with a <label> tag, if the Title is set.
 *
 * <b>Usage</b>
 *
 * <code>
 * FieldGroup::create(
 * 	FieldGroup::create(
 * 		HeaderField::create('FieldGroup 1'),
 * 		TextField::create('Firstname')
 * 	),
 * 	FieldGroup::create(
 * 		HeaderField::create('FieldGroup 2'),
 * 		TextField::create('Surname')
 * 	)
 * )
 * </code>
 *
 * <b>Adding to existing FieldGroup instances</b>
 *
 * <code>
 * function getCMSFields() {
 * 	$fields = parent::getCMSFields();
 *
 * 	$fields->addFieldToTab(
 * 		'Root.Main',
 * 		FieldGroup::create(
 * 			TimeField::create("StartTime","What's the start time?"),
 * 			TimeField::create("EndTime","What's the end time?")
 * 		),
 * 		'Content'
 * 	);
 *
 * 	return $fields;
 *
 * }
 * </code>
 *
 * <b>Setting a title to a FieldGroup</b>
 *
 * <code>
 * $fields->addFieldToTab("Root.Main",
 * 		FieldGroup::create(
 * 			TimeField::create('StartTime','What's the start time?'),
 * 			TimeField::create('EndTime', 'What's the end time?')
 * 		)->setTitle('Time')
 * );
 * </code>
 *
 * @package forms
 * @subpackage fields-structural
 */
class FieldGroup extends CompositeField {

	protected $zebra;

	/**
	 * Create a new field group.
	 *
	 * Accepts any number of arguments.
	 *
	 * @param mixed $titleOrField Either the field title, list of fields, or first field
	 * @param mixed ...$otherFields Subsequent fields or field list (if passing in title to $titleOrField)
	 */
	public function __construct($titleOrField = null, $otherFields = null) {
		$title = null;
		if(is_array($titleOrField) || $titleOrField instanceof FieldList) {
			$fields = $titleOrField;

			// This would be discarded otherwise
			if($otherFields) {
				throw new InvalidArgumentException(
					'$otherFields is not accepted if passing in field list to $titleOrField'
				);
			}

		} else if(is_array($otherFields) || $otherFields instanceof FieldList) {
			$title = $titleOrField;
			$fields = $otherFields;

		} else {
			$fields = func_get_args();
			if(!is_object(reset($fields))) {
				$title = array_shift($fields);
			}
		}

		parent::__construct($fields);

		if($title) {
			$this->setTitle($title);
		}
	}

	/**
	 * Returns the name (ID) for the element.
	 * In some cases the FieldGroup doesn't have a title, but we still want
	 * the ID / name to be set. This code, generates the ID from the nested children
	 */
	public function getName(){
		if(!$this->title) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
			$fs = $this->FieldList();
			$compositeTitle = '';
			$count = 0;
			foreach($fs as $subfield){
				/** @var FormField $subfield */
				$compositeTitle .= $subfield->getName();
				if($subfield->getName()) $count++;
			}
			/** @skipUpgrade */
			if($count == 1) $compositeTitle .= 'Group';
			return preg_replace("/[^a-zA-Z0-9]+/", "", $compositeTitle);
		}

		return preg_replace("/[^a-zA-Z0-9]+/", "", $this->title);
	}

	/**
	 * Set an odd/even class
	 *
	 * @param string $zebra one of odd or even.
	 * @return $this
	 */
	public function setZebra($zebra) {
		if($zebra == 'odd' || $zebra == 'even') $this->zebra = $zebra;
		else user_error("setZebra passed '$zebra'.  It should be passed 'odd' or 'even'", E_USER_WARNING);
		return $this;
	}

	/**
	 * @return string
	 */
	public function getZebra() {
		return $this->zebra;
	}

	/**
	 * @return string
	 */
	public function Message() {
		$fs = array();
		$this->collateDataFields($fs);

		foreach($fs as $subfield) {
			if($m = $subfield->Message()) $message[] = rtrim($m, ".");
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
		}

		return (isset($message)) ? implode(",  ", $message) . "." : "";
	}

	/**
	 * @return string
	 */
	public function MessageType() {
		$fs = array();
		$this->collateDataFields($fs);

		foreach($fs as $subfield) {
			if($m = $subfield->MessageType()) $MessageType[] = $m;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
		}

		return (isset($MessageType)) ? implode(".  ", $MessageType) : "";
	}
}


1			<?php
2			/**
3			* Lets you include a nested group of fields inside a template.
4			* This control gives you more flexibility over form layout.
5			*
6			* Note: the child fields within a field group aren't rendered using FieldHolder(). Instead,
7			* SmallFieldHolder() is called, which just prefixes $Field with a <label> tag, if the Title is set.
8			*
9			* <b>Usage</b>
10			*
11			* <code>
12			* FieldGroup::create(
13			* FieldGroup::create(
14			* HeaderField::create('FieldGroup 1'),
15			* TextField::create('Firstname')
16			* ),
17			* FieldGroup::create(
18			* HeaderField::create('FieldGroup 2'),
19			* TextField::create('Surname')
20			* )
21			* )
22			* </code>
23			*
24			* <b>Adding to existing FieldGroup instances</b>
25			*
26			* <code>
27			* function getCMSFields() {
28			* $fields = parent::getCMSFields();
29			*
30			* $fields->addFieldToTab(
31			* 'Root.Main',
32			* FieldGroup::create(
33			* TimeField::create("StartTime","What's the start time?"),
34			* TimeField::create("EndTime","What's the end time?")
35			* ),
36			* 'Content'
37			* );
38			*
39			* return $fields;
40			*
41			* }
42			* </code>
43			*
44			* <b>Setting a title to a FieldGroup</b>
45			*
46			* <code>
47			* $fields->addFieldToTab("Root.Main",
48			* FieldGroup::create(
49			* TimeField::create('StartTime','What's the start time?'),
50			* TimeField::create('EndTime', 'What's the end time?')
51			* )->setTitle('Time')
52			* );
53			* </code>
54			*
55			* @package forms
56			* @subpackage fields-structural
57			*/
58			class FieldGroup extends CompositeField {
59
60			protected $zebra;
61
62			/**
63			* Create a new field group.
64			*
65			* Accepts any number of arguments.
66			*
67			* @param mixed $titleOrField Either the field title, list of fields, or first field
68			* @param mixed ...$otherFields Subsequent fields or field list (if passing in title to $titleOrField)
69			*/
70			public function __construct($titleOrField = null, $otherFields = null) {
71			$title = null;
72			if(is_array($titleOrField) \|\| $titleOrField instanceof FieldList) {
73			$fields = $titleOrField;
74
75			// This would be discarded otherwise
76			if($otherFields) {
77			throw new InvalidArgumentException(
78			'$otherFields is not accepted if passing in field list to $titleOrField'
79			);
80			}
81
82			} else if(is_array($otherFields) \|\| $otherFields instanceof FieldList) {
83			$title = $titleOrField;
84			$fields = $otherFields;
85
86			} else {
87			$fields = func_get_args();
88			if(!is_object(reset($fields))) {
89			$title = array_shift($fields);
90			}
91			}
92
93			parent::__construct($fields);
94
95			if($title) {
96			$this->setTitle($title);
97			}
98			}
99
100			/**
101			* Returns the name (ID) for the element.
102			* In some cases the FieldGroup doesn't have a title, but we still want
103			* the ID / name to be set. This code, generates the ID from the nested children
104			*/
105			public function getName(){
106			if(!$this->title) {
			0 ignored issues – show Bug Best Practice introduced 2015-11-25 21:50 UTC by Report Bug Copy Issue Report The expression `$this->title` of type `null\|string` is loosely compared to `false`; this is ambiguous if the string can be empty. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
107			$fs = $this->FieldList();
108			$compositeTitle = '';
109			$count = 0;
110			foreach($fs as $subfield){
111			/** @var FormField $subfield */
112			$compositeTitle .= $subfield->getName();
113			if($subfield->getName()) $count++;
114			}
115			/** @skipUpgrade */
116			if($count == 1) $compositeTitle .= 'Group';
117			return preg_replace("/[^a-zA-Z0-9]+/", "", $compositeTitle);
118			}
119
120			return preg_replace("/[^a-zA-Z0-9]+/", "", $this->title);
121			}
122
123			/**
124			* Set an odd/even class
125			*
126			* @param string $zebra one of odd or even.
127			* @return $this
128			*/
129			public function setZebra($zebra) {
130			if($zebra == 'odd' \|\| $zebra == 'even') $this->zebra = $zebra;
131			else user_error("setZebra passed '$zebra'. It should be passed 'odd' or 'even'", E_USER_WARNING);
132			return $this;
133			}
134
135			/**
136			* @return string
137			*/
138			public function getZebra() {
139			return $this->zebra;
140			}
141
142			/**
143			* @return string
144			*/
145			public function Message() {
146			$fs = array();
147			$this->collateDataFields($fs);
148
149			foreach($fs as $subfield) {
150			if($m = $subfield->Message()) $message[] = rtrim($m, ".");
			0 ignored issues – show Coding Style Comprehensibility introduced 2015-11-25 21:50 UTC by Report Bug Copy Issue Report `$message` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$message = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
151			}
152
153			return (isset($message)) ? implode(", ", $message) . "." : "";
154			}
155
156			/**
157			* @return string
158			*/
159			public function MessageType() {
160			$fs = array();
161			$this->collateDataFields($fs);
162
163			foreach($fs as $subfield) {
164			if($m = $subfield->MessageType()) $MessageType[] = $m;
			0 ignored issues – show Coding Style Comprehensibility introduced 2015-11-25 21:50 UTC by Report Bug Copy Issue Report `$MessageType` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$MessageType = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
165			}
166
167			return (isset($MessageType)) ? implode(". ", $MessageType) : "";
168			}
169			}
170

silverstripe / silverstripe-framework

Push — master ( d19955...af891e )

FieldGroup::getName() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like