Project
Version
Language
Contributors Edit (2024/11/23)
Avatar

MVCウェブサイト開発の基礎

このドキュメントでは、Dignite Cmsに基づくMVCウェブサイトの開発の基本的な知識を紹介します。

公開アプリケーション層

ISiteSettingsPublicAppService

API

  • Task<string> GetDefaultLanguageAsync()

    ウェブサイトのデフォルト言語を取得します。

  • Task<IEnumerable<string>> GetAllLanguagesAsync()

    ウェブサイトの全ての言語を取得します。

  • Task<BrandDto> GetBrandAsync()

    ウェブサイトのブランド情報を取得します。

    Dignite.Cms.Web.Host\CmsBrandingProvider.cs ファイルは、ウェブサイトのブランド情報の取得方法を示しています。

IFieldPublicAppService

API

  • Task<FieldDto> FindByNameAsync(string name):

    名前によってフィールドを検索します。見つかった場合はフィールド情報を返し、それ以外の場合は null を返します。

FieldDto のプロパティ

  • Id: フィールドの一意の識別子です。
  • Name: フィールドの一意の名前です。
  • DisplayName: フィールドの表示名です。
  • Description: フィールドの説明です。
  • FormControlName: フィールドコントロールの名前です。
  • FormConfiguration: フィールドコントロールの構成です。

ISectionPublicAppService

API

  • Task<SectionDto> GetAsync(Guid id):

    IDによってセクション情報を取得します。見つかった場合はセクション情報を返し、それ以外の場合は例外をスローします。

  • Task<SectionDto> FindByNameAsync(string name):

    セクション名からセクションを検索し、見つかればセクション情報を返し、見つからなければ null を返す。

  • Task<SectionDto> FindByRouteAsync(string route):

    移動先のUrl (つまり、エントリーのUrlにマッチするセクション)に基づいてセクションを検索し、見つかればそのセクション情報を返し、見つからなければ null を返す。

  • Task<SectionDto> GetDefaultAsync():

    デフォルトのセクションを取得する。

SectionDto のプロパティ

  • Id: セクションの一意の識別子です。
  • Name: セクションの一意の名前です。
  • DisplayName: セクションの表示名です。
  • IsActive: セクションがアクティブかどうかを示します。
  • Type: セクションのタイプ（詳細については Sections を参照してください）。
  • Route: セクションの下のエントリのURLルートです。
  • Template: エントリを表示するためのビューテンプレートです。
  • EntryTypes: セクション内のエントリタイプのリストです。

SectionDto の

拡張メソッド

  • FieldDto GetField(Guid entryTypeId, string name): 指定された名前のフィールドを取得します。

IEntryPublicAppService

API

  • Task<EntryDto> FindBySlugAsync(FindBySlugInput input):

    スラッグによってエントリを検索します。見つかった場合はエントリ情報を返し、それ以外の場合は null を返します。

    input パラメータには、次の3つのクエリ条件が含まれます：

    • SectionId: セクションID（必須）。
    • Slug: エントリのスラッグ（必須）。
    • Culture: エントリのカルチャ。デフォルト値はサイトのデフォルト言語です。

  • Task<EntryDto> GetAsync(Guid id):

    IDによってエントリを取得します。見つかった場合はエントリ情報を返し、それ以外の場合は例外をスローします。

  • Task<EntryDto> FindPrevAsync(Guid id):

    指定された id より前に公開された前のエントリを検索します。見つかった場合はエントリ情報を返し、それ以外の場合は null を返します。

  • Task<EntryDto> FindNextAsync(Guid id):

    指定された id より後に公開された次のエントリを検索します。見つかった場合はエントリ情報を返し、それ以外の場合は null を返します。

  • Task<PagedResultDto<EntryDto>> GetListAsync(GetEntriesInput input):

    指定された条件を満たすエントリのリストを取得します。

    input パラメータには、次のクエリ条件が含まれます：

    • SectionId: セクションID（必須）。
    • Culture: エントリのカルチャ。デフォルト値はサイトのデフォルト言語です。
    • EntryTypeId: エントリタイプID。
    • CreatorId: 作成者のID。
    • StartPublishDate: 開始公開日。
    • ExpiryPublishDate: 有効期限公開日。
    • Filter: エントリタイトルのフィルタ文字列。
    • QueryingByFieldsJson: フィールド値によるエントリのクエリ（詳細については Advanced Development を参照してください）。

    上記の条件に基づいてエントリをクエリするだけでなく、エントリID配列でリストをクエリすることもサポートされています：

    • SectionId: 指定されたセクションID（必須）。
    • EntryIds: 指定されたエントリIDまたはID。

EntryDto のプロパティ

  • Id: エントリの一意の識別子です。
  • CreatorId: 作成者の一意の識別子です。
  • SectionId: エントリが所属するセクションの一意の識別子です。
  • EntryTypeId: エントリのタイプの一意の識別子です。
  • Culture: エントリの文化的な領域です。
  • Title: エントリのタイトルです。
  • Slug: エントリのスラッグです。
  • ParentId: 親エントリの一意の識別子です。
  • Order: セクション内のエントリの順序です。
  • Status: エントリの公開状態です。Draft および Published を含みます。
  • PublishTime: エントリの公開時刻です。
  • IsActivatedVersion: エントリのアクティブ化バージョンであるかどうかを示します。

EntryDto の拡張メソッド

  • GetUrl(SectionDto section): エントリのURLを取得します。

MVCコントローラ

EntryController

EntryController には、次のアクションが含まれています：

  • HomePage()

    デフォルトセクションのスラッグ Index に一致するエントリを検索し、 EntryViewModel ビューモデルをテンプレートページに渡します。

    たとえば、クイックスタート の Home Page セクションでは、 https://localhost:44339 にアクセスすると、 Home Page セクションの下の言語が en でスラッグが index のエントリが取得され、 /Views/Entry/HomePage.cshtml ビューを使用してページがレンダリングされます。

  • EntryPageWithCulture(string culture, string route)

    指定された Culture と一致する route 値のエントリを検索し、 EntryViewModel ビューモデルをテンプレートページに渡します。

    たとえば、クイックスタート の Blog Post セクションでは、 https://localhost:44339/ja/blog/2024/03/first-blog-post にアクセスすると、言語が ja でスラッグが first-blog-post のエントリが取得され、 Entry/Blog/Entry.cshtml ビューを使用してページがレンダリングされます。

  • EntryPage(string route)

    一致する route 値のエント

リを検索し、 EntryViewModel ビューモデルをテンプレートページに渡します。

たとえば、クイックスタート の Blog Home セクションでは、 https://localhost:44339/blog にアクセスすると、言語が en でスラッグが index のエントリが取得され、 Entry/Blog/Index.cshtml ビューを使用してページがレンダリングされます。

EntryViewModel クラスには、次の2つのプロパティが含まれています：

  • Entry: EntryDto 型のエントリです。
  • Section: SectionDto 型のセクションです。

ローカライゼーション

Dignite Cms Mvcウェブサイトは、テナントごとに独立したローカライゼーションをサポートしています。ローカライゼーションリソースを格納するために CmsPublicWebResource.{culture}.json ファイルを使用します。

テナントのローカライゼーションリソースファイルは、 /Tenants/{TenantName}/Localization/ ディレクトリに格納されています：

テナントのローカライゼーションリソースファイル

マルチテナントローカライゼーション機能の使用方法についての情報については、マルチテナントローカライゼーション ドキュメントを参照してください。

ビューコンポーネント

ローカライゼーションスイッチコンポーネント

CultureSwitchViewComponent コンポーネントは、ローカライゼーションを切り替えるために使用されます。

ローカライゼーションスイッチコンポーネント

IToolbarContributor インターフェースを実装するクラスを作成し、次のコードを追加します：

public class CmsWebHostToolbarContributor : IToolbarContributor
{
    public virtual Task ConfigureToolbarAsync(IToolbarConfigurationContext context)
    {
        if (context.Toolbar.Name != StandardToolbars.Main)
        {
            return Task.CompletedTask;
        }

        context.Toolbar.Items.Add(new ToolbarItem(typeof(CultureSwitchViewComponent)));

        return Task.CompletedTask;
    }
}

モジュールクラスの ConfigureServices メソッドに次のコードを追加します：

Configure<AbpToolbarOptions>(options =>
{
    options.Contributors.Add(new CmsWebHostToolbarContributor());
});
InThisDocument