Changeset 2719681

Timestamp:

05/06/2022 10:31:51 PM (4 years ago)

Author:

amit

Message:

Updated to v5.1

Location:

igsyntax-hiliter/trunk

Files:

• README.md (modified) (6 diffs)
• classes/admin.php (modified) (6 diffs)
• classes/ajax-response.php (modified) (4 diffs)
• classes/base.php (modified) (7 diffs)
• classes/cache.php (modified) (11 diffs)
• classes/frontend.php (modified) (22 diffs)
• classes/geshi.php (modified) (3 diffs)
• classes/helper.php (modified) (9 diffs)
• classes/ig-syntax-hiliter-gatekeeper.php (modified) (8 diffs)
• classes/migrate.php (modified) (11 diffs)
• classes/option.php (modified) (4 diffs)
• classes/singleton.php (deleted)
• classes/validate.php (modified) (7 diffs)
• ig-syntax-hiliter.php (modified) (3 diffs)
• readme.txt (modified) (5 diffs)
• templates/frontend-code-box.php (modified) (2 diffs)
• templates/plugin-options-page.php (modified) (1 diff)

igsyntax-hiliter/trunk/README.md

@@ -1 @@
-## **iG:Syntax Hiliter v5.0**
+## **iG:Syntax Hiliter v5.1**
 ---------------------------------
 
@@ -5 +5 @@
 
 ##### **Minimum Requirements**
-- WordPress 4.1 or above
-- PHP 5.3 or above
+- WordPress 5.4 or above
+- PHP 7.4.0 or above
 
 **WordPress.org:** [https://wordpress.org/plugins/igsyntax-hiliter/](https://wordpress.org/plugins/igsyntax-hiliter/)
 
-**iG:Syntax Hiliter** allows you to post source code to your site with syntax highlighting and formatting  (as seen in code editors, IDEs). You can paste the code as is from your code editor or IDE and this plugin will take care of all the code colouring and preserve your formatting. It uses the [GeSHi library](http://qbnz.com/highlighter/) to colourize your code and supports over a 100 programming languages. Most common languages are included with the plugin and it includes drop in support for more languages used by GeSHi.
+**iG:Syntax Hiliter** allows you to post source code to your site with syntax highlighting and formatting  (as seen in code editors, IDEs). You can paste the code as is from your code editor or IDE and this plugin will take care of all the code colouring and preserve your formatting. It uses the [GeSHi library](http://qbnz.com/highlighter/) to colourise your code and supports over a 100 programming languages. Most common languages are included with the plugin and it includes drop in support for more languages used by GeSHi.
 
-**NOTE :** For fast results and less load on your server, you should have a cache plugin installed. That way the plugin won't have to parse the code blocks on a post every time its loaded in browser.
+**NOTE :** For fast results and less load on your server, you should have a cache plugin installed. That way the plugin won't have to parse the code blocks on a post every time it is loaded in browser.
 
+### **[Changelog](CHANGELOG.md)**
 
 ### **Installation**
 
 #### **Upgrading from v4.0 or later**
-Just click `update now` link below the plugin listing on the plugins page in your `wp-admin`. That's quite easy!!
+Just click `update now` link below the plugin listing on the plugins page in your `wp-admin`. The plugin will handle any settings migration if needed. Easy peasy!!
 
 #### **Upgrading from v3.x**
-Just deactivate plugin in WordPress admin, delete the `syntax_hilite.php` file & `ig_syntax_hilite` directory from plugins folder and follow the installation process below. That's quite easy!!
+Deactivate plugin in WordPress admin, delete the `syntax_hilite.php` file & `ig_syntax_hilite` directory from plugins folder and follow the installation process below.
 
 #### **Upgrading from v2.1 or lower**
-Just deactivate plugin in WordPress admin, delete the `syntax_hilite.php` and `geshi.php` files & `geshi` directory from plugins folder and follow the installation process below. That's quite easy!!
+Deactivate plugin in WordPress admin, delete the `syntax_hilite.php` and `geshi.php` files & `geshi` directory from plugins folder and follow the installation process below.
 
 #### **Installing The Plugin**
 1. Login to your WordPress `wp-admin` area.
 2. Click `Add New` in the `Plugins` menu on left.
-3. Enter `iG:Syntax Hiliter` in the search bar on the right on the page that opens and press Enter key.
+3. Enter `iG:Syntax Hiliter` in the search bar on the right of the page that opens and press Enter key.
 4. WordPress would show the **iG:Syntax Hiliter** plugin with install button, click that to install the plugin.
 5. Click on `Activate Plugin` link on the page that opens after the plugin has been installed successfully.
 
-**See Also:** ["Installing Plugins" article on the WP Codex](http://codex.wordpress.org/Managing_Plugins#Installing_Plugins)
+**See Also:** ["Finding and Installing Plugins" article on the WordPress Support](https://wordpress.org/support/article/managing-plugins/#finding-and-installing-plugins)
 
 
@@ -66 +67 @@
 HTML entities need not be escaped, you can post your code as is and the plugin takes care of it all.
 
-**Important :** Do not forget to close the tags, as your code will not be hilited if you don't close your tags. Also, *don't nest tags*. Nesting of tags don't work, so don't try it, it'll ruin your output.
+**Important :** Do not forget to close the tags, as your code will not be highlighted if you don't close your tags. Also, *don't nest tags*. Nesting of tags don't work, so don't try it, it'll ruin your output.
 
-Also a WYSIWYG editor (like the one bundled with WordPress) will probably mess up your code when you paste it in the editor. So if you are having that issue, then please don't report it as a bug. WYSIWYG editors are just not supported at present.
+**Important :** A WYSIWYG editor (like the one bundled with WordPress) will likely mess up your code when you paste it in the editor. If you are having that issue, then please don't report it as a bug. WYSIWYG editors are just not supported at present.
+
+***Similarly, Gutenberg Editor is not supported at present either.***
 
 #### **(Optional) Plugin Attributes**
@@ -107 +110 @@
 Configuring **iG:Syntax Hiliter** is a piece of cake. Login to your WordPress admin section & under the `Settings` menu you'll see `iG:Syntax Hiliter` in the sub-menu.
 
-When you click the `iG:Syntax Hiliter` configuration page, you are offered 10 configuration settings which you can set to your liking. Lets go through each of them.
+When you click the `iG:Syntax Hiliter` configuration page, you are offered some configuration settings which you can set to your liking. Lets go through each of them.
 
-**Use plugin CSS for styling? :** This option allows you to tell the plugin whether it should use its own CSS for styling the code box (not the hilited code, just code box) or not. If you want to use your own styling for the code box, tool-bar etc then you can set it to `NO`. By default its set to `YES`.
+**Use plugin CSS for styling? :** This option allows you to tell the plugin whether it should use its own CSS for styling the code box (not the highlighted code, just code box) or not. If you want to use your own styling for the code box, tool-bar etc then you can set it to `NO`. By default its set to `YES`.
 
-**GeSHi Strict Mode? :** This option allows you to tell the plugin the [strict mode](http://qbnz.com/highlighter/geshi-doc.html#using-strict-mode) setting to use with GeSHi. Strict mode can be set to be always on or off or you can set it to `MAYBE` to have GeSHi decide on its own using the language file of the language whose code you're hiliting. *If you don't have any clue about this then leave it at default setting.* By default its set to `MAYBE`. This option can be overridden for any code block using `strict_mode` attribute in the tag.
+**GeSHi Strict Mode? :** This option allows you to tell the plugin the [strict mode](http://qbnz.com/highlighter/geshi-doc.html#using-strict-mode) setting to use with GeSHi. Strict mode can be set to be always on or off or you can set it to `MAYBE` to have GeSHi decide on its own using the language file of the language whose code you're highlighting. *If you don't have any clue about this then leave it at default setting.* By default its set to `MAYBE`. This option can be overridden for any code block using `strict_mode` attribute in the tag.
 
 **Languages where GeSHi strict mode is disabled :** This option lets you specify a comma separated list of languages where the GeSHi strict mode should always be disabled. Strict mode is disabled for PHP by default.
@@ -121 +124 @@
 **Show line numbers in code? :** This option allows you to tell the plugin whether to show the line numbers along with code in the code boxes or not. Line numbers along with code look great, are a great help when referring to some code from a code box. This option can be overridden for any code block using `gutter` attribute in the tag.
 
-**Hilite code in comments? :** This option allows you to tell the plugin whether to hilite code posted in comments or not. If this is enabled, code posted in the comments will be hilited as it is in the posts.
+**Hilite code in comments? :** This option allows you to tell the plugin whether to highlight code posted in comments or not. If this is enabled, code posted in the comments will be highlighted as it is in the posts.
 
 **Link keywords/function names to Manual? :** This option allows you to tell the plugin whether to link keywords, function names etc to that language's online manual or not. This works only if this feature is enabled for that particular language in GeSHi language file.
@@ -143 +146 @@
 
 **A:** Please feel free to suggest a new feature. Its inclusion might be speedier if you can provide the code to make it work.
-
-
-### **Changelog**
-
-##### **v5.0**
-
-* Minimum required PHP version bumped to 5.3.0. The plugin simply won't load its code on lower versions.
-* Major re-write of plugin for cleaner, modular & better performing code.
-* Assets are enqueued only if needed.
-* NEW: You can now disable plugin stylesheet which styles code boxes. People who have their own styling don't need it anyway.
-* NEW: 2 new options allow more control on GeSHi behaviour.
-* BUGFIX: Language name cache was not re-building automatically.
-
-##### **v4.3**
-
-* BUGFIX: some language file names got snipped when building language name cache
-
-##### **v4.2**
-
-* BUGFIX: Shorthand tags for all languages supported now - props to Karol Kuczmarski for spotting it
-* NEW: Added C++ language file
-
-##### **v4.1**
-
-* BUGFIX: Github Gist URL XSS security hole
-* BUGFIX: `__dir__` doesn't work below PHP 5.3 - props to Karol Kuczmarski for spotting it
-* NEW: Added "lang" as shorthand for "language" attribute
-* NEW: Additional GeSHi language files can be put in "geshi" directory in theme, which will prevent their deletion on plugin upgrade
-* IMPROVED: If a code block is repeated with same attributes then its parsed only once and output is reused
-
-##### **v4.0**
-
-* NEW: Ability to embed Github Gist in post and comments (configurable)
-* NEW: Ability to highlight one or multiple lines in a code block to show them as different
-* NEW: New code box layout
-* NEW: Ability to escape plugin tags to prevent their processing
-* NEW: New GeSHi core (v 1.0.8.11)
-* IMPROVED: Removed quirks from plain text view & its now much more smoother
-* IMPROVED: Handling of how code is prevented from beautification. The rest of the post/comment text is not affected as wptexturize is not removed anymore.
-* IMPROVED: Simpler and faster options page in wp-admin
-
-##### **v3.5**
-
-* BUGFIX: BB Tags except the ones of iG:Syntax Hiliter are allowed. The language file's existence is checked before parsing the code. If the language file does not exist then the code is not parsed.
-* BUGFIX: 'C' code hiliting is now fixed.
-* BUGFIX: 'Plain Text' has been improved to strip the extra blank lines and spaces in Opera and FireFox.
-* The latest stable GeSHi core(v1.0.7.6).
-* NEW: Code Hiliting for Comments has been implemented. This feature can be Enabled/Disabled from the admin interface for iG:Syntax Hiliter. The tags are same for hiliting the code.
-* NEW: A cross-browser Colour Picker(tested in IE6, FireFox1.5 and Opera8.5) is now available to easily set the line colours displayed in the code box.
-* NEW: A new type of view implemented for seeing "Plain Text" code. Besides opening the plain text code in a new window, you can have it displayed in the code box itself with an option to display the hilited HTML code back again. The "Plain Text" view type can be set in the admin interface.
-* The language file for Ruby that I created a while back is now bundled with the plugin and its also a part of the default GeSHi package.
-
-##### **v3.1**
-
-* BUGFIX: Critical bug, which broke the plugin when the square brackets([ & ]) were used in the posts in places other than tags, has been fixed.
-* BUGFIX: Another bug, which allowed any attribute in the tags besides the 'num' and also allowed any attribute value for it, affecting the processing. Now only the 'num' attribute is accepted and if you specify the 'num' attribute then its value must be a positive number otherwise your code won't be hilited. The 'num' attribute is optional and you can leave it out without any problems.
-* BUGFIX: Fixed the unclosed <select> tags in the Plugin GUI code.
-* GeSHi BUGFIX: Fixed a bug in GeSHi where the first line colour was not used when using FANCY LINE NUMBERS thus resulting in just one colour being used for the alternate lines.
-* There's a problem in WordPress due to which the starting delimiters of ASP, PHP were not displayed correctly, as whitespace was inserted between the '<' and the rest of the delimiter. This has been patched so that its displayed correctly, but its not saved in the database, so the database still contains the delimiters as formatted by WordPress.
-
-##### **v3.0**
-
-* Complete re-write of the plugin resulting in reduction of code from 750+ lines to about 400 Lines.
-* New GeSHi Core(v1.0.7) which has some bug-fixes, please see GeSHi Website for its changelog.
-* New languages added are C#, Delphi, Smarty & VB.NET.
-* ASP language file structure updated & more keywords added.
-* Drag-n-Drop usage of new languages. The plugin now supports all languages that GeSHi(v1.0.7) supports. You just need to drop the language file in the "geshi" directory & use the filename as the tag for the language(like if file is "pascal.php", then the filename is "pascal" & the tags will be [pascal] & [/pascal]).
-* Language name which is displayed in the Code-Box can now be turned ON or OFF easily.
-* No more need to set the physical-path to the "geshi" directory if you are doing a default installation.
-* Plain-Text View of the code hilited in the code-box is now possible. This feature can be enabled/disabled easily in the Configuration Interface in WordPress Administration.
-* NO NEED TO EDIT THE PLUGIN FILE ANYMORE. You can now configure the plugin settings from a GUI located under the OPTIONS menu in your WordPress Administration(WordPress 1.5 & above only).
-
-##### **v2.01**
-
-* BUGFIX: Fixed a bug by removing a <br /> tag from the function pFix() which lead to closing of an unnecessary <p> tag making the code not xHTML valid(as per my desires).
-
-##### **v2.0 Final**
-
-* Implemented the new version of GeSHi core, v1.0.2 which has some bug fixes & which uses OL(Ordered Lists) for Line Numbering and supports starting of a Line Number from any given number.
-* The ASP(Active Server Pages) language file has been updated to the new Language File structure of GeSHi as well as more keywords added & hiliting is more effective now.
-* iG:Syntax Hiliter now also supports ActionScript, C, C++, JavaScript, Perl, Python, Visual Basic & XML.
-* The whole plugin has been re-written & all the hiliting code is now in a class. You can just use the class anywhere else too for hiliting the code. But to also use the Code Tags to wrap your code & then hilite them, you will need to use all other functions. You can remove the WordPress Filter calls at the end of the plugin & use the rest of the code as you want somewhere else.
-* BUGFIX: The issue of multi-line comments not being hilited properly in v2.0 Preview has been sorted out.
-
-##### **v2.0 Preview**
-
-* Implemented the new version of GeSHi core, v1.0.1 which has some bug fixes including the extra quote(") bug that broke the xHTML validation of the code.
-* I've created a new language file for ASP(Active Server Pages) which has been added to this release & will also be a part of the next GeSHi release.
-* Line numbering is now done through Ordered Lists(<OL>) & the code is xHTML compliant.
-* Auto-Formatting disabled for posts that contain the iG:Syntax Hiliter code tags so that your code is good for copy-paste operations.
-
-##### **v1.1**
-
-* Implemented the line numbering of code.
-* The code box is now of fixed dimensions without word-wrap & with scrollbars(if required).
-
-##### **v1.0**
-
-* Hilites code between the special tags, all of them differently.
-* Uses GeSHi for syntax hiliting.
-* Supports HTML, CSS, PHP, JAVA & SQL codes.

igsyntax-hiliter/trunk/classes/admin.php

@@ -12 +12 @@
 
     /**
-     * protected constructor, singleton pattern implemented
+     * Class constructor
      */
     protected function __construct() {
+
         parent::__construct();
 
         $this->_setup_hooks();
-    }
-
-    protected function _setup_hooks() {
-        //call function to add options menu item
-        add_action( 'admin_menu', array( $this, 'add_menu' ) );
-
-        //setup our style/script enqueuing for wp-admin
-        add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_stuff' ) );
-
-        //setup callback for AJAX on admin page
-        add_action( 'wp_ajax_ig-sh-save-options', array( $this, 'save_plugin_options' ) );
-
-        //callback to show any migration messages
-        add_action( 'admin_notices', array( $this, 'show_migration_message' ) );
+
+    }
+
+    /**
+     * Method to set up listeners to WP hooks
+     *
+     * @return void
+     */
+    protected function _setup_hooks() : void {
+
+        /*
+         * Actions
+         */
+        add_action( 'admin_menu', [ $this, 'add_menu' ] );
+        add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_stuff' ] );
+        add_action( 'wp_ajax_ig-sh-save-options', [ $this, 'save_plugin_options' ] );
+        add_action( 'admin_notices', [ $this, 'maybe_show_migration_message' ] );
+
+        /*
+         * Filters
+         */
+        add_filter( 'plugin_action_links', [ $this, 'get_action_links' ], 10, 2 );
+
     }
 
@@ -39 +49 @@
      * admin page and then deletes the older version number from DB.
      */
-    public function show_migration_message() {
+    public function maybe_show_migration_message() : void {
+
         if ( get_current_screen()->id !== sprintf( 'settings_page_%s-page', parent::PLUGIN_ID ) ) {
             //not our admin page, bail out
-            return false;
+            return;
         }
 
         $old_version = round( floatval( get_option( parent::PLUGIN_ID . '-migrated-from', 0 ) ), 1 );
 
-        if ( $old_version > 0 ) {
-
-            if ( $old_version < floatval( IG_SYNTAX_HILITER_VERSION ) ) {
-
-                printf( '<div class="updated fade"><p>Options migrated successfully from v%f</p></div>', $old_version );
-
+        if ( 0 < $old_version ) {
+
+            if ( floatval( IG_SYNTAX_HILITER_VERSION ) > $old_version ) {
+                printf(
+                    '<div class="updated fade"><p>Options migrated successfully from v%f</p></div>',
+                    $old_version
+                );
             }
 
@@ -60 +72 @@
         }
 
-        unset( $old_version );
-    }
-
-    /**
-     * This function adds plugin's admin page in the Settings menu
-     */
-    public function add_menu() {
-        add_options_page( parent::PLUGIN_NAME . ' Options', parent::PLUGIN_NAME, 'manage_options', parent::PLUGIN_ID . '-page', array( $this, 'admin_page' ) );
-    }
-
-    /**
-     * This function constructs the UI for the plugin admin page
-     */
-    public function admin_page() {
-
-        echo Helper::render_template( IG_SYNTAX_HILITER_ROOT . '/templates/plugin-options-page.php', array(
-            'plugin_name'      => parent::PLUGIN_NAME,
-            'options'          => $this->_option->get_all(),
-            'strict_mode_opts' => Validate::$strict_mode_values,
-            'human_time_diff'  => Helper::human_time_diff( time(), ( $this->_get_language_cache_build_time() + parent::LANGUAGES_CACHE_LIFE ) ),
-        ) );
-
-    }
-
-    /**
-     * This function is called by WP to handle our AJAX requests
-     */
-    public function save_plugin_options() {
+    }
+
+    /**
+     * Method to add plugin settings page in the Settings menu
+     *
+     * @return void
+     */
+    public function add_menu() : void {
+        add_options_page(
+            sprintf( '%s Options', parent::PLUGIN_NAME ),
+            parent::PLUGIN_NAME,
+            'manage_options',
+            sprintf( '%s-page', parent::PLUGIN_ID ),
+            [ $this, 'admin_page' ]
+        );
+    }
+
+    /**
+     * Method to construct the UI for the plugin settings page
+     *
+     * @return void
+     */
+    public function admin_page() : void {
+
+        Helper::render_template(
+            sprintf( '%s/templates/plugin-options-page.php', untrailingslashit( IG_SYNTAX_HILITER_ROOT ) ),
+            [
+                'plugin_name'      => parent::PLUGIN_NAME,
+                'options'          => $this->_option->get_all(),
+                'strict_mode_opts' => Validate::$strict_mode_values,
+                'human_time_diff'  => Helper::human_time_diff( time(), ( $this->_get_language_cache_build_time() + parent::LANGUAGES_CACHE_LIFE ) ),
+            ],
+            true
+        );
+
+    }
+
+    /**
+     * Method to handle our AJAX requests
+     *
+     * @return void
+     */
+    public function save_plugin_options() : void {
 
         if ( ! is_admin() || ! current_user_can( 'manage_options' ) ) {
-            return false;
+            return;
         }
 
         $response = new Ajax_Response();
 
-        $response->add_nonce( parent::PLUGIN_ID . '-nonce' );
+        $response->add_nonce( sprintf( '%s-nonce', parent::PLUGIN_ID ) );
 
         //check & see if we have the values
+        $option_name  = Helper::filter_input( INPUT_POST, 'option_name', FILTER_SANITIZE_STRING );
+        $option_value = Helper::filter_input( INPUT_POST, 'option_value', FILTER_SANITIZE_STRING );
+
         if (
             ! check_ajax_referer( parent::PLUGIN_ID . '-nonce', '_ig_sh_nonce', false )
-            || ! isset( $_POST['option_name'] ) || ! isset( $_POST['option_value'] )
+            || empty( $option_name ) || empty( $option_value )
         ) {
             $response->add_error( 'Invalid request sent, please refresh the page and try again' );
@@ -106 +136 @@
         }
 
-        $input = array(
-            'option_name'  => sanitize_text_field( strtolower( trim( $_POST['option_name'] ) ) ),
-            'option_value' => sanitize_text_field( strtolower( trim( $_POST['option_value'] ) ) ),
-        );
-
-        if ( $input['option_name'] == 'igsh_refresh_languages' && $input['option_value'] == 'rebuild' ) {
+        $option_name  = sanitize_text_field( strtolower( trim( $option_name ) ) );
+        $option_value = sanitize_text_field( strtolower( trim( $option_value ) ) );
+
+        if ( 'igsh_refresh_languages' === $option_name && 'rebuild' === $option_value ) {
 
             //rebuild language file list
@@ -119 +147 @@
             $response->add( 'time', Helper::human_time_diff( time(), ( $this->_get_language_cache_build_time() + parent::LANGUAGES_CACHE_LIFE ) ) );
 
-        } elseif ( $this->_option->get( $input['option_name'] ) !== false ) {
-
-            $response->add_success( 'Option Saved successfully' );  //assume option saved successfully
-
-            switch ( $input['option_name'] ) {
+        } elseif ( $this->_option->get( $option_name ) !== false ) {
+
+            $response->add_success( 'Option Saved successfully' );    //assume option saved successfully
+
+            switch ( $option_name ) {
+
                 case 'strict_mode':
-                    $this->_option->save( $input['option_name'], $this->_validate->sanitize_strict_mode_values( $input['option_value'] ) );
+                    $this->_option->save(
+                        $option_name,
+                        $this->_validate->sanitize_strict_mode_values( $option_value )
+                    );
                     break;
+
                 case 'non_strict_mode':
-                    $sanitized_language_names = $this->_validate->languages( explode( ',', $input['option_value'] ), array_values( $this->get_languages() ) );
-                    $this->_option->save( $input['option_name'], $sanitized_language_names );
+                    $sanitized_language_names = $this->_validate->languages(
+                        explode( ',', $option_value ),
+                        array_values( $this->get_languages() )
+                    );
+
+                    $this->_option->save( $option_name, $sanitized_language_names );
 
                     unset( $sanitized_language_names );
                     break;
+
                 default:
-                    if ( ! $this->_validate->is_yesno( $input['option_value'] ) ) {
+                    if ( ! $this->_validate->is_yesno( $option_value ) ) {
                         $response->add_error( 'Invalid request sent, please refresh the page and try again' );
                         $response->send();
                     } else {
-                        $this->_option->save( $input['option_name'], $input['option_value'] );
+                        $this->_option->save( $option_name, $option_value );
                     }
+
                     break;
+
             }
 
@@ -147 +187 @@
         $response->send();
 
-    }   //end save_plugin_options()
-
-    /**
-     * function to enqueue stuff in wp-admin head
-     */
-    public function enqueue_stuff( $hook ) {
+    }    //end save_plugin_options()
+
+    /**
+     * Method to load assets on settings page in wp-admin
+     *
+     * @return void
+     */
+    public function enqueue_stuff( $hook ) : void {
 
         if ( ! is_admin() || $hook !== sprintf( 'settings_page_%s-page', parent::PLUGIN_ID ) ) {
             //page is not in wp-admin or not our settings page, so bail out
-            return false;
+            return;
         }
 
         //load stylesheet
-        wp_enqueue_style( parent::PLUGIN_ID . '-admin', plugins_url( 'assets/css/admin.css', __DIR__ ), false, IG_SYNTAX_HILITER_VERSION );
+        wp_enqueue_style(
+            sprintf( '%s-admin', parent::PLUGIN_ID ),
+            plugins_url( '/assets/css/admin.css', __DIR__ ),
+            false,
+            IG_SYNTAX_HILITER_VERSION
+        );
+
         //load jQuery::msg stylesheet
-        wp_enqueue_style( parent::PLUGIN_ID . '-jquery-msg', plugins_url( 'assets/css/jquery.msg.css', __DIR__ ), false, IG_SYNTAX_HILITER_VERSION );
+        wp_enqueue_style(
+            sprintf( '%s-jquery-msg', parent::PLUGIN_ID ),
+            plugins_url( '/assets/css/jquery.msg.css', __DIR__ ),
+            false,
+            IG_SYNTAX_HILITER_VERSION
+        );
 
         //load jQuery::center script
-        wp_enqueue_script( parent::PLUGIN_ID . '-jquery-center', plugins_url( 'assets/js/jquery.center.min.js', __DIR__ ), array( 'jquery' ), IG_SYNTAX_HILITER_VERSION );
+        wp_enqueue_script(
+            sprintf( '%s-jquery-center', parent::PLUGIN_ID ),
+            plugins_url( '/assets/js/jquery.center.min.js', __DIR__ ),
+            [ 'jquery' ],
+            IG_SYNTAX_HILITER_VERSION
+        );
+
         //load jQuery::msg script
-        wp_enqueue_script( parent::PLUGIN_ID . '-jquery-msg', plugins_url( 'assets/js/jquery.msg.min.js', __DIR__ ), array( parent::PLUGIN_ID . '-jquery-center' ), IG_SYNTAX_HILITER_VERSION );
+        wp_enqueue_script(
+            sprintf( '%s-jquery-msg', parent::PLUGIN_ID ),
+            plugins_url( '/assets/js/jquery.msg.min.js', __DIR__ ),
+            [ sprintf( '%s-jquery-center', parent::PLUGIN_ID ) ],
+            IG_SYNTAX_HILITER_VERSION
+        );
+
         //load our script
-        wp_enqueue_script( parent::PLUGIN_ID . '-admin', plugins_url( 'assets/js/admin.js', __DIR__ ), array( parent::PLUGIN_ID . '-jquery-msg' ), IG_SYNTAX_HILITER_VERSION );
+        wp_enqueue_script(
+            sprintf( '%s-admin', parent::PLUGIN_ID ),
+            plugins_url( '/assets/js/admin.js', __DIR__ ),
+            [ sprintf( '%s-jquery-msg', parent::PLUGIN_ID ) ],
+            IG_SYNTAX_HILITER_VERSION
+        );
 
         //some vars in JS that we'll need
-        wp_localize_script( parent::PLUGIN_ID . '-admin', 'ig_sh', array(
-            'plugins_url' => untrailingslashit( plugins_url( '', __DIR__ ) ) . '/',
-            'nonce' => wp_create_nonce( parent::PLUGIN_ID . '-nonce' ),
-        ) );
-
-    }
-
-}   //end of class
-
+        wp_localize_script(
+            sprintf( '%s-admin', parent::PLUGIN_ID ),
+            'ig_sh',
+            [
+                'plugins_url' => plugins_url( '/', __DIR__ ),
+                'nonce'       => wp_create_nonce( sprintf( '%s-nonce', parent::PLUGIN_ID ) ),
+            ]
+        );
+
+    }
+
+    /**
+     * Method to add link to plugin settings page in the plugin listing once plugin has been activated.
+     *
+     * @param array  $links
+     * @param string $file
+     *
+     * @return array
+     */
+    public function get_action_links( array $links, string $file ) : array {
+
+        if ( IG_SYNTAX_HILITER_BASENAME !== $file ) {
+            return $links;
+        }
+
+        $settings_page_slug = sprintf(
+            'options-general.php?page=%s-page',
+            parent::PLUGIN_ID
+        );
+
+        $settings_link = sprintf(
+            '<a href="%s" aria-label="Configure %s">Settings</a>',
+            esc_url( admin_url( $settings_page_slug ) ),
+            esc_attr( parent::PLUGIN_NAME )
+        );
+
+        array_unshift( $links, $settings_link );
+
+        return $links;
+
+    }
+
+}    //end of class
 
 //EOF

igsyntax-hiliter/trunk/classes/ajax-response.php

@@ -3 +3 @@
  * Class for creating and sending an AJAX response
  *
- * @author Amit Gupta <http://amitgupta.in/>
+ * @author Amit Gupta <https://amitgupta.in/>
  *
  * @since 2015-07-22
@@ -20 +20 @@
      * @var array Array of data to be sent to browser
      */
-    protected $_response = array(
+    protected $_response = [
         'nonce' => '',
-        'error' => 1,   //lets assume there's error
+        'error' => 1,    //lets assume there's error
         'msg'   => '',
-    );
+    ];
 
     /**
-     * constructor
+     * Class constructor
      */
     public function __construct() {}
 
     /**
-     * Function to add data to be sent to browser
+     * Method to add data to be sent to browser
      *
-     * @param string $key Key name to identify data
-     * @param string $value Data value
+     * @param string $key   Key name to identify data
+     * @param mixed  $value Data value
+     *
      * @return void
      */
-    public function add( $key, $value ) {
+    public function add( string $key, $value ) : void {
         $this->_response[ sanitize_key( $key ) ] = $value;
     }
 
     /**
-     * Function to nonce to be sent to browser
+     * Method to generate nonce to be sent to browser
      *
      * @param string $key Key to generate nonce
+     *
      * @return void
      */
-    public function add_nonce( $key ) {
-        if ( empty( $key ) || ! is_string( $key ) ) {
+    public function add_nonce( string $key ) : void {
+
+        if ( empty( $key ) ) {
             return;
         }
 
         $this->add( 'nonce', wp_create_nonce( $key ) );
+
     }
 
     /**
-     * Function to add a message to be sent to browser
+     * Method to add a message to be sent to browser
      *
      * @param string $message
-     * @param string $type Type of message, either SUCCESS or ERROR
-     * @return boolean Returns TRUE if message added successfully else FALSE
+     * @param string $type    Type of message, either SUCCESS or ERROR
+     *
+     * @return bool Returns TRUE if message added successfully else FALSE
      */
-    public function add_message( $message, $type = 'success' ) {
-        if ( empty( $message ) || ! is_string( $message ) ) {
+    public function add_message( string $message, string $type = 'success' ) : bool {
+
+        if ( empty( $message ) ) {
             return false;
         }
 
-        $type = ( strtolower( trim( $type ) ) === 'success' ) ? 'success' : 'error';    //type can only be either one
+        $type = ( strtolower( trim( $type ) ) === 'success' ) ? 'success' : 'error';    //type can only be either one
 
-        $this->add( 'msg', sprintf( self::MESSAGE_TEMPLATE, esc_attr( $type ), esc_html( $message ) ) );
+        $this->add(
+            'msg',
+            sprintf(
+                self::MESSAGE_TEMPLATE,
+                esc_attr( $type ),
+                esc_html( $message ) )
+        );
 
         return true;
+
     }
 
     /**
-     * Function to add error message to be sent to browser
+     * Method to add error message to be sent to browser
      *
      * @param string $message
+     *
      * @return void
      */
-    public function add_error( $message ) {
+    public function add_error( string $message ) : void {
         if ( $this->add_message( $message, 'error' ) ) {
             $this->add( 'error', 1 );
@@ -88 +102 @@
 
     /**
-     * Function to add success message to be sent to browser
+     * Method to add success message to be sent to browser
      *
      * @param string $message
+     *
      * @return void
      */
-    public function add_success( $message ) {
+    public function add_success( string $message ) : void {
         if ( $this->add_message( $message, 'success' ) ) {
             $this->add( 'error', 0 );
@@ -100 +115 @@
 
     /**
-     * Function to send data to browser
+     * Method to send data to browser
      *
      * @return void
      */
-    public function send() {
+    public function send() : void {
+
         header( "Content-Type: application/json" );
 
-        echo json_encode( $this->_response );       //we want json
+        echo wp_json_encode( $this->_response );    //we want json
 
-        wp_die( '', '', 200 );  //send 200 HTTP Status back
+        wp_die( '', '', 200 );    //send 200 HTTP Status back
+
     }
 
-}   //end of class
-
+}    //end of class
 
 //EOF

igsyntax-hiliter/trunk/classes/base.php

@@ -5 +5 @@
  * inherited, on its own it doesn't do anything
  *
- * @author Amit Gupta <http://amitgupta.in/>
+ * @author Amit Gupta <https://amitgupta.in/>
  */
 
 namespace iG\Syntax_Hiliter;
 
-abstract class Base extends Singleton {
+use \iG\Syntax_Hiliter\Traits\Singleton;
+
+abstract class Base {
+
+    use Singleton;
 
     /**
      * @var const Class constant containing unique plugin ID
      */
-    const PLUGIN_ID = "ig-syntax-hiliter";
+    const PLUGIN_ID = 'ig-syntax-hiliter';
+
     /**
      * @var const Class constant containing plugin name for display
      */
-    const PLUGIN_NAME = "iG:Syntax Hiliter";
+    const PLUGIN_NAME = 'iG:Syntax Hiliter';
+
     /**
      * @var const Class constant containing life of language name cache in seconds
      */
-    const LANGUAGES_CACHE_LIFE = WEEK_IN_SECONDS;   //1 week
-    /**
-     * @var String Static var containing path to GeSHi language file folder
-     */
-    protected static $__dirs;
-
-    /**
-     * @var iG\Syntax_Hiliter\Option
+    const LANGUAGES_CACHE_LIFE = WEEK_IN_SECONDS;    // 1 week
+
+    /**
+     * @var array Array containing paths to GeSHi language file folders
+     */
+    protected $__dirs;
+
+    /**
+     * @var \iG\Syntax_Hiliter\Option
      */
     protected $_option;
-    /**
-     * @var iG\Syntax_Hiliter\Validate
+
+    /**
+     * @var \iG\Syntax_Hiliter\Validate
      */
     protected $_validate;
@@ -42 +50 @@
      */
     protected function __construct() {
+
         $this->_setup_dir_paths();
 
@@ -60 +69 @@
          */
         $this->get_languages();
-    }
-
-    /**
-     * This function scans the validated language file directories, retrieves the
-     * names of all files with .php extension and returns an array with unique
-     * file names
-     */
-    public function build_language_list() {
-        if ( empty( self::$__dirs ) ) {
-            return false;
-        }
-
-        $tags = array();
-
-        foreach ( self::$__dirs as $dir ) {
-            $tags = array_merge( $tags, glob( $dir . "/*.php" ) );
-        }
-
-        $tags = array_unique( array_filter( array_map( array( $this, '_file_to_tag_name' ), $tags ) ) );
+
+    }
+
+    /**
+     * This method scans the validated language file directories, retrieves the
+     * names of all language files and returns an array with unique file names.
+     *
+     * @return array
+     */
+    public function get_uncached_languages() : array {
+
+        $tags = [];
+
+        if ( empty( $this->__dirs ) ) {
+            return $tags;
+        }
+
+        foreach ( $this->__dirs as $dir ) {
+            $pattern = sprintf(
+                '%s/*.php',
+                untrailingslashit( $dir )
+            );
+
+            $tags = array_merge( $tags, glob( $pattern ) );
+        }
+
+        $tags = array_unique(
+            array_filter(
+                array_map( [ $this, '_file_to_tag_name' ], $tags )
+            )
+        );
 
         sort( $tags );
 
-        $this->_set_language_cache_build_time();    //set language list built time
+        $this->_set_language_cache_build_time();    //set language list built time
 
         return $tags;
-    }
-
-    /**
-     * This function uses WP TLC class to fetch the language file names from supported directories
-     * and schedules a refresh of the transient cache. It also allows a force rebuild of
-     * transient cache via the optional $force_rebuild parameter.
-     */
-    public function get_languages( $force_rebuild = 'no' ) {
+
+    }
+
+    /**
+     * Method to get cached array of language file names from supported directories.
+     *
+     * @param string $force_rebuild Optional parameter to force rebuild the cache
+     *
+     * @return array
+     *
+     * @throws \ErrorException
+     */
+    public function get_languages( string $force_rebuild = 'no' ) : array {
+
         $force_rebuild = ( ! $this->_validate->is_yesno( $force_rebuild ) ) ? 'no' : strtolower( $force_rebuild );
 
-        $cache = new Cache( self::PLUGIN_ID . '-languages' );
-
-        if ( $force_rebuild == 'yes' ) {
-            $cache->delete();   //delete existing cache so we'll get fresh one below
-        }
-
-        $languages = $cache->updates_with( array( $this, 'build_language_list' ) )
+        $cache = Cache::create( self::PLUGIN_ID . '-languages' );
+
+        if ( 'yes' === $force_rebuild ) {
+            $cache->delete();    //delete existing cache so we'll get fresh one below
+        }
+
+        $languages = $cache->updates_with( [ $this, 'get_uncached_languages' ] )
                             ->expires_in( self::LANGUAGES_CACHE_LIFE )
                             ->get();
 
         if ( empty( $languages ) ) {
-            return;
+            return [];
         }
 
         return array_combine( $languages, $languages );
+
     }
 
@@ -115 +143 @@
      * Returns the timestamp when language file name cache was last built. If no timestamp
      * found then it sets current timestamp and returns that.
-     */
-    protected function _get_language_cache_build_time() {
+     *
+     * @return int
+     */
+    protected function _get_language_cache_build_time() : int {
+
         $time = get_option( self::PLUGIN_ID . '-lang-time' );
 
-        if ( $time === false ) {
+        if ( false === $time ) {
             return $this->_set_language_cache_build_time();
         }
 
         return $time;
+
     }
 
     /**
      * Sets the timestamp to mark when language file name cache was built
-     */
-    protected function _set_language_cache_build_time() {
+     *
+     * @return int
+     */
+    protected function _set_language_cache_build_time() : int {
+
         $time = time();
 
@@ -135 +170 @@
 
         return $time;
+
     }
 
     /**
      * Returns the file name of a php file from the physical file path
-     */
-    protected function _file_to_tag_name( $file_path ) {
-
-        $file_path = str_replace( '\\', '/', $file_path );
-
-        if ( empty( $file_path ) || strpos( $file_path, '.php' ) === false ) {
-
-            $file_path = '';
-
+     *
+     * @return string
+     */
+    protected function _file_to_tag_name( string $path ) : string {
+
+        $path = str_replace( '\\', '/', $path );
+
+        if ( empty( $path ) || substr( $path, -4 ) !== '.php' ) {
+            $path = '';
         } else {
 
-            $file_path = explode( '/', $file_path );
-            $file_path = explode( '.', array_pop( $file_path ) );
-
-            array_pop( $file_path );
-
-            $file_path = implode( '.', $file_path );
-
-        }
-
-        return $file_path;
+            $path = explode( '/', $path );
+            $path = explode( '.', array_pop( $path ) );
+
+            array_pop( $path );
+
+            $path = implode( '.', $path );
+
+        }
+
+        return $path;
 
     }
@@ -169 +205 @@
      * @return void
      */
-    protected function _maybe_migrate_older_settings() {
+    protected function _maybe_migrate_older_settings() : void {
         Migrate::get_instance()->settings( $this );
     }
@@ -178 +214 @@
      * and child theme directories, and whichever exists is stored.
      */
-    protected function _setup_dir_paths() {
-
-        self::$__dirs['geshi'] = dirname( __DIR__ ) . "/geshi";                 //setup geshi dir path
-        self::$__dirs['theme'] = get_template_directory() . "/geshi";           //setup geshi dir path in current theme folder
-        self::$__dirs['child_theme'] = get_stylesheet_directory() . "/geshi";   //setup geshi dir path in child theme folder
-
-        if ( ! is_dir( self::$__dirs['child_theme'] ) || self::$__dirs['theme'] == self::$__dirs['child_theme'] ) {
-
-            unset( self::$__dirs['child_theme'] );  //no geshi dir in child theme
-
-        }
-
-        if ( ! is_dir( self::$__dirs['theme'] ) ) {
-
-            unset( self::$__dirs['theme'] );    //no geshi dir in current theme
-
-        }
-
-    }
-
-}   //end of class
-
+    protected function _setup_dir_paths() : void {
+
+        //setup geshi dir path
+        $this->__dirs['geshi'] = sprintf(
+            '%s/geshi',
+            untrailingslashit( IG_SYNTAX_HILITER_ROOT )
+        );
+
+        $theme_path = sprintf(
+            '%s/geshi',
+            untrailingslashit( get_template_directory() )
+        );
+
+        $child_theme_path =sprintf(
+            '%s/geshi',
+            untrailingslashit( get_stylesheet_directory() )
+        );
+
+        //setup geshi dir path in current theme folder
+        if ( is_dir( $theme_path ) ) {
+            $this->__dirs['theme'] = $theme_path;
+        }
+
+        //setup geshi dir path in child theme folder
+        if ( $theme_path !== $child_theme_path && is_dir( $child_theme_path ) ) {
+            $this->__dirs['child_theme'] = $child_theme_path;
+        }
+
+        unset( $child_theme_path, $theme_path );
+
+    }
+
+}    //end of class
 
 //EOF

igsyntax-hiliter/trunk/classes/cache.php

@@ -8 +8 @@
 namespace iG\Syntax_Hiliter;
 
+use \Exception;
 use \ErrorException;
 
@@ -14 +15 @@
     const KEY_PREFIX = 'igsh-cache-';
 
+    const MIN_EXPIRY = 120;    // 2 minutes
+
     protected $_key;
-    protected $_expiry = 1800;  //30 minutes, default expiry
+
+    protected $_expiry = 1800;    // 30 minutes, default expiry
+
     protected $_callback;
-    protected $_params = array();
+
+    protected $_params = [];
 
     protected $_cache;
 
-    protected $_default_storage_format = array(
-        'expiry'   => 0,
-        'callback' => '',
-        'params'   => array(),
-        'data'     => '',
-    );
-
-    /**
-     * @param String $cache_key A mixed character string for use as unique identifier for current dataset stored in cache
-     */
-    public function __construct( $cache_key ) {
-
-        if ( empty( $cache_key ) || ! is_string( $cache_key ) ) {
-
-            throw new ErrorException( 'Cache key is required to create ' . __CLASS__ . ' object' );
+    protected $_default_storage_format = [
+        'expiry' => 0,
+        'data'   => '',
+    ];
+
+    /**
+     * Class constructor
+     *
+     * @param string $cache_key A string for use as unique identifier for current dataset stored in cache
+     *
+     * @throws \ErrorException
+     */
+    public function __construct( string $cache_key ) {
+
+        if ( empty( $cache_key ) ) {
+
+            throw new ErrorException(
+                sprintf(
+                    'Cache key is required to create %s object',
+                    __CLASS__
+                )
+            );
 
         }
@@ -46 +59 @@
      * Factory method to facilitate single call data fetch using method chaining
      *
-     * @param String $cache_key A mixed character string for use as unique identifier for current dataset stored in cache
-     * @return iG\Syntax_Hiliter\Cache
-     */
-    public static function create( $cache_key ) {
-        $class = __CLASS__;
-
-        return new $class( $cache_key );
+     * @param string $cache_key A string for use as unique identifier for current dataset stored in cache
+     *
+     * @return \iG\Syntax_Hiliter\Cache
+     *
+     * @throws \ErrorException
+     */
+    public static function create( string $cache_key ) : self {
+        return new self( $cache_key );
     }
 
@@ -58 +72 @@
      * This function is for deleting the cache
      *
-     * @return iG\Syntax_Hiliter\Cache
-     */
-    public function delete() {
+     * @return \iG\Syntax_Hiliter\Cache
+     */
+    public function delete() : self {
         delete_option( $this->_key );
 
@@ -69 +83 @@
      * This function accepts the cache expiry
      *
-     * @return iG\Syntax_Hiliter\Cache
-     */
-    public function expires_in( $expiry ) {
-        $expiry = intval( $expiry );
-
-        if ( $expiry > 0 ) {
-            $this->_expiry = $expiry;
-        }
-
-        unset( $expiry );
+     * @return \iG\Syntax_Hiliter\Cache
+     */
+    public function expires_in( int $expiry ) : self {
+
+        if ( 0 < $expiry ) {
+            $this->_expiry = max( $expiry, self::MIN_EXPIRY );
+        }
 
         return $this;
+
     }
 
@@ -86 +98 @@
      * This function accepts the callback from which data is to be received
      *
-     * @return iG\Syntax_Hiliter\Cache
-     */
-    public function updates_with( $callback, array $params = array() ) {
-
-        if ( empty( $callback ) || ! is_callable( $callback ) ) {
-
+     * @param callable $callback
+     * @param array    $params
+     *
+     * @return \iG\Syntax_Hiliter\Cache
+     *
+     * @throws \ErrorException
+     */
+    public function updates_with( callable $callback, array $params = [] ) : self {
+
+        if ( empty( $callback ) ) {
             throw new ErrorException( 'Callback passed is not callable' );
-
         }
 
         $this->_callback = $callback;
-        $this->_params = $params;
+        $this->_params   = $params;
 
         return $this;
@@ -125 +140 @@
     }
 
-    protected function _get_cache() {
-
-        if ( is_bool( $this->_cache ) || ( is_array( $this->_cache ) && ! empty( $this->_cache ) ) ) {
+    /**
+     * Method to grab the cache array from storage
+     *
+     * @return array
+     */
+    protected function _get_cache() : array {
+
+        if ( is_array( $this->_cache ) && ! empty( $this->_cache ) ) {
             return $this->_cache;
         }
@@ -137 +157 @@
         }
 
-        return false;
-
-    }
-
-    protected function _set_cache() {
+        return [];
+
+    }
+
+    /**
+     * Method to save cache array in storage
+     *
+     * @return void
+     */
+    protected function _set_cache() : void {
+
+        if ( ! is_array( $this->_cache ) || empty( $this->_cache ) ) {
+            return;
+        }
+
         //delete existing cache
         $this->delete();
@@ -148 +178 @@
         //we want it autoloaded hence the use of update_option()
         update_option( $this->_key, $this->_cache );
-    }
-
-    protected function _has_expired() {
+
+    }
+
+    /**
+     * Method to check if cache has expired or not
+     *
+     * @return bool
+     */
+    protected function _has_expired() : bool {
+
         $cache = $this->_get_cache();
 
-        if ( is_array( $cache ) && ! empty( $cache ) ) {
-
-            if ( ! empty( $cache['expiry'] ) && time() < intval( $cache['expiry'] ) ) {
-                //cache has not expired, yet
-                return false;
-            }
-
+        if ( isset( $cache['expiry'] ) && time() < intval( $cache['expiry'] ) ) {
+            //cache has not expired, yet
+            return false;
         }
 
         //cache has expired
         return true;
-    }
-
-    protected function _refresh_cache() {
-        $cache = array(
-            'expiry'   => ( time() + $this->_expiry ),
-            'callback' => $this->_callback,
-            'params'   => $this->_params,
-            'data'     => '',
-        );
+
+    }
+
+    /**
+     * Method which refreshes cached data
+     *
+     * @return void
+     *
+     * @throws \ErrorException
+     */
+    protected function _refresh_cache() : void {
+
+        $cache = [
+            'expiry' => ( time() + $this->_expiry ),
+            'data'   => '',
+        ];
 
         /*
@@ -185 +225 @@
         try {
             $cache['data'] = call_user_func_array( $this->_callback, $this->_params );
-        } catch( \Exception $e ) {
-            $cache['data'] = false;
+        } catch( Exception $e ) {
+            $cache['data'] = '';
         }
 
@@ -193 +233 @@
         $this->_set_cache();
 
-        unset( $cache );
-    }
-
-}   //end of class
-
+    }
+
+}    //end of class
 
 //EOF

igsyntax-hiliter/trunk/classes/frontend.php

@@ -4 +4 @@
  * for the plugin, hilite code etc.
  *
- * @author Amit Gupta <http://amitgupta.in/>
+ * @author Amit Gupta <https://amitgupta.in/>
  */
 
@@ -14 +14 @@
 
     /**
-     * @var Constant Class constant contains the template for generating tokens for hilited code
+     * @var const Class constant contains the template for generating tokens for hilited code
      */
     const TOKEN = '<pre class="igsh-token" id="%s"></pre>';
-    /**
-     * @var Constant Class constant contains the max length allowed for a file's path
+
+    /**
+     * @var const Class constant contains the max length allowed for a file's path
      */
     const FILE_PATH_LENGTH = 30;
@@ -25 +26 @@
      * @var array Contains hilited code blocks associated to unique tokens
      */
-    protected $__hilited_code = array();
+    protected $__hilited_code = [];
 
     /**
      * @var array Contains IDs/labels etc for use in code boxes
      */
-    protected $__code_box = array(
+    protected $__code_box = [
         'counter'   => 0,
         'id_prefix' => 'ig-sh-',
         'plain'     => 'plain text',
         'html'      => 'hilited code',
-    );
-
-    /**
-     * @var Array Contains filters on which code hiliting is not allowed & code blocks are to be stripped
-     */
-    protected $__no_code_hilite_filters = array(
-        'excerpt_save_pre', 'get_the_excerpt', 'the_excerpt', 'the_excerpt_rss'
-    );
-
-    /**
-     * @var Array Contains filters on which code hiliting is allowed
-     */
-    protected $__code_hilite_filters = array(
-        'the_content'
-    );
-
-    /**
-     * @var Array Contains filters on which Github Gist is not allowed & code blocks are to be stripped
-     */
-    protected $__no_github_gist_filters = array(
-        'excerpt_save_pre', 'get_the_excerpt', 'the_excerpt', 'the_excerpt_rss'
-    );
-
-    /**
-     * @var Array Contains filters on which Github Gist is allowed
-     */
-    protected $__github_gist_filters = array(
-        'the_content'
-    );
-
-    /**
-     * @var Array Contains file names for GeSHi language files associated with expected tag names
-     */
-    protected $__geshi_language = array(
+    ];
+
+    /**
+     * @var array Contains filters on which code hiliting is not allowed & code blocks are to be stripped
+     */
+    protected $__no_code_hilite_filters = [
+        'excerpt_save_pre',
+        'get_the_excerpt',
+        'the_excerpt',
+        'the_excerpt_rss',
+    ];
+
+    /**
+     * @var array Contains filters on which code hiliting is allowed
+     */
+    protected $__code_hilite_filters = [
+        'the_content',
+    ];
+
+    /**
+     * @var array Contains filters on which Github Gist is not allowed & code blocks are to be stripped
+     */
+    protected $__no_github_gist_filters = [
+        'excerpt_save_pre',
+        'get_the_excerpt',
+        'the_excerpt',
+        'the_excerpt_rss',
+    ];
+
+    /**
+     * @var array Contains filters on which Github Gist is allowed
+     */
+    protected $__github_gist_filters = [
+        'the_content',
+    ];
+
+    /**
+     * @var array Contains file names for GeSHi language files associated with expected tag names
+     */
+    protected $__languages = [
         'as'   => 'actionscript',
         'html' => 'html4strict',
         'js'   => 'javascript',
-    );
-
-    /**
-     * @var Array Contains display names for some languages, like C# for csharp, VB.NET for vbnet
-     */
-    protected $__geshi_language_display = array(
+    ];
+
+    /**
+     * @var array Contains display names for some languages, like C# for csharp, VB.NET for vbnet
+     */
+    protected $__language_display_names = [
         'cpp'         => 'C++',
         'cfm'         => 'Cold Fusion',
@@ -86 +93 @@
         'html'        => 'HTML',
         'html4strict' => 'HTML4',
-    );
-
-    /**
-     * @var boolean Flag to determine whether CSS & JS assets are to be enqueued or not
+    ];
+
+    /**
+     * @var bool Flag to determine whether CSS & JS assets are to be enqueued or not
      */
     protected $__enqueue_assets = false;
 
     /**
-     * @var boolean Flag to determine whether JS assets are to be enqueued or not
+     * @var bool Flag to determine whether JS assets are to be enqueued or not
      */
     protected $__enqueue_js_assets = false;
 
     /**
-     * protected constructor, singleton pattern implemented
+     * Class constructor
      */
     protected function __construct() {
+
         parent::__construct();
 
         $this->_build_tags_array();
+        $this->_determine_filters();
+
         $this->_setup_hooks();
+
     }
 
-    protected function _setup_hooks() {
-
-        //setup our style/script enqueuing for front-end
-        add_action( 'wp_footer', array( $this, 'enqueue_stuff' ), 1 );
+    /**
+     * Method to separate out filters on which hiliting of code is to be set up or not
+     *
+     * @return void
+     */
+    protected function _determine_filters() : void {
 
         //setup code hilite handling for comments
-        if ( $this->_option->get( 'hilite_comments' ) == 'yes' ) {
+        if ( $this->_option->get( 'hilite_comments' ) === 'yes' ) {
             //gotta hilite
             $this->__code_hilite_filters[] = 'comment_text';
@@ -123 +136 @@
 
         //setup Github Gist embed in comments
-        if ( $this->_option->get( 'gist_in_comments' ) == 'yes' ) {
+        if ( $this->_option->get( 'gist_in_comments' ) === 'yes' ) {
             //gotta embed
             $this->__github_gist_filters[] = 'comment_text';
@@ -131 +144 @@
         }
 
+    }
+
+    /**
+     * Method to set up listeners to WP hooks
+     *
+     * @return void
+     */
+    protected function _setup_hooks() : void {
+
+        // set on 'wp_footer' hook because we won't know whether to enqueue assets
+        // or not before post content is parsed
+        add_action( 'wp_footer', [ $this, 'enqueue_stuff' ], 1 );
+
         //queue up calls for code hiliting
         foreach ( $this->__code_hilite_filters as $filter ) {
+
             //to grab code blocks to be hilited & replace them with tokens
-            add_filter( $filter, array( $this, 'parse_shortcodes' ), 2 );
+            add_filter( $filter, [ $this, 'parse_shortcodes' ], 3 );
+
             //replace code block tokens with hilited code
-            add_filter( $filter, array( $this, 'add_hilited_code_blocks' ), 100 );
+            add_filter( $filter, [ $this, 'replace_tokens_with_code_blocks' ], 99 );
+
         }
 
         //queue up calls for stripping out code blocks
         foreach ( $this->__no_code_hilite_filters as $filter ) {
-            add_filter( $filter, array( $this, 'parse_shortcodes' ), 2 );
+            add_filter( $filter, [ $this, 'parse_shortcodes' ], 2 );
         }
 
         //queue up calls for Github Gist embed
         foreach ( $this->__github_gist_filters as $filter ) {
-            add_filter( $filter, array( $this, 'parse_github_gist_tags' ), 9 );
+            add_filter( $filter, [ $this, 'parse_github_shortcodes' ], 10 );
         }
 
         //queue up calls for stripping out Github Gist code blocks
         foreach ( $this->__no_github_gist_filters as $filter ) {
-            add_filter( $filter, array( $this, 'parse_github_gist_tags' ), 9 );
-        }
-
-    }   //end _setup_hooks()
-
-    /**
-     * function to enqueue stuff in front-end head
-     */
-    public function enqueue_stuff() {
+            add_filter( $filter, [ $this, 'parse_github_shortcodes' ], 9 );
+        }
+
+    }    //end _setup_hooks()
+
+    /**
+     * Method to enqueue assets on front-end
+     *
+     * @return void
+     */
+    public function enqueue_stuff() : void {
 
         if ( is_admin() || ! $this->__enqueue_assets ) {
-            //page is in wp-admin, so bail out
-            return false;
-        }
-
-        if ( $this->_option->get( 'fe-styles' ) == 'yes' ) {
+            // page is in wp-admin or it has no code blocks to hilite
+            // bail out
+            return;
+        }
+
+        if ( $this->_option->get( 'fe-styles' ) === 'yes' ) {
             //load stylesheet
-            wp_enqueue_style( parent::PLUGIN_ID, plugins_url( 'assets/css/front-end.css', __DIR__ ), false, IG_SYNTAX_HILITER_VERSION );
-        }
-
-        if ( $this->__enqueue_js_assets === true ) {
+            wp_enqueue_style(
+                parent::PLUGIN_ID,
+                Helper::get_asset_url( '/css/front-end.css' ),
+                false,
+                IG_SYNTAX_HILITER_VERSION
+            );
+        }
+
+        if ( true === $this->__enqueue_js_assets ) {
 
             //load utility lib
-            wp_enqueue_script( 'igeek-utils', plugins_url( 'assets/js/igeek-utils.js', __DIR__ ), array(), IG_SYNTAX_HILITER_VERSION );
+            wp_enqueue_script(
+                'igeek-utils',
+                Helper::get_asset_url( '/js/igeek-utils.js' ),
+                [],
+                IG_SYNTAX_HILITER_VERSION
+            );
+
             //load script
-            wp_enqueue_script( parent::PLUGIN_ID, plugins_url( 'assets/js/front-end.js', __DIR__ ), array( 'igeek-utils', 'jquery' ), IG_SYNTAX_HILITER_VERSION );
+            wp_enqueue_script(
+                parent::PLUGIN_ID,
+                Helper::get_asset_url( '/js/front-end.js' ),
+                [ 'igeek-utils', 'jquery' ],
+                IG_SYNTAX_HILITER_VERSION
+            );
 
             //vars for front-end js
-            wp_localize_script( parent::PLUGIN_ID, 'ig_syntax_hiliter', array(
-                'label' => array(
-                    'plain' => $this->__code_box['plain'],
-                    'html'  => $this->__code_box['html']
-                )
-            ) );
+            wp_localize_script(
+                parent::PLUGIN_ID,
+                'ig_syntax_hiliter',
+                [
+                    'label' => [
+                        'plain' => $this->__code_box['plain'],
+                        'html'  => $this->__code_box['html'],
+                    ],
+                ]
+            );
 
         }
@@ -191 +243 @@
 
     /**
-     * This function builds the array for shorthand tags for all language files
+     * Method to build the array for shorthand tags for all language files
      * available in supported directories
-     */
-    protected function _build_tags_array() {
+     *
+     * @return void
+     *
+     * @throws \ErrorException
+     */
+    protected function _build_tags_array() : void {
+
         $languages = $this->get_languages();
 
@@ -201 +258 @@
         }
 
-        $keys = array_unique( array_merge( array_keys( $this->__geshi_language ), array_keys( $languages ) ) );
-
-        $tags = array();
+        $keys = array_unique(
+            array_merge(
+                array_keys( $this->__languages ),
+                array_keys( $languages )
+            )
+        );
+
+        $tags = [];
 
         foreach( $keys as $key ) {
-            if ( array_key_exists( $key, $this->__geshi_language ) ) {
-                $tags[$key] = $this->__geshi_language[$key];
+
+            if ( array_key_exists( $key, $this->__languages ) ) {
+                $tags[ $key ] = $this->__languages[ $key ];
                 continue;
             }
 
             if ( array_key_exists( $key, $languages ) ) {
-                $tags[$key] = $languages[$key];
+                $tags[ $key ] = $languages[ $key ];
                 continue;
             }
+
         }
 
         ksort( $tags );
 
-        $this->__geshi_language = $tags;
-
-        unset( $tags, $keys, $languages );
+        $this->__languages = $tags;
+
     }
 
     /**
-     * This function is used to truncate file path to required length
-     *
-     * @param string $path Path to file
-     * @param int $length Length in number of characters
+     * Method to truncate file path to required length
+     *
+     * @param string $path   Path to file
+     * @param int    $length Length in number of characters
+     *
      * @return string Truncated file path
      */
-    protected function _snip_file_path( $path, $length ) {
-
-        $length = intval( $length );
-        $length = ( $length < 0 || $length > self::FILE_PATH_LENGTH ) ? self::FILE_PATH_LENGTH : $length;
+    protected function _snip_file_path( string $path, int $length ) : string {
+
+        $length = abs( $length );
+        $length = min( self::FILE_PATH_LENGTH, $length );
 
         if ( strlen( $path ) <= $length ) {
@@ -240 +304 @@
         }
 
-        $path = "&hellip;" . substr( $path, intval( 2 - $length ) );
+        $path = sprintf(
+            '&hellip;%s',
+            substr( $path, ( 2 - $length ) )
+        );
 
         return $path;
@@ -247 +314 @@
 
     /**
-     * This function is used to put hilited code in a presentable box
-     */
-    protected function _get_code_in_box( $code, $attrs ) {
+     * Method to put hilited code in a presentable box
+     *
+     * @param string $code
+     * @param array  $attrs
+     *
+     * @return string
+     *
+     * @throws \ErrorException
+     */
+    protected function _get_code_in_box( string $code, array $attrs = [] ) : string {
+
         if ( empty( $code ) ) {
-            return;
-        }
-
-        $code_box = '';
+            return '';
+        }
+
+        $attrs['file'] = ( empty( $attrs['file'] ) ) ? '' : $attrs['file'];
+
         $this->__code_box['counter']++;
 
-        return Helper::render_template( IG_SYNTAX_HILITER_ROOT . '/templates/frontend-code-box.php', array(
-            'id_prefix'  => $this->__code_box['id_prefix'],
-            'counter'    => $this->__code_box['counter'],
-            'plain_text' => $this->__code_box['plain'],
-            'file_path'  => $this->_snip_file_path( $attrs['file'], self::FILE_PATH_LENGTH ),
-            'attrs'      => $attrs,
-            'code'       => $code,
-        ) );
+        return Helper::render_template(
+            sprintf( '%s/templates/frontend-code-box.php', untrailingslashit( IG_SYNTAX_HILITER_ROOT ) ),
+            [
+                'id_prefix'  => $this->__code_box['id_prefix'],
+                'counter'    => $this->__code_box['counter'],
+                'plain_text' => $this->__code_box['plain'],
+                'file_path'  => $this->_snip_file_path( $attrs['file'], self::FILE_PATH_LENGTH ),
+                'attrs'      => $attrs,
+                'code'       => $code,
+            ]
+        );
+
     }
 
     /**
-     * This function is used to hilite code using Geshi
-     */
-    protected function _get_hilited_code( $attrs = array(), $code = '' ) {
-
-        if ( ( empty( $code ) || ! is_string( $code ) ) ) {
-            return;
-        }
-
-        extract( shortcode_atts( array(
-            'strict_mode' => '',
-            'language'    => '',
-            'firstline'   => 1,
-            'highlight'   => 0,
-            'file'        => '',
-            'gutter'      => '',
-            'plaintext'   => '',
-            'toolbar'     => '',
-            'lang'        => 'code',
-            'num'         => 1,
-        ), $attrs ) );
-
-        $num = intval( $num );
-        $firstline = ( intval( $firstline ) < 1 ) ? 1 : intval( $firstline );
-        $firstline = ( $num > $firstline ) ? $num : $firstline;
-
-        $language = ( empty( $language ) ) ? $lang : $language;
+     * Method to hilite code using Geshi and get the HTML
+     *
+     * @param array  $attrs
+     * @param string $code
+     *
+     * @return string
+     *
+     * @throws \ErrorException
+     */
+    protected function _get_hilited_code( array $attrs = [], string $code = '' ) : string {
+
+        if ( empty( $code ) ) {
+            return '';
+        }
+
+        extract(
+            shortcode_atts(
+                [
+                    'strict_mode' => '',
+                    'language'    => 'code',
+                    'firstline'   => 1,
+                    'highlight'   => 0,
+                    'file'        => '',
+                    'gutter'      => '',
+                    'plaintext'   => '',
+                    'toolbar'     => '',
+                    'lang'        => 'code',
+                    'num'         => 1,
+                ],
+                $attrs
+            )
+        );
+
+        $num       = absint( $num );
+        $firstline = absint( $firstline );
+        $firstline = max( 1, $num, $firstline );
+        $language  = ( empty( $language ) && ! empty( $lang ) ) ? $lang : $language;
+
         unset( $lang );
 
-        $language = sanitize_title( $language );
-        $language_display = ( array_key_exists( $language, $this->__geshi_language_display ) ) ? $this->__geshi_language_display[ $language ] : $language;
-        $language = ( array_key_exists( $language, $this->__geshi_language ) ) ? $this->__geshi_language[ $language ] : $language;
+        $language         = sanitize_title( $language );
+        $language_display = $this->__language_display_names[ $language ] ?? $language;
+        $language         = $this->__languages[ $language ] ?? $language;
 
         $non_strict_mode_languages = $this->_option->get( 'non_strict_mode' );
@@ -304 +396 @@
         if ( ! empty( $strict_mode ) ) {
             $strict_mode = strtolower( trim( $strict_mode ) );
-        } elseif ( in_array( $language, $non_strict_mode_languages ) ) {
+        } elseif ( in_array( $language, $non_strict_mode_languages, true ) ) {
             $strict_mode = 'never';
         } else {
@@ -325 +417 @@
         unset( $strict_mode );
 
-        $file = strip_tags( $file );
-        $gutter = ( ! $this->_validate->is_yesno( $gutter ) ) ? '' : strtolower( trim( $gutter ) );
-
+        $file      = sanitize_text_field( wp_strip_all_tags( $file ) );
+        $gutter    = ( ! $this->_validate->is_yesno( $gutter ) ) ? '' : strtolower( trim( $gutter ) );
         $plaintext = ( ! $this->_validate->is_yesno( $plaintext ) ) ? '' : strtolower( trim( $plaintext ) );
-        $toolbar = ( ! $this->_validate->is_yesno( $toolbar ) ) ? '' : strtolower( trim( $toolbar ) );
+        $toolbar   = ( ! $this->_validate->is_yesno( $toolbar ) ) ? '' : strtolower( trim( $toolbar ) );
 
         $code = trim( $code );
@@ -335 +426 @@
         if ( strpos( $highlight, ',' ) === false && strpos( $highlight, '-' ) === false ) {
 
-            $highlight = ( intval( $highlight ) < 0 ) ? 0 : array( intval( $highlight ) );
+            $highlight = [ absint( $highlight ) ];
 
         } else {
 
             $highlight = explode( ',', $highlight );
-
-            $ranges = array();
+            $ranges    = [];
 
             foreach ( $highlight as $num ) {
 
                 if ( strpos( $num, '-' ) === false ) {
-                    $ranges[] = $num;
+                    $ranges[] = absint( $num );
                     continue;
                 }
 
-                $range = explode( '-', $num );
-                $range_start = intval( $range[0] );
-                $range_end = intval( $range[1] );
-
-                if ( $range_end == $range_start ) {
+                $range       = explode( '-', $num );
+                $range_start = absint( $range[0] );
+                $range_end   = absint( $range[1] );
+
+                if ( $range_end === $range_start ) {
                     $ranges[] = $range_start;
                     continue;
                 } elseif ( $range_end < $range_start ) {
-                    $range_start = intval( $range[1] );
-                    $range_end = intval( $range[0] );
+                    $range_start = absint( $range[1] );
+                    $range_end   = absint( $range[0] );
                 }
 
-                $range = range( $range_start, $range_end );
+                $range  = range( $range_start, $range_end );
                 $ranges = array_merge( $ranges, $range );
 
@@ -375 +465 @@
             unset( $ranges );
 
-            $highlight = array_unique( array_map( 'intval', $highlight ) ); //make 'em all int & vaporize duplicates
+            //make 'em all int & vaporize duplicates
+            $highlight = array_unique( array_map( 'intval', $highlight ) );
+
             sort( $highlight, SORT_NUMERIC );
 
         }
 
-        $is_language = true;    //assume we have a valid language
-        $dir_path = parent::$__dirs['geshi'];       //set default path to our geshi dir
-
-        if ( function_exists( 'file_exists' ) ) {
-
-            foreach ( parent::$__dirs as $key => $dir ) {
-
-                if ( file_exists( $dir . '/' . $language . '.php' ) ) {
-                    $is_language = true;    //language file exists
-                    $dir_path = $dir;   //set language file dir
-                    break;
-                }
-
-                $is_language = false;   //language file doesn't exist
-
+        $is_language = true;    //assume we have a valid language
+        $dir_path    = $this->__dirs['geshi'];    //set default path to our geshi dir
+
+        foreach ( $this->__dirs as $key => $dir ) {
+
+            $language_file_path = sprintf(
+                '%s/%s.php',
+                untrailingslashit( $dir ),
+                $language
+            );
+
+            if ( Helper::is_file_path_valid( $language_file_path ) ) {
+                $is_language = true;    //language file exists
+                $dir_path    = $dir;    //set language file dir
+                break;
             }
 
-        }
-
-        if ( $is_language !== true ) {
+            $is_language = false;    //language file doesn't exist
+
+        }
+
+        if ( true !== $is_language ) {
             //we don't have a valid language specified in the tag by user
             //set the code block to be hilited using the 'code' lang file
-            $language = 'code';
+            $language         = 'code';
             $language_display = $language;
         }
 
-        $options = array(
+        $options = [
             'show_line_numbers' => Helper::yesno_to_bool( $this->_option->get( 'show_line_numbers' ) ),
             'show_plain_text'   => Helper::yesno_to_bool( $this->_option->get( 'plain_text' ) ),
             'show_toolbar'      => Helper::yesno_to_bool( $this->_option->get( 'toolbar' ) ),
-        );
+        ];
 
         /*
@@ -440 +534 @@
 
         if ( ! empty( $geshi_error ) ) {
-            return; //there's GeSHi error, bail from this function
-        }
-
-        $geshi->set_header_type( GESHI_HEADER_NONE );               //don't need any wrapper around hilited code, we've our own
-        $geshi->enable_line_numbers( GESHI_NORMAL_LINE_NUMBERS );   //show line numbers
-
-        if ( $options['show_line_numbers'] === false ) {
-            $geshi->set_line_style( 'list-style: none;' );  //hide line numbers
-        }
-
-        $geshi->start_line_numbers_at( $firstline );        //where to start line numbering from
-        $geshi->set_case_keywords( GESHI_CAPS_NO_CHANGE );  //don't mess with our code
-        $geshi->set_tab_width( 4 );                         //if you don't know this then go stuff your head in sand, coding is not for you!
-
-        $geshi->enable_keyword_links( Helper::yesno_to_bool( $this->_option->get( 'link_to_manual' ) ) );
-
-        if ( is_array( $highlight ) ) {
-            $geshi->highlight_lines_extra( $highlight );                            //show these lines as special
-            $geshi->set_highlight_lines_extra_style( 'background-color:#FFFFBC;' ); //set bg color for special lines
-        }
+            return '';    //there's GeSHi error, bail out
+        }
+
+        $geshi->set_header_type( GESHI_HEADER_NONE );    //don't need any wrapper around hilited code, we have our own
+        $geshi->enable_line_numbers( GESHI_NORMAL_LINE_NUMBERS );    //show line numbers
+
+        if ( false === $options['show_line_numbers'] ) {
+
+            // hide line numbers
+            // doing it this way so that line hiliting still works, otherwise it would not
+            $geshi->set_line_style( 'list-style: none;' );
+
+        }
+
+        $geshi->start_line_numbers_at( $firstline );    //where to start line numbering from
+        $geshi->set_case_keywords( GESHI_CAPS_NO_CHANGE );    //don't mess with our code
+        $geshi->set_tab_width( 4 );    //if you don't know this then go stuff your head in sand, coding is not for you!
+
+        $geshi->enable_keyword_links(
+            Helper::yesno_to_bool(
+                $this->_option->get( 'link_to_manual' )
+            )
+        );
+
+        $geshi->highlight_lines_extra( $highlight );    //show these lines as special
+        $geshi->set_highlight_lines_extra_style( 'background-color:#FFFFBC;' );    //set bg color for special lines
 
         $geshi->enable_strict_mode( $geshi_mode );
 
-        $hilited_code = $geshi->parse_code();   //get it all
+        $hilited_code = $geshi->parse_code();    //get it all
 
         if ( empty( $hilited_code ) ) {
-            return;     //geshi banged up somewhere, we have nothing to show for all the hardwork above :(
+            return '';    //geshi banged up somewhere, we have nothing to show for all the hardwork above :(
         }
 
@@ -475 +575 @@
          * to set it to FALSE again.
          */
-        if ( $options['show_plain_text'] === true ) {
+        if ( true === $options['show_plain_text'] ) {
             $this->__enqueue_js_assets = $options['show_plain_text'];
         }
 
-        return $this->_get_code_in_box( $hilited_code, array(
-            'plain_text' => $options['show_plain_text'],
-            'toolbar'    => $options['show_toolbar'],
-            'file'       => $file,
-            'language'   => $language_display,
-        ) );
-
-    }   //end _get_hilited_code()
-
-    /*
-     * This function is called for parsing a code hiliting tag setup in
-     * $this->parse_shortcodes().
-     * It hiltes the code, generates a unique token for the code, stores hilited
-     * code in $this->__hilited_code with token as key and returns the token
+        return $this->_get_code_in_box(
+            $hilited_code,
+            [
+                'plain_text' => $options['show_plain_text'],
+                'toolbar'    => $options['show_toolbar'],
+                'file'       => $file,
+                'language'   => $language_display,
+            ]
+        );
+
+    }    //end _get_hilited_code()
+
+    /**
+     * Method to parse code hiliting tag set up in self::parse_shortcodes().
+     * It hiltes the code, generates a unique token for the hilited code, stores
+     * hilited code in a class var with token as key and returns the token
      * to replace the tag in content which can later be replaced with
      * the hilited code.
-     */
-    public function tokenize_code_block( $atts, $code = '', $tag = false ) {
+     *
+     * @param array  $atts
+     * @param string $code
+     * @param string $tag
+     *
+     * @return string
+     *
+     * @throws \ErrorException
+     */
+    public function replace_code_blocks_with_tokens( array $atts, string $code = '', string $tag = '' ) : string {
 
         if ( empty( $tag ) || empty( $code ) ) {
-            return $code;   //nothing to do, bail out
+            return $code;    //nothing to do, bail out
         }
 
         //check if we've to strip code block
-        if ( in_array( current_filter(), $this->__no_code_hilite_filters ) ) {
-            return '';  //code hiliting not allowed for this filter, so remove code block
-        }
-
-        if ( array_key_exists( $tag, $this->__geshi_language ) ) {
-            $atts['language'] = $tag;   //shorthand tag used, so tag name is language
-        }
-
-        ksort( $atts ); //sort attribute array on keys
-
-        $shortcode_md5 = md5( serialize( array(
-            'text' => $code,
-            'atts' => $atts
-        ) ) );  //create unique token key for this code block with these attributes
-
-        if ( ! array_key_exists( $shortcode_md5, $this->__hilited_code ) ) {
-
-            $this->__hilited_code[ $shortcode_md5 ] = $this->_get_hilited_code( $atts, $code ); //save hilited code in array
+        if ( in_array( current_filter(), $this->__no_code_hilite_filters, true ) ) {
+            return '';    //code hiliting not allowed for this filter, so remove code block
+        }
+
+        if ( ! empty( $this->__languages[ $tag ] ) ) {
+            $atts['language'] = $tag;    //shorthand tag used, so tag name is language
+        }
+
+        ksort( $atts );    //sort attribute array on keys
+
+        $shortcode_md5 = md5(    //create unique token key for this code block with these attributes
+            wp_json_encode(
+                [
+                    'text' => $code,
+                    'atts' => $atts,
+                ]
+            )
+        );
+
+        if ( empty( $this->__hilited_code[ $shortcode_md5 ] ) ) {
+
+            // save hilited code in array
+            $this->__hilited_code[ $shortcode_md5 ] = $this->_get_hilited_code( $atts, $code );
 
             if ( empty( $this->__hilited_code[ $shortcode_md5 ] ) ) {
-                //banged up somewhere, we didn't get anything, unset key in array & return empty
+
+                // messed up somewhere, we didn't get anything
+                // unset key in array and return empty
                 unset( $this->__hilited_code[ $shortcode_md5 ] );
-                return;
+
+                return '';
+
             }
 
         }
 
-        $shortcode_token = sprintf( self::TOKEN, $shortcode_md5 );  //generate token
+        $shortcode_token = sprintf( self::TOKEN, $shortcode_md5 );    //generate token HTML
 
         unset( $shortcode_md5 );
 
-        $this->__enqueue_assets = true; //yes we should enqueue CSS/JS assets, we have hilited code on page
-
-        return $shortcode_token;    //return unique token, we'll replace it with hilited code later
-    }   //end tokenize_code_block()
-
-    /**
-     * This function is called back by a filter early on and sets up shortcode
+        $this->__enqueue_assets = true;    //yes we should enqueue CSS/JS assets, we have hilited code on page
+
+        // return unique token, we'll replace it with hilited code later
+        return $shortcode_token;
+
+    }    //end replace_code_blocks_with_tokens()
+
+    /**
+     * Method called back by a filter early on and sets up shortcode
      * processing for code hiliting tags
-     */
-    public function parse_shortcodes( $content ) {
+     *
+     * @param string $content
+     *
+     * @return string
+     */
+    public function parse_shortcodes( string $content= '' ) : string {
 
         if ( is_admin() ) {
@@ -551 +676 @@
         global $shortcode_tags;
 
-        //keep a copy of the registered shortcodes as we'd need to restore them later
+        // keep a copy of the registered shortcodes as we need to restore them later
         $original_shortcode_tags = $shortcode_tags;
 
-        remove_all_shortcodes();    //clean the slate, we want only our shortcodes to be processed right now
-
-        $tags = array_merge( array_keys( $this->__geshi_language ), array( 'sourcecode' ) );
+        remove_all_shortcodes();    //clean the slate, we want only our shortcodes to be processed right now
+
+        $tags = array_merge( array_keys( $this->__languages ), [ 'sourcecode' ] );
 
         foreach ( $tags as $tag ) {
-            add_shortcode( $tag, array( $this, 'tokenize_code_block' ) );
-        }
-
-        $content = do_shortcode( $content );    //parse our shortcodes
-
-        $shortcode_tags = $original_shortcode_tags; //restore original shortcodes
+            add_shortcode( $tag, [ $this, 'replace_code_blocks_with_tokens' ] );
+        }
+
+        $content = do_shortcode( $content );    //parse our shortcodes
+
+        $shortcode_tags = $original_shortcode_tags;    //restore original shortcodes
 
         unset( $tags, $original_shortcode_tags );
@@ -573 +698 @@
 
     /**
-     * This function is called back by a filter in the last and replaces the unique
-     * tokens with corresponding blocks of hilited code stored in $this->__hilited_code
-     */
-    public function add_hilited_code_blocks( $content ) {
+     * Method, called back by a filter towards the end, to replace code hilite
+     * tokens with corresponding blocks of hilited code
+     *
+     * @param string $content
+     *
+     * @return string
+     */
+    public function replace_tokens_with_code_blocks( string $content ) : string {
+
         if ( is_admin() || empty( $this->__hilited_code ) ) {
             return $content;
@@ -582 +712 @@
 
         /*
-         * Run a loop on $this->__hilited_code and replace all tokens in $content
-         * with appropriate blocks of hilited code.
+         * Loop over our tokens array and replace all tokens
+         * with appropriate blocks of hilited code
          */
         foreach ( $this->__hilited_code as $key => $code_block ) {
 
-            $token = sprintf( self::TOKEN, $key );
+            $token   = sprintf( self::TOKEN, $key );
             $content = str_replace( $token, $code_block, $content );
 
@@ -593 +723 @@
 
         return $content;
+
     }
 
     /**
-     * This function is called on a filter and it sets up [github] shortcode parsing
-     */
-    public function parse_github_gist_tags( $content ) {
+     * Method, called on a filter, to set up [github] shortcode parsing
+     *
+     * @param string $content
+     *
+     * @return string
+     */
+    public function parse_github_shortcodes( string $content ) : string {
+
         if ( is_admin() ) {
             return $content;
@@ -605 +741 @@
         global $shortcode_tags;
 
-        //keep a copy of the registered shortcodes as we'd need to restore them later
+        // keep a copy of the registered shortcodes as we need to restore them later
         $original_shortcode_tags = $shortcode_tags;
 
-        remove_all_shortcodes();    //clean the slate, we want only our shortcodes to be processed right now
-
-        //setup shortcode for github gist
-        add_shortcode( 'github', array( $this, 'parse_github_gist_tag' ) );
-
-        $content = do_shortcode( $content );    //parse our shortcodes
-
-        $shortcode_tags = $original_shortcode_tags; //restore original shortcodes
+        remove_all_shortcodes();    //clean the slate, we want only our shortcodes to be processed right now
+
+        // setup shortcode for github gist
+        add_shortcode( 'github', [ $this, 'get_github_gist_embed' ] );
+
+        $content        = do_shortcode( $content );    //parse our shortcodes
+        $shortcode_tags = $original_shortcode_tags;    //restore original shortcodes
 
         unset( $original_shortcode_tags );
 
         return $content;
+
     }
 
     /**
-     * This function handles the [github] tag
-     */
-    public function parse_github_gist_tag( $attrs, $content = '' ) {
-
-        extract( shortcode_atts( array(
-            'id'   => 0,
-            'gist' => '',
-        ), $attrs ) );
-
-        $gist = parse_url( esc_url( untrailingslashit( $gist ) ), PHP_URL_PATH );
+     * Method to return Github Gist embed
+     *
+     * @param array  $attrs
+     * @param string $content
+     *
+     * @return string
+     */
+    public function get_github_gist_embed( array $attrs, string $content = '' ) : string {
+
+        extract(
+            shortcode_atts(
+                [
+                    'id'   => 0,
+                    'gist' => '',
+                ],
+                $attrs
+            )
+        );
+
+        $gist = wp_parse_url( untrailingslashit( $gist ), PHP_URL_PATH );
 
         if ( ! empty( $gist ) ) {
@@ -650 +796 @@
 
         if ( empty( $id ) ) {
-            return;
-        }
-
-        $gist = sprintf( 'https://gist.github.com/%s', esc_url( sanitize_user( $id, true ) ) );
+            return '';
+        }
+
+        $gist = sprintf(
+            'https://gist.github.com/%s',
+            sanitize_user( $id, true )
+        );
 
         $returnable = sprintf( '<script src="%s.js"></script>', esc_url( $gist ) );
 
-        if ( in_array( current_filter(), $this->__no_github_gist_filters ) ) {
-            $returnable = sprintf( 'Github Gist: <a href="%s" rel="nofollow">%s</a>', esc_url( $gist ), esc_html( $gist ) );
+        if ( in_array( current_filter(), $this->__no_github_gist_filters, true ) ) {
+
+            $returnable = sprintf(
+                '<div class="igsh-gist"><span class="igsh-gist__label">Github Gist:</span> <a href="%s" rel="nofollow">%s</a></div>',
+                esc_url( $gist ),
+                esc_html( $gist )
+            );
+
         }
 
         return $returnable;
 
-    }   //end parse_github_gist_tag()
-
-}   //end of class
-
+    }    //end get_github_gist_embed()
+
+}    //end of class
 
 //EOF

igsyntax-hiliter/trunk/classes/geshi.php

@@ -595 +595 @@
      * @since 1.0.0
      */
-    function GeSHi($source = '', $language = '', $path = '') {
+    function __construct($source = '', $language = '', $path = '') {
         if (!empty($source)) {
             $this->set_source($source);
@@ -4734 +4734 @@
             static $callback_2;
             if (!isset($callback_2)) {
-                $callback_2 = create_function('$matches', 'return "[" . str_replace("|", "", $matches[1]) . "]";');
+                $callback_2 = function( $matches ) {
+                    return '[' . str_replace('|', '', $matches[1]) . ']';
+                };
             }
             $list = preg_replace_callback('#\(\?\:((?:.\|)+.)\)#', $callback_2, $list);
@@ -4773 +4775 @@
 }
 
-?>
+//EOF

igsyntax-hiliter/trunk/classes/helper.php

@@ -3 +3 @@
  * Class containing collection of helper methods.
  *
- * @author Amit Gupta <http://amitgupta.in/>
+ * @author Amit Gupta <https://amitgupta.in/>
  */
 
@@ -16 +16 @@
      *
      * @param array $array_to_check Array which is to be checked
-     * @return boolean Returns TRUE if the array is associative else FALSE. Even a single numeric key would make this function return FALSE.
-     */
-    public static function is_associative_array( array $array_to_check ) {
+     *
+     * @return bool Returns TRUE if the array is associative else FALSE. Even a single numeric key would make this function return FALSE.
+     */
+    public static function is_associative_array( array $array_to_check ) : bool {
         return ! (bool) count( array_filter( array_keys( $array_to_check ), 'is_numeric' ) );
     }
 
     /**
+     * Method to check for existence of a file
+     *
+     * @param string $path Physical path of the file which is to be checked
+     *
+     * @return bool Returns TRUE if file path is valid else FALSE
+     */
+    public static function is_file_path_valid( string $path ) : bool {
+        return ( ! empty( $path ) && file_exists( $path ) && validate_file( $path ) === 0 );
+    }
+
+    /**
      * Method to render a template and return the markup
      *
      * @param string $template File path to the template file
-     * @param array $vars Associative array of values which are to be injected into the template. The array keys become var names and key values respective var values.
-     * @return string Template markup ready for output
-     */
-    public static function render_template( $template, array $vars = array() ) {
+     * @param array  $vars     Associative array of values which are to be injected into the template. The array keys become var names and key values respective var values.
+     * @param bool   $output   Optional - Set to TRUE to print out parsed template content, FALSE to return it as string
+     *
+     * @return string|void
+     *
+     * @throws \ErrorException
+     */
+    public static function render_template( string $template, array $vars = [], bool $output = false ) {
 
         if ( empty( $template ) ) {
@@ -35 +51 @@
         }
 
-        if ( ! file_exists( $template ) ) {
-            throw new ErrorException( 'Template ' . basename( $template ) . ' does not exist' );
+        if ( ! static::is_file_path_valid( $template ) ) {
+            throw new ErrorException(
+                sprintf(
+                    'Template %s does not exist',
+                    basename( $template )
+                )
+            );
         }
 
@@ -47 +68 @@
         ob_start();
         require $template;
-        return ob_get_clean();
-
-    }
-
-    /**
-     * This method returns the URL of an asset if relative path to asset is passed else
-     * the URL to assets folder.
-     *
-     * @param string $asset_path Optional asset path relative from assets folder
+        $html = ob_get_clean();
+
+        if ( true === $output ) {
+            echo $html;    // phpcs:ignore This is ignored because any escaping to be done should be done in the template itself.
+            return;
+        }
+
+        return $html;
+
+    }
+
+    /**
+     * Method to remove forward slash from the beginning of a string
+     *
+     * @param string $path String from which forward slash is to be removed from beginning
+     *
+     * @return string String with forward slash removed from beginning
+     */
+    public static function unleadingslashit( string $path ) : string {
+        return ltrim( $path, '/' );
+    }
+
+    /**
+     * Method to add one forward slash at the beginning of a string
+     *
+     * @param string $path String to which forward slash is to be added at beginning
+     *
+     * @return string String with forward slash added at beginning
+     */
+    public static function leadingslashit( string $path ) : string {
+        return sprintf( '/%s', static::unleadingslashit( $path ) );
+    }
+
+    /**
+     * Method to get the URL of an asset if relative path to asset is passed else the URL to assets folder.
+     *
+     * @param string $path Optional asset path relative from assets folder
+     *
      * @return string URL to asset or asset folder
      */
-    public static function get_asset_url( $asset_path = '' ) {
-        return plugins_url( sprintf( '/assets/%s', ltrim( $asset_path, '/' ) ), dirname( __DIR__ ) );
-    }
-
-    public static function human_time_diff( $from = 0, $to = 0 ) {
-
-        $from = intval( $from );
-        $to = ( intval( $to ) < 1 ) ? time() : intval( $to );
-
-        $divs = array(
+    public static function get_asset_url( string $path = '' ) : string {
+        return plugins_url(
+            sprintf( '/assets/%s', static::unleadingslashit( $path ) ),
+            __DIR__
+        );
+    }
+
+    /**
+     * Method to get difference between two timestamps in a humanly readable format
+     *
+     * @param int $from
+     * @param int $to
+     *
+     * @return string
+     */
+    public static function human_time_diff( int $from = 0, int $to = 0 ) : string {
+
+        $to = ( 1 > $to ) ? time() : $to;
+
+        $divs = [
             'second' => 60,
             'minute' => 60,
@@ -74 +134 @@
             'week'   => ( 30 / 7 ),
             'month'  => 12,
-        );
+        ];
 
         $in_future = ( $to > $from );
-
-        $diff = abs( intval( $from - $to ) );
-
+        $diff      = abs( intval( $from - $to ) );
         $diff_unit = 'year';
 
@@ -110 +168 @@
      *
      * @param array $default Array containing default values which are to be overridden
-     * @param array $new Array containing new values
+     * @param array $new     Array containing new values
+     *
      * @return array An array containing new values from $new which override existing values in $default
      */
-    public static function array_merge( array $default = array(), array $new = array() ) {
+    public static function array_merge( array $default = [], array $new = [] ) : array {
 
         if ( empty( $default ) ) {
-            return false;
+            return [];
         }
 
@@ -143 +202 @@
      *
      * @param bool $value
+     *
      * @return string
      */
     public static function bool_to_yesno( $value ) {
+
         if ( ! is_bool( $value ) ) {
             return $value;
         }
 
-        $value = ( $value === true ) ? 'yes' : 'no';
+        $value = ( true === $value ) ? 'yes' : 'no';
 
         return $value;
+
     }
 
@@ -160 +222 @@
      *
      * @param string $value
+     *
      * @return bool
      */
     public static function yesno_to_bool( $value ) {
+
         if ( ! is_string( $value ) ) {
             return $value;
@@ -170 +234 @@
 
         return $value;
-    }
-
-}   //end of class
-
-
+
+    }
+
+    /**
+     * Improved version of PHP's inbuilt filter_input() which works well on PHP CLI
+     * as well which PHP default method does not.
+     *
+     * @param int    $type          One of INPUT_GET, INPUT_POST, INPUT_COOKIE, INPUT_SERVER, or INPUT_ENV
+     * @param string $variable_name Name of a variable to get
+     * @param int    $filter        The ID of the filter to apply
+     * @param null   $options       Filter to apply
+     *
+     * @return mixed|bool|null Value of the requested variable on success, FALSE if the filter fails, or NULL if the variable_name variable is not set.
+     *
+     * @since 2017-10-05 Amit Gupta
+     */
+    public static function filter_input( int $type, string $variable_name, int $filter = FILTER_DEFAULT, $options = null ) {
+
+        if ( 'cli' !== php_sapi_name() ) {
+
+            /*
+             * Code is not running on PHP CLI and we are in clear.
+             * Use the PHP method and bail out.
+             */
+            switch ( $filter ) {
+
+                case FILTER_SANITIZE_STRING:
+                    $sanitized_variable = sanitize_text_field( filter_input( $type, $variable_name, $filter ) );
+                    break;
+
+                default:
+                    $sanitized_variable = filter_input( $type, $variable_name, $filter, $options );
+                    break;
+
+            }
+
+            return $sanitized_variable;
+
+        }
+
+        /*
+         * Code is running on PHP CLI and INPUT_SERVER returns NULL
+         * even for set vars when run on CLI
+         * @see https://bugs.php.net/bug.php?id=49184
+         *
+         * This is a workaround for that bug till its resolved in PHP binary
+         * which doesn't look to be anytime soon. This is a friggin' 10 year old bug.
+         */
+
+        $input             = '';
+        $allowed_html_tags = wp_kses_allowed_html( 'post' );
+
+        /*
+         * Marking the switch() block below to be ignored by PHPCS
+         * because PHPCS squawks on using superglobals like $_POST or $_GET
+         * directly but it can't be helped in this case as this code
+         * is running on CLI.
+         */
+
+        // phpcs:disable
+
+        switch( $type ) {
+
+            case INPUT_GET:
+                if ( ! isset( $_GET[ $variable_name ] ) ) {
+                    return null;
+                }
+
+                $input = wp_kses( $_GET[ $variable_name ], $allowed_html_tags );
+                break;
+
+            case INPUT_POST:
+                if ( ! isset( $_POST[ $variable_name ] ) ) {
+                    return null;
+                }
+
+                $input = wp_kses( $_POST[ $variable_name ], $allowed_html_tags );
+                break;
+
+            case INPUT_COOKIE:
+                if ( ! isset( $_COOKIE[ $variable_name ] ) ) {
+                    return null;
+                }
+
+                $input = wp_kses( $_COOKIE[ $variable_name ], $allowed_html_tags );
+                break;
+
+            case INPUT_SERVER:
+                if ( ! isset( $_SERVER[ $variable_name ] ) ) {
+                    return null;
+                }
+
+                $input = wp_kses( $_SERVER[ $variable_name ], $allowed_html_tags );
+                break;
+
+            case INPUT_ENV:
+                if ( ! isset( $_ENV[ $variable_name ] ) ) {
+                    return null;
+                }
+
+                $input = wp_kses( $_ENV[ $variable_name ], $allowed_html_tags );
+                break;
+
+            default:
+                return null;
+                break;
+
+        }    // end switch()
+
+        // phpcs:enable
+
+        return filter_var( $input, $filter );
+
+    }    //end filter_input()
+
+}    //end of class
 
 //EOF

igsyntax-hiliter/trunk/classes/ig-syntax-hiliter-gatekeeper.php

@@ -3 +3 @@
  * Gatekeeper class for the plugin which loads plugin only if minimum requirements are satisfied.
  *
- * @author Amit Gupta <http://amitgupta.in/>
+ * @author Amit Gupta <https://amitgupta.in/>
  *
  * @since 2015-07-26
@@ -11 +11 @@
 final class iG_Syntax_Hiliter_Gatekeeper {
 
-    const MIN_PHP_VERSION_REQUIRED = '5.3.0';
+    const MIN_PHP_VERSION_REQUIRED = '7.4.0';
 
     /**
@@ -29 +29 @@
 
     /**
+     * Factory method to initialize the class
+     *
+     * @return \iG_Syntax_Hiliter_Gatekeeper
+     */
+    public static function activate() {
+
+        $class = get_called_class();
+
+        return ( new $class() );
+
+    }
+
+    /**
      * Check if plugin's minimum requirements are satisfied or not. If they are then
      * Gatekeeper can grant a pass else deny passage.
@@ -35 +48 @@
      */
     private function _has_pass() {
+
         if ( version_compare( phpversion(), self::MIN_PHP_VERSION_REQUIRED ) == -1 ) {
             //min requirements not met
@@ -41 +55 @@
 
         return true;
+
     }
 
@@ -49 +64 @@
      */
     private function _load_plugin() {
+
         //load up autoloader
         require_once( IG_SYNTAX_HILITER_ROOT . '/autoloader.php' );
@@ -66 +82 @@
 
         }
+
     }
 
@@ -77 +94 @@
      */
     public function show_admin_notice() {
-        printf( '<div class="error"><p>PHP version %s or greater is needed for <strong>iG:Syntax Hiliter</strong> plugin. You must upgrade your PHP to make it work.</p></div>', esc_html( self::MIN_PHP_VERSION_REQUIRED ) );
+
+        printf(
+            '<div class="error"><p>PHP version %s or greater is needed for <strong>iG:Syntax Hiliter</strong> plugin. You must upgrade your PHP to make it work.</p></div>',
+            esc_html( self::MIN_PHP_VERSION_REQUIRED )
+        );
+
     }
 
-}   //end of class
-
+}    //end of class
 
 //EOF

igsyntax-hiliter/trunk/classes/migrate.php

@@ -3 +3 @@
  * Class for migrating old plugin values to new
  *
- * @author Amit Gupta <http://amitgupta.in/>
+ * @author Amit Gupta <https://amitgupta.in/>
  *
  * @since 2015-07-20
@@ -10 +10 @@
 namespace iG\Syntax_Hiliter;
 
-class Migrate extends Singleton {
+use \iG\Syntax_Hiliter\Traits\Singleton;
+
+class Migrate {
+
+    use Singleton;
 
     const V35_OPTION_NAME = 'igsh_options';
 
     /**
-     * @var iG\Syntax_Hiliter\Option
+     * @var \iG\Syntax_Hiliter\Option
      */
     protected $_option;
@@ -24 +28 @@
     protected $_db_version;
 
+    /**
+     * Class constructor
+     */
     protected function __construct() {
         //init options
@@ -29 +36 @@
     }
 
-    public function settings( Base $obj ) {
+    public function settings( Base $obj ) : void {
 
         $this->_db_version = $this->_get_last_version();
 
-        if ( $this->_db_version == round( floatval( IG_SYNTAX_HILITER_VERSION ), 1 ) ) {
-            return; //current version, nothing to migrate, bail out
+        if ( round( floatval( IG_SYNTAX_HILITER_VERSION ), 1 ) === $this->_db_version ) {
+            return;    //current version, nothing to migrate, bail out
         }
 
@@ -64 +71 @@
      * @return float Last version of plugin installed. Returns 0 if its a fresh install.
      */
-    protected function _get_last_version() {
+    protected function _get_last_version() : float {
+
         $db_version = floatval( get_option( Base::PLUGIN_ID . '-version', 0 ) );
 
@@ -72 +80 @@
 
         return round( floatval( $db_version ), 1 );
+
     }
 
@@ -80 +89 @@
      * @return void
      */
-    protected function _add_migrated_from_version() {
+    protected function _add_migrated_from_version() : void {
         update_option( Base::PLUGIN_ID . '-migrated-from', $this->_db_version );
     }
@@ -88 +97 @@
      * or not.
      *
-     * @return boolean Returns TRUE if plugin's last version in use was v3.5.x else FALSE
+     * @return bool Returns TRUE if plugin's last version in use was v3.5.x else FALSE
      */
-    protected function _is_updating_from_35() {
+    protected function _is_updating_from_35() : bool {
         $old_options = get_option( self::V35_OPTION_NAME, false );
 
-        if ( $old_options === false || ! is_array( $old_options ) ) {
+        if ( false === $old_options || ! is_array( $old_options ) ) {
             return false;
         }
@@ -105 +114 @@
      * @return void
      */
-    protected function _settings_from_35() {
-        $old_options = get_option( self::V35_OPTION_NAME, array() );
+    protected function _settings_from_35() : void {
+
+        $old_options = get_option( self::V35_OPTION_NAME, [] );
 
         if ( isset( $old_options['PLAIN_TEXT'] ) ) {
@@ -120 +130 @@
         }
 
-        delete_option( self::V35_OPTION_NAME ); //delete old options from DB
+        delete_option( self::V35_OPTION_NAME );    //delete old options from DB
 
         $this->_add_migrated_from_version();
 
         unset( $old_options );
+
     }
 
@@ -132 +143 @@
      * @return void
      */
-    protected function _initialize_on_fresh_install( Base $obj ) {
-        $obj->get_languages( 'yes' );       //rebuild language file list
+    protected function _initialize_on_fresh_install( Base $obj ) : void {
+
+        $obj->get_languages( 'yes' );    //rebuild language file list
+
         $this->_option->commit();
+
     }
 
-}   //end of class
-
+}    //end of class
 
 //EOF

igsyntax-hiliter/trunk/classes/option.php

@@ -3 +3 @@
  * Class for fetching and saving plugin options
  *
- * @author Amit Gupta <http://amitgupta.in/>
+ * @author Amit Gupta <https://amitgupta.in/>
  */
 
 namespace iG\Syntax_Hiliter;
 
-class Option extends Singleton {
+use \iG\Syntax_Hiliter\Traits\Singleton;
+
+class Option {
+
+    use Singleton;
 
     /**
-     * @var Array An array which contains plugin options
+     * @var array An array which contains plugin options
      */
     protected $_options;
 
     /**
-     * @var Array An array which contains default plugin options
+     * @var array An array which contains default plugin options
      */
-    protected $_default_options = array(
-        'fe-styles'         => 'yes',               //use plugin CSS to style hilited code box by default
-        'strict_mode'       => 'maybe',             //don't use GeSHi strict mode always
-        'non_strict_mode'   => array( 'php' ),      //langauges where strict mode is disabled
-        'toolbar'           => 'yes',               //show toolbar above hilited code by default
-        'plain_text'        => 'yes',               //show option to view code in plain text by default
-        'show_line_numbers' => 'yes',               //show line numbers in code by default
-        'hilite_comments'   => 'yes',               //hilite code posted in comments by default
-        'link_to_manual'    => 'no',                //don't link keywords to manual by default
-        'gist_in_comments'  => 'no',                //don't embed Github Gist in comments by default
-    );
+    protected $_default_options = [
+        'fe-styles'         => 'yes',    //use plugin CSS to style hilited code box by default
+        'strict_mode'       => 'maybe',    //don't use GeSHi strict mode always
+        'non_strict_mode'   => [ 'php' ],    //langauges where strict mode is disabled
+        'toolbar'           => 'yes',    //show toolbar above hilited code by default
+        'plain_text'        => 'yes',    //show option to view code in plain text by default
+        'show_line_numbers' => 'yes',    //show line numbers in code by default
+        'hilite_comments'   => 'yes',    //hilite code posted in comments by default
+        'link_to_manual'    => 'no',    //don't link keywords to manual by default
+        'gist_in_comments'  => 'no',    //don't embed Github Gist in comments by default
+    ];
 
+    /**
+     * Class constructor
+     */
     protected function __construct() {
         $this->_load_all_options();
@@ -37 +44 @@
      * @return void
      */
-    protected function _load_all_options() {
+    protected function _load_all_options() : void {
+
         //fetch options array from wp_options & then do a safe merge with default options
         $db_options = get_option( Base::PLUGIN_ID . '-options', false );
 
         if ( empty( $db_options ) || ! is_array( $db_options ) ) {
-            $db_options = array();
+            $db_options = [];
         }
 
         $this->_options = Helper::array_merge( $this->_default_options, $db_options );
+
     }
 
     /**
-     * This function is just a wrapper to fetch an option from $_options class var,
-     * since direct access to the $_options var is not allowed
+     * Getter method to fetch a single option by name
+     *
+     * @param string $name
+     *
+     * @return mixed
      */
-    public function get( $option_name ) {
-        if ( empty( $option_name ) || ! is_string( $option_name ) ) {
-            return false;
-        }
+    public function get( string $name ) {
 
-        if ( isset( $this->_options[ $option_name ] ) ) {
-            return $this->_options[ $option_name ];
-        }
-
-        return false;
-    }
-
-    public function get_all() {
-        return $this->_options;
-    }
-
-    /**
-     * This function is for setting a value in the $_options class var as direct
-     * access to it isn't allowed. It takes care of sanitizing the value before
-     * putting it in $_options & saves only if the option name exists already.
-     */
-    public function save( $option_name, $option_value ) {
-
-        if ( empty( $option_name ) || ! is_string( $option_name ) || ! isset( $this->_options[ $option_name ] ) ) {
-            return false;
-        }
-
-        $can_be_empty = false;
-
-        if ( is_array( $option_value ) ) {
-            $option_value = array_map( 'strtolower', array_map( 'trim', array_map( 'sanitize_title', $option_value ) ) );
-            $can_be_empty = true;
-        } else {
-            $option_value = strtolower( trim( sanitize_title( $option_value ) ) );
-        }
-
-        if ( ! empty( $option_value ) || $can_be_empty === true ) {
-            $this->_options[ $option_name ] = $option_value;
-            $this->commit();    //lets save in DB as well
-
-            return true;
+        if ( ! empty( $name ) && isset( $this->_options[ $name ] ) ) {
+            return $this->_options[ $name ];
         }
 
@@ -100 +75 @@
 
     /**
-     * This function is for saving the $_options class var in the DB, can be called anytime
-     * or in the class destructor
+     * Method to get all options
+     *
+     * @return array
+     */
+    public function get_all() : array {
+        return $this->_options;
+    }
+
+    /**
+     * Method to save an option. It takes care of sanitizing the value before
+     * saving it and saves an option only if the option name already exists.
+     *
+     * @param string $name
+     * @param mixed  $value
+     *
+     * @return bool Returns TRUE if option is successfully saved else FALSE
+     */
+    public function save( string $name, $value ) : bool {
+
+        if ( empty( $name ) || ! isset( $this->_options[ $name ] ) ) {
+            return false;
+        }
+
+        $can_be_empty = false;
+
+        if ( is_array( $value ) ) {
+
+            $value = array_map( 'sanitize_title', $value );
+            $value = array_map( 'trim', $value );
+            $value = array_map( 'strtolower', $value );
+
+            $can_be_empty = true;
+
+        } else {
+            $value = strtolower( trim( sanitize_title( $value ) ) );
+        }
+
+        if ( ! empty( $value ) || true === $can_be_empty ) {
+
+            $this->_options[ $name ] = $value;
+
+            $this->commit();    //lets save in DB as well
+
+            return true;
+
+        }
+
+        return false;
+
+    }
+
+    /**
+     * Method to save options in DB. This can be called anytime and even in the class destructor.
      *
      * @return bool
      */
-    public function commit() {
+    public function commit() : bool {
+
         if ( empty( $this->_options ) ) {
             return false;
@@ -113 +140 @@
 
         return true;
+
     }
 
-}   //end of class
-
+}    //end of class
 
 //EOF

igsyntax-hiliter/trunk/classes/validate.php

@@ -3 +3 @@
  * Class for validating plugin values
  *
- * @author Amit Gupta <http://amitgupta.in/>
+ * @author Amit Gupta <https://amitgupta.in/>
  *
  * @since 2015-07-22
@@ -10 +10 @@
 namespace iG\Syntax_Hiliter;
 
-class Validate extends Singleton {
+use \iG\Syntax_Hiliter\Traits\Singleton;
+
+class Validate {
+
+    use Singleton;
 
     /**
      * @var array Allowed values for strict mode option
      */
-    public static $strict_mode_values = array( 'always', 'maybe', 'never' );
+    public static $strict_mode_values = [ 'always', 'maybe', 'never' ];
 
     /**
-     * Protected constructor, Singleton implemented
+     * Class constructor
      */
     protected function __construct() {}
@@ -26 +30 @@
      * it returns TRUE else FALSE. The parameter accepts only string.
      *
-     * @return boolean
+     * @return bool
      */
-    public function is_yesno( $value ) {
+    public function is_yesno( $value ) : bool {
+
         if ( ! is_string( $value ) ) {
             return false;
@@ -35 +40 @@
         $value = strtolower( trim( $value ) );
 
-        if ( $value === "yes" || $value === "no" ) {
-            return true;
-        }
+        return ( in_array( $value, [ 'yes', 'no' ], true ) );
 
-        return false;
     }
 
@@ -47 +49 @@
      *
      * @param string $value Value for strict mode option
+     *
      * @return string
      */
-    public function sanitize_strict_mode_values( $value ) {
+    public function sanitize_strict_mode_values( string $value ) : string {
+
         $value = sanitize_title( strtolower( trim( $value ) ) );
 
-        if ( empty( $value ) || ! is_string( $value ) || ! in_array( $value, static::$strict_mode_values ) ) {
+        if ( empty( $value ) || ! in_array( $value, static::$strict_mode_values, true ) ) {
             $value = static::$strict_mode_values[0];
         }
 
         return $value;
+
     }
 
@@ -66 +71 @@
      * @return array A sanitized $values array, non-existing and duplicate language names removed
      */
-    public function languages( array $values = array(), array $languages = array() ) {
+    public function languages( array $values = [], array $languages = [] ) : array {
 
         if ( empty( $values ) || empty( $languages ) ) {
-            return array();
+            return [];
         }
 
-        $values = array_filter( array_unique( array_map( 'sanitize_file_name', array_map( 'trim', $values ) ) ) );
+        $values = array_filter(
+            array_unique(
+                array_map(
+                    'sanitize_file_name',
+                    array_map( 'trim', $values )
+                )
+            )
+        );
 
         $values_count = count( $values );
-        $clean_values = array();
+        $clean_values = [];
 
         for ( $i = 0; $i < $values_count; $i++ ) {
 
-            if ( in_array( $values[ $i ], $languages ) ) {
+            if ( in_array( $values[ $i ], $languages, true ) ) {
                 $clean_values[] = $values[ $i ];
             }
@@ -91 +103 @@
     }
 
-}   //end of class
-
+}    //end of class
 
 //EOF

igsyntax-hiliter/trunk/ig-syntax-hiliter.php

@@ -2 +2 @@
 /*
 Plugin Name: iG:Syntax Hiliter
-Plugin URI: http://blog.igeek.info/wp-plugins/igsyntax-hiliter/
-Description: Syntax Highlighter plugin to colourize source code for various supported programming languages. See the MANUAL for more instructions.
-Version: 5.0
+Plugin URI: https://igeek.info/category/wp-plugins/igsyntax-hiliter/
+Description: Syntax Highlighter plugin to colourise source code for various supported programming languages. See the <a href="https://github.com/coolamit/ig-syntax-hiliter/blob/master/README.md">documentation</a> for more instructions.
+Version: 5.1
 Author: Amit Gupta
-Author URI: http://blog.igeek.info/
+Author URI: https://igeek.info/
 License: GPL v2
 */
 
+define( 'IG_SYNTAX_HILITER_VERSION', 5.1 );
 define( 'IG_SYNTAX_HILITER_ROOT', __DIR__ );
-
-if ( ! defined( 'IG_SYNTAX_HILITER_VERSION' ) ) {
-    define( 'IG_SYNTAX_HILITER_VERSION', 5.0 );
-}
+define( 'IG_SYNTAX_HILITER_URL', plugins_url( '/' ) );
+define( 'IG_SYNTAX_HILITER_BASENAME', plugin_basename( __FILE__ ) );
 
 //set loader to execute on WP init
@@ -20 +19 @@
 
 function ig_syntax_hiliter_loader() {
+
     /*
      * Load the Gatekeeper
@@ -28 +28 @@
      * Activate the Gatekeeper
      */
-    new iG_Syntax_Hiliter_Gatekeeper();
+    iG_Syntax_Hiliter_Gatekeeper::activate();
+
 }
 

igsyntax-hiliter/trunk/readme.txt

@@ -3 +3 @@
 Tags: syntax highlighter, code highlighter, code, source code, php, mysql, html, css, javascript
 Requires at least: 4.1
-Tested up to: 4.3
-Stable tag: trunk
-License: GPLv2
+Tested up to: 5.9
+Requires PHP: 7.4.0
+Stable tag: 5.1
+License: GPLv2 or later
+License URI: http://www.gnu.org/licenses/gpl-2.0.html
 
 A plugin to easily present source code on your site with syntax highlighting and formatting  (as seen in code editors, IDEs).
@@ -18 +20 @@
 
 * WordPress 4.1 or above
-* PHP 5.3 or above
+* PHP 7.4.0 or above
 
 
 Pull requests are welcome on Github.
 
-Github: https://github.com/coolamit/ig-syntax-hiliter
+Github: [https://github.com/coolamit/ig-syntax-hiliter/](https://github.com/coolamit/ig-syntax-hiliter/)
 
 == Installation ==
@@ -51 +53 @@
 == Other Notes ==
 
-###Plugin Usage###
-
-Using this syntax highlighter is fairly easy. There is one tag and 8 optional attributes. Here's how code is posted for it to be highlighted.
-
-`[sourcecode language="language_name"]
-//some code here
-[/sourcecode]`
-
-So if you are posting some PHP code then it would be
-
-`[sourcecode language="php"]
-//some code here
-[/sourcecode]`
-
-or you can use shorthand tags like
-
-`[php]
-//some code here
-[/php]`
-
-
-Its advised to use the full format of the tag for semantics, however its a personal choice and the plugin supports both full format and shorthand.
-
-HTML entities need not be escaped, you can post your code as is and the plugin takes care of it all.
-
-**Important :** Do not forget to close the tags, as your code will not be hilited if you don't close your tags. Also, *don't nest tags*. Nesting of tags don't work, so don't try it, it'll ruin your output.
-
-Also a WYSIWYG editor (like the one bundled with WordPress) will probably mess up your code when you paste it in the editor. So if you are having that issue, then please don't report it as a bug. WYSIWYG editors are just not supported at present.
-
-###(Optional) Plugin Attributes###
-
-**language :** Use this to specify the programming language whose code you are posting. This language has to be present in `geshi` directory inside plugin directory. If `language` attribute is not specified or if a non-existent language is specified in it then a generic code box is rendered. `lang` is the shorthand for `language` attribute.
-
-**firstline :** Use this to start line numbering from a number greater than 1.
-
-**highlight :** Use this to tell plugin which lines are to be marked as different for emphasis. Line numbers are actual line numbers of code and have no relation to the ones starting as per `firstline` attribute. It accepts a comma separated list of line numbers and line number ranges like 5-8 which is equal to 5,6,7,8
-
-`[sourcecode language="php" highlight="2,4-6,9"]
-//line 1 of PHP code
-//line 2 of PHP code
-//line 3 of PHP code
-//line 4 of PHP code
-//line 5 of PHP code
-//line 6 of PHP code
-//line 7 of PHP code
-//line 8 of PHP code
-//line 9 of PHP code
-[/sourcecode]`
-
-**file :** Use this to show a file name/path. This is displayed in the tool-bar shown above code box.
-
-**gutter :** Use this to tell plugin whether to show line numbers in the code box or not. It accepts either `yes` or `no`. This, if specified, will override the global option to show line numbers for that particular code box.
-
-**plaintext :** Use this to tell plugin whether to show plain text option for the code box or not. It accepts either `yes` or `no`. This, if specified, will override the global option to show plain text option for that particular code box.
-
-**toolbar :** Use this to tell plugin whether to show tool-bar for the code box or not. It accepts either `yes` or `no`. This, if specified, will override the global option to show toolbar for that particular code box.
-
-**strict_mode :** Use this to tell the plugin to use GeSHi Strict Mode for a particular code box or not. This attribute accepts `always` or `never` or `maybe` as value. If you don't know what this means then its better to ignore this attribute and let it remain default.
-
-###Configuration###
-
-Configuring **iG:Syntax Hiliter** is a piece of cake. Login to your WordPress admin section & under the `Settings` menu you'll see `iG:Syntax Hiliter` in the sub-menu.
-
-When you click the `iG:Syntax Hiliter` configuration page, you are offered 10 configuration settings which you can set to your liking. Lets go through each of them.
-
-**Use plugin CSS for styling? :** This option allows you to tell the plugin whether it should use its own CSS for styling the code box (not the hilited code, just code box) or not. If you want to use your own styling for the code box, tool-bar etc then you can set it to `NO`. By default its set to `YES`.
-
-**GeSHi Strict Mode? :** This option allows you to tell the plugin the [strict mode](http://qbnz.com/highlighter/geshi-doc.html#using-strict-mode) setting to use with GeSHi. Strict mode can be set to be always on or off or you can set it to `MAYBE` to have GeSHi decide on its own using the language file of the language whose code you're hiliting. *If you don't have any clue about this then leave it at default setting.* By default its set to `MAYBE`. This option can be overridden for any code block using `strict_mode` attribute in the tag.
-
-**Languages where GeSHi strict mode is disabled :** This option lets you specify a comma separated list of languages where the GeSHi strict mode should always be disabled. Strict mode is disabled for PHP by default.
-
-**Show Toolbar? :** This option allows you to tell the plugin whether to show the tool-bar (which shows plain text option, file name, language name) above the code boxes or not. This option can be overridden for any code block using `toolbar` attribute in the tag.
-
-**Show Plain Text Option? :** This option allows you to tell the plugin whether to show the *Plain Text* view option on the code boxes or not. This option can be overridden for any code block using `plaintext` attribute in the tag.
-
-**Show line numbers in code? :** This option allows you to tell the plugin whether to show the line numbers along with code in the code boxes or not. Line numbers along with code look great, are a great help when referring to some code from a code box. This option can be overridden for any code block using `gutter` attribute in the tag.
-
-**Hilite code in comments? :** This option allows you to tell the plugin whether to hilite code posted in comments or not. If this is enabled, code posted in the comments will be hilited as it is in the posts.
-
-**Link keywords/function names to Manual? :** This option allows you to tell the plugin whether to link keywords, function names etc to that language's online manual or not. This works only if this feature is enabled for that particular language in GeSHi language file.
-
-**Enable GitHub Gist embed in comments? :** This option allows you to tell the plugin whether to embed Github Gist in comments or not. If disabled then a Gist posted in comments would just have a link to its page on Github.
-
-**Rebuild Shorthand Tags :** Language files in the plugin's directory and current theme (parent & child) directory are scanned and their names are cached to allow shorthand tag usage for all languages. This cache is rebuilt automatically every week. But if you wish to rebuild it manually you can do so by clicking this button.
-
+[Documentation on plugin usage and configuration](https://github.com/coolamit/ig-syntax-hiliter/blob/master/README.md)
 
 == Frequently Asked Questions ==
@@ -158 +76 @@
 
 == ChangeLog ==
+
+= v5.1 =
+
+* Minimum required PHP version bumped to 7.4.0. The plugin simply won't load its code on lower versions.
+* Refactored plugin code for PHP 7.4.x for better performing code.
+* **This is the last release using the GeSHi library.** GeSHi library has not been updated in several years and it looks unlikely that it will continue. Next release of the plugin will use a different syntax highlighting library. All existing shortcodes will continue to work and so the update and transition would be seamless for the most part, except a feature or two that will phase out and a few changes in plugin configuration options.
 
 = v5.0 =
@@ -260 +184 @@
 == Upgrade Notice ==
 
-= 5.0 =
-Major re-write of plugin for cleaner, modular & better performing code. Fixes automatic tag cache rebuilds, new options allow more control over plugin and GeSHi.
+= 5.1 =
+Major refactor of plugin code for compatibility with PHP 7.4.0 and above.
 
 

igsyntax-hiliter/trunk/templates/frontend-code-box.php

@@ -1 +1 @@
 <?php
-/*
- * Template for showing code box
+/**
+ * Template for showing hilited code in a box
+ *
+ * @package igsyntax-hiliter
  */
+
+if ( empty( $attrs ) || empty( $id_prefix ) || empty( $code ) ) {
+    return '';
+}
 ?>
 <div id="<?php echo esc_attr( $id_prefix . $counter ); ?>" class="syntax_hilite">
 
-    <?php if ( $attrs['toolbar'] === true ) { ?>
+    <?php if ( true === $attrs['toolbar'] ) { ?>
     <div class="toolbar">
 
         <div class="view-different-container">
-            <?php if ( $attrs['plain_text'] === true ) { ?>
+            <?php if ( true === $attrs['plain_text'] ) { ?>
             <a href="#" class="view-different">&lt; View <span><?php echo esc_html( $plain_text ); ?></span> &gt;</a>
             <?php } ?>
@@ -17 +23 @@
         <div class="language-name"><?php echo esc_html( $attrs['language'] ); ?></div>
 
-        <?php if ( ! empty( $attrs['file'] ) ) { ?>
+        <?php if ( ! empty( $attrs['file'] ) && ! empty( $file_path ) ) { ?>
         <div class="filename" title="<?php echo esc_attr( $attrs['file'] ); ?>"><?php echo esc_html( $file_path ); ?></div>
         <?php } ?>

igsyntax-hiliter/trunk/templates/plugin-options-page.php

@@ -1 +1 @@
 <?php
-/*
+/**
  * Template for the plugin options page
+ *
+ * @package igsyntax-hiliter
  */
 ?>