Inspection of "open-graph" - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#4736)

by Maxence

created 2017-05-09 08:15 UTC

Status

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

@@ -29,354 +29,354 @@
 block discarded – undo
  * @since 11.0.0
  */
 class Definitions {
-	/**
-	 * @var array
-	 * @since 11.0.0
-	 */
-	public $definitions = [
-		'addressbook' => [
-			'author' => 'Nextcloud',
-			'app' => 'dav',
-			'since' => '11.0.0',
-			'parameters' => [
-				'id' => [
-					'since' => '11.0.0',
-					'required' => true,
-					'description' => 'The id used to identify the addressbook on the instance',
-					'example' => '42',
-				],
-				'name' => [
-					'since' => '11.0.0',
-					'required' => true,
-					'description' => 'The display name of the addressbook which should be used in the visual representation',
-					'example' => 'Contacts',
-				],
-			],
-		],
-		'addressbook-contact' => [
-			'author' => 'Nextcloud',
-			'app' => 'dav',
-			'since' => '11.0.0',
-			'parameters' => [
-				'id' => [
-					'since' => '11.0.0',
-					'required' => true,
-					'description' => 'The id used to identify the contact on the instance',
-					'example' => '42',
-				],
-				'name' => [
-					'since' => '11.0.0',
-					'required' => true,
-					'description' => 'The display name of the contact which should be used in the visual representation',
-					'example' => 'John Doe',
-				],
-			],
-		],
-		'announcement' => [
-			'author' => 'Joas Schilling',
-			'app' => 'announcementcenter',
-			'since' => '11.0.0',
-			'parameters' => [
-				'id' => [
-					'since' => '11.0.0',
-					'required' => true, 'description' => 'The id used to identify the announcement on the instance',
-					'example' => '42',
-				],
-				'name' => [
-					'since' => '11.0.0',
-					'required' => true,
-					'description' => 'The announcement subject which should be used in the visual representation',
-					'example' => 'file.txt',
-				],
-				'link' => [
-					'since' => '11.0.0',
-					'required' => false,
-					'description' => 'The full URL to the file',
-					'example' => 'http://localhost/index.php/apps/announcements/#23',
-				],
-			],
-		],
-		'app' => [
-			'author' => 'Nextcloud',
-			'app' => 'updatenotification',
-			'since' => '11.0.0',
-			'parameters' => [
-				'id' => [
-					'since' => '11.0.0',
-					'required' => true, 'description' => 'The app id',
-					'example' => 'updatenotification',
-				],
-				'name' => [
-					'since' => '11.0.0',
-					'required' => true,
-					'description' => 'The name of the app which should be used in the visual representation',
-					'example' => 'Update notification',
-				],
-			],
-		],
-		'calendar' => [
-			'author' => 'Nextcloud',
-			'app' => 'dav',
-			'since' => '11.0.0',
-			'parameters' => [
-				'id' => [
-					'since' => '11.0.0',
-					'required' => true,
-					'description' => 'The id used to identify the calendar on the instance',
-					'example' => '42',
-				],
-				'name' => [
-					'since' => '11.0.0',
-					'required' => true,
-					'description' => 'The display name of the calendar which should be used in the visual representation',
-					'example' => 'Personal',
-				],
-			],
-		],
-		'calendar-event' => [
-			'author' => 'Nextcloud',
-			'app' => 'dav',
-			'since' => '11.0.0',
-			'parameters' => [
-				'id' => [
-					'since' => '11.0.0',
-					'required' => true,
-					'description' => 'The id used to identify the event on the instance',
-					'example' => '42',
-				],
-				'name' => [
-					'since' => '11.0.0',
-					'required' => true,
-					'description' => 'The display name of the event which should be used in the visual representation',
-					'example' => 'Workout',
-				],
-			],
-		],
-		'call' => [
-			'author' => 'Nextcloud',
-			'app' => 'spreed',
-			'since' => '11.0.2',
-			'parameters' => [
-				'id' => [
-					'since' => '11.0.2',
-					'required' => true,
-					'description' => 'The id used to identify the call on the instance',
-					'example' => '42',
-				],
-				'name' => [
-					'since' => '11.0.2',
-					'required' => true,
-					'description' => 'The display name of the call which should be used in the visual representation',
-					'example' => 'Company call',
-				],
-				'call-type' => [
-					'since' => '11.0.2',
-					'required' => true,
-					'description' => 'The type of the call: one2one, group or public',
-					'example' => 'one2one',
-				],
-			],
-		],
-		'email' => [
-			'author' => 'Nextcloud',
-			'app' => 'sharebymail',
-			'since' => '11.0.0',
-			'parameters' => [
-				'id' => [
-					'since' => '11.0.0',
-					'required' => true,
-					'description' => 'The mail-address used to identify the event on the instance',
-					'example' => 'test@localhost',
-				],
-				'name' => [
-					'since' => '11.0.0',
-					'required' => true,
-					'description' => 'The display name of a matching contact or the email (fallback) which should be used in the visual representation',
-					'example' => 'Foo Bar',
-				],
-			],
-		],
-		'file' => [
-			'author' => 'Nextcloud',
-			'app' => 'dav',
-			'since' => '11.0.0',
-			'parameters' => [
-				'id' => [
-					'since' => '11.0.0',
-					'required' => true,
-					'description' => 'The id used to identify the file on the instance',
-					'example' => '42',
-				],
-				'name' => [
-					'since' => '11.0.0',
-					'required' => true,
-					'description' => 'The file name which should be used in the visual representation',
-					'example' => 'file.txt',
-				],
-				'path' => [
-					'since' => '11.0.0',
-					'required' => true,
-					'description' => 'The full path of the file for the user, should not start with a slash',
-					'example' => 'path/to/file.txt',
-				],
-				'link' => [
-					'since' => '11.0.0',
-					'required' => false,
-					'description' => 'The full URL to the file',
-					'example' => 'http://localhost/index.php/f/42',
-				],
-			],
-		],
-		'open-graph' => [
-			'author' => 'Maxence Lange',
-			'app' => 'mood',
-			'since' => '12.0.0',
-			'parameters' => [
-				'id' => [
-					'since' => '12.0.0',
-					'required' => true,
-					'description' => 'The id used to identify the open graph data on the instance',
-					'example' => '42',
-				],
-				'name' => [
-					'since' => '12.0.0',
-					'required' => true,
-					'description' => 'The open graph title of the website',
-					'example' => 'This is a website',
-				],
-				'description' => [
-					'since' => '12.0.0',
-					'required' => false,
-					'description' => 'The open graph description from the website',
-					'example' => 'This is the description of the website',
-				],
-				'thumb' => [
-					'since' => '12.0.0',
-					'required' => false,
-					'description' => 'The full URL of the open graph thumbnail',
-					'example' => 'http://localhost/index.php/apps/mood/data/image?url=https%3A%2F%2Fthumb.example.com%2Fimage.png',
-				],
-				'website' => [
-					'since' => '12.0.0',
-					'required' => false,
-					'description' => 'The name of the described website',
-					'example' => 'Nextcloud - App Store',
-				],
-				'link' => [
-					'since' => '12.0.0',
-					'required' => false,
-					'description' => 'The full link to the website',
-					'example' => 'https://apps.nextcloud.com/apps/mood',
-				],
-			],
-		],
-		'pending-federated-share' => [
-			'author' => 'Nextcloud',
-			'app' => 'dav',
-			'since' => '11.0.0',
-			'parameters' => [
-				'id' => [
-					'since' => '11.0.0',
-					'required' => true,
-					'description' => 'The id used to identify the federated share on the instance',
-					'example' => '42',
-				],
-				'name' => [
-					'since' => '11.0.0',
-					'required' => true,
-					'description' => 'The name of the shared item which should be used in the visual representation',
-					'example' => 'file.txt',
-				],
-			],
-		],
-		'systemtag' => [
-			'author' => 'Nextcloud',
-			'app' => 'core',
-			'since' => '11.0.0',
-			'parameters' => [
-				'id' => [
-					'since' => '11.0.0',
-					'required' => true,
-					'description' => 'The id used to identify the systemtag on the instance',
-					'example' => '23',
-				],
-				'name' => [
-					'since' => '11.0.0',
-					'required' => true,
-					'description' => 'The display name of the systemtag which should be used in the visual representation',
-					'example' => 'Project 1',
-				],
-				'visibility' => [
-					'since' => '11.0.0',
-					'required' => true,
-					'description' => 'If the user can see the systemtag',
-					'example' => '1',
-				],
-				'assignable' => [
-					'since' => '11.0.0',
-					'required' => true,
-					'description' => 'If the user can assign the systemtag',
-					'example' => '0',
-				],
-			],
-		],
-		'user' => [
-			'author' => 'Nextcloud',
-			'app' => 'core',
-			'since' => '11.0.0',
-			'parameters' => [
-				'id' => [
-					'since' => '11.0.0',
-					'required' => true,
-					'description' => 'The id used to identify the user on the instance',
-					'example' => 'johndoe',
-				],
-				'name' => [
-					'since' => '11.0.0',
-					'required' => true,
-					'description' => 'The display name of the user which should be used in the visual representation',
-					'example' => 'John Doe',
-				],
-				'server' => [
-					'since' => '11.0.0',
-					'required' => false,
-					'description' => 'The URL of the instance the user lives on',
-					'example' => 'localhost',
-				],
-			],
-		],
-		'user-group' => [
-			'author' => 'Nextcloud',
-			'app' => 'core',
-			'since' => '11.0.0',
-			'parameters' => [
-				'id' => [
-					'since' => '11.0.0',
-					'required' => true,
-					'description' => 'The id used to identify the group on the instance',
-					'example' => 'supportteam',
-				],
-				'name' => [
-					'since' => '11.0.0',
-					'required' => true,
-					'description' => 'The display name of the group which should be used in the visual representation',
-					'example' => 'Support Team',
-				],
-			],
-		],
-	];
+    /**
+     * @var array
+     * @since 11.0.0
+     */
+    public $definitions = [
+        'addressbook' => [
+            'author' => 'Nextcloud',
+            'app' => 'dav',
+            'since' => '11.0.0',
+            'parameters' => [
+                'id' => [
+                    'since' => '11.0.0',
+                    'required' => true,
+                    'description' => 'The id used to identify the addressbook on the instance',
+                    'example' => '42',
+                ],
+                'name' => [
+                    'since' => '11.0.0',
+                    'required' => true,
+                    'description' => 'The display name of the addressbook which should be used in the visual representation',
+                    'example' => 'Contacts',
+                ],
+            ],
+        ],
+        'addressbook-contact' => [
+            'author' => 'Nextcloud',
+            'app' => 'dav',
+            'since' => '11.0.0',
+            'parameters' => [
+                'id' => [
+                    'since' => '11.0.0',
+                    'required' => true,
+                    'description' => 'The id used to identify the contact on the instance',
+                    'example' => '42',
+                ],
+                'name' => [
+                    'since' => '11.0.0',
+                    'required' => true,
+                    'description' => 'The display name of the contact which should be used in the visual representation',
+                    'example' => 'John Doe',
+                ],
+            ],
+        ],
+        'announcement' => [
+            'author' => 'Joas Schilling',
+            'app' => 'announcementcenter',
+            'since' => '11.0.0',
+            'parameters' => [
+                'id' => [
+                    'since' => '11.0.0',
+                    'required' => true, 'description' => 'The id used to identify the announcement on the instance',
+                    'example' => '42',
+                ],
+                'name' => [
+                    'since' => '11.0.0',
+                    'required' => true,
+                    'description' => 'The announcement subject which should be used in the visual representation',
+                    'example' => 'file.txt',
+                ],
+                'link' => [
+                    'since' => '11.0.0',
+                    'required' => false,
+                    'description' => 'The full URL to the file',
+                    'example' => 'http://localhost/index.php/apps/announcements/#23',
+                ],
+            ],
+        ],
+        'app' => [
+            'author' => 'Nextcloud',
+            'app' => 'updatenotification',
+            'since' => '11.0.0',
+            'parameters' => [
+                'id' => [
+                    'since' => '11.0.0',
+                    'required' => true, 'description' => 'The app id',
+                    'example' => 'updatenotification',
+                ],
+                'name' => [
+                    'since' => '11.0.0',
+                    'required' => true,
+                    'description' => 'The name of the app which should be used in the visual representation',
+                    'example' => 'Update notification',
+                ],
+            ],
+        ],
+        'calendar' => [
+            'author' => 'Nextcloud',
+            'app' => 'dav',
+            'since' => '11.0.0',
+            'parameters' => [
+                'id' => [
+                    'since' => '11.0.0',
+                    'required' => true,
+                    'description' => 'The id used to identify the calendar on the instance',
+                    'example' => '42',
+                ],
+                'name' => [
+                    'since' => '11.0.0',
+                    'required' => true,
+                    'description' => 'The display name of the calendar which should be used in the visual representation',
+                    'example' => 'Personal',
+                ],
+            ],
+        ],
+        'calendar-event' => [
+            'author' => 'Nextcloud',
+            'app' => 'dav',
+            'since' => '11.0.0',
+            'parameters' => [
+                'id' => [
+                    'since' => '11.0.0',
+                    'required' => true,
+                    'description' => 'The id used to identify the event on the instance',
+                    'example' => '42',
+                ],
+                'name' => [
+                    'since' => '11.0.0',
+                    'required' => true,
+                    'description' => 'The display name of the event which should be used in the visual representation',
+                    'example' => 'Workout',
+                ],
+            ],
+        ],
+        'call' => [
+            'author' => 'Nextcloud',
+            'app' => 'spreed',
+            'since' => '11.0.2',
+            'parameters' => [
+                'id' => [
+                    'since' => '11.0.2',
+                    'required' => true,
+                    'description' => 'The id used to identify the call on the instance',
+                    'example' => '42',
+                ],
+                'name' => [
+                    'since' => '11.0.2',
+                    'required' => true,
+                    'description' => 'The display name of the call which should be used in the visual representation',
+                    'example' => 'Company call',
+                ],
+                'call-type' => [
+                    'since' => '11.0.2',
+                    'required' => true,
+                    'description' => 'The type of the call: one2one, group or public',
+                    'example' => 'one2one',
+                ],
+            ],
+        ],
+        'email' => [
+            'author' => 'Nextcloud',
+            'app' => 'sharebymail',
+            'since' => '11.0.0',
+            'parameters' => [
+                'id' => [
+                    'since' => '11.0.0',
+                    'required' => true,
+                    'description' => 'The mail-address used to identify the event on the instance',
+                    'example' => 'test@localhost',
+                ],
+                'name' => [
+                    'since' => '11.0.0',
+                    'required' => true,
+                    'description' => 'The display name of a matching contact or the email (fallback) which should be used in the visual representation',
+                    'example' => 'Foo Bar',
+                ],
+            ],
+        ],
+        'file' => [
+            'author' => 'Nextcloud',
+            'app' => 'dav',
+            'since' => '11.0.0',
+            'parameters' => [
+                'id' => [
+                    'since' => '11.0.0',
+                    'required' => true,
+                    'description' => 'The id used to identify the file on the instance',
+                    'example' => '42',
+                ],
+                'name' => [
+                    'since' => '11.0.0',
+                    'required' => true,
+                    'description' => 'The file name which should be used in the visual representation',
+                    'example' => 'file.txt',
+                ],
+                'path' => [
+                    'since' => '11.0.0',
+                    'required' => true,
+                    'description' => 'The full path of the file for the user, should not start with a slash',
+                    'example' => 'path/to/file.txt',
+                ],
+                'link' => [
+                    'since' => '11.0.0',
+                    'required' => false,
+                    'description' => 'The full URL to the file',
+                    'example' => 'http://localhost/index.php/f/42',
+                ],
+            ],
+        ],
+        'open-graph' => [
+            'author' => 'Maxence Lange',
+            'app' => 'mood',
+            'since' => '12.0.0',
+            'parameters' => [
+                'id' => [
+                    'since' => '12.0.0',
+                    'required' => true,
+                    'description' => 'The id used to identify the open graph data on the instance',
+                    'example' => '42',
+                ],
+                'name' => [
+                    'since' => '12.0.0',
+                    'required' => true,
+                    'description' => 'The open graph title of the website',
+                    'example' => 'This is a website',
+                ],
+                'description' => [
+                    'since' => '12.0.0',
+                    'required' => false,
+                    'description' => 'The open graph description from the website',
+                    'example' => 'This is the description of the website',
+                ],
+                'thumb' => [
+                    'since' => '12.0.0',
+                    'required' => false,
+                    'description' => 'The full URL of the open graph thumbnail',
+                    'example' => 'http://localhost/index.php/apps/mood/data/image?url=https%3A%2F%2Fthumb.example.com%2Fimage.png',
+                ],
+                'website' => [
+                    'since' => '12.0.0',
+                    'required' => false,
+                    'description' => 'The name of the described website',
+                    'example' => 'Nextcloud - App Store',
+                ],
+                'link' => [
+                    'since' => '12.0.0',
+                    'required' => false,
+                    'description' => 'The full link to the website',
+                    'example' => 'https://apps.nextcloud.com/apps/mood',
+                ],
+            ],
+        ],
+        'pending-federated-share' => [
+            'author' => 'Nextcloud',
+            'app' => 'dav',
+            'since' => '11.0.0',
+            'parameters' => [
+                'id' => [
+                    'since' => '11.0.0',
+                    'required' => true,
+                    'description' => 'The id used to identify the federated share on the instance',
+                    'example' => '42',
+                ],
+                'name' => [
+                    'since' => '11.0.0',
+                    'required' => true,
+                    'description' => 'The name of the shared item which should be used in the visual representation',
+                    'example' => 'file.txt',
+                ],
+            ],
+        ],
+        'systemtag' => [
+            'author' => 'Nextcloud',
+            'app' => 'core',
+            'since' => '11.0.0',
+            'parameters' => [
+                'id' => [
+                    'since' => '11.0.0',
+                    'required' => true,
+                    'description' => 'The id used to identify the systemtag on the instance',
+                    'example' => '23',
+                ],
+                'name' => [
+                    'since' => '11.0.0',
+                    'required' => true,
+                    'description' => 'The display name of the systemtag which should be used in the visual representation',
+                    'example' => 'Project 1',
+                ],
+                'visibility' => [
+                    'since' => '11.0.0',
+                    'required' => true,
+                    'description' => 'If the user can see the systemtag',
+                    'example' => '1',
+                ],
+                'assignable' => [
+                    'since' => '11.0.0',
+                    'required' => true,
+                    'description' => 'If the user can assign the systemtag',
+                    'example' => '0',
+                ],
+            ],
+        ],
+        'user' => [
+            'author' => 'Nextcloud',
+            'app' => 'core',
+            'since' => '11.0.0',
+            'parameters' => [
+                'id' => [
+                    'since' => '11.0.0',
+                    'required' => true,
+                    'description' => 'The id used to identify the user on the instance',
+                    'example' => 'johndoe',
+                ],
+                'name' => [
+                    'since' => '11.0.0',
+                    'required' => true,
+                    'description' => 'The display name of the user which should be used in the visual representation',
+                    'example' => 'John Doe',
+                ],
+                'server' => [
+                    'since' => '11.0.0',
+                    'required' => false,
+                    'description' => 'The URL of the instance the user lives on',
+                    'example' => 'localhost',
+                ],
+            ],
+        ],
+        'user-group' => [
+            'author' => 'Nextcloud',
+            'app' => 'core',
+            'since' => '11.0.0',
+            'parameters' => [
+                'id' => [
+                    'since' => '11.0.0',
+                    'required' => true,
+                    'description' => 'The id used to identify the group on the instance',
+                    'example' => 'supportteam',
+                ],
+                'name' => [
+                    'since' => '11.0.0',
+                    'required' => true,
+                    'description' => 'The display name of the group which should be used in the visual representation',
+                    'example' => 'Support Team',
+                ],
+            ],
+        ],
+    ];
 
-	/**
-	 * @param string $type
-	 * @return array
-	 * @throws InvalidObjectExeption
-	 * @since 11.0.0
-	 */
-	public function getDefinition($type) {
-		if (isset($this->definitions[$type])) {
-			return $this->definitions[$type];
-		}
+    /**
+     * @param string $type
+     * @return array
+     * @throws InvalidObjectExeption
+     * @since 11.0.0
+     */
+    public function getDefinition($type) {
+        if (isset($this->definitions[$type])) {
+            return $this->definitions[$type];
+        }
 
-		throw new InvalidObjectExeption('Object type is undefined');
-	}
+        throw new InvalidObjectExeption('Object type is undefined');
+    }
 }

Please login to merge, or discard this patch.

		@@ -29,354 +29,354 @@
		block discarded – undo
29	29	* @since 11.0.0
30	30	*/
31	31	class Definitions {
32		- /**
33		- * @var array
34		- * @since 11.0.0
35		- */
36		- public $definitions = [
37		- 'addressbook' => [
38		- 'author' => 'Nextcloud',
39		- 'app' => 'dav',
40		- 'since' => '11.0.0',
41		- 'parameters' => [
42		- 'id' => [
43		- 'since' => '11.0.0',
44		- 'required' => true,
45		- 'description' => 'The id used to identify the addressbook on the instance',
46		- 'example' => '42',
47		- ],
48		- 'name' => [
49		- 'since' => '11.0.0',
50		- 'required' => true,
51		- 'description' => 'The display name of the addressbook which should be used in the visual representation',
52		- 'example' => 'Contacts',
53		- ],
54		- ],
55		- ],
56		- 'addressbook-contact' => [
57		- 'author' => 'Nextcloud',
58		- 'app' => 'dav',
59		- 'since' => '11.0.0',
60		- 'parameters' => [
61		- 'id' => [
62		- 'since' => '11.0.0',
63		- 'required' => true,
64		- 'description' => 'The id used to identify the contact on the instance',
65		- 'example' => '42',
66		- ],
67		- 'name' => [
68		- 'since' => '11.0.0',
69		- 'required' => true,
70		- 'description' => 'The display name of the contact which should be used in the visual representation',
71		- 'example' => 'John Doe',
72		- ],
73		- ],
74		- ],
75		- 'announcement' => [
76		- 'author' => 'Joas Schilling',
77		- 'app' => 'announcementcenter',
78		- 'since' => '11.0.0',
79		- 'parameters' => [
80		- 'id' => [
81		- 'since' => '11.0.0',
82		- 'required' => true, 'description' => 'The id used to identify the announcement on the instance',
83		- 'example' => '42',
84		- ],
85		- 'name' => [
86		- 'since' => '11.0.0',
87		- 'required' => true,
88		- 'description' => 'The announcement subject which should be used in the visual representation',
89		- 'example' => 'file.txt',
90		- ],
91		- 'link' => [
92		- 'since' => '11.0.0',
93		- 'required' => false,
94		- 'description' => 'The full URL to the file',
95		- 'example' => 'http://localhost/index.php/apps/announcements/#23',
96		- ],
97		- ],
98		- ],
99		- 'app' => [
100		- 'author' => 'Nextcloud',
101		- 'app' => 'updatenotification',
102		- 'since' => '11.0.0',
103		- 'parameters' => [
104		- 'id' => [
105		- 'since' => '11.0.0',
106		- 'required' => true, 'description' => 'The app id',
107		- 'example' => 'updatenotification',
108		- ],
109		- 'name' => [
110		- 'since' => '11.0.0',
111		- 'required' => true,
112		- 'description' => 'The name of the app which should be used in the visual representation',
113		- 'example' => 'Update notification',
114		- ],
115		- ],
116		- ],
117		- 'calendar' => [
118		- 'author' => 'Nextcloud',
119		- 'app' => 'dav',
120		- 'since' => '11.0.0',
121		- 'parameters' => [
122		- 'id' => [
123		- 'since' => '11.0.0',
124		- 'required' => true,
125		- 'description' => 'The id used to identify the calendar on the instance',
126		- 'example' => '42',
127		- ],
128		- 'name' => [
129		- 'since' => '11.0.0',
130		- 'required' => true,
131		- 'description' => 'The display name of the calendar which should be used in the visual representation',
132		- 'example' => 'Personal',
133		- ],
134		- ],
135		- ],
136		- 'calendar-event' => [
137		- 'author' => 'Nextcloud',
138		- 'app' => 'dav',
139		- 'since' => '11.0.0',
140		- 'parameters' => [
141		- 'id' => [
142		- 'since' => '11.0.0',
143		- 'required' => true,
144		- 'description' => 'The id used to identify the event on the instance',
145		- 'example' => '42',
146		- ],
147		- 'name' => [
148		- 'since' => '11.0.0',
149		- 'required' => true,
150		- 'description' => 'The display name of the event which should be used in the visual representation',
151		- 'example' => 'Workout',
152		- ],
153		- ],
154		- ],
155		- 'call' => [
156		- 'author' => 'Nextcloud',
157		- 'app' => 'spreed',
158		- 'since' => '11.0.2',
159		- 'parameters' => [
160		- 'id' => [
161		- 'since' => '11.0.2',
162		- 'required' => true,
163		- 'description' => 'The id used to identify the call on the instance',
164		- 'example' => '42',
165		- ],
166		- 'name' => [
167		- 'since' => '11.0.2',
168		- 'required' => true,
169		- 'description' => 'The display name of the call which should be used in the visual representation',
170		- 'example' => 'Company call',
171		- ],
172		- 'call-type' => [
173		- 'since' => '11.0.2',
174		- 'required' => true,
175		- 'description' => 'The type of the call: one2one, group or public',
176		- 'example' => 'one2one',
177		- ],
178		- ],
179		- ],
180		- 'email' => [
181		- 'author' => 'Nextcloud',
182		- 'app' => 'sharebymail',
183		- 'since' => '11.0.0',
184		- 'parameters' => [
185		- 'id' => [
186		- 'since' => '11.0.0',
187		- 'required' => true,
188		- 'description' => 'The mail-address used to identify the event on the instance',
189		- 'example' => 'test@localhost',
190		- ],
191		- 'name' => [
192		- 'since' => '11.0.0',
193		- 'required' => true,
194		- 'description' => 'The display name of a matching contact or the email (fallback) which should be used in the visual representation',
195		- 'example' => 'Foo Bar',
196		- ],
197		- ],
198		- ],
199		- 'file' => [
200		- 'author' => 'Nextcloud',
201		- 'app' => 'dav',
202		- 'since' => '11.0.0',
203		- 'parameters' => [
204		- 'id' => [
205		- 'since' => '11.0.0',
206		- 'required' => true,
207		- 'description' => 'The id used to identify the file on the instance',
208		- 'example' => '42',
209		- ],
210		- 'name' => [
211		- 'since' => '11.0.0',
212		- 'required' => true,
213		- 'description' => 'The file name which should be used in the visual representation',
214		- 'example' => 'file.txt',
215		- ],
216		- 'path' => [
217		- 'since' => '11.0.0',
218		- 'required' => true,
219		- 'description' => 'The full path of the file for the user, should not start with a slash',
220		- 'example' => 'path/to/file.txt',
221		- ],
222		- 'link' => [
223		- 'since' => '11.0.0',
224		- 'required' => false,
225		- 'description' => 'The full URL to the file',
226		- 'example' => 'http://localhost/index.php/f/42',
227		- ],
228		- ],
229		- ],
230		- 'open-graph' => [
231		- 'author' => 'Maxence Lange',
232		- 'app' => 'mood',
233		- 'since' => '12.0.0',
234		- 'parameters' => [
235		- 'id' => [
236		- 'since' => '12.0.0',
237		- 'required' => true,
238		- 'description' => 'The id used to identify the open graph data on the instance',
239		- 'example' => '42',
240		- ],
241		- 'name' => [
242		- 'since' => '12.0.0',
243		- 'required' => true,
244		- 'description' => 'The open graph title of the website',
245		- 'example' => 'This is a website',
246		- ],
247		- 'description' => [
248		- 'since' => '12.0.0',
249		- 'required' => false,
250		- 'description' => 'The open graph description from the website',
251		- 'example' => 'This is the description of the website',
252		- ],
253		- 'thumb' => [
254		- 'since' => '12.0.0',
255		- 'required' => false,
256		- 'description' => 'The full URL of the open graph thumbnail',
257		- 'example' => 'http://localhost/index.php/apps/mood/data/image?url=https%3A%2F%2Fthumb.example.com%2Fimage.png',
258		- ],
259		- 'website' => [
260		- 'since' => '12.0.0',
261		- 'required' => false,
262		- 'description' => 'The name of the described website',
263		- 'example' => 'Nextcloud - App Store',
264		- ],
265		- 'link' => [
266		- 'since' => '12.0.0',
267		- 'required' => false,
268		- 'description' => 'The full link to the website',
269		- 'example' => 'https://apps.nextcloud.com/apps/mood',
270		- ],
271		- ],
272		- ],
273		- 'pending-federated-share' => [
274		- 'author' => 'Nextcloud',
275		- 'app' => 'dav',
276		- 'since' => '11.0.0',
277		- 'parameters' => [
278		- 'id' => [
279		- 'since' => '11.0.0',
280		- 'required' => true,
281		- 'description' => 'The id used to identify the federated share on the instance',
282		- 'example' => '42',
283		- ],
284		- 'name' => [
285		- 'since' => '11.0.0',
286		- 'required' => true,
287		- 'description' => 'The name of the shared item which should be used in the visual representation',
288		- 'example' => 'file.txt',
289		- ],
290		- ],
291		- ],
292		- 'systemtag' => [
293		- 'author' => 'Nextcloud',
294		- 'app' => 'core',
295		- 'since' => '11.0.0',
296		- 'parameters' => [
297		- 'id' => [
298		- 'since' => '11.0.0',
299		- 'required' => true,
300		- 'description' => 'The id used to identify the systemtag on the instance',
301		- 'example' => '23',
302		- ],
303		- 'name' => [
304		- 'since' => '11.0.0',
305		- 'required' => true,
306		- 'description' => 'The display name of the systemtag which should be used in the visual representation',
307		- 'example' => 'Project 1',
308		- ],
309		- 'visibility' => [
310		- 'since' => '11.0.0',
311		- 'required' => true,
312		- 'description' => 'If the user can see the systemtag',
313		- 'example' => '1',
314		- ],
315		- 'assignable' => [
316		- 'since' => '11.0.0',
317		- 'required' => true,
318		- 'description' => 'If the user can assign the systemtag',
319		- 'example' => '0',
320		- ],
321		- ],
322		- ],
323		- 'user' => [
324		- 'author' => 'Nextcloud',
325		- 'app' => 'core',
326		- 'since' => '11.0.0',
327		- 'parameters' => [
328		- 'id' => [
329		- 'since' => '11.0.0',
330		- 'required' => true,
331		- 'description' => 'The id used to identify the user on the instance',
332		- 'example' => 'johndoe',
333		- ],
334		- 'name' => [
335		- 'since' => '11.0.0',
336		- 'required' => true,
337		- 'description' => 'The display name of the user which should be used in the visual representation',
338		- 'example' => 'John Doe',
339		- ],
340		- 'server' => [
341		- 'since' => '11.0.0',
342		- 'required' => false,
343		- 'description' => 'The URL of the instance the user lives on',
344		- 'example' => 'localhost',
345		- ],
346		- ],
347		- ],
348		- 'user-group' => [
349		- 'author' => 'Nextcloud',
350		- 'app' => 'core',
351		- 'since' => '11.0.0',
352		- 'parameters' => [
353		- 'id' => [
354		- 'since' => '11.0.0',
355		- 'required' => true,
356		- 'description' => 'The id used to identify the group on the instance',
357		- 'example' => 'supportteam',
358		- ],
359		- 'name' => [
360		- 'since' => '11.0.0',
361		- 'required' => true,
362		- 'description' => 'The display name of the group which should be used in the visual representation',
363		- 'example' => 'Support Team',
364		- ],
365		- ],
366		- ],
367		- ];
	32	+ /**
	33	+ * @var array
	34	+ * @since 11.0.0
	35	+ */
	36	+ public $definitions = [
	37	+ 'addressbook' => [
	38	+ 'author' => 'Nextcloud',
	39	+ 'app' => 'dav',
	40	+ 'since' => '11.0.0',
	41	+ 'parameters' => [
	42	+ 'id' => [
	43	+ 'since' => '11.0.0',
	44	+ 'required' => true,
	45	+ 'description' => 'The id used to identify the addressbook on the instance',
	46	+ 'example' => '42',
	47	+ ],
	48	+ 'name' => [
	49	+ 'since' => '11.0.0',
	50	+ 'required' => true,
	51	+ 'description' => 'The display name of the addressbook which should be used in the visual representation',
	52	+ 'example' => 'Contacts',
	53	+ ],
	54	+ ],
	55	+ ],
	56	+ 'addressbook-contact' => [
	57	+ 'author' => 'Nextcloud',
	58	+ 'app' => 'dav',
	59	+ 'since' => '11.0.0',
	60	+ 'parameters' => [
	61	+ 'id' => [
	62	+ 'since' => '11.0.0',
	63	+ 'required' => true,
	64	+ 'description' => 'The id used to identify the contact on the instance',
	65	+ 'example' => '42',
	66	+ ],
	67	+ 'name' => [
	68	+ 'since' => '11.0.0',
	69	+ 'required' => true,
	70	+ 'description' => 'The display name of the contact which should be used in the visual representation',
	71	+ 'example' => 'John Doe',
	72	+ ],
	73	+ ],
	74	+ ],
	75	+ 'announcement' => [
	76	+ 'author' => 'Joas Schilling',
	77	+ 'app' => 'announcementcenter',
	78	+ 'since' => '11.0.0',
	79	+ 'parameters' => [
	80	+ 'id' => [
	81	+ 'since' => '11.0.0',
	82	+ 'required' => true, 'description' => 'The id used to identify the announcement on the instance',
	83	+ 'example' => '42',
	84	+ ],
	85	+ 'name' => [
	86	+ 'since' => '11.0.0',
	87	+ 'required' => true,
	88	+ 'description' => 'The announcement subject which should be used in the visual representation',
	89	+ 'example' => 'file.txt',
	90	+ ],
	91	+ 'link' => [
	92	+ 'since' => '11.0.0',
	93	+ 'required' => false,
	94	+ 'description' => 'The full URL to the file',
	95	+ 'example' => 'http://localhost/index.php/apps/announcements/#23',
	96	+ ],
	97	+ ],
	98	+ ],
	99	+ 'app' => [
	100	+ 'author' => 'Nextcloud',
	101	+ 'app' => 'updatenotification',
	102	+ 'since' => '11.0.0',
	103	+ 'parameters' => [
	104	+ 'id' => [
	105	+ 'since' => '11.0.0',
	106	+ 'required' => true, 'description' => 'The app id',
	107	+ 'example' => 'updatenotification',
	108	+ ],
	109	+ 'name' => [
	110	+ 'since' => '11.0.0',
	111	+ 'required' => true,
	112	+ 'description' => 'The name of the app which should be used in the visual representation',
	113	+ 'example' => 'Update notification',
	114	+ ],
	115	+ ],
	116	+ ],
	117	+ 'calendar' => [
	118	+ 'author' => 'Nextcloud',
	119	+ 'app' => 'dav',
	120	+ 'since' => '11.0.0',
	121	+ 'parameters' => [
	122	+ 'id' => [
	123	+ 'since' => '11.0.0',
	124	+ 'required' => true,
	125	+ 'description' => 'The id used to identify the calendar on the instance',
	126	+ 'example' => '42',
	127	+ ],
	128	+ 'name' => [
	129	+ 'since' => '11.0.0',
	130	+ 'required' => true,
	131	+ 'description' => 'The display name of the calendar which should be used in the visual representation',
	132	+ 'example' => 'Personal',
	133	+ ],
	134	+ ],
	135	+ ],
	136	+ 'calendar-event' => [
	137	+ 'author' => 'Nextcloud',
	138	+ 'app' => 'dav',
	139	+ 'since' => '11.0.0',
	140	+ 'parameters' => [
	141	+ 'id' => [
	142	+ 'since' => '11.0.0',
	143	+ 'required' => true,
	144	+ 'description' => 'The id used to identify the event on the instance',
	145	+ 'example' => '42',
	146	+ ],
	147	+ 'name' => [
	148	+ 'since' => '11.0.0',
	149	+ 'required' => true,
	150	+ 'description' => 'The display name of the event which should be used in the visual representation',
	151	+ 'example' => 'Workout',
	152	+ ],
	153	+ ],
	154	+ ],
	155	+ 'call' => [
	156	+ 'author' => 'Nextcloud',
	157	+ 'app' => 'spreed',
	158	+ 'since' => '11.0.2',
	159	+ 'parameters' => [
	160	+ 'id' => [
	161	+ 'since' => '11.0.2',
	162	+ 'required' => true,
	163	+ 'description' => 'The id used to identify the call on the instance',
	164	+ 'example' => '42',
	165	+ ],
	166	+ 'name' => [
	167	+ 'since' => '11.0.2',
	168	+ 'required' => true,
	169	+ 'description' => 'The display name of the call which should be used in the visual representation',
	170	+ 'example' => 'Company call',
	171	+ ],
	172	+ 'call-type' => [
	173	+ 'since' => '11.0.2',
	174	+ 'required' => true,
	175	+ 'description' => 'The type of the call: one2one, group or public',
	176	+ 'example' => 'one2one',
	177	+ ],
	178	+ ],
	179	+ ],
	180	+ 'email' => [
	181	+ 'author' => 'Nextcloud',
	182	+ 'app' => 'sharebymail',
	183	+ 'since' => '11.0.0',
	184	+ 'parameters' => [
	185	+ 'id' => [
	186	+ 'since' => '11.0.0',
	187	+ 'required' => true,
	188	+ 'description' => 'The mail-address used to identify the event on the instance',
	189	+ 'example' => 'test@localhost',
	190	+ ],
	191	+ 'name' => [
	192	+ 'since' => '11.0.0',
	193	+ 'required' => true,
	194	+ 'description' => 'The display name of a matching contact or the email (fallback) which should be used in the visual representation',
	195	+ 'example' => 'Foo Bar',
	196	+ ],
	197	+ ],
	198	+ ],
	199	+ 'file' => [
	200	+ 'author' => 'Nextcloud',
	201	+ 'app' => 'dav',
	202	+ 'since' => '11.0.0',
	203	+ 'parameters' => [
	204	+ 'id' => [
	205	+ 'since' => '11.0.0',
	206	+ 'required' => true,
	207	+ 'description' => 'The id used to identify the file on the instance',
	208	+ 'example' => '42',
	209	+ ],
	210	+ 'name' => [
	211	+ 'since' => '11.0.0',
	212	+ 'required' => true,
	213	+ 'description' => 'The file name which should be used in the visual representation',
	214	+ 'example' => 'file.txt',
	215	+ ],
	216	+ 'path' => [
	217	+ 'since' => '11.0.0',
	218	+ 'required' => true,
	219	+ 'description' => 'The full path of the file for the user, should not start with a slash',
	220	+ 'example' => 'path/to/file.txt',
	221	+ ],
	222	+ 'link' => [
	223	+ 'since' => '11.0.0',
	224	+ 'required' => false,
	225	+ 'description' => 'The full URL to the file',
	226	+ 'example' => 'http://localhost/index.php/f/42',
	227	+ ],
	228	+ ],
	229	+ ],
	230	+ 'open-graph' => [
	231	+ 'author' => 'Maxence Lange',
	232	+ 'app' => 'mood',
	233	+ 'since' => '12.0.0',
	234	+ 'parameters' => [
	235	+ 'id' => [
	236	+ 'since' => '12.0.0',
	237	+ 'required' => true,
	238	+ 'description' => 'The id used to identify the open graph data on the instance',
	239	+ 'example' => '42',
	240	+ ],
	241	+ 'name' => [
	242	+ 'since' => '12.0.0',
	243	+ 'required' => true,
	244	+ 'description' => 'The open graph title of the website',
	245	+ 'example' => 'This is a website',
	246	+ ],
	247	+ 'description' => [
	248	+ 'since' => '12.0.0',
	249	+ 'required' => false,
	250	+ 'description' => 'The open graph description from the website',
	251	+ 'example' => 'This is the description of the website',
	252	+ ],
	253	+ 'thumb' => [
	254	+ 'since' => '12.0.0',
	255	+ 'required' => false,
	256	+ 'description' => 'The full URL of the open graph thumbnail',
	257	+ 'example' => 'http://localhost/index.php/apps/mood/data/image?url=https%3A%2F%2Fthumb.example.com%2Fimage.png',
	258	+ ],
	259	+ 'website' => [
	260	+ 'since' => '12.0.0',
	261	+ 'required' => false,
	262	+ 'description' => 'The name of the described website',
	263	+ 'example' => 'Nextcloud - App Store',
	264	+ ],
	265	+ 'link' => [
	266	+ 'since' => '12.0.0',
	267	+ 'required' => false,
	268	+ 'description' => 'The full link to the website',
	269	+ 'example' => 'https://apps.nextcloud.com/apps/mood',
	270	+ ],
	271	+ ],
	272	+ ],
	273	+ 'pending-federated-share' => [
	274	+ 'author' => 'Nextcloud',
	275	+ 'app' => 'dav',
	276	+ 'since' => '11.0.0',
	277	+ 'parameters' => [
	278	+ 'id' => [
	279	+ 'since' => '11.0.0',
	280	+ 'required' => true,
	281	+ 'description' => 'The id used to identify the federated share on the instance',
	282	+ 'example' => '42',
	283	+ ],
	284	+ 'name' => [
	285	+ 'since' => '11.0.0',
	286	+ 'required' => true,
	287	+ 'description' => 'The name of the shared item which should be used in the visual representation',
	288	+ 'example' => 'file.txt',
	289	+ ],
	290	+ ],
	291	+ ],
	292	+ 'systemtag' => [
	293	+ 'author' => 'Nextcloud',
	294	+ 'app' => 'core',
	295	+ 'since' => '11.0.0',
	296	+ 'parameters' => [
	297	+ 'id' => [
	298	+ 'since' => '11.0.0',
	299	+ 'required' => true,
	300	+ 'description' => 'The id used to identify the systemtag on the instance',
	301	+ 'example' => '23',
	302	+ ],
	303	+ 'name' => [
	304	+ 'since' => '11.0.0',
	305	+ 'required' => true,
	306	+ 'description' => 'The display name of the systemtag which should be used in the visual representation',
	307	+ 'example' => 'Project 1',
	308	+ ],
	309	+ 'visibility' => [
	310	+ 'since' => '11.0.0',
	311	+ 'required' => true,
	312	+ 'description' => 'If the user can see the systemtag',
	313	+ 'example' => '1',
	314	+ ],
	315	+ 'assignable' => [
	316	+ 'since' => '11.0.0',
	317	+ 'required' => true,
	318	+ 'description' => 'If the user can assign the systemtag',
	319	+ 'example' => '0',
	320	+ ],
	321	+ ],
	322	+ ],
	323	+ 'user' => [
	324	+ 'author' => 'Nextcloud',
	325	+ 'app' => 'core',
	326	+ 'since' => '11.0.0',
	327	+ 'parameters' => [
	328	+ 'id' => [
	329	+ 'since' => '11.0.0',
	330	+ 'required' => true,
	331	+ 'description' => 'The id used to identify the user on the instance',
	332	+ 'example' => 'johndoe',
	333	+ ],
	334	+ 'name' => [
	335	+ 'since' => '11.0.0',
	336	+ 'required' => true,
	337	+ 'description' => 'The display name of the user which should be used in the visual representation',
	338	+ 'example' => 'John Doe',
	339	+ ],
	340	+ 'server' => [
	341	+ 'since' => '11.0.0',
	342	+ 'required' => false,
	343	+ 'description' => 'The URL of the instance the user lives on',
	344	+ 'example' => 'localhost',
	345	+ ],
	346	+ ],
	347	+ ],
	348	+ 'user-group' => [
	349	+ 'author' => 'Nextcloud',
	350	+ 'app' => 'core',
	351	+ 'since' => '11.0.0',
	352	+ 'parameters' => [
	353	+ 'id' => [
	354	+ 'since' => '11.0.0',
	355	+ 'required' => true,
	356	+ 'description' => 'The id used to identify the group on the instance',
	357	+ 'example' => 'supportteam',
	358	+ ],
	359	+ 'name' => [
	360	+ 'since' => '11.0.0',
	361	+ 'required' => true,
	362	+ 'description' => 'The display name of the group which should be used in the visual representation',
	363	+ 'example' => 'Support Team',
	364	+ ],
	365	+ ],
	366	+ ],
	367	+ ];
368	368
369		- /**
370		- * @param string $type
371		- * @return array
372		- * @throws InvalidObjectExeption
373		- * @since 11.0.0
374		- */
375		- public function getDefinition($type) {
376		- if (isset($this->definitions[$type])) {
377		- return $this->definitions[$type];
378		- }
	369	+ /**
	370	+ * @param string $type
	371	+ * @return array
	372	+ * @throws InvalidObjectExeption
	373	+ * @since 11.0.0
	374	+ */
	375	+ public function getDefinition($type) {
	376	+ if (isset($this->definitions[$type])) {
	377	+ return $this->definitions[$type];
	378	+ }
379	379
380		- throw new InvalidObjectExeption('Object type is undefined');
381		- }
	380	+ throw new InvalidObjectExeption('Object type is undefined');
	381	+ }
382	382	}

nextcloud / server

Pull Request — master (#4736)

Status

Category

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