File: abstract.plugins.php

package info (click to toggle)
kalkun 0.8.3.2-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 7,340 kB
  • sloc: php: 30,659; javascript: 30,443; sql: 961; sh: 766; xml: 105; makefile: 40
file content (133 lines) | stat: -rw-r--r-- 4,061 bytes parent folder | download | duplicates (2)
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
<?php
/**
 * CI3 Plugin System
 *
 * Simple plugin system for CodeIgniter v3
 *
 * This content is released under the MIT License (MIT)
 *
 * Copyright (c) 2014 - 2015, British Columbia Institute of Technology
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 * @package	CI Plugins
 * @author	Justin Hyland www.justinhyland.com
 * @license	http://opensource.org/licenses/MIT	MIT License
 * @link	https://github.com/jhyland87/CI3_Plugin_System
 * @since	Version 1.0.0
 * @filesource
 */
defined('BASEPATH') OR exit('No direct script access allowed');

/**
 * CI3 Plugin System Abstract Class
 *
 * @package		CI3 Plugin System
 * @author		Justin Hyland www.justinhyland.com
 * @link        https://github.com/jhyland87/CI3_Plugin_System
 */
abstract class CI3_plugin_system
{
    /**
     * @access protected    Must be protected so the trait can use it as well
     * @var object          Object reference to the CI Instance
     */
    protected static $CI;

    /**
     * Constructor
     *
     * Set the local static CI reference, get the name of the extending class for
     * the plugin name, and set a reference handler to the plugin in the static
     * $plugins variable in the Plugins library
     *
     * @access public
     */
    public function __construct()
    {
        self::$CI =& get_instance();

        $plugin = str_replace('_plugin', '', strtolower(get_called_class()));

        Plugins_lib::$plugins[ $plugin ][ 'handler' ] = &$this;

    }

    // ------------------------------------------------------------------------

    /**
     * Install Plugin
     *
     * Anything that needs to happen when this plugin gets installed
     *
     * @access public
     * @since   0.1.0
     * @return bool    TRUE by default
     */
    public static function install($data = NULL)
    {
        return TRUE;
    }

    // ------------------------------------------------------------------------

    /**
     * Activate Plugin
     *
     * Anything that needs to happen when this plugin gets activate
     *
     * @access public
     * @since   0.1.0
     * @return bool    TRUE by default
     */
    public function activate($data = NULL)
    {
        return TRUE;
    }

    // ------------------------------------------------------------------------

    /**
     * Deactivate Plugin
     *
     * Anything that needs to happen when this plugin gets deactivate
     *
     * @access public
     * @since   0.1.0
     * @return bool    TRUE by default
     */
    public function deactivate($data = NULL)
    {
        return TRUE;
    }

    // ------------------------------------------------------------------------

    /**
     * NOTE: Uncomment this abstract class to require controllers for plugins
     * Plugin Controller
     *
     * Main controller for plugin, handles all the output, as well as input from the output
     *
     * @access  protected
     * @since   0.1.0
     * @return  string      HTML for form
     */
    //abstract public function controller($plugin_data = array());
}