ClientInterface.php 1015 Bytes
Newer Older
1 2 3 4 5 6 7
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

8
namespace yii\authclient;
9 10

/**
11
 * ClientInterface declares basic interface all Auth clients should follow.
12 13 14 15
 *
 * @author Paul Klimov <klimov.paul@gmail.com>
 * @since 2.0
 */
16
interface ClientInterface
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
{
	/**
	 * @param string $id service id.
	 */
	public function setId($id);

	/**
	 * @return string service id
	 */
	public function getId();

	/**
	 * @return string service name.
	 */
	public function getName();

	/**
	 * @param string $name service name.
	 */
	public function setName($name);

	/**
	 * @return string service title.
	 */
	public function getTitle();

	/**
	 * @param string $title service title.
	 */
	public function setTitle($title);

	/**
49
	 * @return array list of user attributes
50
	 */
51
	public function getUserAttributes();
52 53 54 55 56

	/**
	 * @return array view options in format: optionName => optionValue
	 */
	public function getViewOptions();
57
}