MediaInterface.php 665 B

1234567891011121314151617181920212223242526272829
  1. <?php
  2. namespace Grav\Common\Media\Interfaces;
  3. /**
  4. * Class implements media interface.
  5. */
  6. interface MediaInterface
  7. {
  8. /**
  9. * Gets the associated media collection.
  10. *
  11. * @return MediaCollectionInterface Collection of associated media.
  12. */
  13. public function getMedia();
  14. /**
  15. * Get filesystem path to the associated media.
  16. *
  17. * @return string|null Media path or null if the object doesn't have media folder.
  18. */
  19. public function getMediaFolder();
  20. /**
  21. * Get display order for the associated media.
  22. *
  23. * @return array Empty array means default ordering.
  24. */
  25. public function getMediaOrder();
  26. }