属性セットに属性を登録する cif を作りたい ver.8.5.7

FumitoMIZUNO · March 26, 2022, 1:18am

ContentImporterを使って、属性と属性セットを登録したいので、cifを作っています

の「 Grouping attributes in sets」に従って作ったのですが、
属性がその他に入るようなのです。

作ったcif↓

<concrete5-cif version="1.0">
    <attributesets>
        <attributeset name="会社評価" package="company_rating" handle="company_rate" category="collection">
            <attributekey handle="company_rate1" />
            <attributekey handle="company_rate2" />
            <attributekey handle="company_rate3" />
            <attributekey handle="company_rate4" />
            <attributekey handle="company_rate5" />
            <attributekey handle="company_rate6" />
            <attributekey handle="company_rateall" />
        </attributeset>
    </attributesets>
    <attributekeys>
        <attributekey handle="company_rate1" name="評価項目1" package="company_rating" searchable="1" indexed="1" type="number" category="collection" />
        <attributekey handle="company_rate2" name="評価項目2" package="company_rating" searchable="1" indexed="1" type="number" category="collection" />
        <attributekey handle="company_rate3" name="評価項目3" package="company_rating" searchable="1" indexed="1" type="number" category="collection" />
        <attributekey handle="company_rate4" name="評価項目4" package="company_rating" searchable="1" indexed="1" type="number" category="collection" />
        <attributekey handle="company_rate5" name="評価項目5" package="company_rating" searchable="1" indexed="1" type="number" category="collection" />
        <attributekey handle="company_rate6" name="評価項目6" package="company_rating" searchable="1" indexed="1" type="number" category="collection" />
        <attributekey handle="company_rateall" name="全体の評価" package="company_rating" searchable="1" indexed="1" type="number" category="collection" />
    </attributekeys>
</concrete5-cif>

katz515 · April 1, 2022, 11:48am

Concrete のサンプルコンテンツの該当箇所を見ると、
attributesets は attributekeys の後にあります。

github.com

concrete5/concrete5/blob/develop/concrete/config/install/base/attributes.xml

<?xml version="1.0"?>
<concrete5-cif version="1.0">
    <attributecategories>
        <category handle="collection" allow-sets="1" package=""/>
        <category handle="user" allow-sets="1" package=""/>
        <category handle="file" allow-sets="1" package=""/>
        <category handle="site" allow-sets="1" package=""/>
        <category handle="event" allow-sets="1" package=""/>
        <category handle="site_type" allow-sets="1" package=""/>
        <category handle="express" allow-sets="1" package=""/>
    </attributecategories>
    <attributetypes>
        <attributetype handle="text" name="Text" package="">
            <categories>
                <category handle="collection"/>
                <category handle="user"/>
                <category handle="file"/>
                <category handle="site"/>
                <category handle="event"/>
                <category handle="site_type"/>

This file has been truncated. show original

なので、CIF の中の順番を反対にしてみてはいかがでしょうか・

FumitoMIZUNO · April 4, 2022, 12:55am

以下のように、順番変えてみたけど、属性セットへの登録はされなかったです。

<?xml version="1.0"?>
<concrete5-cif version="1.0">
    <attributekeys>
        <attributekey handle="company_rate1" name="rate1" package="company_rating" searchable="1" indexed="1" type="number" category="collection" />
        <attributekey handle="company_rate2" name="rate2" package="company_rating" searchable="1" indexed="1" type="number" category="collection" />
        <attributekey handle="company_rate3" name="rate3" package="company_rating" searchable="1" indexed="1" type="number" category="collection" />
        <attributekey handle="company_rate4" name="rate4" package="company_rating" searchable="1" indexed="1" type="number" category="collection" />
        <attributekey handle="company_rate5" name="rate5" package="company_rating" searchable="1" indexed="1" type="number" category="collection" />
        <attributekey handle="company_rate6" name="rate6" package="company_rating" searchable="1" indexed="1" type="number" category="collection" />
        <attributekey handle="company_rateall" name="all" package="company_rating" searchable="1" indexed="1" type="number" category="collection" />
    </attributekeys>
    <attributesets>
        <attributeset name="rating" package="company_rating" handle="company_rate" category="collection">
            <attributekey handle="company_rate1" />
            <attributekey handle="company_rate2" />
            <attributekey handle="company_rate3" />
            <attributekey handle="company_rate4" />
            <attributekey handle="company_rate5" />
            <attributekey handle="company_rate6" />
            <attributekey handle="company_rateall" />
        </attributeset>
    </attributesets>
</concrete5-cif>

いったん属性を作った後、
もう一個別のアドオンを作って属性セットへの登録cifを実行した場合は属性セットに登録されました。

<?xml version="1.0"?>
<concrete5-cif version="1.0">
    <attributesets>
        <attributeset name="rating" package="company_rating" handle="company_rate" category="collection">
            <attributekey handle="company_rate1" />
            <attributekey handle="company_rate2" />
            <attributekey handle="company_rate3" />
            <attributekey handle="company_rate4" />
            <attributekey handle="company_rate5" />
            <attributekey handle="company_rate6" />
            <attributekey handle="company_rateall" />
        </attributeset>
    </attributesets>
</concrete5-cif>

katz515 · April 8, 2022, 8:30am

@FumitoMIZUNO
うむ。おかしいですね。

ちなみに ContentImporter はどのようなケースで利用予定ですか？
パッケージでインストールできる様にということでしょうか？

別々に登録が可能そうであれば、install() の中で CIF を2回走らせるとかですかね。

FumitoMIZUNO · April 8, 2022, 9:04am

「開発環境で属性を設定する→本番環境に属性を設定する」ときに
作業漏れやミスを防ぎたい、ですね。

なので、cifが2つに分かれる、は許容範囲ですね。

FumitoMIZUNO · April 8, 2022, 11:04pm

gist にサンプルコード置いてみました。

gist.github.com

https://gist.github.com/ounziw/ef2c9afeddcc519bea403152be577f28

controller.php

<?php
namespace Concrete\Package\Attest;

use Concrete\Core\Package\Package;
use Concrete\Core\Backup\ContentImporter;

defined('C5_EXECUTE') or die("Access Denied.");

class Controller extends Package {

This file has been truncated. show original

imort.xml

<?xml version="1.0"?>
<concrete5-cif version="1.0">
    <attributekeys>
        <attributekey handle="attsample1" name="属性1" package="" searchable="1" indexed="1" type="number" category="collection" />
    </attributekeys>
    <attributesets>
        <attributeset name="サンプル属性" package="" handle="att1" category="collection">
            <attributekey handle="attsample1" />
        </attributeset>
    </attributesets>

This file has been truncated. show original

↑cifが1つだと属性セットには登録されないっぽい

katz515 · April 15, 2022, 11:04am

@FumitoMIZUNO ありがとうございます！
では、cif を2つ書いて実行すると実装されそうっていうことですね。

ちなみにですが、

「開発環境で属性を設定する→本番環境に属性を設定する」ときに
作業漏れやミスを防ぎたい、ですね。

なるほど・・・。

ウチの場合であれば、CIF を書いて検証する時間的コストなどを考えて、

1回きりだけであれば、
手順書を書いて2人体制で本番での実施をすることで属性の登録ミスを防いだりしています。

hissy · April 15, 2022, 4:55pm

@FumitoMIZUNO

キャッシュ無効にした方がいいですよ

$pkg = parent::install();
Cache::disableAll();
$ci = new ContentImporter();
$ci->importContentFile($pkg->getPackagePath() . '/import.xml');

FumitoMIZUNO · April 20, 2022, 6:09am

キャッシュ無効にしたら、属性セットに追加されました。ありがとうございました

↑のほうに貼ったgistにもCache::disableAll()追加しました

FumitoMIZUNO · April 21, 2022, 12:26am

installContentFile()を使った方が良さそうですね。
キャッシュの無効化処理に対応している

github.com

concrete5/concrete5/blob/e50867fadc9cd1b7282ac95fc2766291b3378829/concrete/src/Package/Package.php#L319

      
        
            public function getContentSwapper()
            {
                return new ContentSwapper();
            }
            
            
/**
             * Import a concrete5-cif XML file.
             *
             * @param string $file the path to the file, relative to the package directory
             */
            public function installContentFile($file)
            {
                $ci = new ContentImporter();
                $cache = $this->app->make('cache/request');
                $cacheEnabled = $cache->isEnabled();
                if ($cacheEnabled) {
                    $cache->disable();
                }
                try {
                    $ci->importContentFile($this->getPackagePath() . '/' . $file);
                } finally {

hissy · April 21, 2022, 1:07am

そうですね。ドキュメントでもそちらが記載されています。

弊社では installContentFile の方を使っています。
サンプルパッケージもご参考まで。

github.com

MacareuxDigital/v9_package_boilerplate/blob/main/controller.php

<?php

namespace Concrete\Package\V9PackageBoilerplate;

use Concrete\Core\Block\BlockType\BlockType;
use Concrete\Core\Package\Package;
use Concrete\Core\Page\Page;
use Concrete\Core\Page\Theme\Theme;

/**
 * Package Controller.
 *
 * @see https://documentation.concretecms.org/developers/packages/directory-icon-controller
 */
class Controller extends Package
{
    /**
     * The minimum concrete5 version compatible with this package.
     *
     * @var string

This file has been truncated. show original