@@ -14,7 +14,7 @@ |
||
14 | 14 | /** |
15 | 15 | * Add plan highlights to a list |
16 | 16 | * |
17 | - * @param $list Message The list to apply to |
|
17 | + * @param Message $list Message The list to apply to |
|
18 | 18 | * @param $cache Cache The jitm cache |
19 | 19 | */ |
20 | 20 | private static function add_plan_highlights_to_list( $list, $cache ) { |
@@ -794,7 +794,7 @@ discard block |
||
794 | 794 | * |
795 | 795 | * @param $external_user_id int The external user id |
796 | 796 | * |
797 | - * @return object The rendered rule |
|
797 | + * @return \stdClass The rendered rule |
|
798 | 798 | */ |
799 | 799 | public function post_render( $external_user_id ) { |
800 | 800 | // render guides if there's at least one |
@@ -849,7 +849,7 @@ discard block |
||
849 | 849 | /** |
850 | 850 | * Requires a widget to be inactive |
851 | 851 | * |
852 | - * @param $widget_slug string The slug of the widget |
|
852 | + * @param string $widget_slug string The slug of the widget |
|
853 | 853 | * |
854 | 854 | * @return $this |
855 | 855 | */ |
@@ -862,7 +862,7 @@ discard block |
||
862 | 862 | /** |
863 | 863 | * Requires the user or blog owner to be in the gdpr zone |
864 | 864 | * |
865 | - * @param $flag bool Whether or not to show in the gdpr zone |
|
865 | + * @param boolean $flag bool Whether or not to show in the gdpr zone |
|
866 | 866 | * |
867 | 867 | * @return $this |
868 | 868 | */ |
@@ -875,7 +875,7 @@ discard block |
||
875 | 875 | /** |
876 | 876 | * Check if a blog has a specific sticker |
877 | 877 | * |
878 | - * @param $sticker string The sticker to check for |
|
878 | + * @param string $sticker string The sticker to check for |
|
879 | 879 | * |
880 | 880 | * @return $this |
881 | 881 | */ |
@@ -888,8 +888,8 @@ discard block |
||
888 | 888 | /** |
889 | 889 | * Ensure that the browser carries a specific query string |
890 | 890 | * |
891 | - * @param $key string The key to check for |
|
892 | - * @param $value string A regex to match |
|
891 | + * @param string $key string The key to check for |
|
892 | + * @param string $value string A regex to match |
|
893 | 893 | * |
894 | 894 | * @return $this |
895 | 895 | */ |
@@ -899,6 +899,9 @@ discard block |
||
899 | 899 | return $this; |
900 | 900 | } |
901 | 901 | |
902 | + /** |
|
903 | + * @param boolean $value |
|
904 | + */ |
|
902 | 905 | public function with_backups_possible( $value ) { |
903 | 906 | $this->with_backups = $value; |
904 | 907 | |
@@ -943,7 +946,7 @@ discard block |
||
943 | 946 | /** |
944 | 947 | * Ensure that a specific theme is active |
945 | 948 | * |
946 | - * @param $theme |
|
949 | + * @param string $theme |
|
947 | 950 | * |
948 | 951 | * @return $this |
949 | 952 | */ |
@@ -956,7 +959,7 @@ discard block |
||
956 | 959 | /** |
957 | 960 | * Only show this JITM when the specified plugin is inactive OR not installed |
958 | 961 | * |
959 | - * @param $plugin string The path to the plugin |
|
962 | + * @param string $plugin string The path to the plugin |
|
960 | 963 | * |
961 | 964 | * @return $this |
962 | 965 | */ |
@@ -970,7 +973,7 @@ discard block |
||
970 | 973 | * Only show this JITM when the specified plugin is active and installed |
971 | 974 | * Multiple calls are treated as OR: if _any_ of the plugins are active, the rule passes |
972 | 975 | * |
973 | - * @param $plugin string The path to the plugin |
|
976 | + * @param string $plugin string The path to the plugin |
|
974 | 977 | * |
975 | 978 | * @return $this |
976 | 979 | */ |
@@ -983,7 +986,7 @@ discard block |
||
983 | 986 | /** |
984 | 987 | * A rule for a plugin being installed but either active or not active |
985 | 988 | * |
986 | - * @param $plugin string The path to the plugin |
|
989 | + * @param string $plugin string The path to the plugin |
|
987 | 990 | * |
988 | 991 | * @return $this |
989 | 992 | */ |
@@ -996,7 +999,7 @@ discard block |
||
996 | 999 | /** |
997 | 1000 | * A rule to check that a specific plugin is not installed |
998 | 1001 | * |
999 | - * @param $plugin string The path to the plugin |
|
1002 | + * @param string $plugin string The path to the plugin |
|
1000 | 1003 | * |
1001 | 1004 | * @return $this |
1002 | 1005 | */ |
@@ -1009,7 +1012,7 @@ discard block |
||
1009 | 1012 | /** |
1010 | 1013 | * Only show if the user is in the specified role |
1011 | 1014 | * |
1012 | - * @param $role string The role |
|
1015 | + * @param string $role string The role |
|
1013 | 1016 | * |
1014 | 1017 | * @return $this |
1015 | 1018 | */ |
@@ -1087,7 +1090,7 @@ discard block |
||
1087 | 1090 | * |
1088 | 1091 | * The hook to display the content on, such as `admin-notices` |
1089 | 1092 | * |
1090 | - * @param $regex string The message path regex |
|
1093 | + * @param string $regex string The message path regex |
|
1091 | 1094 | * |
1092 | 1095 | * @return $this |
1093 | 1096 | */ |
@@ -1130,7 +1133,7 @@ discard block |
||
1130 | 1133 | /** |
1131 | 1134 | * Set's the priority of this specific jitm if there are any conflicts |
1132 | 1135 | * |
1133 | - * @param $priority int The priority. Higher numbers result in a higher priority |
|
1136 | + * @param integer $priority int The priority. Higher numbers result in a higher priority |
|
1134 | 1137 | * |
1135 | 1138 | * @return $this |
1136 | 1139 | */ |
@@ -1178,7 +1181,7 @@ discard block |
||
1178 | 1181 | /** |
1179 | 1182 | * Set the maximum number of dismissals before this jitm will never be shown again |
1180 | 1183 | * |
1181 | - * @param $times int The maximum number of times to show this message |
|
1184 | + * @param integer $times int The maximum number of times to show this message |
|
1182 | 1185 | * |
1183 | 1186 | * @return $this |
1184 | 1187 | */ |
@@ -1244,7 +1247,6 @@ discard block |
||
1244 | 1247 | /** |
1245 | 1248 | * Sets the ES query to check against the site profile |
1246 | 1249 | * |
1247 | - * @param bool $with_plan |
|
1248 | 1250 | * |
1249 | 1251 | * @return $this |
1250 | 1252 | */ |
@@ -1303,7 +1305,7 @@ discard block |
||
1303 | 1305 | * Limits the JITM to only the provided types. |
1304 | 1306 | * Default: [ 'jetpack' ] (non-Atomic) |
1305 | 1307 | * |
1306 | - * @param array $site_types - can include 'jetpack', 'atomic' |
|
1308 | + * @param string[] $site_types - can include 'jetpack', 'atomic' |
|
1307 | 1309 | * |
1308 | 1310 | * @return $this |
1309 | 1311 | */ |
@@ -1342,7 +1344,7 @@ discard block |
||
1342 | 1344 | /** |
1343 | 1345 | * A rule for a module to be activated |
1344 | 1346 | * |
1345 | - * @param $module string Module slug. |
|
1347 | + * @param string $module string Module slug. |
|
1346 | 1348 | * |
1347 | 1349 | * @return $this |
1348 | 1350 | */ |