Minotaur\View\EntityLinker

Size/Duplication

Total Lines	19
Duplicated Lines	0 %

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
	supports()	0	1	?
	compose()	0	1	?

<?php
declare(strict_types=1);
/**
 * Minotaur
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 *
 * @copyright 2015-2017 Appertly
 * @license   Apache-2.0
 */
namespace Minotaur\View;

/**
 * Allows the creation of `<a>` nodes that point to an entity's canonical location.
 */
interface EntityLinker
{
    /**
     * Whether this linker supports the provided entity.
     *
     * @param $entity - The entity to link
     * @return - `true` if the entity is supported

The doc-type - could not be parsed: Unknown type name "-" at position 0. (view supported doc-types)

     */
    public function supports($entity): bool;

    /**
     * Composes the link for a given entity.
     *
     * @param mixed $entity The entity to link
     * @return \Minotaur\Tags\Node The node for the entity's link
     * @throws \InvalidArgumentException if the entity isn't supported
     */
    public function compose($entity): \Minotaur\Tags\Node;
}