Omelet Reference(Draft) 1

設定

  • \Omelet\Build\Configuration クラス
    • データベース接続先などの、共通設定情報を格納する。

プロパティ

  • daoClassPath

    • DAO (Data Access Object)の具象実装クラスが保存されるディレクトリまでのパスを指定する。
    • 文字列
    • 規定値：auto_generated

  • sqlRootDir

    • SQLが置かれているルートのディレクトリまでのパスを指定する。
    • 文字列
    • 規定値：sql

  • daoClassSuffix

    • DAOの具象実装クラス名のサフィックスとして付与する文字列。
    • 文字列
    • 規定値： Impl
    • 例： TodoDao -> TodoDaoImpl

  • connectionString

    • データベースの接続情報
    • 文字列

  • watchMode = 'Whenever';

    • 作成タイミングの指定
      • Always , Whenever , Once のいずれかを指定する。
        • Always：DAOインターフェースの変更の有無に関わらず、毎回実装クラスを作成する。
        • Whenever：初回または、DAOインターフェースの内容が変更した場合のみ、実装クラスを再作成する。
        • Once：初回に一度だけ、実装クラスを作成する
    • 文字列
    • 規定値：Whenever

  • paramCaseSensor

    • SQLで使用するパラメータ名の命名規則
    • 例えば、DAOメソッドの引数をキャメルケースで定義し、設定を UpperSnake にした場合、アルファベット大文字のスネークケースに変換する。
      • LowerSnake , UpperSnake , LowerCamel , UpperCamel のいずれかを指定する。
        • LowerSnake
          • アルファベット小文字で単語間を アンダースコア文字(_) でつなぐ。
        • UpperSnake
          • アルファベット大文字で単語間を アンダースコア文字(_) でつなぐ。
        • LowerCamel
          • 先頭の単語を除いて、２番目以降の単語の１文字目を大文字にしてそのままつなげる。
          • 元の規則がスネークケースの場合、アンダースコア文字は取り除かれることに注意。
        • UpperCamel
          • 単語の１文字目を大文字にしてそのままつなげる。
          • 元の規則がスネークケースの場合、アンダースコア文字は取り除かれることに注意。
    • 文字列
    • 規定値： LowerSnake

  • returnCaseSensor = 'LowerSnake';

    • クエリ実行により得られる結果セットの列名の命名規則
    • 結果をオブジェクト(エンティティクラス)やドメインに詰め替える際、命名規則の変換が適用される。
      • LowerSnake , UpperSnake , LowerCamel , UpperCamel のいずれかを指定する。
      • それぞれの値の意味は、 paramCaseSensor と同じ
    • 文字列
    • 規定値： LowerSnake
omelet, orm, php