ConfigInterface.php 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. namespace Magento\Framework\Mail\Template;
  7. /**
  8. * High-level interface for mail templates data that hides format from the client code
  9. *
  10. * @api
  11. * @since 100.0.2
  12. */
  13. interface ConfigInterface
  14. {
  15. /**
  16. * Retrieve unique identifiers of all available email templates
  17. *
  18. * @return string[]
  19. */
  20. public function getAvailableTemplates();
  21. /**
  22. * Retrieve translated label of an email template
  23. *
  24. * @param string $templateId
  25. * @return string
  26. */
  27. public function getTemplateLabel($templateId);
  28. /**
  29. * Retrieve type of an email template
  30. *
  31. * @param string $templateId
  32. * @return string
  33. */
  34. public function getTemplateType($templateId);
  35. /**
  36. * Retrieve fully-qualified name of a module an email template belongs to
  37. *
  38. * @param string $templateId
  39. * @return string
  40. */
  41. public function getTemplateModule($templateId);
  42. /**
  43. * Retrieve the area an email template belongs to
  44. *
  45. * @param string $templateId
  46. * @return string
  47. */
  48. public function getTemplateArea($templateId);
  49. /**
  50. * Retrieve full path to an email template file
  51. *
  52. * @param string $templateId
  53. * @param array|null $designParams
  54. * @return string
  55. */
  56. public function getTemplateFilename($templateId, $designParams = []);
  57. }