plugindev:skinimport

SKINIMPORTクラス リファレンス

SKINIMPORTクラスはスキン読み込み機能を実現するためのクラスです。Nucleus 3.24現在、このクラスはSKINEXPORTクラスとともにnucleus/libs/skinie.phpで定義されています。

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

メソッド一覧(一部)

リファレンス

SKINIMPORT

SKINIMPORT SKINIMPORT::SKINIMPORT()

コンストラクタ

コンストラクタです。

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

reset

void SKINIMPORT::reset()

オブジェクトが保持しているデータをリセットする

オブジェクトが保持しているデータをリセットします。

このメソッドはコンストラクタ中で呼ばれます。

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

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

readFile

void SKINIMPORT::readFile(string filename [, int metaonly])

xmlファイルから情報を読み込む

指定したxmlファイルを読み込んで、情報を保持します。

引数metaonlyを1にすることでメタ情報のみを読み込み、メタ情報がすでに読み込まれている場合は読み込みを行いません。0ならば全ての情報を読み込みます。省略時は0です。metaonlyを1にした状態で再読み込みを行うにはresetメソッドで保持している情報をクリアする必要があります。

メタ情報には、書き出されたスキン・テンプレートの名前と、書き出し時に記入された追加情報が含まれます。

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

  • 戻り値
    • なし
  • パラメータ
    1. string filename : 読み込むファイルのパス。fopenに渡されます。
    2. int metaonly : 1にするとメタ情報のみを読み込む。デフォルトでは0で、全てのデータを読み込みます。

getSkinNames

array SKINIMPORT::getSkinNames()

定義されているスキンの名前を返す

保持しているスキン名情報全てが入った配列を返します。

先にreadFileメソッドでxmlファイルを読み込んでおく必要があります。

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

  • 戻り値
    • スキン名が収められた配列
  • パラメータ
    • なし

getTemplateNames

array SKINIMPORT::getTemplateNames()

定義されているテンプレートの名前を返す

保持しているテンプレート名情報全てが入った配列を返します。

先にreadFileメソッドでxmlファイルを読み込んでおく必要があります。

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

  • 戻り値
    • テンプレート名が収められた配列
  • パラメータ
    • なし

getInfo

string SKINIMPORT::getInfo()

定義されている追加情報を返す

書き出し時に追加された追加情報を返します。

先にreadFileメソッドでxmlファイルを読み込んでおく必要があります。

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

  • 戻り値
    • 追加情報
  • パラメータ
    • なし

writeToDatabase

void SKINIMPORT::writeToDatabase([int $allowOverwrite])

読み込まれた情報をデータベースに保存する

readFileメソッドで読みこまれた情報をデータベースに保存します。

引数allowOverwriteが1の場合は同名のスキン/テンプレートがあった場合でも上書きされます。0ならば上書きは行われません。省略時は0です。

先にreadFileメソッドでxmlファイルを読み込んでおく必要があります。

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

  • 戻り値
    • なし
  • パラメータ
    1. int allowOverwrite : 上書きを許可するかどうか

checkSkinNameClashes

array SKINIMPORT::checkSkinNameClashes()

衝突するスキンの名前を返す

すでに存在するスキンの名前をチェックし、読み込まれたxmlファイルで定義されたスキンの名前のうち、衝突するものを配列にして返します。

衝突が発生しない場合は空の配列が返されます。

先にreadFileメソッドでxmlファイルを読み込んでおく必要があります。

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

  • 戻り値
    • 衝突するスキンの名前が入った配列
  • パラメータ
    • なし

checkTemplateNameClashes

array SKINIMPORT::checkTemplateNameClashes()

衝突するテンプレートの名前を返す

すでに存在するテンプレートの名前をチェックし、読み込まれたxmlファイルで定義されたテンプレートの名前のうち、衝突するものを配列にして返します。

衝突が発生しない場合は空の配列が返されます。

先にreadFileメソッドでxmlファイルを読み込んでおく必要があります。

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

  • 戻り値
    • 衝突するテンプレートの名前が入った配列
  • パラメータ
    • なし

searchForCandidates

array SKINIMPORT::searchForCadidates( string dir )

読み込み可能なXMLファイルのリストを返す

引数で渡されたディレクトリの直下にあり、ファイルskinimport.xmlもしくはskindata.xmlを含むディレクトリのリストを返します。

返り値は配列で、スキン名をキーに持ち、ディレクトリ名を値とする要素で構成されていますが、実際には両方ともディレクトリ名です。

このメソッドはスタティックにコールするためのメソッドです。

  • 戻り値
    • ディレクトリ名が入った配列
  • パラメータ
    1. string dir : 検索するディレクトリのパス
 
plugindev/skinimport.txt · 最終更新: 2011/03/23 21:28 (外部編集)