Plugin Directory

Changeset 3259232


Ignore:
Timestamp:
03/20/2025 03:19:36 PM (13 months ago)
Author:
marknokes
Message:

Add docblocks to class properties

Location:
cache-using-gzip
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • cache-using-gzip/tags/2.8.3/classes/CUGZ/class-cugz-gzip-cache.php

    r3259187 r3259232  
    88class GzipCache
    99{
     10    /**
     11    * WordPress options group
     12     *
     13     * @var string
     14    */
    1015    public static $options_group = "cugz_options_group";
    11 
     16    /**
     17    * Link to compare plans
     18     *
     19     * @var string
     20    */
    1221    public static $learn_more = "https://wpgzipcache.com/compare-plans/";
    13 
     22    /**
     23    * Options page url
     24     *
     25     * @var string
     26    */
    1427    public static $options_page_url = "tools.php?page=cugz_gzip_cache";
    15 
     28    /**
     29    * Plugin options array
     30     *
     31     * @var array
     32    */
    1633    public static $options = [
    1734        'cugz_plugin_post_types' => [
     
    5976        ]
    6077    ];
    61 
    62     public $cugz_plugin_post_types;
    63     public $cugz_inline_js_css;
    64     public $cugz_status;
    65     public $host;
    66     public $cache_dir;
    67     public $site_url;
    68     public $plugin_version;
    69     public $plugin_name;
    70     public $settings_url;
     78    /**
     79    * Post types to be cached
     80     *
     81     * @var array
     82    */
     83    public $cugz_plugin_post_types = [];
     84    /**
     85    * Whether to place CSS inline on cached page
     86     *
     87     * @var int
     88    */
     89    public $cugz_inline_js_css = 0;
     90    /**
     91    * Current status of cache. preloaded, empty, processing
     92     *
     93     * @var string
     94    */
     95    public $cugz_status = '';
     96    /**
     97    * WordPress website hostname
     98     *
     99     * @var string
     100    */
     101    public $host = '';
     102    /**
     103    * Directory path on server in which cache files will be stored
     104     *
     105     * @var string
     106    */
     107    public $cache_dir = '';
     108    /**
     109    * WordPress website url
     110     *
     111     * @var string
     112    */
     113    public $site_url = '';
     114    /**
     115    * Current plugin version
     116     *
     117     * @var string
     118    */
     119    public $plugin_version = '';
     120    /**
     121    * The plugin name
     122     *
     123     * @var string
     124    */
     125    public $plugin_name = '';
     126    /**
     127    * Complete options page url including admin url
     128     *
     129     * @var string
     130    */
     131    public $settings_url = '';
     132    /**
     133    * Whether the PHP ZLIB extension is enabled on the server
     134     *
     135     * @var bool
     136    */
    71137    public $zlib_enabled = true;
    72     public $cugz_never_cache;
    73     public $cugz_include_archives;
    74     public $cugz_datepicker;
    75     public $GzipCachePluginExtras;
     138    /**
     139    * Pipe seperated list of page slugs to never cache
     140     *
     141     * @var string
     142    */
     143    public $cugz_never_cache = '';
     144    /**
     145    * Whether to include archive pages in cache preload
     146     *
     147     * @var int
     148    */
     149    public $cugz_include_archives = 0;
     150    /**
     151    * A date before which items will not be cached.
     152     *
     153     * @var string
     154    */
     155    public $cugz_datepicker = '';
     156    /**
     157    * GzipCachePluginExtras class if exists
     158     *
     159     * @var object
     160    */
     161    public $GzipCachePluginExtras = null;
    76162    /**
    77163    * Constructor for the class.
  • cache-using-gzip/trunk/classes/CUGZ/class-cugz-gzip-cache.php

    r3259187 r3259232  
    88class GzipCache
    99{
     10    /**
     11    * WordPress options group
     12     *
     13     * @var string
     14    */
    1015    public static $options_group = "cugz_options_group";
    11 
     16    /**
     17    * Link to compare plans
     18     *
     19     * @var string
     20    */
    1221    public static $learn_more = "https://wpgzipcache.com/compare-plans/";
    13 
     22    /**
     23    * Options page url
     24     *
     25     * @var string
     26    */
    1427    public static $options_page_url = "tools.php?page=cugz_gzip_cache";
    15 
     28    /**
     29    * Plugin options array
     30     *
     31     * @var array
     32    */
    1633    public static $options = [
    1734        'cugz_plugin_post_types' => [
     
    5976        ]
    6077    ];
    61 
    62     public $cugz_plugin_post_types;
    63     public $cugz_inline_js_css;
    64     public $cugz_status;
    65     public $host;
    66     public $cache_dir;
    67     public $site_url;
    68     public $plugin_version;
    69     public $plugin_name;
    70     public $settings_url;
     78    /**
     79    * Post types to be cached
     80     *
     81     * @var array
     82    */
     83    public $cugz_plugin_post_types = [];
     84    /**
     85    * Whether to place CSS inline on cached page
     86     *
     87     * @var int
     88    */
     89    public $cugz_inline_js_css = 0;
     90    /**
     91    * Current status of cache. preloaded, empty, processing
     92     *
     93     * @var string
     94    */
     95    public $cugz_status = '';
     96    /**
     97    * WordPress website hostname
     98     *
     99     * @var string
     100    */
     101    public $host = '';
     102    /**
     103    * Directory path on server in which cache files will be stored
     104     *
     105     * @var string
     106    */
     107    public $cache_dir = '';
     108    /**
     109    * WordPress website url
     110     *
     111     * @var string
     112    */
     113    public $site_url = '';
     114    /**
     115    * Current plugin version
     116     *
     117     * @var string
     118    */
     119    public $plugin_version = '';
     120    /**
     121    * The plugin name
     122     *
     123     * @var string
     124    */
     125    public $plugin_name = '';
     126    /**
     127    * Complete options page url including admin url
     128     *
     129     * @var string
     130    */
     131    public $settings_url = '';
     132    /**
     133    * Whether the PHP ZLIB extension is enabled on the server
     134     *
     135     * @var bool
     136    */
    71137    public $zlib_enabled = true;
    72     public $cugz_never_cache;
    73     public $cugz_include_archives;
    74     public $cugz_datepicker;
    75     public $GzipCachePluginExtras;
     138    /**
     139    * Pipe seperated list of page slugs to never cache
     140     *
     141     * @var string
     142    */
     143    public $cugz_never_cache = '';
     144    /**
     145    * Whether to include archive pages in cache preload
     146     *
     147     * @var int
     148    */
     149    public $cugz_include_archives = 0;
     150    /**
     151    * A date before which items will not be cached.
     152     *
     153     * @var string
     154    */
     155    public $cugz_datepicker = '';
     156    /**
     157    * GzipCachePluginExtras class if exists
     158     *
     159     * @var object
     160    */
     161    public $GzipCachePluginExtras = null;
    76162    /**
    77163    * Constructor for the class.
Note: See TracChangeset for help on using the changeset viewer.