VisibilityConditionInterface.php 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. namespace Magento\Framework\View\Layout\Condition;
  7. /**
  8. * Class VisibilityConditionInterface
  9. *
  10. * Introduces family of visibility conditions for layout elements.
  11. * By using this interface a developer can specify dynamic rule for ui component visibility.
  12. *
  13. * Condition can be used by ui component declaration in layout
  14. *
  15. * <uiComponent name="form">
  16. * <visibilityCondition name='can_show_awesome_element'>
  17. * <arguments>
  18. * <argument name="aclResource" xsi:type="string">Magento_Framework::awesome_page</argument>
  19. * <argument name="extraData" xsi:type="array"></argument>
  20. * <arguments>
  21. * </visibilityCondition>
  22. * </uiComponent>
  23. *
  24. * "visibilityCondition" just another optional child element of ui component declaration
  25. */
  26. interface VisibilityConditionInterface
  27. {
  28. /**
  29. * Validate logical condition for ui component
  30. * If validation passed block will be displayed
  31. *
  32. * @param array $arguments Attributes from element node.
  33. *
  34. * @return bool
  35. */
  36. public function isVisible(array $arguments);
  37. /**
  38. * @return string
  39. */
  40. public function getName();
  41. }