File: _class_plug.php

package info (click to toggle)
b2evolution 0.9.2-3
  • links: PTS
  • area: main
  • in suites: etch-m68k
  • size: 12,976 kB
  • ctags: 5,460
  • sloc: php: 58,989; sh: 298; makefile: 36
file content (154 lines) | stat: -rw-r--r-- 3,045 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
145
146
147
148
149
150
151
152
153
154
<?php
/**
 * This file implements the Plug class (EXPERIMENTAL)
 *
 * This is where you can plug-in some plug-ins :)
 * 
 * b2evolution - {@link http://b2evolution.net/}
 * Released under GNU GPL License - {@link http://b2evolution.net/about/license.html}
 * @copyright (c)2003-2005 by Francois PLANQUE - {@link http://fplanque.net/}
 *
 * @package evocore
 */
if( !defined('DB_USER') ) die( 'Please, do not access this page directly.' );

/**
 * Includes:
 */
require_once dirname(__FILE__)."/$core_dirout/$plugins_subdir/plugin.class.php";

/**
 * Plug Class
 *
 * @package evocore
 */
class Plug
{
	/**#@+
	 * @access private
	 */

	var $collection;

	/**
	 * Array of loaded plug-ins:
	 */
	var $Plugins = array();
	var $index_Plugins = array();

	/**
	 * Path to plug-ins:
	 */
	var $plugins_path;

	/**
	 * Has the plug initialized? (plugins loaded?)
	 */
	var $initialized = false;
	
	/**
	 * Current object idx in array:
	 */
	var $current_idx = 0;
	
	/**#@-*/
	
	/* 
	 * Constructor
	 *
	 * {@internal Plug::Plug(-)}}
	 *
	 * @param string collection = name of plugins subdir
	 */
	function Plug( $collection )
	{
		global $core_dirout, $plugins_subdir;
		
		$this->collection = $collection;
		// Set plugin path for this collection:
		$this->plugins_path = dirname(__FILE__).'/'.$core_dirout.'/'.$plugins_subdir.'/'.$collection.'s';
		 
	}	

	/* 
	 * Initialize Plug if it has not been done before.
	 *
	 * Load the plugins.
	 *
	 * {@internal Plug::init(-)}}
	 */
	function init( )
	{
		if( ! $this->initialized )
		{
			// Go through directory:
			$this_dir = dir( $this->plugins_path );
			while( $this_file = $this_dir->read())
			{
				if( preg_match( '/^_.+\.'.$this->collection.'\.php$/', $this_file ) && is_file( $this->plugins_path. '/'. $this_file ) )
				{	// Valid plugin file name:
					// echo 'Loading ', $this_file, '...<br />';
					// Load the plugin:
					require $this->plugins_path. '/'. $this_file;
				}
			}
		
			// Sort array by priority:
			usort( $this->Plugins, 'sort_Plugin' );
		
			$this->initialized = true;
		}
	}

	/* 
	 * Register a plugin.
	 *
	 * Will be called by plugin includes when they are called by init()
	 *
	 * {@internal Plug::register(-)}}
	 *
	 * @access private
	 */
	function register( & $Plugin )
	{
		$this->Plugins[] = & $Plugin;
		$this->index_Plugins[ $Plugin->code ] = & $Plugin;
	}
	
		
	/* 
	 * Get next plugin in list:
	 *
	 * {@internal Plug::get_next(-)}}
	 *
	 * @return Plugin (false if no more plugin).
	 */
	function get_next()
	{
		$this->init();	// Init if not done yet.

		if( $this->current_idx >= count( $this->Plugins ) )
		{
			return false;
		}
		
		return $this->Plugins[ $this->current_idx++ ];
	}

	/**
	 * Rewind iterator
	 *
	 * {@internal Plug::restart(-) }}
	 */
	function restart()
	{
		$this->current_idx = 0;
	}
	
}

function sort_Plugin( & $a, & $b )
{
	return $a->priority - $b->priority;
}
?>