| Index: trunk/extensions/Wikidata/OmegaWiki/ViewInformation.php |
| — | — | @@ -1,5 +1,16 @@ |
| 2 | 2 | <?php |
| 3 | 3 | |
| | 4 | +/** |
| | 5 | + * ViewInformation is used to capture various settings that influence the way a page will be viewed |
| | 6 | + * depending on different use case scenarios. For instance, by specifying a filterLanguageId a page |
| | 7 | + * with be filtered entirely on one language, collapsing record sets to records where appropiate. |
| | 8 | + * |
| | 9 | + * A ViewInformation can be constructed based on various conditions. The language filtering for instance |
| | 10 | + * could be an application wide setting, or a setting that can be controlled by the user. Functions that |
| | 11 | + * use ViewInformation do not care about this. They are supposed to respect the settings provided wherever |
| | 12 | + * possible. |
| | 13 | + */ |
| | 14 | + |
| 4 | 15 | class ViewInformation { |
| 5 | 16 | public $filterLanguageId; |
| 6 | 17 | public $possiblySynonymousRelationTypeId; |