Merge pull request #3850 from FinnStutzenstein/config

ConfigService
This commit is contained in:
Finn Stutzenstein 2018-09-04 14:44:14 +02:00 committed by GitHub
commit 753f5f2175
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 104 additions and 7 deletions

View File

@ -0,0 +1,15 @@
import { TestBed, inject } from '@angular/core/testing';
import { ConfigService } from './config.service';
describe('ConfigService', () => {
beforeEach(() => {
TestBed.configureTestingModule({
providers: [ConfigService]
});
});
it('should be created', inject([ConfigService], (service: ConfigService) => {
expect(service).toBeTruthy();
}));
});

View File

@ -0,0 +1,75 @@
import { Injectable } from '@angular/core';
import { OpenSlidesComponent } from 'app/openslides.component';
import { Observable, BehaviorSubject } from 'rxjs';
import { Config } from '../../shared/models/core/config';
/**
* Handler for config variables.
*
* @example
* ```ts
* this.configService.get('general_event_name').subscribe(value => {
* console.log(value);
* });
* ```
*
* @example
* ```ts
* const value = this.configService.instant('general_event_name');
* ```
*/
@Injectable({
providedIn: 'root'
})
export class ConfigService extends OpenSlidesComponent {
/**
* Stores a subject per key. Values are published, if the DataStore gets an update.
*/
private configSubjects: { [key: string]: BehaviorSubject<any> } = {};
/**
* Listen for changes of config variables.
*/
public constructor() {
super();
this.DS.getObservable().subscribe(data => {
// on changes notify the observers for specific keys.
if (data instanceof Config && this.configSubjects[data.key]) {
this.configSubjects[data.key].next(data.value);
}
});
}
/**
* Get the constant named by key from the DataStore. If the DataStore isn't up to date or
* not filled via autoupdates the results may be wrong/empty. Use this with caution.
*
* Usefull for synchronos code, e.g. during generation of PDFs, when the DataStore is filled.
*
* @param key The config value to get from.
*/
public instant(key: string): any {
const values = this.DS.filter<Config>('core/config', value => value.key === key);
if (values.length > 1) {
throw new Error('More keys found then expected');
} else if (values.length === 1) {
return values[0].value;
} else {
return;
}
}
/**
* Get an observer for the config value given by the key.
*
* @param key The config value to get from.
*/
public get(key: string): Observable<any> {
if (!this.configSubjects[key]) {
this.configSubjects[key] = new BehaviorSubject<any>(this.instant(key));
}
return this.configSubjects[key].asObservable();
}
}

View File

@ -227,7 +227,7 @@ export class DataStoreService {
public filter<T extends BaseModel>(
collectionType: ModelConstructor | string,
callback: (model: T) => boolean
): BaseModel[] {
): T[] {
return this.getAll<T>(collectionType).filter(callback);
}

View File

@ -4,10 +4,7 @@
<mat-card class="os-card on-transition-fade">
<div>
<div class='legal-notice-text'>
<a href="https://openslides.org/">OpenSlides</a> ist ein freies, webbasiertes Präsentations- und Versammlungssystem zur Darstellung und Steuerung
von Tagesordnung, Anträgen und Wahlen einer Versammlung.
</div>
<div class='legal-notice-text' [innerHtml]='legalNotice'></div>
<mat-divider></mat-divider>
<div class='version-text'>
OpenSlides 3.0 PRE ALPHA (Lizenz: MIT)

View File

@ -1,4 +1,6 @@
import { Component, OnInit } from '@angular/core';
import { ConfigService } from '../../core/services/config.service';
import { TranslateService } from '@ngx-translate/core';
@Component({
selector: 'os-legal-notice',
@ -6,7 +8,15 @@ import { Component, OnInit } from '@angular/core';
styleUrls: ['./legal-notice.component.scss']
})
export class LegalNoticeComponent implements OnInit {
public constructor() {}
public legalNotice: string;
public ngOnInit() {}
public constructor(private configService: ConfigService, private translate: TranslateService) {}
public ngOnInit() {
this.configService.get('general_event_legal_notice').subscribe(value => {
if (value) {
this.legalNotice = this.translate.instant(value);
}
});
}
}