Phproberto\Joomla\Client\ClientInterface

Size/Duplication

Total Lines	51
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
	getFolder()	0	1	?
	getId()	0	1	?
	getName()	0	1	?
	isAdmin()	0	1	?
	isSite()	0	1	?

<?php

For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 18 and the first side effect is on line 11.

/**
 * Joomla! common library.
 *
 * @copyright  Copyright (C) 2017 Roberto Segura López, Inc. All rights reserved.
 * @license    GNU/GPL 2, http://www.gnu.org/licenses/gpl-2.0.htm
 */

namespace Phproberto\Joomla\Client;

defined('_JEXEC') || die;

/**
 * Describes methods required by modules.
 *
 * @since  0.0.1
 */
interface ClientInterface
{
	/**
	 * Site client identifier.
	 *
	 * @const
	 */
	const ID_SITE = 0;

	/**
	 * Administrator client identifier.
	 *
	 * @const
	 */
	const ID_ADMIN = 1;

	/**
	 * Get the base folder of this client.
	 *
	 * @return  string
	 */
	public function getFolder();

	/**
	 * Get the identifier.
	 *
	 * @return  integer
	 */
	public function getId();

	/**
	 * Get the name
	 *
	 * @return  string
	 */
	public function getName();

	/**
	 * Is this admin client?
	 *
	 * @return  boolean
	 */
	public function isAdmin();

	/**
	 * Is this site client?
	 *
	 * @return  boolean
	 */
	public function isSite();
}