a-blog cms PHP API Reference

SQL_Field_Case extends SQL_Field
in package

Application

SQL

SQLヘルパのメソッド群です。

Properties

$_cases : array<string|int, SQL|string|int|float|null}>
$_else : SQL|string|float|int|null
$_field : SQL_Field|string|int|null
$_scope : string|null
$_simple : SQL|string|null
$_quote : bool
$connection : Connection
$result : mixed

Methods

__construct() : mixed
add() : true: WHEN句とTHEN句を追加する。 $case->add(SQL::newOpr('entry_status', 1, '='), 'open'); WHEN entry_status = 1 THEN 'open'
aliasPlaceholders() : array<string|int, mixed>: SQL文中のプレースホルダーとparamsのキーにprefixをつける
currval() : array{sql: string, params: list|array}: 指定されたsequence fieldの現在のシーケンス番号を返す SQL::currval('entry_id', dsn()) SELECT sequence_entry_id FROM acms_sequence
delete() : array{sql: string, params: list|array}: Where句を指定してDelete句を生成する為のSQL文を返す
dumpSQL() : string: プレースホルダ付きSQLとparams配列から、デバッグ用のSQLを生成する
get() : array{sql: string, params: list|array}: SQL文とパラメータを取得するメソッドです。
getField() : SQL_Field|string|int|null
getParams() : array<string, mixed>: SQL文のパラメータを取得するメソッドです。
getQuote() : bool
getScope() : string|null
getSQL() : string: SQL文を取得するメソッドです。
isClass() : bool: 第一引数の値が特定のクラスのオブジェクトのインスタンスであるかどうかを判定
newBulkInsert() : SQL_BulkInsert: TABLEを指定してINSERT句（バルク）を生成する為のSQL_BulkInsertを返す
newCase() : SQL_Field_Case: CASE文を作成するためのSQL_Field_Caseオブジェクトを生成する $case = SQL::newCase(); $case->add(SQL::newOpr('entry_status', 'draft' '='), '下書き'); $case->add(SQL::newOpr('entry_status', 'open' '='), '公開'); $case->add(SQL::newOpr('entry_status', 'close' '='), '非公開'); $case->setElse('下書き'); CASE WHEN entry_status = 'draft' THEN '下書き' WHEN entry_status = 'open' THEN '公開' WHEN entry_status = 'close' THEN '非公開' ELSE '下書き'
newDelete() : SQL_Delete: TABLEを指定してDELETE句を生成する為のSQL_Deleteを返す
newField() : SQL_Field: SQL_Fieldオブジェクトを生成する SQL::newField('entry_title', 'entry') entry.entry_title
newFunction() : SQL_Field_Function: 関数を生成するためのSQL_Field_Functionオブジェクトを生成する $funcに配列を指定すると、添字0を関数名、添字1以降を関数の引数として渡される SQL::newFunction('entry_title', ['SUBSTR', 0, 10]) SUBSTR(entry_title, 0, 10)
newGeometry() : SQL_Field_Function: SQLのGeometry関数を作成するためのSQL_Field_Functionオブジェクトを生成する
newInsert() : SQL_Insert: TABLEを指定してINSERT句を生成する為のSQL_Insertを返す
newInsertOrUpdate() : SQL_InsertOrUpdate: TABLEを指定してINSERT ON DUPLICATE KEY UPDATE句を生成する為のSQL_InsertOrUpdateを返す
newOpr() : mixed: 演算子を生成するためのSQL_Field_Operatorオブジェクトを生成する SQL::newOpr('entry_id', 1, '>') entry_id > 1
newOprBw() : SQL_Field_Operator_Between<string|int, T>: BETWEEN演算子を作成するためのSQL_Field_Operator_Betweenオブジェクトを生成する SQL::newOprBw('entry_id', 1, 10) entry_id BETWEEN 1 AND 10
newOprExists() : SQL_Field_Operator_Exists: EXISTS演算子を作成するためのSQL_Field_Operator_Existsオブジェクトを生成する SQL::newOprExists(SQL::newSelect('entry')) EXISTS (SELECT * FROM acms_entry)
newOprIn() : SQL_Field_Operator_In: IN演算子を作成するためのSQL_Field_Operator_Inオブジェクトを生成する SQL::newOprIn('entry_id', [1, 2, 3, 4, 5]) entry_id IN (1, 2, 3, 4, 5)
newOprNotExists() : SQL_Field_Operator_Exists: NOT EXISTS演算子を作成するためのSQL_Field_Operator_Existsオブジェクトを生成する SQL::newOprExists(SQL::newSelect('entry')) NOT EXISTS (SELECT * FROM acms_entry)
newOprNotIn() : SQL_Field_Operator_In: NOT IN演算子を作成するためのSQL_Field_Operator_Inオブジェクトを生成する SQL::newOprNotIn('entry_id', [1, 2, 3, 4, 5]) entry_id NOT IN (1, 2, 3, 4, 5)
newReplace() : SQL_Replace: TABLEを指定してREPLACE句を生成する為のSQL_Replaceを返す
newSelect() : SQL_Select: TABLEを指定してSELECT句を生成する為のSQL_Selectを返す
newSeq() : SQL_Sequence: SQL_Sequenceオブジェクトを生成する
newUpdate() : SQL_Update: TABLEを指定してUPDATE句を生成する為のSQL_Updateを返す
newWhere() : SQL_Where: WHERE句を生成するためのSQL_Whereオブジェクトを生成する
nextval() : array{sql: string, params: list|array}: 指定されたsequence fieldのシーケンス番号を１進めてその値を返す SQL::nextval('entry_id', dsn()) UPDATE acms_sequence SET sequence_entry_id = ( LAST_INSERT_ID(sequence_entry_id + 1) )
optimizeSeq() : array{sql: string, params: list|array}: 指定されたsequence fieldのシーケンス番号を最適化する SQL::optimizeSeq('entry_id', dsn()) UPDATE acms_sequence SET sequence_entry_id = ( LAST_INSERT_ID(sequence_entry_id + 1) )
quoteKey() : string: SQL文のキーを安全に引用符で囲むメソッドです。
safePlaceholder() : string: プレースホルダ名を安全に生成する
set() : true: WHEN句とTHEN句を設定する。 $case->add(SQL::newOpr('entry_status', 1, '='), 'open'); WHEN entry_status = 1 THEN 'open'
setConnection() : void: データベース接続を設定するメソッドです。
setElse() : void: ELSE句を設定する。 $case->setElse('draft'); ELSE 'draft'
setField() : true
setQuote() : void
setScope() : true
setSimple() : void: 単純CASE式を設定する。 $case->setSimple('entry_status'); CASE entry_status
setval() : array{sql: string, params: list|array}: 指定されたsequence fieldを指定された値にセットする SQL::setval('entry_id', 10, dsn()) UPDATE acms_sequence SET sequence_entry_id = 10
showTable() : SQL_ShowTable: TABLEを指定してSHOW TABLE句を生成する為のSQL_ShowTableを返す
_case() : array{sql: string, params: list|array}
_field() : string|int|false

$_cases


        public
            array<string|int, SQL|string|int|float|null}>
    $_cases
     = []

$_else


        public
            SQL|string|float|int|null
    $_else
     = \null

$_field


        public
            SQL_Field|string|int|null
    $_field
     = \null

$_scope


        public
            string|null
    $_scope
     = \null

$_simple


        public
            SQL|string|null
    $_simple
     = \null

$_quote


        protected
            bool
    $_quote
     = \true

$connection


        protected
        static    Connection
    $connection
     = \null

$result


        protected
            mixed
    $result
     = \null

__construct()


    public
                    __construct([SQL|null $SQL = null ]) : mixed

Parameters

$SQL : SQL|null = null

add()

WHEN句とTHEN句を追加する。 $case->add(SQL::newOpr('entry_status', 1, '='), 'open'); WHEN entry_status = 1 THEN 'open'


    public
                    add(SQL|string|int|float|null $when, SQL|string|int|float|null $then) : true

Parameters

$when : SQL|string|int|float|null
$then : SQL|string|int|float|null

Return values

true

aliasPlaceholders()

SQL文中のプレースホルダーとparamsのキーにprefixをつける


    public
            static        aliasPlaceholders(string $sql, array<string|int, mixed> $params, string $prefix) : array<string|int, mixed>

Parameters

$sql : string: 元のSQL文
$params : array<string|int, mixed>: 元のパラメータ（:name → 値）
$prefix : string: プレフィックス（例: 'when_0_'）

Return values

array<string|int, mixed> —

[$newSql, $newParams]

currval()

指定されたsequence fieldの現在のシーケンス番号を返す SQL::currval('entry_id', dsn()) SELECT sequence_entry_id FROM acms_sequence


    public
            static        currval(string|SQL_Sequence $seq[, Dsn|null $dsn = null ][, bool $plugin = false ]) : array{sql: string, params: list|array}

Parameters

$seq : string|SQL_Sequence
$dsn : Dsn|null = null
$plugin : bool = false

Return values

array{sql: string, params: list|array}

delete()

Where句を指定してDelete句を生成する為のSQL文を返す


    public
            static        delete(string|null $tb[, SQL_Where|null $w = null ][, Dsn|null $dsn = null ]) : array{sql: string, params: list|array}

未使用のため非推奨

Parameters

$tb : string|null
$w : SQL_Where|null = null
$dsn : Dsn|null = null

Return values

array{sql: string, params: list|array}

dumpSQL()

プレースホルダ付きSQLとparams配列から、デバッグ用のSQLを生成する


    public
            static        dumpSQL(array{sql: string, params: list|array} $query) : string

Parameters

$query : array{sql: string, params: list|array}

Return values

string

get()

SQL文とパラメータを取得するメソッドです。


    public
                    get([mixed $dsn = null ]) : array{sql: string, params: list|array}

Parameters

$dsn : mixed = null

Return values

array{sql: string, params: list|array}

getField()


    public
                    getField() : SQL_Field|string|int|null

Return values

SQL_Field|string|int|null

getParams()

SQL文のパラメータを取得するメソッドです。


    public
                    getParams([Dsn|null $dsn = null ]) : array<string, mixed>

Parameters

$dsn : Dsn|null = null

Return values

array<string, mixed>

getQuote()


    public
                    getQuote() : bool

Return values

bool

getScope()


    public
                    getScope() : string|null

Return values

string|null

getSQL()

SQL文を取得するメソッドです。


    public
                    getSQL([Dsn|null $dsn = null ]) : string

Parameters

$dsn : Dsn|null = null

Return values

string

isClass()

第一引数の値が特定のクラスのオブジェクトのインスタンスであるかどうかを判定


    public
            static        isClass(mixed $obj, T> $className) : bool

Parameters

$obj : mixed
$className : T>

Return values

bool

newBulkInsert()

TABLEを指定してINSERT句（バルク）を生成する為のSQL_BulkInsertを返す


    public
            static        newBulkInsert([string|null $tb = null ]) : SQL_BulkInsert

Parameters

$tb : string|null = null

Return values

SQL_BulkInsert

newCase()

CASE文を作成するためのSQL_Field_Caseオブジェクトを生成する $case = SQL::newCase(); $case->add(SQL::newOpr('entry_status', 'draft' '='), '下書き'); $case->add(SQL::newOpr('entry_status', 'open' '='), '公開'); $case->add(SQL::newOpr('entry_status', 'close' '='), '非公開'); $case->setElse('下書き'); CASE WHEN entry_status = 'draft' THEN '下書き' WHEN entry_status = 'open' THEN '公開' WHEN entry_status = 'close' THEN '非公開' ELSE '下書き'


    public
            static        newCase([SQL|string|null $simple = null ]) : SQL_Field_Case

Parameters

$simple : SQL|string|null = null: 単純CASE文を作成する場合はSQLオブジェクトまたは文字列を指定する

Return values

SQL_Field_Case

newDelete()

TABLEを指定してDELETE句を生成する為のSQL_Deleteを返す


    public
            static        newDelete([string|null $tb = null ]) : SQL_Delete

Parameters

$tb : string|null = null

Return values

SQL_Delete

newField()

SQL_Fieldオブジェクトを生成する SQL::newField('entry_title', 'entry') entry.entry_title


    public
            static        newField(SQL_Field|string|int $fd[, string|null $scp = null ][, bool $quote = true ]) : SQL_Field

Parameters

$fd : SQL_Field|string|int
$scp : string|null = null
$quote : bool = true

Return values

SQL_Field

newFunction()

関数を生成するためのSQL_Field_Functionオブジェクトを生成する $funcに配列を指定すると、添字0を関数名、添字1以降を関数の引数として渡される SQL::newFunction('entry_title', ['SUBSTR', 0, 10]) SUBSTR(entry_title, 0, 10)


    public
            static        newFunction(SQL_Field|string|int|null $fd[, array<string|int, mixed>|string|null $func = null ][, string|null $scp = null ][, bool $quote = true ]) : SQL_Field_Function

$funcに文字列を指定すると、その文字列が関数名として渡される
SQL::newFunction('entry_id', 'COUNT')
COUNT(entry_id)

Parameters

$fd : SQL_Field|string|int|null
$func : array<string|int, mixed>|string|null = null
$scp : string|null = null
$quote : bool = true

Return values

SQL_Field_Function

newGeometry()

SQLのGeometry関数を作成するためのSQL_Field_Functionオブジェクトを生成する


    public
            static        newGeometry(float|string $lat, float|string $lng[, string|null $scp = null ]) : SQL_Field_Function

Parameters

$lat : float|string
$lng : float|string
$scp : string|null = null

Return values

SQL_Field_Function

newInsert()

TABLEを指定してINSERT句を生成する為のSQL_Insertを返す


    public
            static        newInsert([string|null $tb = null ]) : SQL_Insert

Parameters

$tb : string|null = null

Return values

SQL_Insert

newInsertOrUpdate()

TABLEを指定してINSERT ON DUPLICATE KEY UPDATE句を生成する為のSQL_InsertOrUpdateを返す


    public
            static        newInsertOrUpdate([string|null $tb = null ][, string|null $als = null ]) : SQL_InsertOrUpdate

Parameters

$tb : string|null = null
$als : string|null = null

Return values

SQL_InsertOrUpdate

newOpr()

演算子を生成するためのSQL_Field_Operatorオブジェクトを生成する SQL::newOpr('entry_id', 1, '>') entry_id > 1


    public
            static        newOpr(string|SQL_Field $fd[, SQL_Field|string|int|float|null $val = null ][, string $opr = '=' ][, string|null $scp = null ][, array<string|int, mixed>|string|null $func = null ]) : mixed

Parameters

$fd : string|SQL_Field
$val : SQL_Field|string|int|float|null = null
$opr : string = '='
$scp : string|null = null
$func : array<string|int, mixed>|string|null = null

newOprBw()

BETWEEN演算子を作成するためのSQL_Field_Operator_Betweenオブジェクトを生成する SQL::newOprBw('entry_id', 1, 10) entry_id BETWEEN 1 AND 10


    public
            static        newOprBw(string|SQL_Field $fd, T $a, T $b[, string|null $scp = null ][, array<string|int, mixed>|string|null $func = null ]) : SQL_Field_Operator_Between<string|int, T>

Parameters

$fd : string|SQL_Field
$a : T: 文字列（日付型の文字列）または数値
$b : T: 文字列（日付型の文字列）または数値
$scp : string|null = null
$func : array<string|int, mixed>|string|null = null

Return values

SQL_Field_Operator_Between<string|int, T>

newOprExists()

EXISTS演算子を作成するためのSQL_Field_Operator_Existsオブジェクトを生成する SQL::newOprExists(SQL::newSelect('entry')) EXISTS (SELECT * FROM acms_entry)


    public
            static        newOprExists(SQL_Select $val[, string|null $scp = null ]) : SQL_Field_Operator_Exists

Parameters

$val : SQL_Select
$scp : string|null = null

Return values

SQL_Field_Operator_Exists

newOprIn()

IN演算子を作成するためのSQL_Field_Operator_Inオブジェクトを生成する SQL::newOprIn('entry_id', [1, 2, 3, 4, 5]) entry_id IN (1, 2, 3, 4, 5)


    public
            static        newOprIn(string|SQL_Field $fd, array<string|int, mixed>|SQL_Select $val[, string|null $scp = null ][, array<string|int, mixed>|string|null $func = null ]) : SQL_Field_Operator_In

Parameters

$fd : string|SQL_Field
$val : array<string|int, mixed>|SQL_Select
$scp : string|null = null
$func : array<string|int, mixed>|string|null = null

Return values

SQL_Field_Operator_In

newOprNotExists()

NOT EXISTS演算子を作成するためのSQL_Field_Operator_Existsオブジェクトを生成する SQL::newOprExists(SQL::newSelect('entry')) NOT EXISTS (SELECT * FROM acms_entry)


    public
            static        newOprNotExists(SQL_Select $val[, string|null $scp = null ]) : SQL_Field_Operator_Exists

Parameters

$val : SQL_Select
$scp : string|null = null

Return values

SQL_Field_Operator_Exists

newOprNotIn()

NOT IN演算子を作成するためのSQL_Field_Operator_Inオブジェクトを生成する SQL::newOprNotIn('entry_id', [1, 2, 3, 4, 5]) entry_id NOT IN (1, 2, 3, 4, 5)


    public
            static        newOprNotIn(string|SQL_Field $fd, array<string|int, mixed>|SQL_Select $val[, string|null $scp = null ][, array<string|int, mixed>|string|null $func = null ]) : SQL_Field_Operator_In

Parameters

$fd : string|SQL_Field
$val : array<string|int, mixed>|SQL_Select
$scp : string|null = null
$func : array<string|int, mixed>|string|null = null

Return values

SQL_Field_Operator_In

newReplace()

TABLEを指定してREPLACE句を生成する為のSQL_Replaceを返す


    public
            static        newReplace([string|null $tb = null ]) : SQL_Replace

Parameters

$tb : string|null = null

Return values

SQL_Replace

newSelect()

TABLEを指定してSELECT句を生成する為のSQL_Selectを返す


    public
            static        newSelect([SQL_Select|SQL_Field|string|null $tb = null ][, string|null $als = null ][, bool $straight_join = false ]) : SQL_Select

Parameters

$tb : SQL_Select|SQL_Field|string|null = null
$als : string|null = null
$straight_join : bool = false

Return values

SQL_Select

newSeq()

SQL_Sequenceオブジェクトを生成する


    public
            static        newSeq(string $seq[, "nextval"|"currval"|"setval"|"optimize" $method = 'nextval' ][, int|null $val = null ]) : SQL_Sequence

Parameters

$seq : string: シーケンス名例: entry_id, blog_id, category_id, user_id
$method : "nextval"|"currval"|"setval"|"optimize" = 'nextval': メソッド名例: nextval, currval, setval, optimize
$val : int|null = null

Return values

SQL_Sequence

newUpdate()

TABLEを指定してUPDATE句を生成する為のSQL_Updateを返す


    public
            static        newUpdate([string|null $tb = null ]) : SQL_Update

Parameters

$tb : string|null = null

Return values

SQL_Update

newWhere()

WHERE句を生成するためのSQL_Whereオブジェクトを生成する


    public
            static        newWhere() : SQL_Where

Return values

SQL_Where

nextval()

指定されたsequence fieldのシーケンス番号を１進めてその値を返す SQL::nextval('entry_id', dsn()) UPDATE acms_sequence SET sequence_entry_id = ( LAST_INSERT_ID(sequence_entry_id + 1) )


    public
            static        nextval(string|SQL_Sequence $seq[, Dsn|null $dsn = null ][, mixed $plugin = false ]) : array{sql: string, params: list|array}

Parameters

$seq : string|SQL_Sequence
$dsn : Dsn|null = null
$plugin : mixed = false

Return values

array{sql: string, params: list|array}

optimizeSeq()

指定されたsequence fieldのシーケンス番号を最適化する SQL::optimizeSeq('entry_id', dsn()) UPDATE acms_sequence SET sequence_entry_id = ( LAST_INSERT_ID(sequence_entry_id + 1) )


    public
            static        optimizeSeq(string|SQL_Sequence $seq[, Dsn|null $dsn = null ][, bool $plugin = false ]) : array{sql: string, params: list|array}

Parameters

$seq : string|SQL_Sequence
$dsn : Dsn|null = null
$plugin : bool = false

Return values

array{sql: string, params: list|array}

quoteKey()

SQL文のキーを安全に引用符で囲むメソッドです。


    public
            static        quoteKey(string $key) : string

Parameters

$key : string

Return values

string

safePlaceholder()

プレースホルダ名を安全に生成する


    public
            static        safePlaceholder(string $keyName[, string|null $suffix = null ]) : string

Parameters

$keyName : string: 任意のキー名（例: 'user-id.1'）
$suffix : string|null = null: 一意性のための接尾語（例: '0'）

Return values

string

set()

WHEN句とTHEN句を設定する。 $case->add(SQL::newOpr('entry_status', 1, '='), 'open'); WHEN entry_status = 1 THEN 'open'


    public
                    set([SQL|string|int|float|null $when = null ][, SQL|string|int|float|null $then = null ]) : true

Parameters

$when : SQL|string|int|float|null = null
$then : SQL|string|int|float|null = null

Return values

true

setConnection()

データベース接続を設定するメソッドです。


    public
            static        setConnection(Connection $connection) : void

Parameters

$connection : Connection

setElse()

ELSE句を設定する。 $case->setElse('draft'); ELSE 'draft'


    public
                    setElse(SQL|string|int|float|null $exp) : void

Parameters

$exp : SQL|string|int|float|null

setField()


    public
                    setField(SQL_Field|string|int|null $fd) : true

Parameters

$fd : SQL_Field|string|int|null

Return values

true

setQuote()


    public
                    setQuote(bool $quote) : void

Parameters

$quote : bool

setScope()


    public
                    setScope(string|null $scp) : true

Parameters

$scp : string|null

Return values

true

setSimple()

単純CASE式を設定する。 $case->setSimple('entry_status'); CASE entry_status


    public
                    setSimple(SQL|string|null $exp) : void

Parameters

$exp : SQL|string|null

setval()

指定されたsequence fieldを指定された値にセットする SQL::setval('entry_id', 10, dsn()) UPDATE acms_sequence SET sequence_entry_id = 10


    public
            static        setval(string|SQL_Sequence $seq, int $val[, Dsn|null $dsn = null ][, bool $plugin = false ]) : array{sql: string, params: list|array}

Parameters

$seq : string|SQL_Sequence
$val : int
$dsn : Dsn|null = null
$plugin : bool = false

Return values

array{sql: string, params: list|array}

showTable()

TABLEを指定してSHOW TABLE句を生成する為のSQL_ShowTableを返す


    public
            static        showTable([string|null $tb = null ]) : SQL_ShowTable

Parameters

$tb : string|null = null

Return values

SQL_ShowTable

_case()


    protected
                    _case([Dsn|null $dsn = null ]) : array{sql: string, params: list|array}

Parameters

$dsn : Dsn|null = null

Return values

array{sql: string, params: list|array}

_field()


    protected
                    _field([Dsn|null $dsn = null ]) : string|int|false

Parameters

$dsn : Dsn|null = null

Return values

string|int|false

SQL_Field_Case extends SQL_Field in package Application

Table of Contents

Properties

Methods

Properties

$_cases

$_else

$_field

$_scope

$_simple

$_quote

$connection

$result

Methods

__construct()

Parameters

add()

Parameters

Return values

aliasPlaceholders()

Parameters

Return values

currval()

Parameters

Tags

Return values

delete()

Parameters

Return values

dumpSQL()

Parameters

Return values

get()

Parameters

Tags

Return values

getField()

Return values

getParams()

Parameters

Return values

getQuote()

Return values

getScope()

Return values

getSQL()

Parameters

Return values

isClass()

Parameters

Tags

Return values

newBulkInsert()

Parameters

Tags

Return values

newCase()

Parameters

Return values

newDelete()

Parameters

Tags

Return values

newField()

Parameters

Return values

newFunction()

Parameters

Return values

newGeometry()

Parameters

Return values

newInsert()

Parameters

Tags

Return values

newInsertOrUpdate()

Parameters

Tags

Return values

SQL_Field_Case extends SQL_Field
in package

Application