Complex classes like GitPlugin often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use GitPlugin, and based on these observations, apply Extract Interface, too.
1 | <?php |
||
29 | class GitPlugin extends Plugin { |
||
30 | |||
31 | /** |
||
32 | * |
||
33 | * @var Logger |
||
34 | */ |
||
35 | private $logger; |
||
36 | |||
37 | /** |
||
38 | * @var Git_UserAccountManager |
||
39 | */ |
||
40 | private $user_account_manager; |
||
41 | |||
42 | /** |
||
43 | * Service short_name as it appears in 'service' table |
||
44 | * |
||
45 | * Should be transfered in 'ServiceGit' class when we introduce it |
||
46 | */ |
||
47 | const SERVICE_SHORTNAME = 'plugin_git'; |
||
48 | |||
49 | public function __construct($id) { |
||
50 | parent::__construct($id); |
||
51 | $this->setScope(Plugin::SCOPE_PROJECT); |
||
52 | $this->_addHook('site_admin_option_hook', 'site_admin_option_hook', false); |
||
53 | $this->_addHook('cssfile', 'cssFile', false); |
||
54 | $this->_addHook('javascript_file', 'jsFile', false); |
||
55 | $this->_addHook(Event::JAVASCRIPT, 'javascript', false); |
||
56 | $this->_addHook(Event::GET_SYSTEM_EVENT_CLASS, 'getSystemEventClass', false); |
||
57 | $this->_addHook(Event::GET_PLUGINS_AVAILABLE_KEYWORDS_REFERENCES, 'getReferenceKeywords', false); |
||
58 | $this->_addHook(Event::GET_AVAILABLE_REFERENCE_NATURE, 'getReferenceNatures', false); |
||
59 | $this->addHook(Event::GET_REFERENCE); |
||
60 | $this->_addHook('SystemEvent_PROJECT_IS_PRIVATE', 'changeProjectRepositoriesAccess', false); |
||
61 | $this->_addHook('SystemEvent_PROJECT_RENAME', 'systemEventProjectRename', false); |
||
62 | $this->_addHook('project_is_deleted', 'project_is_deleted', false); |
||
63 | $this->_addHook('file_exists_in_data_dir', 'file_exists_in_data_dir', false); |
||
64 | $this->addHook(Event::SERVICE_ICON); |
||
65 | $this->addHook(Event::SERVICES_ALLOWED_FOR_PROJECT); |
||
66 | |||
67 | // Stats plugin |
||
68 | $this->_addHook('plugin_statistics_disk_usage_collect_project', 'plugin_statistics_disk_usage_collect_project', false); |
||
69 | $this->_addHook('plugin_statistics_disk_usage_service_label', 'plugin_statistics_disk_usage_service_label', false); |
||
70 | $this->_addHook('plugin_statistics_color', 'plugin_statistics_color', false); |
||
71 | |||
72 | $this->_addHook(Event::LIST_SSH_KEYS, 'getRemoteServersForUser', false); |
||
73 | $this->_addHook(Event::DUMP_SSH_KEYS); |
||
74 | $this->_addHook(Event::EDIT_SSH_KEYS); |
||
75 | $this->_addHook(Event::PROCCESS_SYSTEM_CHECK); |
||
76 | $this->_addHook(Event::SYSTEM_EVENT_GET_TYPES_FOR_DEFAULT_QUEUE); |
||
77 | $this->_addHook(Event::SYSTEM_EVENT_GET_CUSTOM_QUEUES); |
||
78 | $this->_addHook(Event::SYSTEM_EVENT_GET_TYPES_FOR_CUSTOM_QUEUE); |
||
79 | |||
80 | $this->_addHook('permission_get_name', 'permission_get_name', false); |
||
81 | $this->_addHook('permission_get_object_type', 'permission_get_object_type', false); |
||
82 | $this->_addHook('permission_get_object_name', 'permission_get_object_name', false); |
||
83 | $this->_addHook('permission_get_object_fullname', 'permission_get_object_fullname', false); |
||
84 | $this->_addHook('permission_user_allowed_to_change', 'permission_user_allowed_to_change', false); |
||
85 | $this->_addHook('permissions_for_ugroup', 'permissions_for_ugroup', false); |
||
86 | |||
87 | $this->_addHook('statistics_collector', 'statistics_collector', false); |
||
88 | |||
89 | $this->_addHook('collect_ci_triggers', 'collect_ci_triggers', false); |
||
90 | $this->_addHook('save_ci_triggers', 'save_ci_triggers', false); |
||
91 | $this->_addHook('update_ci_triggers', 'update_ci_triggers', false); |
||
92 | $this->_addHook('delete_ci_triggers', 'delete_ci_triggers', false); |
||
93 | |||
94 | $this->_addHook('logs_daily', 'logsDaily', false); |
||
95 | $this->_addHook('widget_instance', 'myPageBox', false); |
||
96 | $this->_addHook('widgets', 'widgets', false); |
||
97 | $this->_addHook('codendi_daily_start', 'codendiDaily', false); |
||
98 | $this->_addHook('show_pending_documents', 'showArchivedRepositories', false); |
||
99 | |||
100 | $this->_addHook('SystemEvent_USER_RENAME', 'systemevent_user_rename'); |
||
101 | |||
102 | // User Group membership modification |
||
103 | $this->_addHook('project_admin_add_user'); |
||
104 | $this->_addHook('project_admin_ugroup_add_user'); |
||
105 | $this->_addHook('project_admin_remove_user'); |
||
106 | $this->_addHook('project_admin_ugroup_remove_user'); |
||
107 | $this->_addHook('project_admin_change_user_permissions'); |
||
108 | $this->_addHook('project_admin_ugroup_deletion'); |
||
109 | $this->_addHook('project_admin_remove_user_from_project_ugroups'); |
||
110 | $this->_addHook('project_admin_ugroup_creation'); |
||
111 | $this->_addHook('project_admin_parent_project_modification'); |
||
112 | $this->_addHook(Event::UGROUP_MANAGER_UPDATE_UGROUP_BINDING_ADD); |
||
113 | $this->_addHook(Event::UGROUP_MANAGER_UPDATE_UGROUP_BINDING_REMOVE); |
||
114 | |||
115 | // Project hierarchy modification |
||
116 | $this->_addHook(Event::PROJECT_SET_PARENT_PROJECT, 'project_admin_parent_project_modification'); |
||
117 | $this->_addHook(Event::PROJECT_UNSET_PARENT_PROJECT, 'project_admin_parent_project_modification'); |
||
118 | |||
119 | //Gerrit user synch help |
||
120 | $this->_addHook(Event::MANAGE_THIRD_PARTY_APPS, 'manage_third_party_apps'); |
||
121 | |||
122 | $this->_addHook('register_project_creation'); |
||
123 | $this->_addHook(Event::GET_PROJECTID_FROM_URL); |
||
124 | $this->_addHook('anonymous_access_to_script_allowed'); |
||
125 | $this->_addHook(Event::IS_SCRIPT_HANDLED_FOR_RESTRICTED); |
||
126 | $this->_addHook(Event::GET_SERVICES_ALLOWED_FOR_RESTRICTED); |
||
127 | $this->_addHook(Event::PROJECT_ACCESS_CHANGE); |
||
128 | $this->_addHook(Event::SITE_ACCESS_CHANGE); |
||
129 | |||
130 | $this->_addHook('fill_project_history_sub_events'); |
||
131 | $this->_addHook(Event::POST_SYSTEM_EVENTS_ACTIONS); |
||
132 | |||
133 | $this->addHook(EVENT::REST_RESOURCES); |
||
134 | $this->addHook(EVENT::REST_PROJECT_RESOURCES); |
||
135 | $this->addHook(EVENT::REST_PROJECT_GET_GIT); |
||
136 | $this->addHook(EVENT::REST_PROJECT_OPTIONS_GIT); |
||
137 | |||
138 | $this->_addHook(Event::IMPORT_XML_PROJECT, 'importXmlProject', false); |
||
139 | |||
140 | // Gerrit user suspension |
||
141 | if (defined('LDAP_DAILY_SYNCHRO_UPDATE_USER')) { |
||
142 | $this->addHook(LDAP_DAILY_SYNCHRO_UPDATE_USER); |
||
143 | } |
||
144 | |||
145 | $this->addHook(Event::SERVICES_TRUNCATED_EMAILS); |
||
146 | } |
||
147 | |||
148 | public function getServiceShortname() { |
||
151 | |||
152 | public function service_icon($params) { |
||
155 | |||
156 | public function site_admin_option_hook() { |
||
157 | $url = $this->getPluginPath().'/admin/'; |
||
158 | $name = $GLOBALS['Language']->getText('plugin_git', 'descriptor_name'); |
||
159 | echo '<li><a href="', $url, '">', $name, '</a></li>'; |
||
160 | } |
||
161 | |||
162 | public function getPluginInfo() { |
||
163 | if (!is_a($this->pluginInfo, 'GitPluginInfo')) { |
||
164 | $this->pluginInfo = new GitPluginInfo($this); |
||
165 | } |
||
166 | return $this->pluginInfo; |
||
167 | } |
||
168 | |||
169 | /** |
||
170 | * Returns the configuration defined for given variable name |
||
171 | * |
||
172 | * @param String $key |
||
173 | * |
||
174 | * @return Mixed |
||
175 | */ |
||
176 | public function getConfigurationParameter($key) { |
||
179 | |||
180 | public function cssFile($params) { |
||
181 | // Only show the stylesheet if we're actually in the Git pages. |
||
182 | // This stops styles inadvertently clashing with the main site. |
||
183 | if (strpos($_SERVER['REQUEST_URI'], $this->getPluginPath()) === 0 || |
||
184 | strpos($_SERVER['REQUEST_URI'], '/widgets/') === 0) { |
||
185 | echo '<link rel="stylesheet" type="text/css" href="'.$this->getThemePath().'/css/style.css" />'; |
||
186 | echo '<link rel="stylesheet" type="text/css" href="/plugins/git/themes/default/css/gitphp.css" />'; |
||
187 | } |
||
188 | } |
||
189 | |||
190 | public function jsFile() { |
||
191 | // Only show the javascript if we're actually in the Git pages. |
||
192 | if (strpos($_SERVER['REQUEST_URI'], $this->getPluginPath()) === 0) { |
||
193 | echo '<script type="text/javascript" src="'.$this->getPluginPath().'/scripts/git.js"></script>'; |
||
194 | echo '<script type="text/javascript" src="'.$this->getPluginPath().'/scripts/online_edit.js"></script>'; |
||
195 | echo '<script type="text/javascript" src="'.$this->getPluginPath().'/scripts/clone_url.js"></script>'; |
||
196 | echo '<script type="text/javascript" src="'.$this->getPluginPath().'/scripts/mass-update.js"></script>'; |
||
197 | } |
||
198 | } |
||
199 | |||
200 | public function javascript($params) { |
||
203 | |||
204 | public function system_event_get_types_for_default_queue(array &$params) { |
||
207 | |||
208 | /** @see Event::SYSTEM_EVENT_GET_CUSTOM_QUEUES */ |
||
209 | public function system_event_get_custom_queues(array &$params) { |
||
213 | |||
214 | /** @see Event::SYSTEM_EVENT_GET_TYPES_FOR_CUSTOM_QUEUE */ |
||
215 | public function system_event_get_types_for_custom_queue(array &$params) { |
||
216 | if ($params['queue'] == Git_SystemEventQueue::NAME) { |
||
217 | $params['types'] = array_merge( |
||
218 | $params['types'], |
||
219 | $this->getGitSystemEventManager()->getTypes() |
||
220 | ); |
||
221 | } |
||
222 | |||
223 | if ($params['queue'] == Git_Mirror_MirrorSystemEventQueue::NAME) { |
||
224 | $params['types'] = array_merge( |
||
225 | $params['types'], |
||
226 | $this->getGitSystemEventManager()->getGrokMirrorTypes() |
||
227 | ); |
||
228 | } |
||
229 | } |
||
230 | |||
231 | /** |
||
232 | *This callback make SystemEvent manager knows about git plugin System Events |
||
233 | * @param <type> $params |
||
234 | */ |
||
235 | public function getSystemEventClass($params) { |
||
236 | switch($params['type']) { |
||
237 | case SystemEvent_GIT_REPO_UPDATE::NAME: |
||
238 | $params['class'] = 'SystemEvent_GIT_REPO_UPDATE'; |
||
239 | $params['dependencies'] = array( |
||
240 | $this->getRepositoryFactory(), |
||
241 | $this->getSystemEventDao(), |
||
242 | $this->getLogger(), |
||
243 | $this->getGitSystemEventManager() |
||
244 | ); |
||
245 | break; |
||
246 | case SystemEvent_GIT_REPO_DELETE::NAME: |
||
247 | $params['class'] = 'SystemEvent_GIT_REPO_DELETE'; |
||
248 | $params['dependencies'] = array( |
||
249 | $this->getRepositoryFactory(), |
||
250 | $this->getLogger(), |
||
251 | $this->getGitSystemEventManager(), |
||
252 | ); |
||
253 | break; |
||
254 | case SystemEvent_GIT_LEGACY_REPO_DELETE::NAME: |
||
255 | $params['class'] = 'SystemEvent_GIT_LEGACY_REPO_DELETE'; |
||
256 | $params['dependencies'] = array( |
||
257 | $this->getRepositoryFactory(), |
||
258 | $this->getManifestManager(), |
||
259 | $this->getLogger(), |
||
260 | ); |
||
261 | break; |
||
262 | case SystemEvent_GIT_LEGACY_REPO_ACCESS::NAME: |
||
263 | $params['class'] = 'SystemEvent_GIT_LEGACY_REPO_ACCESS'; |
||
264 | break; |
||
265 | case SystemEvent_GIT_GERRIT_MIGRATION::NAME: |
||
266 | $params['class'] = 'SystemEvent_GIT_GERRIT_MIGRATION'; |
||
267 | $params['dependencies'] = array( |
||
268 | $this->getGitDao(), |
||
269 | $this->getRepositoryFactory(), |
||
270 | $this->getGerritServerFactory(), |
||
271 | $this->getLogger(), |
||
272 | $this->getProjectCreator(), |
||
273 | $this->getGitRepositoryUrlManager(), |
||
274 | ); |
||
275 | break; |
||
276 | case SystemEvent_GIT_REPO_FORK::NAME: |
||
277 | $params['class'] = 'SystemEvent_GIT_REPO_FORK'; |
||
278 | $params['dependencies'] = array( |
||
279 | $this->getRepositoryFactory() |
||
280 | ); |
||
281 | break; |
||
282 | case SystemEvent_GIT_GERRIT_ADMIN_KEY_DUMP::NAME: |
||
283 | $params['class'] = 'SystemEvent_GIT_GERRIT_ADMIN_KEY_DUMP'; |
||
284 | $params['dependencies'] = array( |
||
285 | $this->getGerritServerFactory(), |
||
286 | $this->getGitoliteSSHKeyDumper(), |
||
287 | ); |
||
288 | break; |
||
289 | case SystemEvent_GIT_GERRIT_PROJECT_DELETE::NAME: |
||
290 | $params['class'] = 'SystemEvent_GIT_GERRIT_PROJECT_DELETE'; |
||
291 | $params['dependencies'] = array( |
||
292 | $this->getRepositoryFactory(), |
||
293 | $this->getGerritServerFactory(), |
||
294 | $this->getGerritDriverFactory() |
||
295 | ); |
||
296 | break; |
||
297 | case SystemEvent_GIT_GERRIT_PROJECT_READONLY::NAME: |
||
298 | $params['class'] = 'SystemEvent_GIT_GERRIT_PROJECT_READONLY'; |
||
299 | $params['dependencies'] = array( |
||
300 | $this->getRepositoryFactory(), |
||
301 | $this->getGerritServerFactory(), |
||
302 | $this->getGerritDriverFactory() |
||
303 | ); |
||
304 | break; |
||
305 | case SystemEvent_GIT_USER_RENAME::NAME: |
||
306 | $params['class'] = 'SystemEvent_GIT_USER_RENAME'; |
||
307 | $params['dependencies'] = array( |
||
308 | $this->getGitoliteSSHKeyDumper(), |
||
309 | UserManager::instance() |
||
310 | ); |
||
311 | break; |
||
312 | case SystemEvent_GIT_GROKMIRROR_MANIFEST_UPDATE::NAME: |
||
313 | $params['class'] = 'SystemEvent_GIT_GROKMIRROR_MANIFEST_UPDATE'; |
||
314 | $params['dependencies'] = array( |
||
315 | $this->getRepositoryFactory(), |
||
316 | $this->getManifestManager(), |
||
317 | ); |
||
318 | break; |
||
319 | case SystemEvent_GIT_GROKMIRROR_MANIFEST_UPDATE_FOLLOWING_A_GIT_PUSH::NAME: |
||
320 | $params['class'] = 'SystemEvent_GIT_GROKMIRROR_MANIFEST_UPDATE_FOLLOWING_A_GIT_PUSH'; |
||
321 | $params['dependencies'] = array( |
||
322 | $this->getRepositoryFactory(), |
||
323 | $this->getManifestManager(), |
||
324 | ); |
||
325 | break; |
||
326 | case SystemEvent_GIT_GROKMIRROR_MANIFEST_CHECK::NAME: |
||
327 | $params['class'] = 'SystemEvent_GIT_GROKMIRROR_MANIFEST_CHECK'; |
||
328 | $params['dependencies'] = array( |
||
329 | $this->getManifestManager(), |
||
330 | ); |
||
331 | break; |
||
332 | case SystemEvent_GIT_GROKMIRROR_MANIFEST_REPODELETE::NAME: |
||
333 | $params['class'] = 'SystemEvent_GIT_GROKMIRROR_MANIFEST_REPODELETE'; |
||
334 | $params['dependencies'] = array( |
||
335 | $this->getManifestManager(), |
||
336 | ); |
||
337 | break; |
||
338 | case SystemEvent_GIT_EDIT_SSH_KEYS::NAME: |
||
339 | $params['class'] = 'SystemEvent_GIT_EDIT_SSH_KEYS'; |
||
340 | $params['dependencies'] = array( |
||
341 | UserManager::instance(), |
||
342 | $this->getSSHKeyDumper(), |
||
343 | $this->getUserAccountManager(), |
||
344 | $this->getGitSystemEventManager(), |
||
345 | $this->getLogger() |
||
346 | ); |
||
347 | break; |
||
348 | case SystemEvent_GIT_DUMP_ALL_SSH_KEYS::NAME: |
||
349 | $params['class'] = 'SystemEvent_GIT_DUMP_ALL_SSH_KEYS'; |
||
350 | $params['dependencies'] = array( |
||
351 | $this->getSSHKeyMassDumper(), |
||
352 | $this->getLogger() |
||
353 | ); |
||
354 | break; |
||
355 | case SystemEvent_GIT_REPO_RESTORE::NAME: |
||
356 | $params['class'] = 'SystemEvent_GIT_REPO_RESTORE'; |
||
357 | $params['dependencies'] = array( |
||
358 | $this->getRepositoryFactory(), |
||
359 | $this->getGitSystemEventManager(), |
||
360 | $this->getLogger() |
||
361 | ); |
||
362 | break; |
||
363 | case SystemEvent_GIT_PROJECTS_UPDATE::NAME: |
||
364 | $params['class'] = 'SystemEvent_GIT_PROJECTS_UPDATE'; |
||
365 | $params['dependencies'] = array( |
||
366 | $this->getLogger(), |
||
367 | $this->getGitSystemEventManager(), |
||
368 | $this->getProjectManager(), |
||
369 | $this->getGitoliteDriver(), |
||
370 | ); |
||
371 | break; |
||
372 | case SystemEvent_GIT_DUMP_ALL_MIRRORED_REPOSITORIES::NAME: |
||
373 | $params['class'] = 'SystemEvent_GIT_DUMP_ALL_MIRRORED_REPOSITORIES'; |
||
374 | $params['dependencies'] = array( |
||
375 | $this->getGitoliteDriver() |
||
376 | ); |
||
377 | break; |
||
378 | case SystemEvent_GIT_UPDATE_MIRROR::NAME: |
||
379 | $params['class'] = 'SystemEvent_GIT_UPDATE_MIRROR'; |
||
380 | $params['dependencies'] = array( |
||
381 | $this->getGitoliteDriver() |
||
382 | ); |
||
383 | break; |
||
384 | case SystemEvent_GIT_DELETE_MIRROR::NAME: |
||
385 | $params['class'] = 'SystemEvent_GIT_DELETE_MIRROR'; |
||
386 | $params['dependencies'] = array( |
||
387 | $this->getGitoliteDriver() |
||
388 | ); |
||
389 | break; |
||
390 | default: |
||
391 | break; |
||
392 | } |
||
393 | } |
||
394 | |||
395 | private function getTemplateFactory() { |
||
398 | |||
399 | private function getSystemEventDao() { |
||
402 | |||
403 | public function getReferenceKeywords($params) { |
||
404 | $params['keywords'] = array_merge( |
||
405 | $params['keywords'], |
||
406 | array(Git::REFERENCE_KEYWORD) |
||
407 | ); |
||
408 | } |
||
409 | |||
410 | public function getReferenceNatures($params) { |
||
411 | $params['natures'] = array_merge( |
||
412 | $params['natures'], |
||
413 | array( |
||
414 | Git::REFERENCE_NATURE => array( |
||
415 | 'keyword' => Git::REFERENCE_KEYWORD, |
||
416 | 'label' => $GLOBALS['Language']->getText('plugin_git', 'reference_commit_nature_key') |
||
417 | ) |
||
418 | ) |
||
419 | ); |
||
420 | } |
||
421 | |||
422 | public function get_reference($params) { |
||
423 | if ($params['keyword'] == Git::REFERENCE_KEYWORD) { |
||
424 | $reference = false; |
||
425 | if ($params['project']) { |
||
426 | $git_reference_manager = new Git_ReferenceManager( |
||
427 | $this->getRepositoryFactory(), |
||
428 | $params['reference_manager'] |
||
429 | ); |
||
430 | $reference = $git_reference_manager->getReference( |
||
431 | $params['project'], |
||
432 | $params['keyword'], |
||
433 | $params['value'] |
||
434 | ); |
||
435 | } |
||
436 | $params['reference'] = $reference; |
||
437 | } |
||
438 | } |
||
439 | |||
440 | public function changeProjectRepositoriesAccess($params) { |
||
441 | $groupId = $params[0]; |
||
442 | $isPrivate = $params[1]; |
||
443 | $dao = new GitDao(); |
||
444 | $factory = $this->getRepositoryFactory(); |
||
445 | GitActions::changeProjectRepositoriesAccess($groupId, $isPrivate, $dao, $factory); |
||
446 | } |
||
447 | |||
448 | public function systemEventProjectRename($params) { |
||
451 | |||
452 | public function file_exists_in_data_dir($params) { |
||
455 | |||
456 | private function isNameAvailable($newName, &$error) { |
||
457 | $backend_gitolite = $this->getBackendGitolite(); |
||
458 | $backend_gitshell = Backend::instance('Git','GitBackend', array($this->getGitRepositoryUrlManager())); |
||
459 | |||
460 | if (! $backend_gitolite->isNameAvailable($newName) && ! $backend_gitshell->isNameAvailable($newName)) { |
||
461 | $error = $GLOBALS['Language']->getText('plugin_git', 'actions_name_not_available'); |
||
462 | return false; |
||
463 | } |
||
464 | |||
465 | return true; |
||
466 | } |
||
467 | |||
468 | public function getBackendGitolite() { |
||
471 | |||
472 | public function process() { |
||
475 | |||
476 | /** |
||
477 | * We expect that the check fo access right to this method has already been done by the caller |
||
478 | */ |
||
479 | public function processAdmin(Codendi_Request $request) { |
||
480 | require_once 'common/include/CSRFSynchronizerToken.class.php'; |
||
481 | $admin = new Git_AdminRouter( |
||
482 | $this->getGerritServerFactory(), |
||
483 | new CSRFSynchronizerToken('/plugin/git/admin/'), |
||
484 | $this->getMirrorDataMapper(), |
||
485 | new Git_MirrorResourceRestrictor( |
||
486 | new Git_RestrictedMirrorDao(), |
||
487 | $this->getMirrorDataMapper(), |
||
498 | |||
499 | private function getMirrorDataMapper() { |
||
513 | |||
514 | /** |
||
515 | * Hook to collect docman disk size usage per project |
||
516 | * |
||
517 | * @param array $params |
||
518 | */ |
||
519 | function plugin_statistics_disk_usage_collect_project($params) { |
||
533 | |||
534 | /** |
||
535 | * Hook to list docman in the list of serices managed by disk stats |
||
536 | * |
||
537 | * @param array $params |
||
538 | */ |
||
539 | function plugin_statistics_disk_usage_service_label($params) { |
||
542 | |||
543 | /** |
||
544 | * Hook to choose the color of the plugin in the graph |
||
545 | * |
||
546 | * @param array $params |
||
547 | */ |
||
548 | function plugin_statistics_color($params) { |
||
553 | |||
554 | /** |
||
555 | * Function called when a user is removed from a project |
||
556 | * If a user is removed from a project wich having a private git repository, the |
||
557 | * user should be removed from notification. |
||
558 | * |
||
559 | * @param array $params |
||
560 | * |
||
561 | * @return void |
||
562 | */ |
||
563 | private function projectRemoveUserFromNotification($params) { |
||
574 | |||
575 | /** |
||
576 | * |
||
577 | * @see Event::EDIT_SSH_KEYS |
||
578 | * @param array $params |
||
579 | */ |
||
580 | public function edit_ssh_keys(array $params) { |
||
583 | |||
584 | /** |
||
585 | * Hook. Call by backend when SSH keys are modified |
||
586 | * |
||
587 | * @param array $params Should contain two entries: |
||
588 | * 'user' => PFUser, |
||
589 | * 'original_keys' => string of concatenated ssh keys |
||
590 | */ |
||
591 | public function dump_ssh_keys(array $params) { |
||
594 | |||
595 | /** |
||
596 | * |
||
597 | * @param PFUser $user |
||
598 | * @return Git_UserAccountManager |
||
599 | */ |
||
600 | private function getUserAccountManager() { |
||
610 | |||
611 | /** |
||
612 | * |
||
613 | * @param Git_UserAccountManager $manager |
||
614 | */ |
||
615 | public function setUserAccountManager(Git_UserAccountManager $manager) { |
||
618 | |||
619 | /** |
||
620 | * Method called as a hook. |
||
621 | * |
||
622 | * @param array $params Should contain two entries: |
||
623 | * 'user' => PFUser, |
||
624 | * 'html' => string An emty string of html output- passed by reference |
||
625 | */ |
||
626 | public function getRemoteServersForUser(array $params) { |
||
667 | |||
668 | /** |
||
669 | * Method called as a hook. |
||
670 | |||
671 | * Copies all SSH Keys to Remote Git Servers |
||
672 | * @param PFUser $user |
||
673 | */ |
||
674 | private function pushUserSSHKeysToRemoteServers(PFUser $user) { |
||
692 | |||
693 | private function getUserFromParameters($params) { |
||
701 | |||
702 | function permission_get_name($params) { |
||
768 | |||
769 | var $_cached_permission_user_allowed_to_change; |
||
770 | function permission_user_allowed_to_change($params) { |
||
796 | |||
797 | public function proccess_system_check($params) { |
||
812 | |||
813 | public function getGitoliteDriver() { |
||
829 | |||
830 | /** |
||
831 | * When project is deleted all its git repositories are archived and marked as deleted |
||
832 | * |
||
833 | * @param Array $params Parameters contining project id |
||
834 | * |
||
835 | * @return void |
||
836 | */ |
||
837 | public function project_is_deleted($params) { |
||
846 | |||
847 | /** |
||
848 | * Display git backend statistics in CSV format |
||
849 | * |
||
850 | * @param Array $params parameters of the event |
||
851 | * |
||
852 | * @return void |
||
853 | */ |
||
854 | public function statistics_collector($params) { |
||
862 | |||
863 | /** |
||
864 | * Add ci trigger information for Git service |
||
865 | * |
||
866 | * @param Array $params Hook parms |
||
867 | * |
||
868 | * @return Void |
||
869 | */ |
||
870 | public function collect_ci_triggers($params) { |
||
875 | |||
876 | /** |
||
877 | * Save ci trigger for Git service |
||
878 | * |
||
879 | * @param Array $params Hook parms |
||
880 | * |
||
881 | * @return Void |
||
882 | */ |
||
883 | public function save_ci_triggers($params) { |
||
902 | |||
903 | /** |
||
904 | * Update ci trigger for Git service |
||
905 | * |
||
906 | * @param Array $params Hook parms |
||
907 | * |
||
908 | * @return Void |
||
909 | */ |
||
910 | public function update_ci_triggers($params) { |
||
936 | |||
937 | /** |
||
938 | * Delete ci trigger for Git service |
||
939 | * |
||
940 | * @param Array $params Hook parms |
||
941 | * |
||
942 | * @return Void |
||
943 | */ |
||
944 | public function delete_ci_triggers($params) { |
||
952 | |||
953 | /** |
||
954 | * Add log access for git pushs |
||
955 | * |
||
956 | * @param Array $params parameters of the event |
||
957 | * |
||
958 | * @return Void |
||
959 | */ |
||
960 | function logsDaily($params) { |
||
968 | |||
969 | /** |
||
970 | * Instanciate the corresponding widget |
||
971 | * |
||
972 | * @param Array $params Name and instance of the widget |
||
973 | * |
||
974 | * @return Void |
||
975 | */ |
||
976 | function myPageBox($params) { |
||
988 | |||
989 | public function project_admin_remove_user_from_project_ugroups($params) { |
||
1000 | |||
1001 | public function project_admin_change_user_permissions($params) { |
||
1010 | |||
1011 | public function project_admin_ugroup_deletion($params) { |
||
1024 | |||
1025 | public function project_admin_add_user($params) { |
||
1029 | |||
1030 | public function project_admin_remove_user($params) { |
||
1035 | |||
1036 | public function project_admin_ugroup_add_user($params) { |
||
1042 | |||
1043 | public function project_admin_ugroup_remove_user($params) { |
||
1049 | |||
1050 | public function project_admin_ugroup_creation($params) { |
||
1055 | |||
1056 | public function project_admin_parent_project_modification($params) { |
||
1068 | |||
1069 | public function ugroup_manager_update_ugroup_binding_add($params) { |
||
1075 | |||
1076 | public function ugroup_manager_update_ugroup_binding_remove($params) { |
||
1081 | |||
1082 | private function getUserFromParams(array $params) { |
||
1085 | |||
1086 | |||
1087 | private function getUGroupFromParams(array $params) { |
||
1095 | |||
1096 | /** |
||
1097 | * List plugin's widgets in customize menu |
||
1098 | * |
||
1099 | * @param Array $params List of widgets |
||
1100 | * |
||
1101 | * @return Void |
||
1102 | */ |
||
1103 | function widgets($params) { |
||
1118 | |||
1119 | private function getProjectCreator() { |
||
1132 | |||
1133 | private function getTemplateProcessor() { |
||
1136 | |||
1137 | private function getGerritUmbrellaProjectManager() { |
||
1145 | |||
1146 | private function getProjectManager() { |
||
1149 | |||
1150 | private function getGerritUserFinder() { |
||
1153 | |||
1154 | private function getGitController() { |
||
1176 | |||
1177 | public function getGitSystemEventManager() { |
||
1180 | |||
1181 | /** |
||
1182 | * @return GitRepositoryManager |
||
1183 | */ |
||
1184 | private function getRepositoryManager() { |
||
1192 | |||
1193 | public function getRepositoryFactory() { |
||
1196 | |||
1197 | private function getGitDao() { |
||
1200 | |||
1201 | /** |
||
1202 | * @return Git_Driver_Gerrit_GerritDriverFactory |
||
1203 | */ |
||
1204 | private function getGerritDriverFactory() { |
||
1207 | |||
1208 | private function getPermissionsManager() { |
||
1211 | |||
1212 | private function getGitPermissionsManager() { |
||
1218 | |||
1219 | /** |
||
1220 | * |
||
1221 | * @return Logger |
||
1222 | */ |
||
1223 | public function getLogger() { |
||
1230 | |||
1231 | /** |
||
1232 | * |
||
1233 | * @param Logger $logger |
||
1234 | */ |
||
1235 | public function setLogger(Logger $logger) { |
||
1238 | |||
1239 | private function getGerritMembershipManager() { |
||
1250 | |||
1251 | protected function getGerritServerFactory() { |
||
1259 | |||
1260 | private function getGitoliteSSHKeyDumper() { |
||
1267 | |||
1268 | private function getGitoliteAdminPath() { |
||
1271 | |||
1272 | private function getUGroupManager() { |
||
1275 | |||
1276 | /** |
||
1277 | * @param array $params |
||
1278 | * Parameters: |
||
1279 | * 'user' => PFUser |
||
1280 | * 'html' => string |
||
1281 | */ |
||
1282 | public function manage_third_party_apps($params) { |
||
1285 | |||
1286 | /** |
||
1287 | * @param array $params |
||
1288 | * Parameters: |
||
1289 | * 'user' => PFUser |
||
1290 | * 'html' => string |
||
1291 | */ |
||
1292 | private function resynch_gerrit_groups_with_user($params) { |
||
1307 | |||
1308 | private function addMissingGerritAccess($user) { |
||
1311 | |||
1312 | /** |
||
1313 | * @see Event::USER_RENAME |
||
1314 | */ |
||
1315 | public function systemevent_user_rename($params) { |
||
1318 | |||
1319 | public function register_project_creation($params) { |
||
1329 | |||
1330 | /** @see Event::GET_PROJECTID_FROM_URL */ |
||
1331 | public function get_projectid_from_url($params) { |
||
1348 | |||
1349 | public function anonymous_access_to_script_allowed($params) { |
||
1361 | |||
1362 | /** |
||
1363 | * @return boolean true if friendly URLs have been activated |
||
1364 | */ |
||
1365 | public function areFriendlyUrlsActivated() { |
||
1368 | |||
1369 | /** |
||
1370 | * @return Git_GitRepositoryUrlManager |
||
1371 | */ |
||
1372 | private function getGitRepositoryUrlManager() { |
||
1375 | |||
1376 | /** |
||
1377 | * @return Git_Mirror_ManifestManager |
||
1378 | */ |
||
1379 | public function getManifestManager() { |
||
1388 | |||
1389 | private function getSSHKeyDumper() { |
||
1394 | |||
1395 | private function getSSHKeyMassDumper() { |
||
1401 | |||
1402 | /** |
||
1403 | * Hook: called by daily codendi script. |
||
1404 | */ |
||
1405 | function codendiDaily() { |
||
1408 | |||
1409 | public function fill_project_history_sub_events($params) { |
||
1425 | |||
1426 | /** |
||
1427 | * @see Event::POST_EVENTS_ACTIONS |
||
1428 | */ |
||
1429 | public function post_system_events_actions($params) { |
||
1441 | |||
1442 | private function pluginIsConcerned($params) { |
||
1447 | |||
1448 | public function getRESTRepositoryRepresentationBuilder($version) { |
||
1452 | |||
1453 | public function rest_project_get_git($params) { |
||
1468 | |||
1469 | public function rest_project_options_git($params) { |
||
1472 | |||
1473 | /** |
||
1474 | * @see Event::REST_PROJECT_RESOURCES |
||
1475 | */ |
||
1476 | public function rest_project_resources(array $params) { |
||
1480 | |||
1481 | /** |
||
1482 | * @see REST_RESOURCES |
||
1483 | */ |
||
1484 | public function rest_resources($params) { |
||
1488 | |||
1489 | /** |
||
1490 | * @return PFUser |
||
1491 | */ |
||
1492 | private function getCurrentUser() { |
||
1495 | |||
1496 | /** |
||
1497 | * Hook to list archived repositories for restore in site admin page |
||
1498 | * |
||
1499 | * @param array $params |
||
1500 | */ |
||
1501 | public function showArchivedRepositories($params) { |
||
1526 | |||
1527 | public function is_script_handled_for_restricted($params) { |
||
1533 | |||
1534 | public function get_services_allowed_for_restricted($params) { |
||
1537 | |||
1538 | /** |
||
1539 | * @see Event::PROJECT_ACCESS_CHANGE |
||
1540 | * @param type $params |
||
1541 | */ |
||
1542 | public function project_access_change($params) { |
||
1547 | |||
1548 | /** |
||
1549 | * @see Event::SITE_ACCESS_CHANGE |
||
1550 | * @param array $params |
||
1551 | */ |
||
1552 | public function site_access_change(array $params) { |
||
1555 | |||
1556 | /** |
||
1557 | * @param PFUser user |
||
1558 | */ |
||
1559 | public function ldap_daily_synchro_update_user(PFUser $user) { |
||
1570 | |||
1571 | /** @see Event::SERVICES_TRUNCATED_EMAILS */ |
||
1572 | public function services_truncated_emails(array $params) { |
||
1578 | |||
1579 | |||
1580 | /** |
||
1581 | * |
||
1582 | * @param array $params |
||
1583 | * @see Event::IMPORT_XML_PROJECT |
||
1584 | */ |
||
1585 | public function importXmlProject($params) { |
||
1598 | } |
||
1599 |
It seems like the method you are trying to call exists only in some of the possible types.
Let’s take a look at an example:
Available Fixes
Add an additional type-check:
Only allow a single type to be passed if the variable comes from a parameter: