api_status.class.php 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  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.'/core/lib/functions.lib.php';
  18. /**
  19. * API that gives the status of the Dolibarr instance.
  20. *
  21. * @access protected
  22. * @class DolibarrApiAccess {@requires user,external}
  23. */
  24. class Status
  25. {
  26. /**
  27. * Get status (Dolibarr version)
  28. *
  29. * @return array
  30. */
  31. public function index()
  32. {
  33. global $conf;
  34. return array(
  35. 'success' => array(
  36. 'code' => 200,
  37. 'dolibarr_version' => DOL_VERSION,
  38. 'access_locked' => (empty($conf->global->MAIN_ONLY_LOGIN_ALLOWED) ? '0' : $conf->global->MAIN_ONLY_LOGIN_ALLOWED),
  39. ),
  40. );
  41. }
  42. }