| @@ -1,5 +1,8 @@ | ||
| 1 | 1 | <?php |
| 2 | +/** | |
| 3 | + * @package Polylang | |
| 4 | + */ | |
| 2 | 5 | |
| 3 | 6 | /** |
| 4 | 7 | * Base class for all settings |
| 5 | 8 | * |
| @@ -5,12 +8,85 @@ | ||
| 5 | 8 | * |
| 6 | 9 | * @since 1.8 |
| 7 | 10 | */ |
| 8 | 11 | class PLL_Settings_Module { |
| 9 | - public $active_option, $configure; | |
| 10 | - public $module, $title, $description; | |
| 12 | + /** | |
| 13 | + * Stores the plugin options. | |
| 14 | + * | |
| 15 | + * @var array | |
| 16 | + */ | |
| 11 | 17 | public $options; |
| 12 | - protected $action_links, $buttons, $form = false; | |
| 18 | + | |
| 19 | + /** | |
| 20 | + * Instance of PLL_Model. | |
| 21 | + * | |
| 22 | + * @var PLL_Model | |
| 23 | + */ | |
| 24 | + public $model; | |
| 25 | + | |
| 26 | + /** | |
| 27 | + * Instance of a child class of PLL_Links_Model. | |
| 28 | + * | |
| 29 | + * @var PLL_Links_Model | |
| 30 | + */ | |
| 31 | + public $links_model; | |
| 32 | + | |
| 33 | + /** | |
| 34 | + * Stores if the module is active. | |
| 35 | + * | |
| 36 | + * @var bool | |
| 37 | + */ | |
| 38 | + public $active_option; | |
| 39 | + | |
| 40 | + /** | |
| 41 | + * Stores the display order priority. | |
| 42 | + * | |
| 43 | + * @var int | |
| 44 | + */ | |
| 45 | + public $priority = 100; | |
| 46 | + | |
| 47 | + /** | |
| 48 | + * Stores the module name. | |
| 49 | + * It must be unique. | |
| 50 | + * | |
| 51 | + * @var string | |
| 52 | + */ | |
| 53 | + public $module; | |
| 54 | + | |
| 55 | + /** | |
| 56 | + * Stores the module title. | |
| 57 | + * | |
| 58 | + * @var string | |
| 59 | + */ | |
| 60 | + public $title; | |
| 61 | + | |
| 62 | + /** | |
| 63 | + * Stores the module description. | |
| 64 | + * | |
| 65 | + * @var string | |
| 66 | + */ | |
| 67 | + public $description; | |
| 68 | + | |
| 69 | + /** | |
| 70 | + * Stores the settings actions. | |
| 71 | + * | |
| 72 | + * @var array | |
| 73 | + */ | |
| 74 | + protected $action_links; | |
| 75 | + | |
| 76 | + /** | |
| 77 | + * Stores html fragment for the buttons. | |
| 78 | + * | |
| 79 | + * @var array | |
| 80 | + */ | |
| 81 | + protected $buttons; | |
| 82 | + | |
| 83 | + /** | |
| 84 | + * Stores html form when provided by a child class. | |
| 85 | + * | |
| 86 | + * @var bool|string | |
| 87 | + */ | |
| 88 | + protected $form = false; | |
| 13 | 89 | |
| 14 | 90 | /** |
| 15 | 91 | * Constructor |
| 16 | 92 | * |