DreamineWeb.Services.SiteSettingsService 클래스 참조

더 자세히 ...

DreamineWeb.Services.SiteSettingsService에 대한 협력 다이어그램:

Public 멤버 함수
	SiteSettingsService (DreamineOptions opts)
async Task	SaveAsync (SiteSettings settings)

속성
SiteSettings	Current [get]

정적 Private 멤버 함수
static SiteSettings	DefaultFrom (DreamineOptions opts)

Private 속성
SiteSettings	_settings
readonly string	_filePath

정적 Private 속성
static readonly JsonSerializerOptions	_json = new() { WriteIndented = true }

상세한 설명

Site Settings Service 기능과 관련 상태를 캡슐화합니다.

SiteSettingsService.cs 파일의 15 번째 라인에서 정의되었습니다.

생성자 & 소멸자 문서화

SiteSettingsService()

DreamineWeb.Services.SiteSettingsService.SiteSettingsService ( DreamineOptions opts )

inline

지정한 설정으로 SiteSettingsService 클래스의 새 인스턴스를 초기화합니다.

매개변수

opts	opts에 사용할 DreamineOptions 값입니다.

SiteSettingsService.cs 파일의 72 번째 라인에서 정의되었습니다.

    {
        _filePath = Path.Combine(opts.ResolvedDataPath, "site_settings.json");
 
        var defaults = DefaultFrom(opts);
        if (File.Exists(_filePath))
        {
            try
            {
                var loaded = JsonSerializer.Deserialize<SiteSettings>(File.ReadAllText(_filePath));
                if (loaded is null)
                {
                    _settings = defaults;
                }
                else
                {
                    // 저장된 파일에 없는 필드는 기본값으로 채움
                    loaded.OgImageUrl  = string.IsNullOrEmpty(loaded.OgImageUrl)  ? defaults.OgImageUrl  : loaded.OgImageUrl;
                    loaded.OgSiteName  = string.IsNullOrEmpty(loaded.OgSiteName)  ? defaults.OgSiteName  : loaded.OgSiteName;
                    loaded.OgUrl       = string.IsNullOrEmpty(loaded.OgUrl)       ? defaults.OgUrl       : loaded.OgUrl;
                    loaded.TwitterCard = string.IsNullOrEmpty(loaded.TwitterCard) ? defaults.TwitterCard : loaded.TwitterCard;
                    _settings = loaded;
                }
            }
            catch { _settings = defaults; }
        }
        else
        {
            _settings = defaults;
        }
    }

다음을 참조함 : _filePath, _settings, DefaultFrom(), DreamineWeb.Models.DreamineOptions.ResolvedDataPath.

이 함수 내부에서 호출하는 함수들에 대한 그래프입니다.:

멤버 함수 문서화

DefaultFrom()

SiteSettings DreamineWeb.Services.SiteSettingsService.DefaultFrom ( DreamineOptions opts )

inlinestaticprivate

Default From 작업을 수행합니다.

매개변수

opts	opts에 사용할 DreamineOptions 값입니다.

반환값

Default From 작업에서 생성한 SiteSettings 결과입니다.

SiteSettingsService.cs 파일의 159 번째 라인에서 정의되었습니다.

                                                                  => new()
    {
        Title = opts.SiteTitle,
        Description = opts.SiteDescription,
        IconUrl = string.Empty,
        GitHubUrl = opts.GitHubOrgUrl
    };

다음을 참조함 : DreamineWeb.Models.DreamineOptions.SiteDescription, DreamineWeb.Models.DreamineOptions.SiteTitle.

다음에 의해서 참조됨 : SiteSettingsService().

이 함수를 호출하는 함수들에 대한 그래프입니다.:

SaveAsync()

async Task DreamineWeb.Services.SiteSettingsService.SaveAsync ( SiteSettings settings )

inline

Async 데이터를 저장합니다.

매개변수

settings

settings에 사용할 SiteSettings 값입니다.

반환값

Save Async 작업에서 생성한 Task 결과입니다.

SiteSettingsService.cs 파일의 128 번째 라인에서 정의되었습니다.

    {
        _settings = settings;
        Directory.CreateDirectory(Path.GetDirectoryName(_filePath)!);
        await File.WriteAllTextAsync(_filePath, JsonSerializer.Serialize(settings, _json));
    }

다음을 참조함 : _filePath, _json, _settings.

멤버 데이터 문서화

_filePath

readonly string DreamineWeb.Services.SiteSettingsService._filePath

private

file Path 값을 보관합니다.

SiteSettingsService.cs 파일의 34 번째 라인에서 정의되었습니다.

다음에 의해서 참조됨 : SaveAsync(), SiteSettingsService().

_json

readonly JsonSerializerOptions DreamineWeb.Services.SiteSettingsService._json = new() { WriteIndented = true }

staticprivate

json 값을 보관합니다.

SiteSettingsService.cs 파일의 44 번째 라인에서 정의되었습니다.

{ WriteIndented = true };

다음에 의해서 참조됨 : SaveAsync().

_settings

SiteSettings DreamineWeb.Services.SiteSettingsService._settings

private

settings 값을 보관합니다.

SiteSettingsService.cs 파일의 25 번째 라인에서 정의되었습니다.

다음에 의해서 참조됨 : SaveAsync(), SiteSettingsService().

속성 문서화

Current

SiteSettings DreamineWeb.Services.SiteSettingsService.Current

get

Current 값을 가져옵니다.

SiteSettingsService.cs 파일의 54 번째 라인에서 정의되었습니다.

---

이 클래스에 대한 문서화 페이지는 다음의 파일로부터 생성되었습니다.:

• SiteSettingsService.cs