Skip to content
Browse files

-Removed $Id from the comments

-Removed unnecessary languages from PluginExample/lang/Makefile
-Refactored some comments
-Made some changes in the function add_plugin in the PluginManager
-Removed some whitespaces
-Comment added in plugins/PluginExample/lang/convert.awk saying that file was copied from lang/convert.awk
  • Loading branch information...
1 parent 57e0917 commit 4f185866156fbdf959ee432f949be930ad59a4e4 @leonardosapiras committed
View
18 classes/plugins/PluginManager.php
@@ -2,8 +2,6 @@
/**
* A class that implements the plugin's system
- *
- * $Id:
*/
class PluginManager {
@@ -15,16 +13,20 @@ class PluginManager {
public $functions_list = array();
/**
- * Add a plugin in the manager
- * @param $plugin
+ * Add a plugin in the list of plugins to manage
+ * @param $plugin - Instance from plugin
*/
function add_plugin($plugin) {
- $this->plugins_list[$plugin->get_plugin_index()] = $plugin;
+ //The plugin index is the identification of the plugin.
+ //Example: PluginExample is the identification for PluginExample
+ //It will be used to get a specific plugin from the plugins_list.
+ $plugin_index = $plugin->get_plugin_index();
+ $this->plugins_list[$plugin_index] = $plugin;
}
/**
- * Get a plugin from the $plugins_list by the plugin's name.
- * @param $plugin_index
+ * Get a plugin from the $plugins_list by the plugin's identification.
+ * @param $plugin_index - plugin identification. Exemple: PluginExample.
*/
function get_plugin($plugin_index) {
return $this->plugins_list[$plugin_index];
@@ -53,7 +55,7 @@ function execute_plugin_funtions($when, &$function_args) {
foreach ($this->functions_list[$when] as $node) {
$plugin_index = $node['plugin_index'];
$function = $node['function'];
- $plugin = $this->get_plugin($plugin_index);
+ $plugin = $this->get_plugin($plugin_index);
//
if (method_exists($plugin, $function)) {
call_user_func_array(array($plugin, $function), array(&$function_args));
View
219 plugins/PluginExample/lang/Makefile
@@ -1,4 +1,4 @@
-# This Makefile recodes source lang files into XML Unicode.
+# This Makefile is a copy of lang/Makefile, it recodes source lang files into XML Unicode.
# You should add your encodings to this file. You need to have GNU Recode
# installed.
#
@@ -9,52 +9,10 @@
# - remove all text after last ?>
# - convert "'" -> "'"
# using 'convert.awk'
-#
-# Modifications by Dave Smith, 2003-11-10:
-# Added TARGETS variable for easy listing of all lang files.
-# Added 'prepare' target to check that 'recode' is installed.
-# Added 'clean' target to nuke recoded files.
-# Surpressed verbose command line dumpage with '@'.
-# Added dependency checking for incremental recoding.
-# Added pretty "Recoding ..." messages.
-# Added 'chmod 644' to 'all' target for correct file permissions.
-# Modifications by Rafal Slubowski, 2003-12-12:
-# All conversions of recoded text moved to convert.awk script
-#
-# $Id: Makefile,v 1.48 2007/02/10 03:48:35 xzilla Exp $
DESTDIR=./recoded
-TARGETS=polish \
- english \
- chinese-sim \
- chinese-tr \
- chinese-utf8-zh_TW \
- chinese-utf8-zh_CN \
- danish \
- dutch \
- german \
- spanish \
- italian \
- french \
- russian \
- russian-utf8 \
- japanese \
- slovak \
- turkish \
- czech \
+TARGETS=english \
portuguese-br \
- portuguese-pt \
- swedish \
- afrikaans \
- arabic \
- mongol \
- ukrainian \
- hungarian \
- hebrew \
- catalan \
- romanian \
- greek \
- galician
all: prepare ${TARGETS}
@for p in ${TARGETS} ; do chmod 644 ${DESTDIR}/$$p.php ; done
@@ -71,187 +29,14 @@ clean:
@echo "Nuking recoded lang files..."
@for p in ${TARGETS} ; do rm -fv ${DESTDIR}/$$p.php ; done
-catalan: catalan.php
- @echo "Recoding catalan..."
- @cat catalan.php | recode utf-8..xml | ./convert.awk \
- > ${DESTDIR}/catalan.php
- @chmod 644 catalan.php ${DESTDIR}/catalan.php
-
-polish: polish.php
- @echo "Recoding polish..."
- @cat polish.php | recode utf-8..xml | ./convert.awk \
- > ${DESTDIR}/polish.php
- @chmod 644 polish.php ${DESTDIR}/polish.php
-
english: english.php
@echo "Recoding english..."
@cat english.php | recode latin1..xml | ./convert.awk \
> ${DESTDIR}/english.php
@chmod 644 english.php ${DESTDIR}/english.php
-dutch: dutch.php
- @echo "Recoding dutch..."
- @cat dutch.php | recode latin1..xml | ./convert.awk \
- > ${DESTDIR}/dutch.php
- @chmod 644 dutch.php ${DESTDIR}/dutch.php
-
-danish: danish.php
- @echo "Recoding danish..."
- @cat danish.php | recode latin1..xml | ./convert.awk \
- > ${DESTDIR}/danish.php
- @chmod 644 danish.php ${DESTDIR}/danish.php
-
-german: german.php
- @echo "Recoding german..."
- @cat german.php | recode utf-8..xml | ./convert.awk \
- > ${DESTDIR}/german.php
- @chmod 644 german.php ${DESTDIR}/german.php
-
-spanish: spanish.php
- @echo "Recoding spanish..."
- @cat spanish.php | recode iso-8859-1..xml | ./convert.awk \
- > ${DESTDIR}/spanish.php
- @chmod 644 spanish.php ${DESTDIR}/spanish.php
-
-italian: italian.php
- @echo "Recoding italian..."
- @cat italian.php | recode iso-8859-1..xml | ./convert.awk \
- > ${DESTDIR}/italian.php
- @chmod 644 italian.php ${DESTDIR}/italian.php
-
-chinese-sim: chinese-sim.php
- @echo "Recoding chinese-sim..."
- @cat chinese-sim.php | recode gb2312..xml | ./convert.awk \
- > ${DESTDIR}/chinese-sim.php
- @chmod 644 chinese-sim.php ${DESTDIR}/chinese-sim.php
-
-chinese-tr: chinese-tr.php
- @echo "Recoding chinese-tr..."
- @cat chinese-tr.php | recode big5..xml | ./convert.awk \
- > ${DESTDIR}/chinese-tr.php
- @chmod 644 chinese-tr.php ${DESTDIR}/chinese-tr.php
-
-chinese-utf8-zh_CN: chinese-utf8-zh_CN.php
- @echo "Recoding chinese-utf8-zh_CN..."
- @cat chinese-utf8-zh_CN.php | recode utf-8..xml | ./convert.awk \
- > ${DESTDIR}/chinese-utf8-zh_CN.php
- @chmod 644 chinese-utf8-zh_CN.php ${DESTDIR}/chinese-utf8-zh_CN.php
-
-chinese-utf8-zh_TW: chinese-utf8-zh_TW.php
- @echo "Recoding chinese-utf8-zh_TW..."
- @cat chinese-utf8-zh_TW.php | recode utf-8..xml | ./convert.awk \
- > ${DESTDIR}/chinese-utf8-zh_TW.php
- @chmod 644 chinese-utf8-zh_TW.php ${DESTDIR}/chinese-utf8-zh_TW.php
-
-french: french.php
- @echo "Recoding french..."
- @cat french.php | recode latin1..xml | ./convert.awk \
- > ${DESTDIR}/french.php
- @chmod 644 french.php ${DESTDIR}/french.php
-
-japanese: japanese.php
- @echo "Recoding japanese..."
- @cat japanese.php | recode euc-jp..xml | ./convert.awk \
- > ${DESTDIR}/japanese.php
- @chmod 644 japanese.php ${DESTDIR}/japanese.php
-
-russian: russian.php
- @echo "Recoding russian..."
- @cat russian.php | recode koi8..xml | ./convert.awk \
- > ${DESTDIR}/russian.php
- @chmod 644 russian.php ${DESTDIR}/russian.php
-russian-utf8: russian-utf8.php
- @echo "Recoding russian-utf8..."
- @cat russian-utf8.php | recode utf-8..xml | ./convert.awk \
- > ${DESTDIR}/russian-utf8.php
- @chmod 644 russian-utf8.php ${DESTDIR}/russian-utf8.php
-
-slovak: slovak.php
- @echo "Recoding slovak..."
- @cat slovak.php | recode utf-8..xml | ./convert.awk \
- > ${DESTDIR}/slovak.php
- @chmod 644 slovak.php ${DESTDIR}/slovak.php
-
-czech: czech.php
- @echo "Recoding czech..."
- @cat czech.php | recode utf-8..xml | ./convert.awk \
- > ${DESTDIR}/czech.php
- @chmod 644 czech.php ${DESTDIR}/czech.php
-
-turkish: turkish.php
- @echo "Recoding turkish..."
- @cat turkish.php | recode iso-8859-9..xml | ./convert.awk \
- > ${DESTDIR}/turkish.php
- @chmod 644 turkish.php ${DESTDIR}/turkish.php
-
portuguese-br: portuguese-br.php
@echo "Recoding portuguese-br..."
@cat portuguese-br.php | recode iso-8859-1..xml | ./convert.awk \
> ${DESTDIR}/portuguese-br.php
@chmod 644 portuguese-br.php ${DESTDIR}/portuguese-br.php
-
-portuguese-pt: portuguese-pt.php
- @echo "Recoding portuguese-pt..."
- @cat portuguese-pt.php | recode iso-8859-15..xml | ./convert.awk \
- > ${DESTDIR}/portuguese-pt.php
- @chmod 644 portuguese-pt.php ${DESTDIR}/portuguese-pt.php
-
-swedish: swedish.php
- @echo "Recoding swedish..."
- @cat swedish.php | recode iso-8859-1..xml | ./convert.awk \
- > ${DESTDIR}/swedish.php
- @chmod 644 swedish.php ${DESTDIR}/swedish.php
-
-afrikaans: afrikaans.php
- @echo "Recoding afrikaans..."
- @cat afrikaans.php | recode iso-8859-1..xml | ./convert.awk \
- > ${DESTDIR}/afrikaans.php
- @chmod 644 afrikaans.php ${DESTDIR}/afrikaans.php
-
-hungarian: hungarian.php
- @echo "Recoding hungarian..."
- @cat hungarian.php | recode utf-8..xml | ./convert.awk \
- > ${DESTDIR}/hungarian.php
- @chmod 644 hungarian.php ${DESTDIR}/hungarian.php
-
-arabic: arabic.php
- @echo "Recoding arabic..."
- @cat arabic.php | recode utf-8..xml | ./convert.awk \
- > ${DESTDIR}/arabic.php
- @chmod 644 arabic.php ${DESTDIR}/arabic.php
-
-mongol: mongol.php
- @echo "Recoding mongol..."
- @cat mongol.php | recode iso-8859-5..xml | ./convert.awk \
- > ${DESTDIR}/mongol.php
- @chmod 644 mongol.php ${DESTDIR}/mongol.php
-
-ukrainian: ukrainian.php
- @echo "Recoding ukrainian..."
- @cat ukrainian.php | recode koi8-r..xml | ./convert.awk \
- > ${DESTDIR}/ukrainian.php
- @chmod 644 ukrainian.php ${DESTDIR}/ukrainian.php
-
-hebrew: hebrew.php
- @echo "Recoding hebrew..."
- @cat hebrew.php | recode utf-8..xml | ./convert.awk \
- > ${DESTDIR}/hebrew.php
- @chmod 644 hebrew.php ${DESTDIR}/hebrew.php
-
-romanian: romanian.php
- @echo "Recoding romanian..."
- @cat romanian.php | recode utf-8..xml | ./convert.awk \
- > ${DESTDIR}/romanian.php
- @chmod 644 romanian.php ${DESTDIR}/romanian.php
-
-greek: greek.php
- @echo "Recoding greek..."
- @cat greek.php | recode iso-8859-7..xml | ./convert.awk \
- > ${DESTDIR}/greek.php
- @chmod 644 greek.php ${DESTDIR}/greek.php
-
-galician: galician.php
- @echo "Recoding galician..."
- @cat galician.php | recode utf-8..xml | ./convert.awk \
- > ${DESTDIR}/galician.php
- @chmod 644 galician.php ${DESTDIR}/galician.php
View
1 plugins/PluginExample/lang/convert.awk
@@ -1,6 +1,7 @@
#!/usr/bin/awk -f
#
# Script contains all needed conversions of recoded text
+# This script is a copy of lang/convert.awk
#
# Remove everything before first "<?php"
BEGIN { while (index($0,"&lt;?php")==0) { getline; continue }
View
2 plugins/PluginExample/lang/english.php
@@ -3,8 +3,6 @@
/**
* English language file for plugin Example. Use this as a basis
* for new translations.
- *
- * $Id:
*/
//Plugin data
View
2 plugins/PluginExample/lang/portuguese-br.php
@@ -3,8 +3,6 @@
/**
* Brazilian Portuguese language file for plugin Example. Use this as a basis
* for new translations.
- *
- * $Id:
*/
//Plugin data
View
4 plugins/PluginExample/lang/recoded/english.php
@@ -3,12 +3,10 @@
/**
* English language file for plugin Example. Use this as a basis
* for new translations.
- *
- * $Id:
*/
//Plugin data
- $plugin_lang['plugin_name'] = 'PluginExample';
+ $plugin_lang['plugin_name'] = 'Plugin Example';
//Test
$plugin_lang['plugin_toplink'] = 'Example extra toplink';
View
2 plugins/PluginExample/lang/recoded/portuguese-br.php
@@ -3,8 +3,6 @@
/**
* Brazilian Portuguese language file for plugin Example. Use this as a basis
* for new translations.
- *
- * $Id:
*/
//Plugin data
View
2 plugins/PluginExample/lang/translations.php
@@ -1,8 +1,6 @@
<?php
/**
* Supported Translations for PluginExample
- *
- * $Id:
*/
View
4 plugins/PluginExample/plugin.php
@@ -6,7 +6,7 @@ class PluginExample {
*/
public $plugin_name = 'Plugin example';
public $plugin_index = __CLASS__;
- public $plugin_lang = '';
+ public $plugin_lang;
/**
* Constructor
@@ -22,7 +22,7 @@ function __construct($plugin_manager, $language) {
}
/**
- * Get the $plugin_index
+ * Get the plugin identification
* @return $plugin_index
*/
function get_plugin_index() {

0 comments on commit 4f18586

Please sign in to comment.
Something went wrong with that request. Please try again.