File: trait.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 (144 lines) | stat: -rw-r--r-- 4,769 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
134
135
136
137
138
139
140
141
142
143
144
<?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 Trait
 *
 * @package		CI3 Plugin System
 * @author		Justin Hyland www.justinhyland.com
 * @link        https://github.com/jhyland87/CI3_Plugin_System
 */
trait plugin_trait {

    /**
     * Fetch an item from the GET array
     *
     * Shortcut to Loader::get()
     *
     * @param	mixed	    $index		Index for item to be fetched from $_GET
     * @param	bool	    $xss_clean	Whether to apply XSS filtering
     * @access  protected
     * @since   0.1.0
     * @return	mixed
     */
    protected function get($index = NULL, $xss_clean = NULL)
    {
        return parent::$CI->input->get($index, $xss_clean);
    }

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

    /**
     * Fetch an item from the POST array
     *
     * Shortcut to Loader::post()
     *
     * @param	mixed	    $index		Index for item to be fetched from $_POST
     * @param	bool	    $xss_clean	Whether to apply XSS filtering
     * @access  protected
     * @since   0.1.0
     * @return	mixed
     */
    protected function post($index = NULL, $xss_clean = NULL)
    {
        return parent::$CI->input->post($index, $xss_clean);
    }

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

    /**
     * Fetch an item from POST data with fallback to GET
     *
     * Shortcut to Loader::post_get()
     *
     * @param	string	    $index		Index for item to be fetched from $_POST or $_GET
     * @param	bool	    $xss_clean	Whether to apply XSS filtering
     * @access  protected
     * @since   0.1.0
     * @return	mixed
     */
    protected function post_get($index, $xss_clean = NULL)
    {
        return parent::$CI->input->post_get($index, $xss_clean);
    }

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

    /**
     * Fetch an item from GET data with fallback to POST
     *
     * Shortcut to Loader::get_post()
     *
     * @param	string	    $index		Index for item to be fetched from $_GET or $_POST
     * @param	bool	    $xss_clean	Whether to apply XSS filtering
     * @access  protected
     * @since   0.1.0
     * @return	mixed
     */
    protected function get_post($index, $xss_clean = NULL)
    {
        return parent::$CI->input->get_post($index, $xss_clean);
    }

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

    /**
     * Plugin View
     *
     * Load a plugin view via Loader::plugin_view()
     *
     * @param   str         $view       Plugin view to load, must exist in the /views/ folder of the plugins root directory
     * @param   array       $data       Data to load into view.
     * @access  protected
     * @since   0.1.0
     * @return  str         String value of processed view
     */
    protected function view($view, array $data = array())
    {
        $backtrace = debug_backtrace();

        if( ! isset($backtrace[1]['class']))
        {
            return FALSE;
        }

        // The strtolower version of the class name should be the plugin folder name
        $class = strtolower($backtrace[1]['class']);

        return parent::$CI->load->plugin_view($class, $view, $data, TRUE);
    }
}