ColdFusionの関数の紹介・前編

作成日: 2009年7月1日
作成者:ハイミン・エンタープライズ（株）	千葉　博胤佐藤　弘一
最終更新日: 2009年7月1日

ColdFusionの関数の紹介・前編

　前回の連載第１回では、ColｄFusionの多彩なタグの紹介をしました。他言語では面倒な機能でも、ColdFusionのタグでは驚くほど簡単に実装できることを体感できたかと思います。
　今回の連載第２回では前編・後編に分けて、ColdFusionの関数を紹介いたします。多くの言語にある基本的な関数をはじめ、タグと同様多彩な関数が用意されています。その一部ですが紹介したいと思います。第１回記事と同様、サンプルソースはそのままコピー＆ペーストで実行できるようにしてあります。是非実際に動かしてみてください。

ColdFusion関数

■文字列関数
   Left/Right/Mid/Len/Trim/Replace/REReplace
■日付/時刻関連関数
   DateFormat/TimeFormat/CreateDate/IsLeapYear/DateDiff/DateCompare/DateAdd
■Array関連関数
   ArrayNew/ArrayIsEmpty/ArrayAppend/ArrayLen/ArrayToList/ListToArray/
   ArrayDeleteAt/ArrayInsertAt
■List関連関数
   ListFind/ListGetAt/ListLen

■文字列関数

文字列の操作を行います。
　

○Left/Right/Mid
まずは基本的な文字列関数です。
文字列を左（Left）、右（Right）、指定の位置（Mid）から、指定の文字数分抜き出します。

例）

<cfset birthday = "2009/06/27">
<cfoutput>
元の変数：#birthday# 
年だけを抽出します：#Left(birthday,4)#年 
月だけを抽出します：#Mid(birthday,6,2)#月 
日だけを抽出します：#Right(birthday,2)#日 
</cfoutput>

表示結果

元の変数： 2009/06/27
年だけを抽出します： 2009 年
月だけを抽出します： 06 月
日だけを抽出します： 27 日

どの言語でもあるおなじみのleft関数,mid関数,right関数です。
対象となる文字列と抜き出す文字数を指定します。Mid関数は、抜き出す位置（何文字目か）を指定します。
　

○Len
文字列の文字数を取得します。

例）

<cfset country = "japan">
<cfoutput>
文字列「japan」の文字数：#Len(country)#
</cfoutput>

表示結果

文字列「japan」の文字数：5

取得するのは、バイト数ではなく文字数になります。
　

○Trim/Rtrim/Ltrim

文字列の先頭や末尾、その両方のスペースと制御文字を削除します。

例）

<cfset company = " ハイミン ">

<cfoutput>
先頭と末尾のtrim：[#Trim(company)#] 
末尾のtrim：[#Rtrim(company)#] 
先頭のtrim：[#Ltrim(company)#]
</cfoutput>

表示結果

先頭と末尾のtrim：[ハイミン]
末尾のtrim：[△ハイミン]
先頭のtrim：[ハイミン△ ]

※△は実際には半角スペースが表示されます。

Trim関数は先頭と末尾、Rtrim関数は末尾、Ltrim関数は先頭の半角スペースを削除しています。
Trim/Rtrim/Ltrim関数では全角スペースは削除されないので注意しましょう。
　

○Replace/REReplace
文字列内の指定した文字列１を文字列２に置き換えます。

例）

<cfset tmpString="abababb">
<cfoutput>
#Replace(tmpString,'a','x')# 
#Replace(tmpString,'a','x','all')# 
#ReReplace(tmpString,'[a-z]','x','all')#
</cfoutput>

表示結果

xbababb
xbxbxbb
xxxxxxx

上記のReplace関数では、変数「tmpString」の文字列内の「a」を「x」に置き換えます。１つ目の例では先頭の「a」のみ「x」に置き換えています。２つ目の例のように第4パラメータでallを指定すると、文字列内にある一致した文字列すべてを置き換えます。
ReReplace関数では、正規表現を使用して置き換えを行います。
　

■日付/時刻関連関数

日付/時刻の操作を行います。
　

○DateFormat/TimeFormat
日付および時刻の書式を指定します。

例）

<cfset tmpNow=NOW()>
<cfoutput>
年月日フォーマット：#DateFormat(tmpNow,"yyyy/mm/dd")# 
年月日フォーマット：#DateFormat(tmpNow,"yyyy/m/d")# 
月名表示：#DateFormat(tmpNow,"mmmm")# 
曜日名表示：#DateFormat(tmpNow,"dddd")# 
時刻フォーマット：#TimeFormat(tmpNow,"hh:mm:ss")# 
時刻フォーマット：#TimeFormat(tmpNow,"hh時mm分ss秒")#
</cfoutput>

表示結果

年月日フォーマット：2009/06/25
年月日フォーマット：2009/6/25
月名表示：June
曜日名表示：Thursday
時刻フォーマット：11:48:41
時刻フォーマット：11時48分41秒

DateFormat/TimeFormat関数のそれぞれの第2パラメータで日付および時刻の書式を指定します。
　

○CreateDate/CreateTime
日付および時刻オブジェクトを作成します。

例）

<cfoutput>
#CreateDate('2009','06','20')# 
#DateFormat(CreateDate('2009','06','20'),'yyyy/mm/dd')# 
#CreateTime('10','34','12')# 
#TimeFormat(CreateTime('10','34','12'),'hh:mm:ss')#
</cfoutput>

表示結果

{ts '2009-06-20 00:00:00'}
2009/06/20
{ts '1899-12-30 10:34:12'}
10:34:12

パラメータにて、年月日および時分秒を個別に指定します。DateFormat関数と組み合わせる事によって、指定の書式となります。
年・月・日（時・分・秒）それぞれのテキストボックスがあり、それらに入力された３つの数値をCreateDate/CreateTime関数を使用して日付形式に変換する、といった使い方がでます。
　

○DateAdd
指定した単位で、日付を加算します。

例）

<cfset tmpNow=Now()>
<cfoutput>
基準日：#tmpNow# 
5年後：#DateAdd('yyyy',5,tmpNow)# 
10ヶ月後：#DateAdd('m',10,tmpNow)# 
5日後：#DateAdd('d',5,tmpNow)# 
15日前：#DateAdd('d',-15,tmpNow)# 
5時間後：#DateAdd('h',5,tmpNow)#
</cfoutput>

表示結果

基準日：{ts '2009-06-25 12:10:32'}
5年後：{ts '2014-06-25 12:10:32'}
10ヶ月後：{ts '2010-04-25 12:10:32'}
5日後：{ts '2009-06-30 12:10:32'}
15日前：{ts '2009-06-10 12:10:32'}
5時間後：{ts '2009-06-25 17:10:32'}

第1パラメータで加算する単位（年、月、日、時等）を指定し、第2パラメータで加算する数値を指定します。減算する場合は、－（マイナス）値を指定します。
　

○DateDiff
指定した２つの日付の差を取得します。

例）

<cfset tmpDateTime1="2000/01/01">
<cfset tmpDateTime2=Now()>
<cfoutput>
2000年1月1日と2009年6月25日の差を表示 
年換算：#DateDiff('yyyy',tmpDateTime1,tmpDateTime2)#年 
月換算：#DateDiff('m',tmpDateTime1,tmpDateTime2)#ヶ月 
日換算：#DateDiff('d',tmpDateTime1,tmpDateTime2)#日 
時間換算：#DateDiff('h',tmpDateTime1,tmpDateTime2)#時間 
秒換算：#DateDiff('s',tmpDateTime1,tmpDateTime2)#秒
</cfoutput>

表示結果

2000年1月1日と2009年6月25日の差を表示
年換算：9年
月換算：113ヶ月
日換算：3463日
時間換算：83124時間
秒換算：299247449秒

tmpDateTime1とtmpDateTime2の差を求めます。差の単位を第1パラメータで指定できます。
　

○DateCompare
指定した２つの日付の比較を行います。

例）

<cfset tmpDateTime1=CreateDate('2009','06','19')>
<cfset tmpDateTime2=Now()>
<cfoutput>
tmpDateTime1：#tmpDateTime1# 
tmpDateTime2：#tmpDateTime2# 
比較結果：#DateCompare(tmpDateTime1,tmpDateTime2,'d')#
</cfoutput>

表示結果

tmpDateTime1：{ts '2009-06-19 00:00:00'}
tmpDateTime2：{ts '2009-06-25 12:21:30'}
比較結果：-1

tmpDateTime1とtmpDateTime2を比較し、tmpDateTime1の方が過去であれば「-1」、tmpDateTime1の方が未来であれば「1」、同じであれば「0」を返します。第2パラメータは、比較を行う精度を指定します。
　

○IsLeapYear
指定した年が閏年かを返します。

例）

<cfoutput>
今年は閏年ですか？：#IsLeapYear(Now())#
</cfoutput>

表示結果

今年は閏年ですか？：NO

閏年の場合「YES（true）」、閏年ではない場合「NO（false）」を返します。
※表示結果は2009年現在です。
　

■Array関連関数

配列関連の操作を行います。
　

○ArrayNew
配列を作成します。3次元までの配列を作成する事ができます。

例）

パラメータで配列の次元の数を指定します。配列の宣言をしただけなので、<cfdump>タグで見ると「empty」になっています。
※<cfdump>タグで配列や構造体を表示すると、上記のように一覧表として表示されます。デバッグの際に便利です。

○ArrayIsEmpty
指定した配列が空かどうかを判断します。

例）

<cfset arrNumber = ArrayNew(1)>
<cfoutput>
配列は空ですか？#ArrayIsEmpty(arrNumber)#
</cfoutput>

表示結果

配列は空ですか？YES

配列を宣言しただけで値を入れていないので、結果は「YES（true）」となります。
　

○ArrayAppend
配列に値を追加します。

例）

表示結果

第1パラメータで配列、第2パラメータで配列に追加する値を指定します。
　

○ArrayLen
配列の要素数を取得します。

例）

<cfset arrNumber = ArrayNew(1)>
<cfloop index="i" from=1 to=5>
<cfset tmp = ArrayAppend(arrNumber,i * 2)>
</cfloop>
<cfdump var="#(arrNumber)#" label="arrNumber"> 
<cfoutput>
配列「arrNumber」の要素数：#ArrayLen(arrNumber)#
</cfoutput>

表示結果

配列「arrNumber」の要素数：5

<cfloop>タグで５回ループして値をセットしているので、配列「arrNumber」の要素数は５となります。

○ArrayToList
配列をリストに変換します。

例）

<cfset arrNumber = ArrayNew(1)>
<cfloop index="i" from=1 to=5>
<cfset tmp = ArrayAppend(arrNumber,i * 2)>
</cfloop>
<cfdump var="#arrNumber#" label="arrNumber"> 
<cfoutput>
配列「arrNumber」をリストに変換：#ArrayToList(arrNumber)#
</cfoutput>

表示結果