Application/ApplicationInterface.php at master · CommonApi/Application · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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
49
<?php
/**
 * Application Interface
 *
 * @package    Controller
 * @copyright  2014 Amy Stephen. All rights reserved.
 * @license    http://www.opensource.org/licenses/mit-license.html MIT License
 */
namespace CommonApi\Application;

use stdClass;

/**
 * Application Interface
 *
 * @package    Controller
 * @license    http://www.opensource.org/licenses/mit-license.html MIT License
 * @copyright  2014 Amy Stephen. All rights reserved.
 * @since      1.0
 */
interface ApplicationInterface
{
    /**
     * Using Request, Identify and Set the Application
     *
     * @return  $this
     * @since   1.0.0
     */
    public function setApplication();

    /**
     * Retrieve Application Configuration Data
     *
     * @return  stdClass
     * @since   1.0.0
     */
    public function getConfiguration();

    /**
     * Check if the Site has permission to utilise this Application
     *
     * @param   integer  $site_id
     *
     * @return  $this
     * @since   1.0.0
     * @throws  \CommonApi\Exception\RuntimeException
     */
    public function verifySiteApplication($site_id);
}