連載第1回!CS-Cart3アドオン作成講座 -初級編-「addon.xmlの作成とアドオンのインストール」

アドオン作成講座 -初級編- vol1

有限会社フロッグマンオフィスで行われたCS-Cartの勉強会「アドオン制作講座-初級編-」に参加しました。

今回は数回に分けてアドオンの作成方法を解説します。

  
この記事は2年以上前に書かれたものです。
情報が古い可能性があります。

検証バージョン

CS-Cart Free Edition v3.0.2-jp-1 を使用して検証しています。

INDEX

1. 「addon.xml」の作成

先ずは基本となるファイル addon.xml を作成します。
XMLは文書やデータの意味や構造を記述するためのマークアップ言語の一つで、HTMLのようにタグで構成されています。

以下のように addon.xml を作成します。これが基本の形です。
<addon scheme="2.0"></addon> の中に記述を行っていきます。

addon.xml

<?xml version="1.0"?>

<addon scheme="2.0">
   <!-- この中にアドオンに関する情報を記述していきます。 -->
</addon>

2. アドオンの基本情報

addon.xml

<?xml version="1.0"?>

<addon scheme="2.0">
    <id>webcake</id>
    <version>1.0</version> 
    <default_language>EN</default_language> 
    <name>WebCake Addon</name>
    <description>It is an add-on of original WebCake! </description>
    <priority>100</priority>
    <status>active</status>
</addon>

アドオンの基本情報を記述します。

アドオンの基本情報

  定義名称 説明
1 id アドオンの識別子。アドオンのフォルダ名と同じにしてください。 【例】/addons/webcake
2 version アドオンのバージョン
3 default_language アドオンのデフォルト言語。このオプションが指定されていない場合は英語(EN)として認識されます
4 name デフォルト言語でのアドオン名。管理画面で表示される名称です。
5 description デフォルト言語でのアドオンの説明文
6 priority アドオンの優先順位 数値が大きなアドオンほど後で実行されます
7 status アドオンをインストールした直後のステータス(有効/無効)デフォルトでは無効となります。(active または disabled を指定)

3. アドオンの基本情報の翻訳

デフォルトの言語は日本語にしても構わないのですが、英語にしておくと販売するときに海外でも使ってもらえる可能性があるのでおすすめです。
また、今回はデフォルトの言語を英語にしているので、日本語の翻訳も記述していきます。

addon.xml

<?xml version="1.0"?>

<addon scheme="2.0">
    <id>webcake</id>
    <version>1.0</version> 
    <default_language>EN</default_language> 
    <name>WebCake Addon</name>
    <description>It is an add-on of original WebCake! </description>
    <priority>100</priority>
    <status>active</status>
    
    <translations> 
        <!-- この中に翻訳情報を記述していきます。 -->
    </translations>
</addon>

先ほど記述した基本情報の翻訳は<addon scheme="2.0"></addon> の中の <translations></translations> の中に記述していきます。

addon.xml

<?xml version="1.0"?>
    
<addon scheme="2.0">
    <id>webcake</id>
    <version>1.0</version> 
    <default_language>EN</default_language> 
    <name>WebCake Addon</name>
    <description>It is an add-on of original WebCake! </description>
    <priority>100</priority>
    <status>active</status>
    
    <translations> 
        <item for="name" lang="JA">WebCakeアドオン</item>
        <item for="description" lang="JA">WebCakeのオリジナルアドオンです!</item>
    </translations>
</addon>

アドオンの基本情報の翻訳

itemタグでプロパティと翻訳する言語コードを指定する

for – 翻訳が提供されるプロパティー。 値: name/description/tooltip. オプション:デフォルトの値は”name”です。
lang – 翻訳する言語コード。ショップで使用されていない言語に関しては、インストールされません。
  プロパティ 説明
1 name 翻訳言語でのアドオン名。管理画面で表示される名称です。
2 description 翻訳言語でのアドオンの説明文

4. 「addon.xml」の配置

ディレクトリの作成
addonswebcakeaddon.xml というディレクトリ構成で addon.xml とフォルダを作成します。
webcake の部分はアドオンのid (識別子) ですので addon.xml に記述しているアドオンのidと同名にする必要があります。

addon.xmlの配置
CS-Cartの addons フォルダに作成したフォルダを被せます。
僕はMacのローカル環境で試しています。Macで被せる時は 結合 を選んでください。

CS-Cartのディレクトリに配置

5. アドオンのインストール

アドオンメニューの選択
管理画面よりメニューの 一般設定アドオン を選択します。

アドオンのインストール
作成したアドオンが表示されているので インストール をクリックします。

インストール完了
インストールが完了しました。

ここまでのサンプルファイルのダウンロード

6. まとめ

いかがでしたでしょうか。
今回はアドオンをインストールしても特に動作はしませんし、アドオンの設定ページも表示出来ません。

次回はアドオンの設定ページの作成方法をご紹介していきたいと思います。

連載記事目次

  

共有やブックマークなど