baserCMS クラスリファレンス

MaildataHelper extends BcTextHelper
in package

メールデータヘルパー

Attributes
#[AllowDynamicProperties]

Table of Contents

Properties

$BcBaser  : BcBaserHelper
$helpers  : array<string|int, string>
ヘルパー
$_View  : View
View

Methods

age()  : mixed
日付より年齢を取得する
arrayValue()  : mixed
配列とキーを指定して値を取得する
arrayValues()  : string
連想配列とキーのリストより値のリストを取得し文字列で返す 文字列に結合する際、指定した結合文字を指定できる
booleanAllow()  : string
boolean型のデータを可、不可で出力
booleanAllowList()  : array<string|int, mixed>
boolean型用のリストを可、不可で出力
booleanDo()  : string
boolean型のデータを [〜する / 〜しない] 形式で出力する
booleanDoList()  : array<string|int, mixed>
boolean型用のリストを[〜する/〜しない]形式で出力する
booleanExists()  : string
boolean型用を有無で出力
booleanExistsList()  : array<string|int, mixed>
boolean型用のリストを「有」「無」で出力
booleanMark()  : string
boolean型を ○ または ― マークで出力
booleanMarkList()  : array<string|int, mixed>
boolean型用のリストを ○ ― マークで出力
booleanStatus()  : string
boolean型用を無効・有効で出力
booleanStatusList()  : array<string|int, mixed>
boolean型用のリストを有効、無効で出力
control()  : string
メール表示用のデータを出力する ※互換性維持用
dateTime()  : string
配列形式の日付データを文字列データに変換する
dispatchLayerEvent()  : bool|Event
イベントを発火
format()  : string
文字をフォーマット形式で出力し、値が存在しない場合は初期値を出力する
listValue()  : string
モデルのコントロールソースより表示用データを取得する
moneyFormat()  : string
通貨表示
noValue()  : mixed
データをチェックして空の場合に指定した値を返す
pref()  : string
番号を都道府県に変換して出力
prefList()  : array<string|int, mixed>
都道府県のリストを出力
sex()  : string
性別を出力
toDisplayString()  : string
メール表示用のデータを出力する
zipFormat()  : string
郵便番号にハイフンをつけて出力

Properties

$helpers

ヘルパー

public array<string|int, string> $helpers = ['BaserCore.BcTime', 'BaserCore.BcBaser']

Methods

age()

日付より年齢を取得する

public age(string $birthday[, string $suffix = '歳' ][, mixed $noValue = '不明' ]) : mixed
Parameters
$birthday : string
$suffix : string = '歳'
$noValue : mixed = '不明'
Tags
checked
noTodo
unitTest

arrayValue()

配列とキーを指定して値を取得する

public arrayValue(int $key, array<string|int, mixed> $array[, mixed $noValue = '' ]) : mixed
Parameters
$key : int

配列のキー

$array : array<string|int, mixed>

配列

$noValue : mixed = ''
Tags
checked
noTodo
unitTest

arrayValues()

連想配列とキーのリストより値のリストを取得し文字列で返す 文字列に結合する際、指定した結合文字を指定できる

public arrayValues(string $glue, array<string|int, mixed> $keys, array<string|int, mixed> $array) : string
Parameters
$glue : string

結合文字

$keys : array<string|int, mixed>

結合対象のキーのリスト

$array : array<string|int, mixed>

リスト

Tags
checked
noTodo
unitTest
Return values
string

booleanAllow()

boolean型のデータを可、不可で出力

public booleanAllow(bool $value) : string

0 or 1 の int も許容する 文字列を与えた場合には、不可を出力

Parameters
$value : bool
Tags
checked
noTodo
unitTest
Return values
string —

可/不可

booleanAllowList()

boolean型用のリストを可、不可で出力

public booleanAllowList() : array<string|int, mixed>
Tags
checked
noTodo
unitTest
Return values
array<string|int, mixed> —

可/不可リスト

booleanDo()

boolean型のデータを [〜する / 〜しない] 形式で出力する

public booleanDo(bool $value[, string $doText = null ]) : string
Parameters
$value : bool

値

$doText : string = null

Do文字列

Tags
checked
noTodo
unitTest
Return values
string

booleanDoList()

boolean型用のリストを[〜する/〜しない]形式で出力する

public booleanDoList([string $doText = null ]) : array<string|int, mixed>
Parameters
$doText : string = null

Do文字列

Tags
checked
noTodo
unitTest
Return values
array<string|int, mixed> —

[〜する/〜しない]形式のリスト

booleanExists()

boolean型用を有無で出力

public booleanExists(bool $value) : string
Parameters
$value : bool
Tags
checked
noTodo
unitTest
Return values
string —

有/無

booleanExistsList()

boolean型用のリストを「有」「無」で出力

public booleanExistsList() : array<string|int, mixed>
Tags
checked
noTodo
unitTest
Return values
array<string|int, mixed> —

「有」「無」リスト

booleanMark()

boolean型を ○ または ― マークで出力

public booleanMark(bool $value) : string
Parameters
$value : bool
Tags
checked
noTodo
unitTest
Return values
string —

○ または ―

booleanMarkList()

boolean型用のリストを ○ ― マークで出力

public booleanMarkList() : array<string|int, mixed>
Tags
checked
noTodo
unitTest
Return values
array<string|int, mixed> —

マークリスト（ - ○ ）

booleanStatus()

boolean型用を無効・有効で出力

public booleanStatus(mixed $value) : string
Parameters
$value : mixed
Tags
checked
noTodo
unitTest
Return values
string —

無効/有効

booleanStatusList()

boolean型用のリストを有効、無効で出力

public booleanStatusList() : array<string|int, mixed>
Tags
checked
noTodo
unitTest
Return values
array<string|int, mixed> —

可/不可リスト

control()

メール表示用のデータを出力する ※互換性維持用

public control(string $type, mixed $value[, bool $escape = true ]) : string
Parameters
$type : string

コントロールタイプ

$value : mixed

変換前の値

$escape : bool = true

エスケープ処理を行うかどうか （初期値 : true）

Tags
checked
noTodo
unitTest
Return values
string —

メール用データ

dateTime()

配列形式の日付データを文字列データに変換する

public dateTime(array<string|int, mixed> $arrDate) : string

配列形式のデータは、FormHelper::dateTime()で取得できる

Parameters
$arrDate : array<string|int, mixed>
  • year : 年
  • month : 月
  • day : 日
Tags
checked
noTodo
unitTest
Return values
string —

日付（例）2015/8/11

dispatchLayerEvent()

イベントを発火

public dispatchLayerEvent(string $name[, array<string|int, mixed> $data = [] ][, mixed $options = [] ]) : bool|Event
Parameters
$name : string
$data : array<string|int, mixed> = []
$options : mixed = []
Tags
checked
unitTest
noTodo
Return values
bool|Event

format()

文字をフォーマット形式で出力し、値が存在しない場合は初期値を出力する

public format(string $format, mixed $value[, mixed $noValue = '' ]) : string
Parameters
$format : string

フォーマット文字列（sprintfで利用できるもの）

$value : mixed

フォーマット対象の値

$noValue : mixed = ''

データがなかった場合の初期値

Tags
checked
noTodo
unitTest
Return values
string —

変換後の文字列

listValue()

モデルのコントロールソースより表示用データを取得する

public listValue(string $field, mixed $value) : string
Parameters
$field : string

フィールド名

$value : mixed

値

Tags
checked
noTodo
unitTest
Return values
string —

表示用データ

moneyFormat()

通貨表示

public moneyFormat(int $value[, string $prefix = '¥' ]) : string
Parameters
$value : int

通貨となる数値

$prefix : string = '¥'

'¥'

Tags
checked
noTodo
unitTest
Return values
string

noValue()

データをチェックして空の場合に指定した値を返す

public noValue(mixed $value, mixed $noValue) : mixed
Parameters
$value : mixed
$noValue : mixed

データが空の場合に返す値

Tags
checked
noTodo
unitTest
Return values
mixed —

そのままのデータ/空の場合のデータ

pref()

番号を都道府県に変換して出力

public pref(int $value[, string $noValue = '' ]) : string
Parameters
$value : int

都道府県番号

$noValue : string = ''

都道府県名

Tags
checked
noTodo
unitTest
Return values
string —

都道府県名

prefList()

都道府県のリストを出力

public prefList([mixed $empty = '' ]) : array<string|int, mixed>
Parameters
$empty : mixed = ''
Tags
checked
noTodo
unitTest
Return values
array<string|int, mixed> —

都道府県リスト

sex()

性別を出力

public sex([array<string|int, mixed> $value = 1 ]) : string
Parameters
$value : array<string|int, mixed> = 1
Tags
checked
noTodo
unitTest
Return values
string

toDisplayString()

メール表示用のデータを出力する

public toDisplayString(string $type, mixed $value[, bool $prefixSpace = true ]) : string
Parameters
$type : string

コントロールタイプ

$value : mixed

変換前の値

$prefixSpace : bool = true
Tags
checked
noTodo
Return values
string —

メール用データ

zipFormat()

郵便番号にハイフンをつけて出力

public zipFormat(string $value[, string $prefix = "〒 " ]) : string
Parameters
$value : string

郵便番号

$prefix : string = "〒 "

'〒'

Tags
checked
noTodo
unitTest
Return values
string —

〒マーク、ハイフン付きの郵便番号


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results