1
0

BxBaseReportServices.php 2.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. <?php defined('BX_DOL') or die('hack attempt');
  2. /**
  3. * Copyright (c) UNA, Inc - https://una.io
  4. * MIT License - https://opensource.org/licenses/MIT
  5. *
  6. * @defgroup UnaBaseView UNA Base Representation Classes
  7. * @{
  8. */
  9. /**
  10. * System services related to Reports.
  11. */
  12. class BxBaseReportServices extends BxDol
  13. {
  14. public function __construct()
  15. {
  16. parent::__construct();
  17. }
  18. /**
  19. * @page service Service Calls
  20. * @section bx_system_general System Services
  21. * @subsection bx_system_general-report Report
  22. * @subsubsection bx_system_general-do do
  23. *
  24. * @code bx_srv('system', 'do', [[...]], 'TemplReportServices'); @endcode
  25. * @code {{~system:do:TemplReportServices[[...]]~}} @endcode
  26. *
  27. * Performs Do (Report) action
  28. * @param $aParams an array with necessary parameters
  29. *
  30. * @see BxBaseReportServices::serviceDo
  31. */
  32. /**
  33. * @ref bx_system_general-do "do"
  34. * @api @ref bx_system_general-do "do"
  35. */
  36. public function serviceDo($aParams)
  37. {
  38. if(is_string($aParams))
  39. $aParams = json_decode($aParams, true);
  40. if(!$aParams['s'] || !$aParams['o'])
  41. return ['code' => BX_DOL_OBJECT_ERR_NOT_AVAILABLE];
  42. $oReport = BxDolReport::getObjectInstance($aParams['s'], $aParams['o']);
  43. if(!$oReport || !$oReport->isEnabled())
  44. return ['code' => BX_DOL_OBJECT_ERR_NOT_AVAILABLE];
  45. $aResult = $oReport->report(array_diff_key($aParams, array_flip(['s', 'o'])));
  46. return (int)$aResult['code'] != 0 ? $aResult : $aResult['api'];
  47. }
  48. /**
  49. * @page service Service Calls
  50. * @section bx_system_general System Services
  51. * @subsection bx_system_general-report Report
  52. * @subsubsection bx_system_general-get_performed_by get_performed_by
  53. *
  54. * @code bx_srv('system', 'get_performed_by', [[...]], 'TemplReportServices'); @endcode
  55. * @code {{~system:get_performed_by:TemplReportServices[[...]]~}} @endcode
  56. *
  57. * Gets a list of PerformedBy users.
  58. * @param $aParams an array with necessary parameters
  59. *
  60. * @see BxBaseReportServices::serviceGetPerformedBy
  61. */
  62. /**
  63. * @ref bx_system_general-get_performed_by "get_performed_by"
  64. * @api @ref bx_system_general-get_performed_by "get_performed_by"
  65. */
  66. public function serviceGetPerformedBy($aParams)
  67. {
  68. if(is_string($aParams))
  69. $aParams = json_decode($aParams, true);
  70. if(!$aParams['s'] || !$aParams['o'])
  71. return ['code' => BX_DOL_OBJECT_ERR_NOT_AVAILABLE];
  72. $oReport = BxDolReport::getObjectInstance($aParams['s'], $aParams['o']);
  73. if(!$oReport || !$oReport->isEnabled())
  74. return ['code' => BX_DOL_OBJECT_ERR_NOT_AVAILABLE];
  75. return $oReport->getPerformedByAPI($aParams);
  76. }
  77. }
  78. /** @} */