バックエンドを格納する

カスタム·ストレージ·バックエンドを作成するためには、 StorageBackend 級友たち。そして新しいクラスのインスタンスを作成して storage キーワードパラメータ WebSupport 対象：：

support = WebSupport(srcdir=srcdir,
                     builddir=builddir,
                     storage=MyStorage())

カスタム·ストレージ·バックエンドの作成についての詳細は、参照 StorageBackend 下のクラスです。

class sphinxcontrib.websupport.storage.StorageBackend

バックエンドを格納するインタフェースを定義する.

バージョン 1.6 で変更: StorageBackendクラスは、sphinx.websupport.storageからsphinxcontri.websupport.storageに移動する。

方法

StorageBackend.pre_build()

生成プロセスが開始される前にただちに呼び出す.このオプションを使用して、追加ノードのためのStorageBackendを用意します。

StorageBackend.add_node(id, document, source)

StorageBackendにノードを追加する.

パラメータ

• id -- 注釈の一意ID。

• document -- ノードが属する文書の名前.

• source -- ソースファイル名。

StorageBackend.post_build()

生成が完了した後に呼び出す.必要であれば，このオプションを用いてノードを追加する操作を完了する.

StorageBackend.add_comment(text, displayed, username, time, proposal, node_id, parent_id, moderator)

アノテーションを付加する際に呼び出す.

パラメータ

• text -- 評論のテキスト

• displayed -- コメントを表示すべきかどうか

• username -- コメントを追加したユーザーの名前

• time -- アノテーション付き時間のDateオブジェクト

• proposal -- ユーザが提示したアドバイスのテキスト

• node_id -- アノテーションを付加するノードのID

• parent_id -- コメントの親コメントのID。

• moderator -- コメントを追加したユーザーが著作者かどうか

StorageBackend.delete_comment(comment_id, username, moderator)

コメントを削除する。

賃上げをする UserNotAuthorizedError もし版元が偽であれば username コメント上のユーザ名と一致しない.

パラメータ

• comment_id -- 削除するコメントのID。

• username -- 削除を要求したユーザのユーザ名。

• moderator -- ユーザが著作者であるかどうか.

StorageBackend.get_data(node_id, username, moderator)

ノードのすべてのデータを検索するために呼び出される.これは2つの鍵を持つDICTに戻るべきです 源. そして 評論 述べたとおり WebSupport 張氏. get_data() 方法です。

パラメータ

• node_id -- データを取得するノードのID.

• username -- データを要求するユーザの名前。

• moderator -- 依頼者が司会者かどうか。

StorageBackend.process_vote(comment_id, username, value)

投票中の投票用紙を処理する。 value -1、0、または1となります。

パラメータ

• comment_id -- 投票中のコメントのID。

• username -- 投票したユーザーのユーザー名。

• value -- 投票された投票の価値。

StorageBackend.update_username(old_username, new_username)

ユーザがそのユーザ名を変更することが許可されている場合、この方法は、ストレージシステムに停滞したデータが発生しないように呼び出されるべきである。

パラメータ

• old_username -- 変更中のユーザー名です。

• new_username -- ユーザ名がなぜ変更されるのか.

StorageBackend.accept_comment(comment_id)

版元がコメントを受け取ったときに呼び出します。このメソッドを呼び出すと，すべてのユーザにアノテーションを表示すべきである.

パラメータ

comment_id -- 受け取っているコメントのID。