primo commit

libraries/vendor/psr/link/src/LinkProviderInterface.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Psr\Link;
+
+/**
+ * A link provider object.
+ */
+interface LinkProviderInterface
+{
+    /**
+     * Returns an iterable of LinkInterface objects.
+     *
+     * The iterable may be an array or any PHP \Traversable object. If no links
+     * are available, an empty array or \Traversable MUST be returned.
+     *
+     * @return LinkInterface[]|\Traversable
+     */
+    public function getLinks();
+
+    /**
+     * Returns an iterable of LinkInterface objects that have a specific relationship.
+     *
+     * The iterable may be an array or any PHP \Traversable object. If no links
+     * with that relationship are available, an empty array or \Traversable MUST be returned.
+     *
+     * @param string $rel
+     *   The relationship name for which to retrieve links.
+     *
+     * @return LinkInterface[]|\Traversable
+     */
+    public function getLinksByRel(string $rel);
+}