For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 29 and the first side effect is on line 24.
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.
Loading history...
2
/**
3
* WP Review Me
4
*
5
* A lightweight library to help you get more reviews for your WordPress theme/plugin.
6
*
7
* LICENSE: This program is free software; you can redistribute it and/or modify it under the terms of the GNU
8
* General Public License as published by the Free Software Foundation; either version 3 of the License, or (at
9
* your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY
10
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11
* General Public License for more details. You should have received a copy of the GNU General Public License along
12
* with this program. If not, see <http://opensource.org/licenses/gpl-license.php>
'message' => sprintf( esc_html__( 'Hey! It's been a little while that you've been using this product. You might not realize it, but user reviews are such a great help to us. We would be so grateful if you could take a minute to leave a review on WordPress.org. Many thanks in advance :)', 'wp-review-me' ) ),
113
'link_label' => esc_html__( 'Click here to leave your review', 'wp-review-me' ),
114
// Parameters used in WP Dismissible Notices Handler
115
'cap' => 'administrator',
116
'scope' => 'global',
117
);
118
119
return $defaults;
120
121
}
122
123
/**
124
* Initialize the library
125
*
126
* @since 1.0
127
* @return void
128
*/
129
private function init() {
130
131
// Make sure WordPress is compatible
132
if ( ! $this->is_wp_compatible() ) {
133
$this->spit_error(
134
sprintf(
135
esc_html__( 'The library can not be used because your version of WordPress is too old. You need version %s at least.', 'wp-review-me' ),
136
$this->wordpress_version_required
137
)
138
);
139
140
return;
141
}
142
143
// Make sure PHP is compatible
144
if ( ! $this->is_php_compatible() ) {
145
$this->spit_error(
146
sprintf(
147
esc_html__( 'The library can not be used because your version of PHP is too old. You need version %s at least.', 'wp-review-me' ),
148
$this->php_version_required
149
)
150
);
151
152
return;
153
}
154
155
// Make sure the dependencies are loaded
156
if ( ! function_exists( 'dnh_register_notice' ) ) {
dismiss_notice uses the super-global variable $_POST which is generally not recommended.
Instead of super-globals, we recommend to explicitly inject the dependencies
of your class. This makes your code less dependent on global state and it
becomes generally more testable:
// BadclassRouter{publicfunctiongenerate($path){return$_SERVER['HOST'].$path;}}// BetterclassRouter{private$host;publicfunction__construct($host){$this->host=$host;}publicfunctiongenerate($path){return$this->host.$path;}}classController{publicfunctionmyAction(Request$request){// Instead of$page=isset($_GET['page'])?intval($_GET['page']):1;// Better (assuming you use the Symfony2 request)$page=$request->query->get('page',1);}}
julien731 /
WP-Review-Me
Julien Liabeuf
Loading history...
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.