Permalink
Browse files

Add some missing phpdoc tags

  • Loading branch information...
flack committed Jan 7, 2019
1 parent e07044c commit 81f974123231de153692f298c1e342ece6431081
Showing with 190 additions and 6 deletions.
  1. +1 −0 lib/midcom/admin/folder/handler/approvals.php
  2. +2 −0 lib/midcom/admin/folder/handler/delete.php
  3. +1 −0 lib/midcom/admin/folder/handler/edit.php
  4. +1 −0 lib/midcom/admin/folder/handler/metadata.php
  5. +1 −1 lib/midcom/admin/folder/handler/move.php
  6. +3 −1 lib/midcom/admin/folder/handler/order.php
  7. +1 −0 lib/midcom/application.php
  8. +2 −0 lib/midcom/baseclasses/components/handler/configuration.php
  9. +2 −1 lib/midcom/baseclasses/components/handler/configuration/recreate.php
  10. +2 −2 lib/midcom/core/context.php
  11. +1 −0 lib/midcom/helper/imagepopup/handler/list.php
  12. +2 −0 lib/midcom/helper/search/handler/search.php
  13. +2 −1 lib/midcom/services/auth/backend.php
  14. +1 −0 lib/midcom/services/auth/frontend/form.php
  15. +2 −0 lib/midcom/services/auth/main.php
  16. +6 −0 lib/midcom/services/cache/module/content.php
  17. +1 −0 lib/midgard/admin/asgard/handler/component/configuration.php
  18. +3 −0 lib/midgard/admin/asgard/handler/object/attachments.php
  19. +4 −0 lib/midgard/admin/asgard/handler/object/manage.php
  20. +1 −0 lib/midgard/admin/asgard/handler/object/metadata.php
  21. +1 −0 lib/midgard/admin/asgard/handler/object/permissions.php
  22. +3 −0 lib/midgard/admin/asgard/handler/preferences.php
  23. +1 −0 lib/midgard/admin/asgard/handler/shell.php
  24. +1 −0 lib/midgard/admin/asgard/handler/type.php
  25. +1 −0 lib/midgard/admin/asgard/handler/undelete.php
  26. +1 −0 lib/midgard/admin/asgard/handler/welcome.php
  27. +1 −0 lib/midgard/admin/user/handler/group/create.php
  28. +1 −0 lib/midgard/admin/user/handler/group/edit.php
  29. +1 −0 lib/midgard/admin/user/handler/group/list.php
  30. +4 −0 lib/midgard/admin/user/handler/list.php
  31. +2 −0 lib/midgard/admin/user/handler/user/account.php
  32. +1 −0 lib/midgard/admin/user/handler/user/create.php
  33. +1 −0 lib/midgard/admin/user/handler/user/edit.php
  34. +2 −0 lib/net/nehmer/blog/handler/admin.php
  35. +1 −0 lib/net/nehmer/blog/handler/create.php
  36. +1 −0 lib/net/nehmer/comments/handler/admin.php
  37. +4 −0 lib/net/nehmer/comments/handler/moderate.php
  38. +5 −0 lib/net/nehmer/comments/handler/view.php
  39. +2 −0 lib/net/nehmer/static/handler/admin.php
  40. +1 −0 lib/net/nehmer/static/handler/create.php
  41. +3 −0 lib/net/nemein/redirector/handler/tinyurl.php
  42. +3 −0 lib/net/nemein/rss/handler/admin.php
  43. +1 −0 lib/net/nemein/wiki/handler/create.php
  44. +1 −0 lib/net/nemein/wiki/handler/delete.php
  45. +2 −0 lib/net/nemein/wiki/handler/edit.php
  46. +1 −0 lib/net/nemein/wiki/handler/view.php
  47. +3 −0 lib/org/openpsa/calendar/handler/event/admin.php
  48. +1 −0 lib/org/openpsa/calendar/handler/event/create.php
  49. +1 −0 lib/org/openpsa/calendar/handler/event/view.php
  50. +1 −0 lib/org/openpsa/calendar/handler/filters.php
  51. +1 −0 lib/org/openpsa/calendar/handler/ical.php
  52. +2 −0 lib/org/openpsa/calendar/handler/json.php
  53. +2 −0 lib/org/openpsa/calendar/handler/resource.php
  54. +1 −0 lib/org/openpsa/contacts/handler/group/action.php
  55. +1 −0 lib/org/openpsa/contacts/handler/group/create.php
  56. +1 −0 lib/org/openpsa/contacts/handler/group/edit.php
  57. +1 −0 lib/org/openpsa/contacts/handler/mycontacts.php
  58. +2 −0 lib/org/openpsa/contacts/handler/person/admin.php
  59. +1 −0 lib/org/openpsa/contacts/handler/person/create.php
  60. +1 −0 lib/org/openpsa/contacts/handler/search.php
  61. +2 −0 lib/org/openpsa/directmarketing/handler/campaign/admin.php
  62. +1 −0 lib/org/openpsa/directmarketing/handler/campaign/create.php
  63. +1 −0 lib/org/openpsa/directmarketing/handler/campaign/rules.php
  64. +4 −0 lib/org/openpsa/directmarketing/handler/import.php
  65. +5 −0 lib/org/openpsa/directmarketing/handler/logger.php
  66. +3 −0 lib/org/openpsa/directmarketing/handler/message/admin.php
  67. +1 −0 lib/org/openpsa/directmarketing/handler/message/create.php
  68. +1 −0 lib/org/openpsa/directmarketing/handler/message/report.php
  69. +1 −0 lib/org/openpsa/directmarketing/handler/subscriber.php
  70. +1 −0 lib/org/openpsa/documents/handler/directory/create.php
  71. +1 −0 lib/org/openpsa/documents/handler/directory/edit.php
  72. +3 −0 lib/org/openpsa/documents/handler/document/admin.php
  73. +1 −0 lib/org/openpsa/documents/handler/search.php
  74. +5 −0 lib/org/openpsa/expenses/handler/hours/admin.php
  75. +1 −0 lib/org/openpsa/helpers/handler/chooser.php
  76. +2 −0 lib/org/openpsa/invoices/handler/billingdata.php
  77. +1 −0 lib/org/openpsa/invoices/handler/goto.php
  78. +3 −0 lib/org/openpsa/invoices/handler/invoice/crud.php
  79. +2 −0 lib/org/openpsa/invoices/handler/invoice/items.php
  80. +1 −0 lib/org/openpsa/mypage/handler/workingon.php
  81. +1 −0 lib/org/openpsa/products/handler/group/create.php
  82. +1 −0 lib/org/openpsa/products/handler/group/edit.php
  83. +2 −0 lib/org/openpsa/products/handler/product/admin.php
  84. +1 −0 lib/org/openpsa/products/handler/product/create.php
  85. +4 −0 lib/org/openpsa/projects/handler/project/crud.php
  86. +3 −0 lib/org/openpsa/projects/handler/task/crud.php
  87. +1 −0 lib/org/openpsa/projects/handler/task/resourcing.php
  88. +1 −0 lib/org/openpsa/projects/handler/workflow.php
  89. +3 −0 lib/org/openpsa/relatedto/handler/journal/entry.php
  90. +1 −0 lib/org/openpsa/relatedto/handler/journal/list.php
  91. +2 −0 lib/org/openpsa/reports/handler/base.php
  92. +2 −0 lib/org/openpsa/reports/handler/common.php
  93. +1 −0 lib/org/openpsa/sales/handler/deliverable/add.php
  94. +2 −0 lib/org/openpsa/sales/handler/deliverable/admin.php
  95. +1 −0 lib/org/openpsa/sales/handler/deliverable/process.php
  96. +3 −0 lib/org/openpsa/sales/handler/edit.php
  97. +2 −0 lib/org/openpsa/sales/handler/offer.php
  98. +2 −0 lib/org/openpsa/slideshow/handler/edit.php
  99. +1 −0 lib/org/openpsa/user/handler/group/create.php
  100. +1 −0 lib/org/openpsa/user/handler/group/delete.php
  101. +1 −0 lib/org/openpsa/user/handler/group/edit.php
  102. +1 −0 lib/org/openpsa/user/handler/group/notifications.php
  103. +1 −0 lib/org/openpsa/user/handler/group/privileges.php
  104. +1 −0 lib/org/openpsa/user/handler/lostpassword.php
  105. +2 −0 lib/org/openpsa/user/handler/person/account.php
  106. +1 −0 lib/org/openpsa/user/handler/person/create.php
  107. +1 −0 lib/org/openpsa/user/handler/person/delete.php
  108. +1 −0 lib/org/openpsa/user/handler/person/edit.php
  109. +1 −0 lib/org/openpsa/user/handler/person/notifications.php
  110. +1 −0 lib/org/openpsa/user/handler/person/privileges.php
@@ -19,6 +19,7 @@ class midcom_admin_folder_handler_approvals extends midcom_baseclasses_component
* Checks the integrity of the content topic and gets the stored approvals of
* the content folder.
*
* @param Request $request The request object
* @param mixed $handler_id The ID of the handler.
*/
public function _handler_approval(Request $request, $handler_id)
@@ -17,6 +17,8 @@ class midcom_admin_folder_handler_delete extends midcom_baseclasses_components_h
{
/**
* Handler for folder deletion.
*
* @param Request $request The request object
*/
public function _handler_delete(Request $request)
{
@@ -81,6 +81,7 @@ private function _load_controller()
/**
* Handler for folder editing. Checks for the permissions and folder integrity.
*
* @param Request $request The request object
* @param mixed $handler_id The ID of the handler.
*/
public function _handler_edit(Request $request, $handler_id)
@@ -26,6 +26,7 @@ class midcom_admin_folder_handler_metadata extends midcom_baseclasses_components
* Handler for folder metadata. Checks for updating permissions, initializes
* the metadata and the content topic itself. Handles also the sent form.
*
* @param Request $request The request object
* @param string $guid The object GUID
*/
public function _handler_metadata(Request $request, $guid)
@@ -26,7 +26,7 @@ class midcom_admin_folder_handler_move extends midcom_baseclasses_components_han
* Handler for folder move. Checks for updating permissions, initializes
* the move and the content topic itself. Handles also the sent form.
*
* @param Request $request
* @param Request $request The request object
* @param string $guid The object GUID
* @param array &$data The local request data.
*/
@@ -24,6 +24,8 @@ class midcom_admin_folder_handler_order extends midcom_baseclasses_components_ha
/**
* Set the score.
*
* @param Request $request The request object
*/
private function _process_order_form(Request $request)
{
@@ -106,7 +108,7 @@ private function _update_score($identifier, $score)
/**
* Handler for setting the sort order
*
* @param Request $request
* @param Request $request The request object
* @param array &$data The local request data.
*/
public function _handler_order(Request $request, array &$data)
@@ -350,6 +350,7 @@ public function finish()
* If the parsing process doesn't find any component that declares to be able to
* handle the request, an HTTP 404 - Not Found error is triggered.
*
* @param Request $request The request object
* @param midcom_core_context $context
* @return midcom_response
*/
@@ -51,6 +51,8 @@ private function load_controller()
/**
* Generic handler for all the DM2 based configuration requests
*
* @param Request $request The request object
*/
public function _handler_config(Request $request)
{
@@ -33,7 +33,8 @@ abstract class midcom_baseclasses_components_handler_configuration_recreate exte
/**
* Handler for regenerating all derived images used in the folder.
*
* @param array &$data Miscellaneous output data
* @param Request $request The request object
* @param array &$data Miscellaneous output data
*/
public function _handler_recreate(Request $request, array &$data)
{
@@ -311,7 +311,7 @@ public function set_custom_key($key, &$value, $component = null)
* The URL of the component that is used to handle the request is obtained automatically.
* If the handler hook returns false (i.e. handling failed), it will produce an error page.
*
* @param Request $request
* @param Request $request The request object
* @return midcom_response
*/
public function run(Request $request)
@@ -328,7 +328,7 @@ public function run(Request $request)
/**
* @param midcom_db_topic $topic The node that is currently being tested.
* @param Request $request
* @param Request $request The request object
* @return midcom_response
*/
public function handle(midcom_db_topic $topic, Request $request)
@@ -22,6 +22,7 @@ class midcom_helper_imagepopup_handler_list extends midcom_baseclasses_component
private $_search_results = [];
/**
* @param Request $request The request object
* @param mixed $handler_id The ID of the handler.
* @param string $filetype The file type
* @param array &$data The local request data.
@@ -20,6 +20,7 @@ class midcom_helper_search_handler_search extends midcom_baseclasses_components_
*
* It uses the handler ID to distinguish between basic and advanced search forms.
*
* @param Request $request The request object
* @param mixed $handler_id The ID of the handler.
*/
public function _handler_searchform(Request $request, $handler_id)
@@ -92,6 +93,7 @@ private function append_terms_recursive(&$final_query, $terms)
/**
* Queries the information from the index and prepares to display the result page.
*
* @param Request $request The request object
* @param array &$data The local request data.
*/
public function _handler_result(Request $request, array &$data)
@@ -42,6 +42,7 @@ public function __construct(midcom_services_auth $auth)
* system to load a login session. At the end of the successful execution of this
* function, you have to populate the $session and $user members accordingly.
*
* @param Request $request The request object
* @return boolean|array Return clientip, userid and timeout if the login session was successfully loaded, false
* otherwise.
*/
@@ -75,7 +76,7 @@ public function __construct(midcom_services_auth $auth)
/**
* Checks for a running login session.
*
* @param Request $request
* @param Request $request The request object
* @return boolean|midcom_core_user
*/
public function check_for_active_login_session(Request $request)
@@ -28,6 +28,7 @@ class midcom_services_auth_frontend_form implements midcom_services_auth_fronten
* This call checks whether the two form fields we have created are present, if yes
* it reads and returns their values.
*
* @param Request $request The request object
* @return Array A simple associative array with the two indexes 'username' and
* 'password' holding the information read by the driver or null if no
* information could be read.
@@ -135,6 +135,8 @@ public function __construct()
/**
* Checks if the current authentication fronted has new credentials
* ready. If yes, it processes the login accordingly. Otherwise look for existing session
*
* @param Request $request The request object
*/
public function check_for_login_session(Request $request)
{
@@ -308,6 +308,8 @@ private function get_strategy($name)
*
* Note, that HTTP GET is <b>not</b> checked this way, as GET requests can be
* safely distinguished by their URL.
*
* @param Request $request The request object
*/
private function _check_hit(Request $request)
{
@@ -375,6 +377,8 @@ private function _check_hit(Request $request)
/**
* Start the output cache. Call this before any output
* is made. MidCOM's startup sequence will automatically do this.
*
* @param Request $request The request object
*/
public function start_caching(Request $request)
{
@@ -612,6 +616,8 @@ public function register($guid)
* If the midcom configuration option cache_uncached is set or the corresponding runtime function
* has been called, the cache file will not be written, but the header stuff will be added like
* usual to allow for browser-side caching.
*
* @param Request $request The request object
*/
public function finish_caching(Request $request)
{
@@ -348,6 +348,7 @@ private function _get_config_from_controller()
}
/**
* @param Request $request The request object
* @param mixed $handler_id The ID of the handler.
* @param array &$data The local request data.
* @param string $component The component name
@@ -184,6 +184,7 @@ private function prepare_object($guid)
/**
* Handler for creating new attachments
*
* @param Request $request The request object
* @param string $handler_id Name of the used handler
* @param string $guid The object's GUID
* @param array &$data Data passed to the show method
@@ -228,6 +229,7 @@ public function _show_create($handler_id, array &$data)
}
/**
* @param Request $request The request object
* @param string $handler_id Name of the used handler
* @param string $guid The object's GUID
* @param string $filename The filename
@@ -296,6 +298,7 @@ public function _show_edit($handler_id, array &$data)
/**
* Handler for confirming file deleting for the requested file
*
* @param Request $request The request object
* @param string $guid The object's GUID
* @param string $filename The filename
*/
@@ -150,6 +150,7 @@ public function _show_view($handler_id, array &$data)
/**
* Object editing view
*
* @param Request $request The request object
* @param mixed $handler_id The ID of the handler.
* @param string $guid The object's GUID
* @param array &$data The local request data.
@@ -196,6 +197,7 @@ public function _show_edit($handler_id, array &$data)
/**
* Object creating view
*
* @param Request $request The request object
* @param mixed $handler_id The ID of the handler.
* @param array $args The argument list.
* @param array &$data The local request data.
@@ -361,6 +363,7 @@ private function _prepare_relocate(midcom_core_dbaobject $object, $mode = 'defau
/**
* Object display
*
* @param Request $request The request object
* @param mixed $handler_id The ID of the handler.
* @param string $guid The object's GUID
* @param array &$data The local request data.
@@ -419,6 +422,7 @@ public function _show_delete($handler_id, array &$data)
/**
* Copy handler
*
* @param Request $request The request object
* @param mixed $handler_id The ID of the handler.
* @param string $guid The object's GUID
* @param array &$data The local request data.
@@ -44,6 +44,7 @@ private function _prepare_request_data()
* Handler for folder metadata. Checks for updating permissions, initializes
* the metadata and the content topic itself. Handles also the sent form.
*
* @param Request $request The request object
* @param mixed $handler_id The ID of the handler.
* @param string $guid The object's GUID
* @param array &$data The local request data.
@@ -255,6 +255,7 @@ public function get_schema_name()
/**
* Object editing view
*
* @param Request $request The request object
* @param mixed $handler_id The ID of the handler.
* @param string $guid The object's GUID
* @param array &$data The local request data.
@@ -42,6 +42,7 @@ private function _process_request_data(array &$data)
/**
* Handle the preference request
*
* @param Request $request The request object
* @param array &$data The local request data.
* @param string $guid The person GUID
*/
@@ -115,6 +116,8 @@ public static function get_languages()
/**
* AJAX backend for saving data on the fly
*
* @param Request $request The request object
*/
public function _handler_ajax(Request $request)
{
@@ -17,6 +17,7 @@
class midgard_admin_asgard_handler_shell extends midcom_baseclasses_components_handler
{
/**
* @param Request $request The request object
* @param array &$data The local request data.
*/
public function _handler_shell(Request $request, array &$data)
@@ -111,6 +111,7 @@ private function _find_component()
/**
* Object editing view
*
* @param Request $request The request object
* @param string $type The MgdSchema type
* @param array &$data The local request data.
*/
@@ -73,6 +73,7 @@ public function _show_trash($handler_id, array &$data)
/**
* Trash view
*
* @param Request $request The request object
* @param string $type The MgdSchema type
* @param array &$data The local request data.
*/
@@ -70,6 +70,7 @@ private function _list_revised($since, $type = null, $only_mine = false)
/**
* Object editing view
*
* @param Request $request The request object
* @param array &$data The local request data.
*/
public function _handler_welcome(Request $request, array &$data)
@@ -23,6 +23,7 @@ public function _on_initialize()
}
/**
* @param Request $request The request object
* @param array &$data Data passed to the show method
*/
public function _handler_create(Request $request, array &$data)
@@ -47,6 +47,7 @@ private function _update_breadcrumb()
}
/**
* @param Request $request The request object
* @param string $handler_id Name of the used handler
* @param string $guid The object's GUID
* @param array &$data Data passed to the show method
@@ -39,6 +39,7 @@ private function _update_breadcrumb($handler_id)
/**
* Handle the moving of a group phase
*
* @param Request $request The request object
* @param mixed $handler_id The ID of the handler.
* @param string $guid The object's GUID
* @param array &$data The local request data.
@@ -45,6 +45,7 @@ private function _prepare_toolbar(&$data)
}
/**
* @param Request $request The request object
* @param array &$data Data passed to the show method
*/
public function _handler_list(Request $request, array &$data)
@@ -150,6 +151,7 @@ public function _show_list($handler_id, array &$data)
}
/**
* @param Request $request The request object
* @param string $action The requested action
* @param array &$data Data passed to the show method
*/
@@ -201,6 +203,8 @@ private function _batch_removeaccount(Request $request, midcom_db_person $person
/**
* Internal helper for processing the batch change of passwords
*
* @param Request $request The request object
*/
private function _batch_passwords(Request $request, midcom_db_person $person)
{
@@ -30,6 +30,7 @@ public function _on_initialize()
}
/**
* @param Request $request The request object
* @param string $handler_id Name of the used handler
* @param string $guid The object's GUID
* @param array &$data Data passed to the show method
@@ -107,6 +108,7 @@ private function save_account(controller $controller)
}
/**
* @param Request $request The request object
* @param string $handler_id Name of the used handler
* @param string $guid The object's GUID
* @param array &$data Data passed to the show method
@@ -23,6 +23,7 @@ public function _on_initialize()
}
/**
* @param Request $request The request object
* @param array &$data Data passed to the show method
*/
public function _handler_create(Request $request, array &$data)
@@ -52,6 +52,7 @@ private function _prepare_toolbar(&$data, $handler_id, midcom_db_person $person)
}
/**
* @param Request $request The request object
* @param string $handler_id Name of the used handler
* @param string $guid The object's GUID
* @param array &$data Data passed to the show method
Oops, something went wrong.

0 comments on commit 81f9741

Please sign in to comment.