readme.md 1.42 KB
Newer Older
Dainis Abols's avatar
Dainis Abols committed
1
2
3
4
5
6
LU Contacts List
=========
Extension to render list of contacts for University of Latvia

## Version

7
4.0.4
Dainis Abols's avatar
Dainis Abols committed
8
9
10

## Dependencies

Dainis Abols's avatar
Dainis Abols committed
11
12
TYPO3 v11+
LU API v3+
Dainis Abols's avatar
Dainis Abols committed
13
14
15

## Inserted Plugin Configuration

Dainis Abols's avatar
Dainis Abols committed
16
17
18
19
20
* Edit contacts url - provide url to edit contacts info
* Single Unit ID - Enter Unit ID to display contacts only for that unit
* Single Address Name - Choose an address to display contacts only in that address
* Mini navigation - Choose to show or not show mini navigation
* Default navigation - Choose what view will be rendered as default
Dainis Abols's avatar
Dainis Abols committed
21

Dainis Abols's avatar
Dainis Abols committed
22
23
24
25
26
27
28
## Template override constants

  ```
  plugin.lu_contacts {
    view.templateRootPath = EXT:lu_contacts/Resources/Private/Templates/
    view.partialRootPath = EXT:lu_contacts/Resources/Private/Partials/
    view.layoutRootPath = EXT:lu_contacts/Resources/Private/Layouts/
Dainis Abols's avatar
Dainis Abols committed
29

Dainis Abols's avatar
Dainis Abols committed
30
31
32
    settings.cssFile = EXT:lu_contacts/Resources/Public/Css/styles.css
  }
  ```
Dainis Abols's avatar
Dainis Abols committed
33

Dainis Abols's avatar
Dainis Abols committed
34
35
## Install requirements

Dainis Abols's avatar
Dainis Abols committed
36
37
38
39
* Check solr data status
* Check LU_API version
* Create frontend templates
* Reconfigure realurl (standard example in Hooks > RealUrlAutoConfiguration)
Dainis Abols's avatar
Dainis Abols committed
40

Dainis Abols's avatar
Dainis Abols committed
41
## Testing
Dainis Abols's avatar
Dainis Abols committed
42

Dainis Abols's avatar
Dainis Abols committed
43
44
45
46
47
48
49
50
```shell
 ./vendor/bin/phpunit  public/typo3conf/ext/lu_contacts/Tests (or /<test-file>)
```
| Test File                      | Assertions |
|--------------------------------|------------|
| Functional/ListSurnameTest.php | 4          |
| Functional/ListAddressTest.php | 4          |
| Functional/ListUnitTest.php    | 5          |
51
| Functional/SearchTest.php      | 4          |