QueryParamsResolverInterface.php 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. namespace Magento\Framework\Url;
  7. /**
  8. * Resolves query parameters in a URL.
  9. *
  10. * @api
  11. * @since 100.0.2
  12. */
  13. interface QueryParamsResolverInterface
  14. {
  15. /**
  16. * Get query params part of url
  17. *
  18. * @param bool $escape "&" escape flag
  19. * @return string
  20. */
  21. public function getQuery($escape = false);
  22. /**
  23. * Set URL query param(s)
  24. *
  25. * @param mixed $data
  26. * @return \Magento\Framework\Url\QueryParamsResolverInterface
  27. */
  28. public function setQuery($data);
  29. /**
  30. * Set query param
  31. *
  32. * @param string $key
  33. * @param mixed $data
  34. * @return \Magento\Framework\Url\QueryParamsResolverInterface
  35. */
  36. public function setQueryParam($key, $data);
  37. /**
  38. * Return Query Params
  39. *
  40. * @return array
  41. */
  42. public function getQueryParams();
  43. /**
  44. * Set query parameters
  45. *
  46. * @param array $data
  47. * @return \Magento\Framework\Url\QueryParamsResolverInterface
  48. */
  49. public function setQueryParams(array $data);
  50. /**
  51. * Add query parameters
  52. *
  53. * @param array $data
  54. * @return \Magento\Framework\Url\QueryParamsResolverInterface
  55. */
  56. public function addQueryParams(array $data);
  57. /**
  58. * Unset data from the object.
  59. *
  60. * @param null|string|array $key
  61. * @return \Magento\Framework\DataObject
  62. */
  63. public function unsetData($key = null);
  64. }