| @@ -1,5 +1,8 @@ | ||
| 1 | 1 | <?php |
| 2 | +/** | |
| 3 | + * @package Polylang | |
| 4 | + */ | |
| 2 | 5 | |
| 3 | 6 | /** |
| 4 | 7 | * Manages links related functions |
| 5 | 8 | * |
| @@ -5,11 +8,28 @@ | ||
| 5 | 8 | * |
| 6 | 9 | * @since 1.2 |
| 7 | 10 | */ |
| 8 | 11 | class PLL_Links { |
| 9 | - public $links_model, $model, $options; | |
| 12 | + /** | |
| 13 | + * Stores the plugin options. | |
| 14 | + * | |
| 15 | + * @var array | |
| 16 | + */ | |
| 17 | + public $options; | |
| 10 | 18 | |
| 11 | 19 | /** |
| 20 | + * @var PLL_Model | |
| 21 | + */ | |
| 22 | + public $model; | |
| 23 | + | |
| 24 | + /** | |
| 25 | + * Instance of a child class of PLL_Links_Model. | |
| 26 | + * | |
| 27 | + * @var PLL_Links_Model | |
| 28 | + */ | |
| 29 | + public $links_model; | |
| 30 | + | |
| 31 | + /** | |
| 12 | 32 | * Constructor |
| 13 | 33 | * |
| 14 | 34 | * @since 1.2 |
| 15 | 35 | * |
| @@ -21,14 +41,15 @@ | ||
| 21 | 41 | $this->options = &$polylang->options; |
| 22 | 42 | } |
| 23 | 43 | |
| 24 | 44 | /** |
| 25 | - * Returns the home url in the requested language | |
| 45 | + * Returns the home url in the requested language. | |
| 26 | 46 | * |
| 27 | 47 | * @since 1.3 |
| 28 | 48 | * |
| 29 | - * @param object|string $language | |
| 30 | - * @param bool $is_search optional whether we need the home url for a search form, defaults to false | |
| 49 | + * @param PLL_Language|string $language The language. | |
| 50 | + * @param bool $is_search Optional, whether we need the home url for a search form, defaults to false. | |
| 51 | + * @return string | |
| 31 | 52 | */ |
| 32 | 53 | public function get_home_url( $language, $is_search = false ) { |
| 33 | 54 | $language = is_object( $language ) ? $language : $this->model->get_language( $language ); |
| 34 | 55 | return $is_search ? $language->search_url : $language->home_url; |