api_status.class.php 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. <?php
  2. /* Copyright (C) 2015 Jean-François Ferry <jfefe@aternatik.fr>
  3. *
  4. * This program is free software; you can redistribute it and/or modify
  5. * it under the terms of the GNU General Public License as published by
  6. * the Free Software Foundation; either version 3 of the License, or
  7. * (at your option) any later version.
  8. *
  9. * This program is distributed in the hope that it will be useful,
  10. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. * GNU General Public License for more details.
  13. *
  14. * You should have received a copy of the GNU General Public License
  15. * along with this program. If not, see <https://www.gnu.org/licenses/>.
  16. */
  17. require_once DOL_DOCUMENT_ROOT.'/api/class/api.class.php';
  18. require_once DOL_DOCUMENT_ROOT.'/core/lib/functions.lib.php';
  19. /**
  20. * API that gives the status of the Dolibarr instance.
  21. *
  22. * @access protected
  23. * @class DolibarrApiAccess {@requires user,external}
  24. */
  25. class Status extends DolibarrApi
  26. {
  27. /**
  28. * Constructor of the class
  29. */
  30. public function __construct()
  31. {
  32. global $db;
  33. $this->db = $db;
  34. }
  35. /**
  36. * Get status (Dolibarr version)
  37. *
  38. * @return array
  39. */
  40. public function index()
  41. {
  42. global $conf;
  43. return array(
  44. 'success' => array(
  45. 'code' => 200,
  46. 'dolibarr_version' => DOL_VERSION,
  47. 'access_locked' => (!getDolGlobalString('MAIN_ONLY_LOGIN_ALLOWED') ? '0' : $conf->global->MAIN_ONLY_LOGIN_ALLOWED),
  48. ),
  49. );
  50. }
  51. }