next »

[kazuike]

概要
CSVファイルを使って、MODxのドキュメントやウェブリンクを一括で作成・更新するモジュールです。
MODx標準のドキュメント変数はもちろん、ユーザが設定したテンプレート変数も使えます。
ちなみに、実際に登録する前に、確認表示が出ますので、安心して更新できます。
また、適用作業にあわせていくつでもモジュール実行画面を追加でき、
モジュール実行時に入力するパラメータも個々に設定できます。

ダウンロード

モジュール実行画面（確認表示）例



インストールとアンインストール

インストール
下記の通り、一般的なMODxモジュールと同様にインストールします。
１．ダウンロードしたファイルを全て展開します。
２．展開した「Csv2Doc-****/assets/modules/」の中にある「csv2doc」を、
　　サーバの「assets/mudules/」の中に、FTPでアップロードします。
　　（「****」部分はバージョンによります）
３．展開した中にある「module.Csv2Doc.ja.php」を、UTF-8が利用可能なテキストエディタで開きます。
４．MODx管理画面のモジュール／モジュール管理から、モジュールの作成を行い、
　　「module.Csv2Doc.ja.php」のソースコードをすべてコピーして、モジュールコード欄に貼り付けます。
　　モジュール名は、「Csv2Doc」か、もしくは、適用作業にあわせて、たとえば「商品データ更新」などにします。
５．デフォルトのままでも使えますが、適用作業にあわせる等必要に応じて「設定」タブのモジュール設定も入力します。

アンインストール
下記の通り、一般的なMODxモジュールと同様にアンインストールします。
１．MODx管理画面から作成したモジュールを削除します。
２．FTPでアップロードしたファイルを削除します。


使い方

１．Excel等を使って、CSVファイルを作成します。
２．ファイルマネージャーやFTPを使って、CSVファイルをアップロードします。
３．モジュール実行画面で「確認する」をクリックします。
４．確認表示を見て、問題なければ「登録する」をクリックします。

CSVファイル

以下のようなCSVファイル(*1)を用意し、あらかじめ「assets/files/」にアップロードしておきます。
１．1行目：フィールド名行(*2)(*3)
　　フィールド名として、ドキュメント変数名やテンプレート変数名を入力します。
２．2行目：コメント行(*4)
　　後でわかる（再利用できる）ように、任意のコメント（説明文等）を記入します。
３．3行目以降：データ行
　　実際に登録するデータを入力します。

*1：デフォルトでは、文字コード等は日本語版Excelで作成されたCSVファイルを想定しています。
*2：設定により、フィールド名行を省略し、フィールドの並びを固定にすることもできます。
*3：MODxで定義されていないフィールド名については、確認表示で警告が出ますが、そのまま登録することは可能です。
*4：設定により、コメント行は省略可能です。

更新に使う場合の注意

新規作成だけにCSVを使う場合を除き、既存のドキュメントの更新にもCSVを使う場合、
あらかじめ、各ドキュメントを識別するためのフィールドを用意しておく必要があります。

例えば、メニューインデックスを特に使っていないのでしたら、CSVに「menuindex」フィールドを用意し、
これに連番を振っておく等して、ドキュメントを一意に識別できるようにしておき、
モジュール実行画面で「更新用一致判定フィールド」に「menuindex」を入力します。
（もしくは、設定パラメータ「matching_fieldname」に「menuindex」を設定しておきます）

CSVファイルの例


設定パラメータ

一般的なMODxモジュールと同様に、MODx管理画面（モジュール管理）で設定ができますが、
それ以外にも、モジュール実行画面で、直接パラメータを入力することも可能になってます。

デフォルトでは、以下のパラメータをモジュール実行画面で指定できるようになっています。(*5)
・ドキュメントを作成するフォルダのドキュメントID
・ドキュメントに使用するテンプレートID（プルダウンメニュー）
・更新用一致判定フィールド
・フォルダ内の不要なレコードを削除する（Yes/No）
・デフォルトで公開日時に現在時刻を設定する（Yes/No）
・アップロードされたCSVファイルのファイル名
・2行目からデータレコードまで読み飛ばす行数
・CSVファイルエンコーディング（プルダウンメニュー）
・確認表示列数

*5：モジュール実行時に入力するパラメータは、モジュール設定で変更できます。

主な設定パラメータ

runparams	実行時パラメータ	モジュール実行画面で入力するパラメータ名を指定します。 カンマ区切りで複数指定可能。 デフォルトは「doc_parent,doc_template,matching_fieldname,delete_in_parent, set_pub_date,csv_fname,csv_skiplines,csv_encoding,num_verify_cols」です。
matching_fieldname	更新用一致判定フィールド	既存のドキュメントを更新する際に使うレコード識別用フィールド名を指定します。 詳しくは、前述の「更新に使う場合の注意」を参照してください。
require_fieldnames	必須フィールド名	入力がなければエラーとするフィールド名を指定します。 カンマ区切りで複数指定可能。
num_verify_cols	確認表示列数	確認表示に表示する列の数を指定します。デフォルトは「8」です。
verify_fieldnames	確認表示フィールド名	確認表示に表示するフィールド名を指定します。 カンマ区切りで複数指定可能。num_verify_colsよりこちらの指定が優先されます。
csv_only_data	CSVファイルはヘッダ行を含まない	1(Yes)を指定すると、1行目からデータとして処理します。
csv_fieldnames	フィールド名	フィールド名の並びをカンマ区切りで指定します。
doc_parent	ドキュメントを作成するフォルダのドキュメントID	どこにドキュメントを作成（どこのドキュメントを更新）するかを指定します。 CSVのフィールドに「parent」か「byname_parent」で指定したフィールドがあれば、そちらが優先されます。 ※このフォルダに対する、ドキュメント作成・編集・保存権限が必要です。 （権限がなければエラーになります）
doc_template	ドキュメントに使用するテンプレートID	使用するテンプレートを指定します。 CSVのフィールドに「template」か「byname_template」で指定したフィールドがあれば、そちらが優先されます。 デフォルトは、グローバル設定のデフォルトテンプレートに設定されているテンプレートです。
csv_fname	アップロードされたCSVファイルのファイル名	ファイル名を指定します。 デフォルトは「data.csv」です。
csv_dname	アップロードされたCSVファイルのディレクトリ名	ディレクトリ名を指定します。 デフォルトは「assets/files/」です。
csv_skiplines	2行目からデータレコードまで読み飛ばす行数	コメント行として読み飛ばす行数を指定します。 デフォルトは「1」です。
csv_encoding	CSVファイルエンコーディング	CSVファイルに使用している文字コードを指定します。 デフォルトは「SJIS（シフトJIS）」です。
delete_in_parent	フォルダ内の不要なレコードを削除する	CSVのデータ中に無いドキュメントがあった場合、削除するかどうかを指定します。 1(Yes)を指定すると、フォルダ内の不要なドキュメントが削除されます。
nl2br_fieldnames	改行時にbrタグを挿入するフィールド	複数行にわたるデータ等、改行をウェブ上で再現したいフィールド名を指定します。 カンマ区切りで複数指定可能。
doc_published	デフォルトで公開する	デフォルトで公開するにチェックを入れるかどうかを指定します。 1(Yes)を指定した場合、各ドキュメントの「公開する」にチェックを入れます。 CSVのフィールドに「published」か「byname_published」で指定したフィールドがあれば、そちらが優先されます。
set_pub_date	デフォルトで公開日時に現在時刻を設定する	デフォルトで公開開始日時に現在時刻を入れるかどうかを指定します。 デフォルトは「0(No)」です。 CSVのフィールドに「pub_date」か「byname_pub_date」で指定したフィールドがあれば、そちらが優先されます。

モジュール設定

一般的なMODxモジュールと同様に、MODx管理画面（モジュール管理）で設定します。

例えば、
親フォルダ「1」、識別フィールド「menuindex」、不要レコードを削除する、実行時パラメータはCSVファイル名
とするモジュール設定は、以下のようになります。

Code:

&doc_parent=親フォルダID;int;1 &matching_fieldname=識別フィールド;string;menuindex &delete_in_parent=不要レコードを削除する;int;1 &runparams=実行時パラメータ;string;csv_fname

補足説明

PHPのわかる人は、Csv2Docクラスを継承して、個別にカスタマイズする等は可能だと思います。

• 現バージョンでは、テンプレート変数とテンプレートの対応は考慮していません。（いずれ対応するつもりですが）
• 現バージョンでは、モジュール実行画面でのファイルアップロードはできません。（いずれ対応するつもりですが）
• トランザクション（InnoDB）には、現バージョンでは対応していません。（いずれ対応するつもりですが）
• CSVデータのフィールド毎のバリデート機能等は、現バージョンではありません。これらチェック機能は今後の課題です。

バグ報告や仕様の不備、その他機能のご要望等、いただけるとありがたいです。
（どこまで対応できるかは確約できませんが、無理のない範囲でバージョンアップしていきたいと思っています。）


リソースの情報

作者	Kazuyuki Ikeda (HIKIDAS Co.,Ltd)
Webサイト	http://www.hikidas.com/
リソース名	Csv2Doc
バージョン	0.9.2
ライセンス	GPL
動作環境	MODx 0.9.6.x
リソースの種別	モジュール
タグ	モジュール/CSV/一括作成/一括更新/一括登録/一括追加/module

[yama]

面白そうなのでEvoリリース記念にデザインをカスタマイズしてみようかな？と開いてみたら、そのへんもきっちり考慮して作り込まれてますね。すごいです。

tableタグに関しては$params->add('form_gen_param')メソッド？でclass="grid"を指定できるのはすぐ分かりましたが、tdにclass="gridItem"を振るのはどうやるといいでしょう？

[sama55]

入があるってことは出も？（本家extraにあり？）
将来的にはphpMyAdminを使えない人向けの引越しセンターとか？

[kazuike]

すみません。気持としてはあったのですが、ちょっと手を抜きました。
現状としては、Csv2Docを継承して、メソッドをオーバーライドしていただくのが近道かと思います。
モジュールの222行目あたり、

Code:

$csv2doc = new Csv2Doc($params);

を以下のようにすれば良いと思います。

Code:

class MyCsv2Doc extends Csv2Doc {
function init_form_gen($gen_cols='') {
$gen_name = $this->paramV('form_gen_class');
$gen_param = $this->paramV('form_gen_param');
if ($gen_cols === '') {
$gen_cols = $this->paramV('form_gen_cols');
}
if ($gen_cols === '') {
$gen_cols = 2;
}
$this->form_gen = new $gen_name($gen_cols, $gen_param, NULL, 'class="gridItem"');
}
}
$csv2doc = new MyCsv2Doc($params);

newでオブジェクトを生成しているところ（1行分）のパラメータを増やすだけなんですが…
ちなみに、3番目のパラメータ（上記「NULL」の箇所）で、trの属性を指定できます。

面白そうなのでEvoリリース記念にデザインをカスタマイズしてみようかな？と開いてみたら、そのへんもきっちり考慮して作り込まれてますね。すごいです。

tableタグに関しては$params->add('form_gen_param')メソッド？でclass="grid"を指定できるのはすぐ分かりましたが、tdにclass="gridItem"を振るのはどうやるといいでしょう？

[kazuike]

そのものズバリ（ドキュメントを丸ごとDL）ではありませんが、CSVでダウンロードする系のモジュールは、いくつか作ったりしています。

たとえば、cfFormMailerを拡張して、送信された内容の控えをDBにためておき、後からまとめてCSVでダウンロードするモジュールも作っていて、複数フォーム対応、前回DL以降の差分か全件かを選んでDL可能、アンケート項目などでは集計しやすいようにフラグとして記録する設定ができる等、けっこう高機能なんですが、モジュールの設定がたいへんで、世に送り出すには、そのままでははばかるようなものだったりします。

入があるってことは出も？（本家extraにあり？）
将来的にはphpMyAdminを使えない人向けの引越しセンターとか？

[kazuike]

すみません。
先の方法では、テーブル毎に設定が必要なので、HTMLtableを継承する方が早いですね。

モジュールコードの30行目あたりに以下のコードを追加して、
モジュールコード内の「HTMLtable」を全て「MyHTMLtable」に置換すれば良いと思います。

Code:

class MyHTMLtable extends HTMLtable {
// initialize the properties for table block
function initSettings($num_cols, $block_attrs=NULL, $row_attrs=NULL, $col_attrs=NULL) {
$this->num_cols = $num_cols;
$this->begin_block_tags = $this->addAttrs("<table>", $block_attrs);
$this->end_block_tags = "</table>\n";
$this->begin_row_tags = $this->addAttrs("<tr>", $row_attrs);
$this->end_row_tags = "</tr>\n";
$this->begin_col_tags = $this->addAttrs("<td class="gridItem">", $col_attrs); // ←★ここ★
$this->end_col_tags = "</td>";
$this->empty_col_tags = "<br />";
return $this;
}
}

すみません。気持としてはあったのですが、ちょっと手を抜きました。
現状としては、Csv2Docを継承して、メソッドをオーバーライドしていただくのが近道かと思います。

tableタグに関しては$params->add('form_gen_param')メソッド？でclass="grid"を指定できるのはすぐ分かりましたが、tdにclass="gridItem"を振るのはどうやるといいでしょう？

[thr]

こんにちはthrです。

このモジュールをちょっと使ってみたいとおもってインストールしてみたのですが、下記のようなエラーになってしまいました、、、

Catchable fatal error: Object of class Csv2Doc could not be converted to string in /Applications/XAMPP/xamppfiles/htdocs/*****/assets/modules/csv2doc/Csv2Doc.class.inc.php on line 188

テスト環境は
modx0963 and modx1.0.2j
サーバー：xampp Mac osx 1.0.1
php:PHP Version 5.2.9
mysql: 5.1.33

CSV作成はmac版エクセル2008

お時間があれば少しおしえていただけるとありがたいです。

[yama]

↑
（一部伏せ字にしました）

http://d.hatena.ne.jp/hikidas_ikeda/20090618/1245333783
こちらコメント欄が参考になるかも。evoでうまく動かないらしい？コメントもありますが。

[kazuike]

今、手元に環境が無く、本日はほとんど外なので、すぐには対応できないかもしれません。
申し訳ないです。

[thr]

すすいません。

字ふせていただいて有り難うございます。


URL参考に自分でも試してみます。
↓
0963でうごきましたっ！
1.0.2jはどうかなぁ〜調査中。。。

↓
うっやはりリンク先のzeroさんのコメントと同じ状況に、、、
しかし、一斉に登録される様は本当壮快ですね。良いモジュールです。

[kazuike]

Catchable fatal error: Object of class Csv2Doc could not be converted to string in /Applications/XAMPP/xamppfiles/htdocs/*****/assets/modules/csv2doc/Csv2Doc.class.inc.php on line 188

この件について修正したファイルを添付します。解凍して入れ替えていただけますでしょうか？
/assets/modules/csv2doc/Csv2Doc.class.inc.php

残念ながら、「Undefined variable: _style」については、いまだ原因不明です。
（_styleらしきものはこのモジュールで使っていないので、コアの仕様変更についていけていないのかもしれません）

上記以外のエラーについては、こちらで再現できていません。
添付したものを試していただき、結果を教えていただけますでしょうか？
よろしくお願いいたします。

[terada]

立て続けに、新しい質問で恐縮ですが、よろしくお願いします。

記事の通り、Csv2DocのファイルををDLして、インストール手順に従ってインストールし、管理画面でモジュールタブの下のところに「Csv2Doc」が表示されたのですが、Csv2Docを選択すると設定画面ではなく、下記のようなエラー分が表示されます。

Parse error: syntax error, unexpected T_OBJECT_OPERATOR in /・・・・/manager/processors/execute_module.processor.php(114) : eval()'d code on line 80

modxのバージョンは1.0.1jです。

modx初心者のため、もしかしたら初歩的ミスかもしれないのですが、
何か、原因がお分かりでしょうか？
それとも、上の方にコメントがあるようにevolutionでは動かないのでしょうか？？
とても便利そうなモジュールで、どうしても、ぜひぜひ、これを使いたいので、どうぞよろしくお願いします！

寺田

[yama]

残念ながら、「Undefined variable: _style」については、いまだ原因不明です。
（_styleらしきものはこのモジュールで使っていないので、コアの仕様変更についていけていないのかもしれません）

Undefined variable・・・変数？_styleじゃなくて$_styleだったらEvoになってからザッと増えましたが。管理画面で利用するアイコン関係だったと思います。従来はハードコーディングでアイコンの画像ファイル名を記述してたのですが。関係ないかな・・・

teradaさん
v1.0.1はちょっとバグありで、もしできれば1.0.2にアップデートすることをオススメします。今回の件は関係なさそうですが・・
機会があれば僕も調べてみます

[kazuike]

「Undefined variable: _style」ですが、
/manager/includes/header.inc.php
の最後の行に

Code:

<div class="preLoaderText"><?php echo $_style['ajax_loader']; ?></div>

という箇所があって、この表示に使っている「$_style」が無いのでエラーになっているようです。
ですので、動作には直接関係ないと思われます。（対応はしたいと思いますが）

残念ながら、「Undefined variable: _style」については、いまだ原因不明です。
（_styleらしきものはこのモジュールで使っていないので、コアの仕様変更についていけていないのかもしれません）

Undefined variable・・・変数？_styleじゃなくて$_styleだったらEvoになってからザッと増えましたが。管理画面で利用するアイコン関係だったと思います。従来はハードコーディングでアイコンの画像ファイル名を記述してたのですが。関係ないかな・・・

teradaさん
v1.0.1はちょっとバグありで、もしできれば1.0.2にアップデートすることをオススメします。今回の件は関係なさそうですが・・
機会があれば僕も調べてみます

[kazuike]

teradaさん
よろしかったら、PHPのバージョンを教えていただけますか？

Parse error: syntax error, unexpected T_OBJECT_OPERATOR in /・・・・/manager/processors/execute_module.processor.php(114) : eval()'d code on line 80

[kazuike]

「Undefined variable: _style」対応版を添付しようとしたのですが、
どうも、このトピックにファイルが添付できないようなので、
Evo対応暫定版として、こちら↓にアップしました。
http://www.hikidas.com/hikidas/modx_resource/Csv2Doc.php#dl
（昨日修正分もあわせて一式入れておきます）
解凍して、「module.Csv2Doc.ja.php」を、モジュールコードに貼りつけてください。

＃
Evoで、けっこうグローバル変数が増えているようですね。
こういうの、オブジェクトか何かでカプセル化してもらえると嬉しかったり…

[terada]

yamaさま

情報ありがとうございます！
さっそく1.0.2にアップデートしました。
しかし、上記の問題には変わりありませんでした。。。

----

kazuikeさま

情報不足ですみません！
PHP Version 4.4.4
MySQL クライアントのバージョン: 4.0.25
でした。

よろしくお願いします！


寺田

[thr]

thrです。

modx 1.0.2jで試してみました。
結果から言うと動きました。最高！！


しかし下記の問題がありました。

Invalid argument supplied for foreach() in /*****/assets/modules/csv2doc/Csv2Doc.class.inc.php on line 646

これに対してはいぜんのブログのコメントで下記のように対応ということでいじってみましたが、0963ではこの方法で回避できましたが、1.0系では別のパーサーエラーが発生してしまいました。

いくつかの条件で、これが出る可能性がありそうです。
検証の必要はありそうですが、とりあえずの対処として、ちょっと荒っぽいですが、641行目の
return FALSE;
を
return array();
に変えると回避することができると思います。

エラー内容は下記です

Execution of a query to the database failed - You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near ')' at line 1

検証の情報になれば、、、

[terada]

kazuikeさま

すみません！MySQLのバージョンが間違っていました。先ほどのはphpMyAdminのバージョンのようです。

サーバのバージョン: 5.0.82-community-log

こちらがMySQLのバージョンだと思います。（phpMyAdminのホーム画面で左側の「サーバのバージョン」というところで良いのですよね？）


それから、別のサーバーにもmodxをインストールしてCsv2Docを入れてみたところ、とりあえず管理画面を見ることは出来ました。
そちらの環境は、
modx:1.0.2j
PHP:5.2.5
MySQL:5.1.22-rc
です。実際に読み込ませるなどの動作はまだ確認していません。

が、やはりできれば先ほどのサーバーで動かしたいので、対応していただけると大変助かります。
わがままを言って申し訳ありません。よろしくお願いいたします。

[kazuike]

thrさん、teradaさん
情報ありがとうございます。

こちらに修正したもの（Csv2Doc-093b2.zip）をアップしました。
http://www.hikidas.com/hikidas/modx_resource/Csv2Doc.php#dl
ご確認いただけますでしょうか？
問題ないようでしたら、正式版をリリースしたいと思います。

teradaさんへ

PHP Version 4.4.4

PHP4で使えないシンタックスを使っていたようです。
具体的には、以下のようなオブジェクトのリファレンスを返す関数の戻り値をそのままオブジェクトとして使う方法。

Code:

func_ret_obj()->a_method();

thrさんへ

いくつかの条件で、これが出る可能性がありそうです。
検証の必要はありそうですが、とりあえずの対処として、ちょっと荒っぽいですが、641行目の
return FALSE;
を
return array();
に変えると回避することができると思います。

本当に荒っぽすぎでした。