BxBaseServiceCategory.php 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  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. * Services for category objects functionality - @see BxDolCategory
  11. */
  12. class BxBaseServiceCategory extends BxDol
  13. {
  14. /**
  15. * @page service Service Calls
  16. * @section bx_system_general System Services
  17. * @subsection bx_system_general-categories Categories
  18. * @subsubsection bx_system_general-categories_list categories_list
  19. *
  20. * @code bx_srv('system', 'categories_list', ["bx_posts_cats", ["show_empty_categories" => true]], 'TemplServiceCategory'); @endcode
  21. * @code {{~system:categories_list:TemplServiceCategory["bx_posts_cats", {"show_empty_categories":true}]~}} @endcode
  22. *
  23. * Get categories list.
  24. * @param $sObject categories object name
  25. * @param $aParams additional params:
  26. * - show_empty
  27. * - show_empty_categories
  28. *
  29. * @see BxBaseServiceCategory::serviceCategoriesList
  30. */
  31. /**
  32. * @ref bx_system_general-categories_list "categories_list"
  33. */
  34. public function serviceCategoriesList ($sObject, $aParams = array())
  35. {
  36. $bShowEmpty = isset($aParams['show_empty']) ? (bool)$aParams['show_empty'] : false;
  37. $bShowEmptyCategories = isset($aParams['show_empty_categories']) ? (bool)$aParams['show_empty_categories'] : false;
  38. if (!($o = BxDolCategory::getObjectInstance($sObject)))
  39. return $bShowEmpty ? MsgBox(_t('_Empty')) : '';
  40. $sResult = $o->getCategoriesList($bShowEmptyCategories);
  41. if(empty($sResult))
  42. return $bShowEmpty ? MsgBox(_t('_Empty')) : '';
  43. return $sResult;
  44. }
  45. }
  46. /** @} */