1 | <?php |
||
0 ignored issues
–
show
|
|||
2 | /* |
||
3 | Plugin Name: Piwigo to MediaWiki |
||
4 | Version: 0.1.0 |
||
5 | Description: A Piwigo plugin for exporting photos to MediaWiki wikis. |
||
6 | Plugin URI: auto |
||
7 | Author: Sam Wilson |
||
8 | Author URI: https://samwilson.id.au |
||
9 | */ |
||
10 | |||
11 | // Make sure we're already in Piwigo. |
||
12 | defined('PHPWG_ROOT_PATH') or exit(1); |
||
13 | |||
14 | // Define plugin's paths etc. |
||
15 | define('PIWIGO2MEDIAWIKI_ID', 'piwigo2mediawiki'); |
||
16 | define('PIWIGO2MEDIAWIKI_PATH', PHPWG_PLUGINS_PATH.PIWIGO2MEDIAWIKI_ID.'/'); |
||
17 | define('PIWIGO2MEDIAWIKI_PAGE', 'plugin-'.PIWIGO2MEDIAWIKI_ID); |
||
18 | define( |
||
19 | 'PIWIGO2MEDIAWIKI_ADMIN', |
||
20 | get_absolute_root_url().'admin.php?page=plugin-'.PIWIGO2MEDIAWIKI_ID |
||
21 | ); |
||
22 | define( |
||
23 | 'PIWIGO2MEDIAWIKI_DIR', |
||
24 | realpath(PHPWG_PLUGINS_PATH.PIWIGO2MEDIAWIKI_ID).'/' |
||
25 | ); |
||
26 | |||
27 | // Complain if our plugin directory is not named correctly. |
||
28 | if (basename(dirname(__FILE__)) != PIWIGO2MEDIAWIKI_ID) { |
||
29 | add_event_handler('init', function () { |
||
30 | global $page; |
||
0 ignored issues
–
show
Compatibility
Best Practice
introduced
by
Use of
global functionality is not recommended; it makes your code harder to test, and less reusable.
Instead of relying on 1. Pass all data via parametersfunction myFunction($a, $b) {
// Do something
}
2. Create a class that maintains your stateclass MyClass {
private $a;
private $b;
public function __construct($a, $b) {
$this->a = $a;
$this->b = $b;
}
public function myFunction() {
// Do something
}
}
![]() |
|||
31 | $page['errors'][] = l10n( |
||
32 | 'Plugin folder name is incorrect, please rename %s to %s', |
||
33 | basename(dirname(__FILE__)), |
||
34 | PIWIGO2MEDIAWIKI_ID |
||
35 | ); |
||
36 | }); |
||
37 | return; |
||
38 | } |
||
39 | |||
40 | //Initialise the plugin. |
||
41 | add_event_handler('init', function(){ |
||
42 | global $conf; |
||
0 ignored issues
–
show
Compatibility
Best Practice
introduced
by
Use of
global functionality is not recommended; it makes your code harder to test, and less reusable.
Instead of relying on 1. Pass all data via parametersfunction myFunction($a, $b) {
// Do something
}
2. Create a class that maintains your stateclass MyClass {
private $a;
private $b;
public function __construct($a, $b) {
$this->a = $a;
$this->b = $b;
}
public function myFunction() {
// Do something
}
}
![]() |
|||
43 | load_language('plugin.lang', PIWIGO2MEDIAWIKI_PATH); |
||
44 | if (isset($conf['piwigo2mediawiki'])) { |
||
45 | $conf['piwigo2mediawiki'] = safe_unserialize($conf['piwigo2mediawiki']); |
||
46 | } |
||
47 | }); |
||
48 | |||
49 | // Add event handlers. |
||
50 | if (defined('IN_ADMIN')) { |
||
51 | |||
52 | // Add the admin menu item. |
||
53 | add_event_handler('get_admin_plugin_menu_links', function($menu) { |
||
54 | $menu[] = array( |
||
55 | 'NAME' => l10n('Piwigo to MediaWiki'), |
||
56 | 'URL' => PIWIGO2MEDIAWIKI_ADMIN, |
||
57 | ); |
||
58 | return $menu; |
||
59 | }); |
||
60 | |||
61 | // Add the send-to-MediaWiki global action. |
||
62 | add_event_handler('loc_end_element_set_global', |
||
63 | function () { |
||
64 | global $template, $conf; |
||
0 ignored issues
–
show
Compatibility
Best Practice
introduced
by
Use of
global functionality is not recommended; it makes your code harder to test, and less reusable.
Instead of relying on 1. Pass all data via parametersfunction myFunction($a, $b) {
// Do something
}
2. Create a class that maintains your stateclass MyClass {
private $a;
private $b;
public function __construct($a, $b) {
$this->a = $a;
$this->b = $b;
}
public function myFunction() {
// Do something
}
}
![]() |
|||
65 | $content = $template->assign( PIWIGO2MEDIAWIKI_DIR.'action.tpl' ); |
||
66 | $template->append('element_set_global_plugins_actions', |
||
67 | array( |
||
68 | 'ID' => PIWIGO2MEDIAWIKI_ID, |
||
69 | 'NAME' => l10n('Copy to MediaWiki'), 'CONTENT' => $content, |
||
70 | ) |
||
71 | ); |
||
72 | } |
||
73 | ); |
||
74 | |||
75 | } |
||
76 |
The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file.
The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place.
To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1.