tomk79/px2-sitemapexcel

Pickles2 に、サイトマップをグラフィカルなエクセル形式(xlsx)で編集できる機能を追加します。

Thursday, August 6, 2015
by tomk79
Repository
2 Watchers
0 Stars
630 Installations

PHP
6 Dependents
0 Suggesters
0 Forks
0 Open issues
5 Versions
0 % Grown

The README.md

pickles2/px2-sitemapexcel

	Linux	Windows
master
develop

pickles2/px2-sitemapexcel は、Pickles 2 のサイトマップを、 Excel 形式 (*.xlsx) で編集できるようにするプラグインです。, _(*1)

本来の Pickles 2 のサイトマップは、CSV形式で記述されます。 CSVはもっとも単純で基本的なデータ形式の1つで、コンピューターが処理するには扱いやすいフォーマットですが、人間が編集するには不便なこともありました。このプラグインを導入することで、より直感的でグラフィカルな Excel 形式 (*.xlsx) で編集することができるようになります。, _(*2)

Excel 形式 (*.xlsx)のサイトマップファイルを直接読み込むことができるようになります。
- *.xlsx を更新すると、次のアクセス時に自動的に読み込まれ、 *.csv の内容が上書きされます。
- *.csv を更新した場合は、逆に *.xlsx が上書きされます。タイムスタンプが新しい方を正として、古い方が上書きされます。
- この挙動は、 master_format オプションおよび files_master_format オプションで変更することができます。
ページの階層構造(logical_path)を、視覚的な階層構造で表現できます。
エクセルの色付きセルやテキスト装飾などの編集機能を使い、美しい表をアレンジできます。
セル値に Excel の計算式を使うことができます。
*.xlsx の A1 のセルに、サイトマップの設定が記述されています。
- 設定例 : row_definition=8&row_data_start=9&skip_empty_col=20&version=2.0.5
- row_definition : 定義行番号
- row_data_start : データ行の開始行番号
- skip_empty_col : 定義行に値のない列がある場合、その先を読み込む列数
- version : この *.xlsx ファイルを生成した pickles2/px2-sitemapexcel のバージョン番号
A 列に、文字列 EndOfData を見つけたら、それより下の行はスキャンされません。コメント欄を追加したり、ページ数のカウンターを設置するなど、自由に使えます。
拡張カラム **delete_flg に 1 をセットすると、CSVに出力されなくなります。
1枚目のシートを使用します。2枚目以降のシートは読み取りません。

Excel ファイルの操作には、 phpoffice/phpexcel を利用しています。, _(*3)

※旧名 pickles-sitemap-excel-2 から px2-sitemapexcel へ名称変更されました。, _(*4)

導入手順 - Setup

1. composer.json に pickles2/px2-sitemapexcel を追加

require の項目に、"pickles2/px2-sitemapexcel" を追加します。, _(*5)

$ composer require pickles2/px2-sitemapexcel;

2. config.php に、機能を追加

設定ファイル config.php (通常は ./px-files/config.php) を編集します。 before_sitemap のどこか(例では最後)に、tomk79\pickles2\sitemap_excel\pickles_sitemap_excel::exec を追加します。, _(*6)

<?php
    /* 中略 */

    // funcs: Before sitemap
    $conf->funcs->before_sitemap = [
         // PX=config
        'picklesFramework2\commands\config::register' ,

         // PX=phpinfo
        'picklesFramework2\commands\phpinfo::register' ,

        // PX=clearcache
        'picklesFramework2\commands\clearcache::register' ,

        // sitemapExcel
        'tomk79\pickles2\sitemap_excel\pickles_sitemap_excel::exec'
    ];

Pickles 2 の設定をJSON形式で編集している方は、config.json の該当箇所に追加してください。, _(*7)

3. サイトマップディレクトリのパーミッション設定

macOS や Linux系の OS ではこの操作が必要な場合があります。, _(*8)

$ cd {$documentRoot}
$ chmod -R 777 ./px-files/sitemaps

4. サイトマップディレクトリに sitemap.xlsx を設置

エクセルファイルは、このリポジトリに同梱されている sitemap.xlsx をサンプルに作成してみてください。, _(*9)

編集したファイルは、あなたの Pickles 2 のサイトマップディレクトリ(通常は ./px-files/sitemaps/) に置きます。次回、ブラウザでアクセスした最初に、同名のCSVファイル(sitemap.xlsx なら、sitemap.csv)が自動的に更新されます。その後も、エクセルのタイムスタンプが更新されるたびに、CSVファイルは自動更新されます。, _(*10)

逆に、XLSXファイルよりも新しいCSVファイルがある場合は、XLSXファイルがCSVファイルの内容に従って更新されます。, _(*11)

オプション - Options

<?php
    // funcs: Before sitemap
    $conf->funcs->before_sitemap = [
        // sitemapExcel
        'tomk79\pickles2\sitemap_excel\pickles_sitemap_excel::exec('.json_encode(array(
            // `master_format`
            // マスターにするファイルフォーマットを指定します。
            //   - `timestamp` = タイムスタンプが新しい方をマスターにする(デフォルト)
            //   - `xlsx` = XLSXをマスターにする
            //   - `csv` = CSVをマスターにする
            //   - `pass` = 変換しない
            // のいずれかを指定します。
            'master_format'=>'timestamp',

            // `files_master_format`
            // サイトマップファイル名ごとにマスターにするファイルフォーマットを指定します。
            // ここに設定されていないファイルは、 `master_format` の設定に従います。
            'files_master_format'=>array(
                'timestamp_sitemap'=>'timestamp',
                'csv_master_sitemap'=>'csv',
                'xlsx_master_sitemap'=>'xlsx',
                'no_convert'=>'pass',
            ),

            // `files_master_format_blogs`
            // ブログファイル名ごとにマスターにするファイルフォーマットを指定します。
            // ここに設定されていないファイルは、 `master_format` の設定に従います。
            'files_master_format_blogs'=>array(
                'timestamp_sitemap'=>'timestamp',
                'csv_master_sitemap'=>'csv',
                'xlsx_master_sitemap'=>'xlsx',
                'no_convert'=>'pass',
            ),
        )).')'
    ];

更新履歴 - Change log