plugindev:member

MEMBERクラス リファレンス

MEMBERクラスはメンバー、およびそのログイン状況を管理するクラスです。v3.24現在、このクラスはnucleus/libs/MEMBER.phpで定義されています。

間違い、補足など、お気付きの点がありましたら、積極的に編集してください。プラグイン作りに必要な情報を、Wikiに集結できたら良いなと思っています。

MEMBERオブジェクトの取得

一般に、現在Nucleusを使用しているメンバーについてのMEMBERオブジェクトは、グローバル変数$memberで参照できます。

それ以外のメンバーについては、MEMBER::createFromName()またはMEMBER::createFromID()を使用してください。

メンバーの持つ権限について

メンバーに与えられる権限には複数のものがあります。

権限の種類チェックするメソッド設定するメソッド
最高管理者権限MEMBER::isAdmin()MEMBER::setAdmin()
ブログの管理者権限MEMBER::isBlogAdmin()BLOG::addTeamMember()
ACTION::action_batchmember()
チームのメンバーMEMBER::isTeamMember()BLOG::addTeamMember()
ACTION::action_batchmember()
管理者画面にログインできる権限MEMBER::canLogin()MEMBER::setCanLogin()

アクティベートについて

アクティベートは新規メンバー登録、パスワードの再発行、メールアドレスの変更について必要になります。アクティベートされていないメンバーは管理画面へのログインができません。

一般に、専用のURLにメンバーが一定期間内に訪問することでアクティベートが完了します。

アクティベートの種類による動作の違いは以下のとおりです。

アクティベートの種類typeの値extraの値MEMBER::generateActivationEntry()によるアクティベーション解除アクティベート期限切れ時の動作
新規メンバー登録register省略可解除メンバー削除
パスワードを忘れたforgot省略可解除されず何もなし
メールアドレスの変更addresschangeいままでのメールアドレス解除今までのメールアドレスのままアクティベートされる

メソッド一覧

A-Z順

用途別

リファレンス

MEMBER

MEMBER MEMBER::MEMBER()

コンストラクタ

コンストラクタです。privateなメソッドです。

  • 戻り値
    • MEMBERオブジェクト
  • パラメータ
    • なし

createFromName

MEMBER MEMBER::createFromName(string displayname)

名前(displayname)に対応したMEMBERオブジェクトへの参照を返す

displaynameに対応したMEMBERオブジェクトへの参照を返します。

コールされるたびにMEMBER::readFromName()を実行してデータベースから情報を読み込みます。

対応するMEMBERが存在しない場合でもMEMBERオブジェクトへの参照は返されます。

  • 戻り値
    • MEMBERオブジェクトへの参照
  • パラメータ
    1. string displayname : メンバーの名前

createFromID

MEMBER MEMBER::createFromID(int id)

メンバーIDに対応したMEMBERオブジェクトへの参照を返す

メンバーIDに対応したMEMBERオブジェクトへの参照を返します。

コールされるたびにMEMBER::readFromID()を実行してデータベースから情報を読み込みます。

対応するMEMBERが存在しない場合でもMEMBERオブジェクトへの参照は返されます。

  • 戻り値
    • MEMBERオブジェクトへの参照
  • パラメータ
    1. int id : メンバーID

readFromName

int MEMBER::readFromName(string displayname)

名前(displayname)をもとにデータベースから情報を読み込む

displaynameに対応したデータベースの情報を読み込み、メンバ変数にセットします。

返り値は該当するデータが存在した場合1、存在しなかった場合0になります。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • 該当するデータが存在する場合1、そうでない場合0。
  • パラメータ
    1. string displayname : メンバーの名前

readFromID

int MEMBER::readFromID(int id)

メンバーIDをもとにデータベースから情報を読み込む

メンバーIDに対応したデータベースの情報を読み込み、メンバ変数にセットします。

返り値は該当するデータが存在した場合1、存在しなかった場合0になります。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • 該当するデータが存在する場合1、そうでない場合0。
  • パラメータ
    1. int id : メンバーID

login

int MEMBER::login(string login, string password)

ログインする

引数loginで渡されたdisplaynameを持つメンバーについて、パスワードにpasswordを使ってログインします。

パスワードのチェックだけを行いたい場合は、MEMBER::checkPassword()を使って行うことができます。

コールされるたびにMEMBER::readFromName()を実行してデータベースから情報を読み込みます。

  • サンプル
    • $member =& new MEMBER();
      $login = 'name';
      $pw = 'pass';
      $member->login($login,$pw);

ログインに成功した場合は1が返ります。ログインに失敗した場合は0が返り、ログインしていた場合はログアウトされます。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • 成功した場合1、そうでない場合0。
  • パラメータ
    1. string login : メンバー名(displayname)
    2. string password : パスワード

cookielogin

int MEMBER::cookielogin(string login, string cookiekey)

cookieを使ってログインする

引数loginで渡されたdisplaynameを持つメンバーについて、cookiekeyを使ってログインします。

cookiekeyはログイン状態を保存するためにcookieに保持されている文字列です。cookieにはloginに使う値(メンバーのdisplayname)も保存されています。

cookiekeyのチェックだけを行いたい場合は、MEMBER::checkCookieKey()を使って行うことができます。

コールされるたびにMEMBER::readFromName()を実行してデータベースから情報を読み込みます。

  • サンプル
    • global $CONF;
      $member =& new MEMBER();
      $member->cookielogin(cookieVar($CONF['CookiePrefix'] .'user'), cookieVar($CONF['CookiePrefix'] .'loginkey'));

ログインに成功した場合は1が返ります。ログインに失敗した場合は0が返り、ログインしていた場合はログアウトされます。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • 成功した場合1、そうでない場合は0。
  • パラメータ
    1. string login : メンバー名(displayname)
    2. string cookiekey : cookieに保存されている値

logout

void MEMBER::logout()

ログアウトする

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • なし
  • パラメータ
    • なし

isLoggedIn

int MEMBER::isLoggedIn()

ログインしているかどうかチェックする

メンバーがログインしているかどうかチェックします。

ログインしている場合は1が、そうでない場合は0が返ります。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • ログインしている場合は1、そうでない場合は0
  • パラメータ
    • なし

read

int MEMBER::read(string where)

データベースから情報を読み込む

whereで与えられた条件に合致するデータをメンバ変数に代入します。

また、条件に合致したメンバーの数を返します。

  • サンプル(readFromID)
    • 	function readFromID($id) {
      		return $this->read("mnumber=" . intval($id));
      	}

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • 条件に合致したメンバーの数
  • パラメータ
    1. string where : SQLクエリに使う条件式

isBlogAdmin

bool MEMBER::isBlogAdmin(int blogid)

ブログの管理者権限を持っているかどうかチェックする

メンバーが与えられたblogidをIDに持つブログについて、管理者権限を持っているかどうかをチェックします。

管理者権限を持つ場合はtrueが、そうでない場合はfalseか0が返されます。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • 管理者権限を持つ場合はtrue、そうでない場合はfalseか0
  • パラメータ
    1. int blogid : ブログID

blogAdminRights

bool MEMBER::blogAdminRights(int blogid)

ブログまたはサイトの管理者権限を持っているかどうかチェックする

メンバーが与えられたblogidをIDに持つブログの、もしくはサイト全体の、いずれかの管理者権限を持っているかをチェックします。

少なくとも1種類の管理者権限を持っている場合trueが、そうでない場合falseが返ります。

実際のコードは、MEMBER::isAdmin()MEMBER::isBlogAdmin()を使って

	function blogAdminRights($blogid) {
		return ($this->isAdmin() || $this->isBlogAdmin($blogid));
	}

のように書かれています。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • 何らかの管理者権限を持つ場合はtrue、そうでない場合はfalse
  • パラメータ
    1. int blogid : ブログID

teamRights

bool MEMBER::teamRights(int blogid)

サイトの管理者またはチームのメンバーであるかどうかチェックする

メンバーが与えられたblogidをIDに持つブログのチームのメンバーか、もしくはサイト全体の管理者権限を持っているかをチェックします。

少なくとも1つの条件に該当する場合trueが、そうでない場合falseが返ります。

実際のコードは、MEMBER::isAdmin()MEMBER::isTeamMember()を使って

	function teamRights($blogid) {
		return ($this->isAdmin() || $this->isTeamMember($blogid));
	}

のように書かれています。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • どちらか少なくとも1つに該当する場合はtrue、そうでない場合はfalse
  • パラメータ
    1. int blogid : チームのブログID

isTeamMember

bool MEMBER::isTeamMember(int blogid)

チームのメンバーかどうかチェックする

メンバーが与えられたblogidをIDに持つブログのチームのメンバーかどうかをチェックします。

チームのメンバーである場合trueが、そうでない場合falseが返ります。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • チームのメンバーである場合はtrue、そうでない場合はfalse
  • パラメータ
    1. int blogid : チームのブログID

canAlterComment

bool MEMBER::canAlterComment(int commentid)

コメントについて削除・編集権限があるかどうかチェックする

与えられたcommentidをもつコメントについて、メンバーが削除・編集権限があるかどうかチェックします。

削除・編集権限があるメンバーとは、

  • 最高管理者権限を持つメンバー
  • コメントの投稿者であるメンバー
  • コメントがつけられたブログの管理者権限を持つメンバー
  • コメントがつけられたアイテムの投稿者であるメンバー

です。

権限を持つ場合trueが、そうでない場合falseが返ります。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • 権限を持つ場合true、そうでない場合false
  • パラメータ
    1. int commentid : コメントID

canAlterItem

bool MEMBER::canAlterItem(int itemid)

アイテムについて削除・編集権限があるかどうかチェックする

与えられたitemidをもつアイテムについて、メンバーが削除・編集権限があるかどうかチェックします。

削除・編集権限があるメンバーとは、

  • 最高管理者権限を持つメンバー
  • アイテムの投稿者であるメンバー
  • アイテムが投稿されたブログの管理者権限を持つメンバー

です。

権限を持つ場合trueが、そうでない場合falseが返ります。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • 権限を持つ場合true、そうでない場合false
  • パラメータ
    1. int itemid : アイテムID

canUpdateItem

bool MEMBER::canUpdateItem(int itemid, string newcat)

アイテムを別のカテゴリーに移動させることができるかどうかチェックする

引数で与えられたitemidをもつアイテムを引数newcatで与えられる別のカテゴリーに移動させる権限があるかどうかチェックします。

newcatはカテゴリーIDですが、新しいカテゴリーとしてnewcat-x(文字列でxはブログID)を用いることもできます。

権限を持つ場合trueが、そうでない場合falseが返ります。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • 権限を持つ場合true、そうでない場合false
  • パラメータ
    1. int itemid : アイテムID
    2. string newcat : 移動先のカテゴリーID、もしくはnewcat-xという形の文字列

canAddItem

bool MEMBER::canAddItem(string catid)

カテゴリーに新しいアイテムを追加できるかどうかチェックする

引数catidで与えられたカテゴリーにアイテムを追加する権限があるかどうかチェックします。

catidはカテゴリーIDですが、新しいカテゴリーとしてnewcat-x(文字列でxはブログID)を用いることもできます。

権限を持つ場合trueが、そうでない場合falseが返ります。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • 権限を持つ場合true、そうでない場合false
  • パラメータ
    1. string catid : カテゴリーID、もしくはnewcat-xという形の文字列

canBeDeleted

bool MEMBER::canBeDeleted()

削除可能かどうかチェックする

メンバーを削除できるかどうかチェックします。

投稿したコメントやアイテムが残っているメンバーは削除できません。

削除できる場合trueが、そうでない場合falseが返ります。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • 削除できる場合true、そうでない場合false
  • パラメータ
    • なし

void MEMBER::sendActivationLink(string type[, string extra])

アクティベートのためのメールを送信する

アクティベートのためのメールを送信します。

引数についてはMEMBER::generateActivationEntry()を参照してください。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • なし
  • パラメータ
    1. string type : アクティベートの種類
    2. string extra : アクティベートの種類に対応した追加情報

setCookies

void MEMBER::setCookies(int sharedpc)

自動ログインに使うcookieをセットする

自動ログインに使うcookieをセットします。

sharedpcが1の場合はPCを共有するセットとみなし、セッション終了まで有効なcookieをセットします。

そうでない場合は管理画面での設定に従います。

セットされるcookieの名前は以下のとおりです。(実際にはPrefixがつきます)

名前用途
userログインに使うユーザー名
loginkeyログインに使うキー(パスワードとは違い、Nucleusシステムから自動生成されるもの)
sharedpcPCを共有する設定かどうか

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • なし
  • パラメータ
    1. int sharedpc : PCを共有する設定なら1、そうでないなら0

getAdminBlogs

array MEMBER::getAdminBlogs()

何らかの管理者権限を持つブログの一覧を得る

メンバーがなんらかの管理者権限を持ったブログの一覧を配列で返します。

メンバーが最高管理者権限を持つ場合は、全てのブログのIDが配列として返されることになります。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • メンバーが何らかの管理者権限を持つブログIDが収められた配列
  • パラメータ
    • なし

getNotifyFromMailAddress

array MEMBER::getNotifyFromMailAddress([string suggest])

通知メールの送信元として適切なメールアドレスを返す

通知メールを送信する際に適切だと思われるメールアドレスを返します。

返されるメールアドレスは以下の手順で決定されます。

  1. 現在セッションを実行しているメンバーがログイン状態ならばそのメンバーのメールアドレス(とdisplayname)が返されます。
  2. そうでない場合で、任意の引数suggestにメールアドレスとして適切な文字列が指定されている場合、そのアドレスが返されます。
  3. いずれの場合にも該当しなければ、サイト管理者のメールアドレスが返されます。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • メールアドレス
  • パラメータ
    1. string suggest : 考慮すべきメールアドレス

write

void MEMBER::write()

データベースに情報を保存する

オブジェクトの情報をデータベースに保存します。

メンバー情報は別の場所でデータベースから読み込まれる場合があるので、何らかの変更を加えた後はこのメソッドで変更を保存する必要があります。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • なし
  • パラメータ
    • なし

checkPassword

bool MEMBER::checkPassword(string pw)

与えられたパスワードが正しいものかどうかチェックする

pwで与えられたパスワードが、メンバーの正しいパスワードと一致するかどうかチェックします。

一致した場合trueが、そうでない場合falseが返ります。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • 正しいパスワードならtrue、そうでないならfalse
  • パラメータ
    1. string pw : チェックするパスワード

checkCookieKey

bool MEMBER::checkCookieKey(string key)

与えられたloginkeyが正しいものかどうかチェックする

loginkeyは自動ログイン機能実現のためにNucleusシステムが用意するランダムな文字列で、cookieとデータベースに保存されています。このメソッドはデータベースからMEMBER::readで読み込まれたloginkeyとkeyが一致するかどうかのチェックを行います。

一致した場合trueが、そうでない場合falseが返ります。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • 正しいパスワードならtrue、そうでないならfalse
  • パラメータ
    1. string key : チェックするloginkey

getRealName

string MEMBER::getRealName()

本名(realname)を取得する

本名(realname)を返します。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • 本名(realname)
  • パラメータ
    • なし

setRealName

void MEMBER::setRealName(string name)

本名(realname)を設定する

本名(realname)を設定します。

データベースに変更を反映させるためにはMEMBER::writeを実行する必要があります。

このメソッドは、値が適切なものかどうかチェックしません。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • なし
  • パラメータ
    1. string name : 本名

getEmail

string MEMBER::getEmail()

メールアドレスを取得する

メールアドレスを返します。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • メールアドレス
  • パラメータ
    • なし

setEmail

void MEMBER::setEmail(string email)

メールアドレスを設定する

メールアドレスを設定します。

データベースに変更を反映させるためにはMEMBER::writeを実行する必要があります。

このメソッドはメールアドレスとして適切な文字列かどうかチェックしません。チェックにはグローバルファンクションisValidMailAddress()が使用できます。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • メールアドレス
  • パラメータ
    1. string email : メールアドレス

getPassword

string MEMBER::getPassword()

MD5エンコードされたパスワードを取得する

MD5エンコードされたパスワードを返します。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • パスワード
  • パラメータ
    • なし

setPassword

void MEMBER::setPassword(string pwd)

パスワードを設定する

パスワードを設定します。

データベースに変更を反映させるためにはMEMBER::writeを実行する必要があります。

このメソッドは、値が適切なものかどうかチェックしません。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • パスワード
  • パラメータ
    1. string pwd : パスワード

getCookieKey

string MEMBER::getCookieKey()

loginkeyを取得する

loginkeyを返します。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • loginkey
  • パラメータ
    • なし

newCookieKey

string MEMBER::newCookieKey()

loginkeyを作成/更新する

loginkeyを新たに作成し、MEMBER::writeでデータベースに保存します。それまでMEMBERオブジェクトに加えた変更も同時に保存されます。

このメソッドは新しく作成されたloginkeyを返します。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • loginkey
  • パラメータ
    • なし

setCookieKey

void MEMBER::setCookieKey(string val)

loginkeyを設定する

loginkeyを設定します。

データベースに変更を反映させるためにはMEMBER::writeを実行する必要があります。

このメソッドは、値が適切なものかどうかチェックしません。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • loginkey
  • パラメータ
    1. string val : loginkey

getURL

string MEMBER::getURL()

URLを取得する

URLを返します。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • URL
  • パラメータ
    • なし

setURL

void MEMBER::setURL(string site)

URLを設定する

URLを設定します。

データベースに変更を反映させるためにはMEMBER::writeを実行する必要があります。

このメソッドは、値が適切なものかどうかチェックしません。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • URL
  • パラメータ
    1. string site : URL

getLanguage

string MEMBER::getLanguage()

言語を取得する

言語を返します。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • 言語
  • パラメータ
    • なし

setLanguage

void MEMBER::setLanguage(string lang)

言語を設定する

言語を設定します。

データベースに変更を反映させるためにはMEMBER::writeを実行する必要があります。

このメソッドは、値が適切なものかどうかチェックしません。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • 言語
  • パラメータ
    1. string lang : 言語

getDisplayName

string MEMBER::getDisplayName()

表示用の名前を取得する

表示用の名前を返します。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • 表示用の名前
  • パラメータ
    • なし

setDisplayName

void MEMBER::setDisplayName(string nick)

表示用の名前を設定する

表示用の名前を設定します。(表示用の名前はログインに使われる名前です。)

このメソッドは表示用の名前として適切な文字列かどうかチェックしません。チェックにはグローバルファンクションisValidDisplayName()が使用できます。

データベースに変更を反映させるためにはMEMBER::writeを実行する必要があります。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • 表示用の名前
  • パラメータ
    1. string nick : 表示用の名前

isAdmin

bool MEMBER::isAdmin()

最高権限管理者かどうかチェックする

最高権限管理者かどうかチェックします。

最高権限管理者ならtrueが、そうでないならfalseが返ります。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • 最高権限管理者ならtrue、そうでないならfalse。
  • パラメータ
    • なし

setAdmin

void MEMBER::setAdmin(bool val)

最高権限管理者かどうか設定する

最高権限管理者かどうかを設定します。

引数valがtrueなら最高管理権限がメンバーに与えられ、そうでないなら剥奪されます。

データベースに変更を反映させるためにはMEMBER::writeを実行する必要があります。

このメソッドは、値が適切なものかどうかチェックしません。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • なし
  • パラメータ
    1. bool val : 設定後の最高権限の有無

canLogin

bool MEMBER::canLogin()

管理者領域へのログインが許可されているかどうかチェックする

管理者領域へのログインが許可されているかどうかチェックします。

許可されているならtrueが、そうでないならfalseが返ります。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • ログインが許可されているならtrue、そうでないならfalse。
  • パラメータ
    • なし

setCanLogin

void MEMBER::setCanLogin(bool val)

管理者領域へのログインを許可するかどうか設定する

管理者領域へのログインを許可するかどうかを設定します。

引数valがtrueならログインが許可され、そうでないなら禁止されます。

データベースに変更を反映させるためにはMEMBER::writeを実行する必要があります。

このメソッドは、値が適切なものかどうかチェックしません。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • なし
  • パラメータ
    1. bool val : ログインを許可するかどうか

getNotes

string MEMBER::getNotes()

備考を取得する

備考を返します。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • 備考
  • パラメータ
    • なし

setNotes

void MEMBER::setNotes(string val)

備考を設定する

備考を設定します。

データベースに変更を反映させるためにはMEMBER::writeを実行する必要があります。

このメソッドは、値が適切なものかどうかチェックしません。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • 備考
  • パラメータ
    1. string val : 備考

getID

string MEMBER::getID()

IDを取得する

IDを返します。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • メンバーID
  • パラメータ
    • なし

exists

bool MEMBER::exists(string name)

指定した名前のメンバーが存在するかどうかチェックする

指定した名前のメンバーが存在するかどうかチェックします。

存在するならtrue、そうでないならfalseが返ります。

  • 戻り値
    • メンバーが存在するならtrue、そうでないならfalse
  • パラメータ
    1. string name : 名前

existsID

bool MEMBER::exists(int id)

指定したメンバーIDのメンバーが存在するかどうかチェックする

指定したメンバーIDのメンバーが存在するかどうかチェックします。

存在するならtrue、そうでないならfalseが返ります。

  • 戻り値
    • メンバーが存在するならtrue、そうでないならfalse
  • パラメータ
    1. int id : メンバーID

isNameProtected

bool MEMBER::isNameProtected(string name)

指定した名前が保護されているかどうかチェックする

指定した名前が保護されているかどうかチェックします。

保護されている(使用できない)ならtrue、そうでないならfalseが返ります。

  • 戻り値
    • 保護されているならtrue、そうでないならfalse
  • パラメータ
    1. string name : 名前

create

mixed MEMBER::create(string name, string realname, string password, string email, string url, bool admin, bool canlogin, string notes)

メンバーを作成する

メンバーを作成します。

作成に成功した場合は1が返ります。エラーが発生した場合はその内容を示す文字列が返されます。

name(ログインに使われる名前)、passwordの有無、メールアドレス以外の値は適切かどうかチェックされません。名前の衝突もチェックされません。名前の衝突チェックにはMEMBER::isNameProtected()が使用できます。

作成に成功したメンバーの情報は即座にデータベースに保存されます。

  • 戻り値
    • 成功した場合は1、エラーが発生した場合はその内容を示す文字列。
  • パラメータ
    1. string name : ログインに使われる名前
    2. string realname : 本名
    3. string email : メールアドレス
    4. string url : URL
    5. bool admin : 最高管理権限の有無
    6. bool canlogin : 管理画面へのログインの許可
    7. string notes : 備考

getActivationInfo

mixed MEMBER::getActivationInfo(string key)

アクティベートキーに対応した情報を返す

アクティベートキーに対応した情報を返します。

対応する情報がない場合は0が返ります。対応する情報があれば、それらをメンバ変数に持ったオブジェクトが返ります。メンバ変数の名前はactivationテーブルのカラム名になっています。詳しくはactivationテーブルの説明をご覧ください。

  • 戻り値
    • 対応する情報があれば、それらをメンバ変数に持ったオブジェクト、そうでないなら0。
  • パラメータ
    1. string key : アクティベートキー

generateActivationEntry

string MEMBER::generateActivationEntry(string type [, string extra])

必要があればメンバーをアクティベートされていない状態にし、アクティベートキーを作成する

必要があればメンバーをアクティベートされていない状態にし、アクティベートキーを作成しそれを返します。

アクティベーション解除されたメンバーは管理者画面にログインすることができません。

内部でMEMBER::writeを使っています。それまでMEMBERオブジェクトに加えた変更も同時に保存されます。

このメソッドは、スタティックにコールすることはできません。

  • 戻り値
    • アクティベートキー
  • パラメータ
    1. string type : アクティベートの種類
    2. string extra : アクティベートの種類に対応した追加情報

activate

bool MEMBER::activate(string key)

メンバーをアクティベートする

アクティベートキーを使ってメンバーをアクティベートします。

どのメンバーをアクティベートするかは、アクティベートキーから決定されます。

アクティベートが成功すればtrueが、そうでなければfalseが返されます。

  • 戻り値
    • アクティベートが成功したならtrue、そうでないならfalse。
  • パラメータ
    1. string key : アクティベートキー

cleanupActivationTable

void MEMBER::cleanupActivationTable()

アクティベーション情報を保存しているテーブルを整理する

アクティベート情報を保存しているテーブルを整理します。

一定時間(デフォルトでは2日)がすぎたアクティベートキーが破棄されます。

  • 戻り値
    • なし
  • パラメータ
    • なし
 
plugindev/member.txt · 最終更新: 2011/03/23 21:28 (外部編集)