2014年11月6日木曜日

Welcart 会員情報操作関係の関数まとめ

Welcartで会員情報を操作するために用意されている関数まとめ

get_memberメソッド

array get_member()
パラメータ
    なし
返り値
    現在ログインしているメンバーの情報を$_SESSION['usces_member']から取得し
    連想配列として返す。メンバーがログインしていない場合は空の配列を返す。

返り値には次のような値が格納されている。
array (size=23)
  'ID' => string '1001' (length=4)
  'registered' => string '2014-11-04 17:27:34' (length=19)
  'mailaddress1' => string 'test_user@testdomain.co.jp' (length=26)
  'mailaddress2' => string 'test_user@testdomain.co.jp' (length=26)
  'password1' => string '' (length=0)
  'password2' => string '' (length=0)
  'point' => string '0' (length=1)
  'name1' => string '実験' (length=6)
  'name2' => string '太郎' (length=6)
  'name3' => string 'ジッケン' (length=12)
  'name4' => string 'タロウ' (length=9)
  'zipcode' => string '123-4567' (length=8)
  'address1' => string '横浜市上北町' (length=18)
  'address2' => string '1-2-3' (length=5)
  'address3' => string '' (length=0)
  'tel' => string '000-1111-2223' (length=13)
  'fax' => string '' (length=0)
  'country' => string 'JP' (length=2)
  'pref' => string '北海道' (length=9)
  'status' => string '0' (length=1)
  'delivery_flag' => string '0' (length=1)
  'delivery' => string '' (length=0)
  'nicename' => string '' (length=0)
後述のget_member_infoメソッドと異なり、'country'以外のwp_usces_member_metaテーブルに登録されたメンバーメタ情報は入っていない。

usces_memberinfoメソッド

mixed usces_memberinfo(string $key, string $out = '' )
パラメータ
    $key : 取得したい$key
    $out : 表示をするか、値として返すか。省略した場合は表示を行う。
              'return'を指定した場合、関数は値を返す。
返り値
    現在ログインしているメンバーの$key項目の値を$_SESSION['$key']から取得し
    返す。$keyに空の値を渡すとget_memberと同じく全ての情報を返す。
    $keyは前述のget_memberが返す連想配列のキーと同じものが指定できる。

get_member_infoメソッド

array get_member_info( int $mid )
パラメータ
    $mid : 会員No
返り値
    会員No $midに登録された情報が格納された連想配列

返り値には次のような値が格納されている。
array (size=23)
  'ID' => string '1001' (length=4)
  'mem_email' => string 'test_user@testdomain.co.jp' (length=26)
  'mem_pass' => string '*********' (length=32)
  'mem_status' => string '0' (length=1)
  'mem_cookie' => string '' (length=0)
  'mem_point' => string '0' (length=1)
  'mem_name1' => string '実験' (length=6)
  'mem_name2' => string '太郎' (length=6)
  'mem_name3' => string 'ジッケン' (length=12)
  'mem_name4' => string 'タロウ' (length=9)
  'mem_zip' => string '123-4567' (length=8)
  'mem_pref' => string '北海道' (length=9)
  'mem_address1' => string '横浜市上北町' (length=18)
  'mem_address2' => string '1-2-3' (length=5)
  'mem_address3' => string '' (length=0)
  'mem_tel' => string '999-8888-7777' (length=13)
  'mem_fax' => string '' (length=0)
  'mem_delivery_flag' => string '0' (length=1)
  'mem_delivery' => string '' (length=0)
  'mem_registered' => string '2014-11-04 17:27:34' (length=19)
  'mem_nicename' => string '' (length=0)
  'customer_country' => string 'JP' (length=2)
  'nickname' => string 'test_nickname-kneesocksMan' (length=26)
get_member_infoメソッドは、前述のget_memberメソッドと連想配列のキーが異なる。またwp_usces_memberテーブルだけでなくwp_usces_member_metaテーブルに登録されているmember_idが$midで登録されているメンバーメタ情報も
'meta_key' => 'meta_value'の形式で同時に取得する。上記の例では
'customer_country' => string 'JP' (length=2)
'nickname' => string 'test_nickname-kneesocksMan' (length=26)
がそれにあたる。

set_member_infoメソッド

int set_member_info( array $data=array(), int $mid )
パラメータ
    $data : 更新するカラムと値の連想配列
    $mid;  : 上記$dataで更新するメンバーのID
返り値
    データベースへの書き込みが正常に行われた場合は1、失敗した場合は0。
    存在しないメンバーIDを指定した場合は0、現在の値と同じ値を書き込んだ場合も0を返す。

例:メンバーID 1001の電話番号mem_telを'000-1111-2222'にセットする。
    $res = $usces->set_member_info(array(
            'mem_tel' => '000-1111-2222'
        ), 1001);
この関数が操作するのはwp_usces_memberテーブルの値のみ。wp_usces_member_metaテーブルの方に記録されたデータを操作するには後述するset_member_meta_valueメソッドを使用する。

get_member_meta_valueメソッド

mixed get_member_meta_value(string $key, int $member_id)
パラメータ
    $key : 読み込むmeta_key
    $member_id 読み込むmember_id
返り値
    読み込んだmeta_valueを返す。読み込みが行えなかった場合はnullを返す。

set_member_meta_valueメソッド

mixed set_member_meta_value(string $key, string $meta_value, mixed $member_id = '')
パラメータ
    $key : 書き込むmeta_key
    $meta_value : 書き込むmeta_value
    $member_id 書き込むmember_id
返り値
    データベースへの書き込みが正常に行われた場合は1、失敗した場合は0。
    存在しないメンバーIDに対して書き込みを試みた場合も書き込まれ1を返す。
    現在の値と同じ値を書き込んだ場合は0を返す。
注意
    $member_idを省略した場合は、現在ログインしているメンバーのIDに対して書き込みを行う。
    メンバーがログインしていない場合は何も行わずnullを返す

usces_delete_memberdataメソッド

int usces_delete_memberdata(int $ID = 0 )
パラメータ
    $ID : 登録削除を行うメンバーID
返り値
    正常に削除が行われた場合1、削除が行われなかった場合0
注意
    wp_usces_member_metaテーブルに書き込まれたメンバーIDが
    $IDのメタ情報も同時に削除される。

0 件のコメント:

コメントを投稿