Inspection of "Unify settings" - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#4890)

by Blizzz

created 2017-06-26 09:04 UTC

Status

Indentation +85 added lines, -85 removed lines patch added patch discarded remove patch

@@ -27,99 +27,99 @@
 block discarded – undo
  * @since 9.1
  */
 interface IManager {
-	/**
-	 * @since 9.1.0
-	 */
-	const KEY_ADMIN_SETTINGS = 'admin';
+    /**
+     * @since 9.1.0
+     */
+    const KEY_ADMIN_SETTINGS = 'admin';
 
-	/**
-	 * @since 9.1.0
-	 */
-	const KEY_ADMIN_SECTION  = 'admin-section';
+    /**
+     * @since 9.1.0
+     */
+    const KEY_ADMIN_SECTION  = 'admin-section';
 
-	/**
-	 * @since 13.0.0
-	 */
-	const KEY_PERSONAL_SETTINGS = 'personal';
+    /**
+     * @since 13.0.0
+     */
+    const KEY_PERSONAL_SETTINGS = 'personal';
 
-	/**
-	 * @since 13.0.0
-	 */
-	const KEY_PERSONAL_SECTION  = 'personal-section';
+    /**
+     * @since 13.0.0
+     */
+    const KEY_PERSONAL_SECTION  = 'personal-section';
 
-	/**
-	 * sets up settings according to data specified by an apps info.xml, within
-	 * the <settings> element.
-	 *
-	 * @param array $settings an associative array, allowed keys are as specified
-	 *                        by the KEY_ constant of  this interface. The value
-	 *                        must always be a class name, implement either
-	 *                        IAdmin or ISection. I.e. only one section and admin
-	 *                        setting can be configured per app.
-	 * @since 9.1.0
-	 */
-	public function setupSettings(array $settings);
+    /**
+     * sets up settings according to data specified by an apps info.xml, within
+     * the <settings> element.
+     *
+     * @param array $settings an associative array, allowed keys are as specified
+     *                        by the KEY_ constant of  this interface. The value
+     *                        must always be a class name, implement either
+     *                        IAdmin or ISection. I.e. only one section and admin
+     *                        setting can be configured per app.
+     * @since 9.1.0
+     */
+    public function setupSettings(array $settings);
 
-	/**
-	 * attempts to remove an apps section and/or settings entry. A listener is
-	 * added centrally making sure that this method is called ones an app was
-	 * disabled.
-	 *
-	 * What this does not help with is when applications change their settings
-	 * or section classes during their life time. New entries will be added,
-	 * but inactive ones will still reside in the database.
-	 *
-	 * @param string $appId
-	 * @since 9.1.0
-	 */
-	public function onAppDisabled($appId);
+    /**
+     * attempts to remove an apps section and/or settings entry. A listener is
+     * added centrally making sure that this method is called ones an app was
+     * disabled.
+     *
+     * What this does not help with is when applications change their settings
+     * or section classes during their life time. New entries will be added,
+     * but inactive ones will still reside in the database.
+     *
+     * @param string $appId
+     * @since 9.1.0
+     */
+    public function onAppDisabled($appId);
 
-	/**
-	 * The method should check all registered classes whether they are still
-	 * instantiable and remove them, if not. This method is called by a
-	 * background job once, after one or more apps were updated.
-	 *
-	 * An app`s info.xml can change during an update and make it unknown whether
-	 * a registered class name was changed or not. An old one would just stay
-	 * registered. Another case is if an admin takes a radical approach and
-	 * simply removes an app from the app folder. These unregular checks will
-	 * take care of such situations.
-	 *
-	 * @since 9.1.0
-	 */
-	public function checkForOrphanedClassNames();
+    /**
+     * The method should check all registered classes whether they are still
+     * instantiable and remove them, if not. This method is called by a
+     * background job once, after one or more apps were updated.
+     *
+     * An app`s info.xml can change during an update and make it unknown whether
+     * a registered class name was changed or not. An old one would just stay
+     * registered. Another case is if an admin takes a radical approach and
+     * simply removes an app from the app folder. These unregular checks will
+     * take care of such situations.
+     *
+     * @since 9.1.0
+     */
+    public function checkForOrphanedClassNames();
 
-	/**
-	 * returns a list of the admin sections
-	 *
-	 * @return array array of ISection[] where key is the priority
-	 * @since 9.1.0
-	 */
-	public function getAdminSections();
+    /**
+     * returns a list of the admin sections
+     *
+     * @return array array of ISection[] where key is the priority
+     * @since 9.1.0
+     */
+    public function getAdminSections();
 
-	/**
-	 * returns a list of the personal sections
-	 *
-	 * @return array array of ISection[] where key is the priority
-	 * @since 13.0.0
-	 */
-	public function getPersonalSections();
+    /**
+     * returns a list of the personal sections
+     *
+     * @return array array of ISection[] where key is the priority
+     * @since 13.0.0
+     */
+    public function getPersonalSections();
 
-	/**
-	 * returns a list of the admin settings
-	 *
-	 * @param string $section the section id for which to load the settings
-	 * @return array array of IAdmin[] where key is the priority
-	 * @since 9.1.0
-	 */
-	public function getAdminSettings($section);
+    /**
+     * returns a list of the admin settings
+     *
+     * @param string $section the section id for which to load the settings
+     * @return array array of IAdmin[] where key is the priority
+     * @since 9.1.0
+     */
+    public function getAdminSettings($section);
 
-	/**
-	 * returns a list of the personal  settings
-	 *
-	 * @param string $section the section id for which to load the settings
-	 * @return array array of IPersonal[] where key is the priority
-	 * @since 13.0.0
-	 */
-	public function getPersonalSettings($section);
+    /**
+     * returns a list of the personal  settings
+     *
+     * @param string $section the section id for which to load the settings
+     * @return array array of IPersonal[] where key is the priority
+     * @since 13.0.0
+     */
+    public function getPersonalSettings($section);
 }

Please login to merge, or discard this patch.

Spacing +2 added lines, -2 removed lines patch added patch discarded remove patch

@@ -35,7 +35,7 @@  discard block
 block discarded – undo
 	/**
 	 * @since 9.1.0
 	 */
-	const KEY_ADMIN_SECTION  = 'admin-section';
+	const KEY_ADMIN_SECTION = 'admin-section';
 
 	/**
 	 * @since 13.0.0
@@ -45,7 +45,7 @@  discard block
 block discarded – undo
 	/**
 	 * @since 13.0.0
 	 */
-	const KEY_PERSONAL_SECTION  = 'personal-section';
+	const KEY_PERSONAL_SECTION = 'personal-section';
 
 	/**
 	 * sets up settings according to data specified by an apps info.xml, within

Please login to merge, or discard this patch.

		@@ -27,99 +27,99 @@
		block discarded – undo
27	27	* @since 9.1
28	28	*/
29	29	interface IManager {
30		- /**
31		- * @since 9.1.0
32		- */
33		- const KEY_ADMIN_SETTINGS = 'admin';
	30	+ /**
	31	+ * @since 9.1.0
	32	+ */
	33	+ const KEY_ADMIN_SETTINGS = 'admin';
34	34
35		- /**
36		- * @since 9.1.0
37		- */
38		- const KEY_ADMIN_SECTION = 'admin-section';
	35	+ /**
	36	+ * @since 9.1.0
	37	+ */
	38	+ const KEY_ADMIN_SECTION = 'admin-section';
39	39
40		- /**
41		- * @since 13.0.0
42		- */
43		- const KEY_PERSONAL_SETTINGS = 'personal';
	40	+ /**
	41	+ * @since 13.0.0
	42	+ */
	43	+ const KEY_PERSONAL_SETTINGS = 'personal';
44	44
45		- /**
46		- * @since 13.0.0
47		- */
48		- const KEY_PERSONAL_SECTION = 'personal-section';
	45	+ /**
	46	+ * @since 13.0.0
	47	+ */
	48	+ const KEY_PERSONAL_SECTION = 'personal-section';
49	49
50		- /**
51		- * sets up settings according to data specified by an apps info.xml, within
52		- * the <settings> element.
53		- *
54		- * @param array $settings an associative array, allowed keys are as specified
55		- * by the KEY_ constant of this interface. The value
56		- * must always be a class name, implement either
57		- * IAdmin or ISection. I.e. only one section and admin
58		- * setting can be configured per app.
59		- * @since 9.1.0
60		- */
61		- public function setupSettings(array $settings);
	50	+ /**
	51	+ * sets up settings according to data specified by an apps info.xml, within
	52	+ * the <settings> element.
	53	+ *
	54	+ * @param array $settings an associative array, allowed keys are as specified
	55	+ * by the KEY_ constant of this interface. The value
	56	+ * must always be a class name, implement either
	57	+ * IAdmin or ISection. I.e. only one section and admin
	58	+ * setting can be configured per app.
	59	+ * @since 9.1.0
	60	+ */
	61	+ public function setupSettings(array $settings);
62	62
63		- /**
64		- * attempts to remove an apps section and/or settings entry. A listener is
65		- * added centrally making sure that this method is called ones an app was
66		- * disabled.
67		- *
68		- * What this does not help with is when applications change their settings
69		- * or section classes during their life time. New entries will be added,
70		- * but inactive ones will still reside in the database.
71		- *
72		- * @param string $appId
73		- * @since 9.1.0
74		- */
75		- public function onAppDisabled($appId);
	63	+ /**
	64	+ * attempts to remove an apps section and/or settings entry. A listener is
	65	+ * added centrally making sure that this method is called ones an app was
	66	+ * disabled.
	67	+ *
	68	+ * What this does not help with is when applications change their settings
	69	+ * or section classes during their life time. New entries will be added,
	70	+ * but inactive ones will still reside in the database.
	71	+ *
	72	+ * @param string $appId
	73	+ * @since 9.1.0
	74	+ */
	75	+ public function onAppDisabled($appId);
76	76
77		- /**
78		- * The method should check all registered classes whether they are still
79		- * instantiable and remove them, if not. This method is called by a
80		- * background job once, after one or more apps were updated.
81		- *
82		- * An app`s info.xml can change during an update and make it unknown whether
83		- * a registered class name was changed or not. An old one would just stay
84		- * registered. Another case is if an admin takes a radical approach and
85		- * simply removes an app from the app folder. These unregular checks will
86		- * take care of such situations.
87		- *
88		- * @since 9.1.0
89		- */
90		- public function checkForOrphanedClassNames();
	77	+ /**
	78	+ * The method should check all registered classes whether they are still
	79	+ * instantiable and remove them, if not. This method is called by a
	80	+ * background job once, after one or more apps were updated.
	81	+ *
	82	+ * An app`s info.xml can change during an update and make it unknown whether
	83	+ * a registered class name was changed or not. An old one would just stay
	84	+ * registered. Another case is if an admin takes a radical approach and
	85	+ * simply removes an app from the app folder. These unregular checks will
	86	+ * take care of such situations.
	87	+ *
	88	+ * @since 9.1.0
	89	+ */
	90	+ public function checkForOrphanedClassNames();
91	91
92		- /**
93		- * returns a list of the admin sections
94		- *
95		- * @return array array of ISection[] where key is the priority
96		- * @since 9.1.0
97		- */
98		- public function getAdminSections();
	92	+ /**
	93	+ * returns a list of the admin sections
	94	+ *
	95	+ * @return array array of ISection[] where key is the priority
	96	+ * @since 9.1.0
	97	+ */
	98	+ public function getAdminSections();
99	99
100		- /**
101		- * returns a list of the personal sections
102		- *
103		- * @return array array of ISection[] where key is the priority
104		- * @since 13.0.0
105		- */
106		- public function getPersonalSections();
	100	+ /**
	101	+ * returns a list of the personal sections
	102	+ *
	103	+ * @return array array of ISection[] where key is the priority
	104	+ * @since 13.0.0
	105	+ */
	106	+ public function getPersonalSections();
107	107
108		- /**
109		- * returns a list of the admin settings
110		- *
111		- * @param string $section the section id for which to load the settings
112		- * @return array array of IAdmin[] where key is the priority
113		- * @since 9.1.0
114		- */
115		- public function getAdminSettings($section);
	108	+ /**
	109	+ * returns a list of the admin settings
	110	+ *
	111	+ * @param string $section the section id for which to load the settings
	112	+ * @return array array of IAdmin[] where key is the priority
	113	+ * @since 9.1.0
	114	+ */
	115	+ public function getAdminSettings($section);
116	116
117		- /**
118		- * returns a list of the personal settings
119		- *
120		- * @param string $section the section id for which to load the settings
121		- * @return array array of IPersonal[] where key is the priority
122		- * @since 13.0.0
123		- */
124		- public function getPersonalSettings($section);
	117	+ /**
	118	+ * returns a list of the personal settings
	119	+ *
	120	+ * @param string $section the section id for which to load the settings
	121	+ * @return array array of IPersonal[] where key is the priority
	122	+ * @since 13.0.0
	123	+ */
	124	+ public function getPersonalSettings($section);
125	125	}

		@@ -35,7 +35,7 @@ discard block
		block discarded – undo
35	35	/**
36	36	* @since 9.1.0
37	37	*/
38		- const KEY_ADMIN_SECTION = 'admin-section';
	38	+ const KEY_ADMIN_SECTION = 'admin-section';
39	39
40	40	/**
41	41	* @since 13.0.0
		@@ -45,7 +45,7 @@ discard block
		block discarded – undo
45	45	/**
46	46	* @since 13.0.0
47	47	*/
48		- const KEY_PERSONAL_SECTION = 'personal-section';
	48	+ const KEY_PERSONAL_SECTION = 'personal-section';
49	49
50	50	/**
51	51	* sets up settings according to data specified by an apps info.xml, within

nextcloud / server

Pull Request — master (#4890)

Status

Category

Indentation +85 added lines, -85 removed lines patch added patch discarded remove patch

Spacing +2 added lines, -2 removed lines patch added patch discarded remove patch