EntityLinker::supports() - Code Metrics - appertly/minotaur - Measure and Improve Code Quality continuously with Scrutinizer

EntityLinker::supports()
last analyzed 2018-02-14 18:59 UTC

↳ Parent: EntityLinker

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	1
c	0
b	0
f	0

<?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

     */
    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;
}


1			<?php
2			declare(strict_types=1);
3			/**
4			* Minotaur
5			*
6			* Licensed under the Apache License, Version 2.0 (the "License"); you may not
7			* use this file except in compliance with the License. You may obtain a copy of
8			* the License at
9			*
10			* http://www.apache.org/licenses/LICENSE-2.0
11			*
12			* Unless required by applicable law or agreed to in writing, software
13			* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14			* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
15			* License for the specific language governing permissions and limitations under
16			* the License.
17			*
18			* @copyright 2015-2017 Appertly
19			* @license Apache-2.0
20			*/
21			namespace Minotaur\View;
22
23			/**
24			* Allows the creation of `<a>` nodes that point to an entity's canonical location.
25			*/
26			interface EntityLinker
27			{
28			/**
29			* Whether this linker supports the provided entity.
30			*
31			* @param $entity - The entity to link
32			* @return - `true` if the entity is supported
			0 ignored issues – show Documentation introduced 2017-02-10 15:08 UTC by Report Bug Copy Issue Report The doc-type `-` could not be parsed: Unknown type name "-" at position 0. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
33			*/
34			public function supports($entity): bool;
35
36			/**
37			* Composes the link for a given entity.
38			*
39			* @param mixed $entity The entity to link
40			* @return \Minotaur\Tags\Node The node for the entity's link
41			* @throws \InvalidArgumentException if the entity isn't supported
42			*/
43			public function compose($entity): \Minotaur\Tags\Node;
44			}
45

appertly / minotaur

EntityLinker::supports() last analyzed 2018-02-14 18:59 UTC

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

EntityLinker::supports()
last analyzed 2018-02-14 18:59 UTC