gravityview /
GravityView
Complex classes like GravityView_oEmbed often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use GravityView_oEmbed, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 22 | class GravityView_oEmbed { |
||
| 23 | |||
| 24 | protected $output = array(); |
||
| 25 | protected $entry_id = NULL; |
||
| 26 | protected $view_id = NULL; |
||
| 27 | protected $is_full_oembed_preview = false; |
||
| 28 | |||
| 29 | static $instance = NULL; |
||
| 30 | |||
| 31 | private function __construct() {} |
||
| 32 | |||
| 33 | private function initialize() { |
||
| 42 | |||
| 43 | /** |
||
| 44 | * @return GravityView_oEmbed |
||
| 45 | * @since 1.6 |
||
| 46 | */ |
||
| 47 | static function getInstance() { |
||
| 57 | |||
| 58 | /** |
||
| 59 | * Register the oEmbed handler |
||
| 60 | * |
||
| 61 | * @since 1.6 |
||
| 62 | * @uses get_handler_regex |
||
| 63 | */ |
||
| 64 | function register_handler() { |
||
| 69 | |||
| 70 | /** |
||
| 71 | * Become an oEmbed provider for GravityView. |
||
| 72 | * |
||
| 73 | * @since 1.21.5.3 |
||
| 74 | * |
||
| 75 | * @return void |
||
| 76 | */ |
||
| 77 | function add_provider() { |
||
| 80 | |||
| 81 | /** |
||
| 82 | * Output a response as a provider for an entry oEmbed URL. |
||
| 83 | * |
||
| 84 | * For now we only output the JSON format and don't care about the size (width, height). |
||
| 85 | * Our only current use-case is for it to provide output to the Add Media / From URL box |
||
| 86 | * in WordPress 4.8. |
||
| 87 | * |
||
| 88 | * @since 1.21.5.3 |
||
| 89 | * |
||
| 90 | * @return void |
||
| 91 | */ |
||
| 92 | function render_provider_request() { |
||
| 128 | |||
| 129 | /** |
||
| 130 | * Generate the Regular expression that matches embedded entries. |
||
| 131 | * |
||
| 132 | * Generates different regex if using permalinks and if not using permalinks |
||
| 133 | * |
||
| 134 | * @since 1.6 |
||
| 135 | * |
||
| 136 | * @return string Regex code |
||
| 137 | */ |
||
| 138 | private function get_handler_regex() { |
||
| 167 | |||
| 168 | /** |
||
| 169 | * Get the post ID from an URL |
||
| 170 | * |
||
| 171 | * This is necessary because url_to_postid() doesn't work with permalinks off for custom post types |
||
| 172 | * |
||
| 173 | * @uses url_to_postid() |
||
| 174 | * @since 1.6 |
||
| 175 | * |
||
| 176 | * @param string $url URL to get the post ID from |
||
| 177 | * @param string $slug The name of a post, used as backup way of checking for post ID |
||
| 178 | * @return int 0 if not found; int of URL post ID otherwise |
||
| 179 | */ |
||
| 180 | private function get_postid_from_url_and_slug( $url = '', $slug = '' ) { |
||
| 203 | |||
| 204 | /** |
||
| 205 | * Get the entry id for the current oEmbedded entry |
||
| 206 | * |
||
| 207 | * @since 1.6 |
||
| 208 | * |
||
| 209 | * @return int|null |
||
| 210 | */ |
||
| 211 | public function get_entry_id() { |
||
| 214 | |||
| 215 | /** |
||
| 216 | * |
||
| 217 | * |
||
| 218 | * @since 1.6 |
||
| 219 | * @see GravityView_oEmbed::add_providers() for the regex |
||
| 220 | * |
||
| 221 | * @param array $matches The regex matches from the provided regex when calling wp_embed_register_handler() |
||
| 222 | * @param array $attr Embed attributes. |
||
| 223 | * @param string $url The original URL that was matched by the regex. |
||
| 224 | * @param array $rawattr The original unmodified attributes. |
||
| 225 | * @return string The embed HTML. |
||
| 226 | */ |
||
| 227 | public function render_handler( $matches, $attr, $url, $rawattr ) { |
||
| 263 | |||
| 264 | |||
| 265 | /** |
||
| 266 | * Generate a warning to users when previewing oEmbed in the Add Media modal |
||
| 267 | * |
||
| 268 | * @return string HTML notice |
||
| 269 | */ |
||
| 270 | private function generate_preview_notice() { |
||
| 276 | |||
| 277 | /** |
||
| 278 | * Set entry_id and view_id from the data sent to render_handler |
||
| 279 | * |
||
| 280 | * @var $entry_id |
||
| 281 | * @var $view_id |
||
| 282 | * |
||
| 283 | * @see render_handler |
||
| 284 | */ |
||
| 285 | 1 | private function set_vars( $matches, $attr, $url, $rawattr ) { |
|
| 323 | |||
| 324 | /** |
||
| 325 | * Display a nice placeholder in the admin for the entry |
||
| 326 | * |
||
| 327 | * @param array $matches The regex matches from the provided regex when calling wp_embed_register_handler() |
||
| 328 | * @param array $attr Embed attributes. |
||
| 329 | * @param string $url The original URL that was matched by the regex. |
||
| 330 | * @param array $rawattr The original unmodified attributes. |
||
| 331 | * @return string The embed HTML. |
||
| 332 | */ |
||
| 333 | private function render_admin( $matches, $attr, $url, $rawattr ) { |
||
| 353 | |||
| 354 | private function generate_entry_output() { |
||
| 375 | |||
| 376 | /** |
||
| 377 | * Tell get_gravityview() to display a single entry |
||
| 378 | * |
||
| 379 | * REQUIRED FOR THE VIEW TO OUTPUT A SINGLE ENTRY |
||
| 380 | * |
||
| 381 | * @param bool|int $is_single_entry Existing single entry. False, because GV thinks we're in a post or page. |
||
| 382 | * |
||
| 383 | * @return int The current entry ID |
||
| 384 | */ |
||
| 385 | public function set_single_entry_id( $is_single_entry = false ) { |
||
| 389 | |||
| 390 | /** |
||
| 391 | * GravityView embed entry handler |
||
| 392 | * |
||
| 393 | * @param array $matches The regex matches from the provided regex when calling {@link wp_embed_register_handler()}. |
||
| 394 | * @param array $attr Embed attributes. |
||
| 395 | * @param string $url The original URL that was matched by the regex. |
||
| 396 | * @param array $rawattr The original unmodified attributes. |
||
| 397 | * @return string The embed HTML. |
||
| 398 | */ |
||
| 399 | private function render_frontend( $matches, $attr, $url, $rawattr ) { |
||
| 431 | |||
| 432 | } |
||
| 433 | |||
| 434 | GravityView_oEmbed::getInstance(); |
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.