| Index: trunk/extensions/SemanticWatchlist/specials/SpecialWatchlistConditions.php |
| — | — | @@ -120,8 +120,8 @@ |
| 121 | 121 | } |
| 122 | 122 | |
| 123 | 123 | /** |
| | 124 | + * Creates and returns the HTML for a single watchlist group. |
| 124 | 125 | * |
| 125 | | - * |
| 126 | 126 | * @since 0.1 |
| 127 | 127 | * |
| 128 | 128 | * @param SWLGroup $group |
| Index: trunk/extensions/SemanticWatchlist/includes/SWL_Group.php |
| — | — | @@ -13,18 +13,70 @@ |
| 14 | 14 | */ |
| 15 | 15 | class SWLGroup { |
| 16 | 16 | |
| | 17 | + /** |
| | 18 | + * The ID of the group; the group_id field in swl_groups. |
| | 19 | + * When creating a new group, this will be null, and |
| | 20 | + * automatically set after writing the group to the DB. |
| | 21 | + * |
| | 22 | + * @since 0.1 |
| | 23 | + * |
| | 24 | + * @var integer or null |
| | 25 | + */ |
| 17 | 26 | protected $id; |
| 18 | 27 | |
| | 28 | + /** |
| | 29 | + * Name of the group. |
| | 30 | + * |
| | 31 | + * @since 0.1 |
| | 32 | + * |
| | 33 | + * @var string |
| | 34 | + */ |
| 19 | 35 | protected $name; |
| 20 | 36 | |
| | 37 | + /** |
| | 38 | + * List of categories this group covers. |
| | 39 | + * |
| | 40 | + * @since 0.1 |
| | 41 | + * |
| | 42 | + * @var array of string |
| | 43 | + */ |
| 21 | 44 | protected $categories; |
| 22 | 45 | |
| | 46 | + /** |
| | 47 | + * List of namespaces IDs of namespaces this group covers. |
| | 48 | + * |
| | 49 | + * @since 0.1 |
| | 50 | + * |
| | 51 | + * @var array of integer |
| | 52 | + */ |
| 23 | 53 | protected $namespaces = array(); |
| 24 | 54 | |
| | 55 | + /** |
| | 56 | + * List of SMW properties this group covers. |
| | 57 | + * |
| | 58 | + * @since 0.1 |
| | 59 | + * |
| | 60 | + * @var array of string |
| | 61 | + */ |
| 25 | 62 | protected $properties; |
| 26 | 63 | |
| | 64 | + /** |
| | 65 | + * List of SMW concepts this group covers. |
| | 66 | + * |
| | 67 | + * @since 0.1 |
| | 68 | + * |
| | 69 | + * @var array of string |
| | 70 | + */ |
| 27 | 71 | protected $concepts; |
| 28 | 72 | |
| | 73 | + /** |
| | 74 | + * Cached list of IDs of users that are watching this group, |
| | 75 | + * or false if this data has not been obtained yet. |
| | 76 | + * |
| | 77 | + * @since 0.1 |
| | 78 | + * |
| | 79 | + * @var array of integer or false |
| | 80 | + */ |
| 29 | 81 | protected $watchingUsers = false; |
| 30 | 82 | |
| 31 | 83 | /** |
| — | — | @@ -52,7 +104,7 @@ |
| 53 | 105 | * |
| 54 | 106 | * @since 0.1 |
| 55 | 107 | * |
| 56 | | - * @param integer $id Can be null for new groups |
| | 108 | + * @param integer $id Set to null when creating a new group. |
| 57 | 109 | * @param string $name |
| 58 | 110 | * @param array $categories List of category names |
| 59 | 111 | * @param array $namespaces List of namespace names or IDs |
| Index: trunk/extensions/SemanticWatchlist/includes/SWL_Groups.php |
| — | — | @@ -110,23 +110,5 @@ |
| 111 | 111 | } |
| 112 | 112 | } |
| 113 | 113 | } |
| 114 | | - |
| 115 | | - /** |
| 116 | | - * Determines and returns if a certain user should be notified of changes |
| 117 | | - * or not (in case this already happened, so this extension doesn't spam). |
| 118 | | - * |
| 119 | | - * @since 0.1 |
| 120 | | - * |
| 121 | | - * @param integer $userId |
| 122 | | - * |
| 123 | | - * @return boolean |
| 124 | | - */ |
| 125 | | - protected static function userShouldBeNotified( $userId ) { |
| 126 | | - |
| 127 | | - } |
| 128 | | - |
| 129 | | - protected static function notifyUserOfChangesToGroup( $userId, $group, SMWSemanticData $data ) { |
| 130 | | - |
| 131 | | - } |
| 132 | 114 | |
| 133 | 115 | } |