system-setting.html

<!DOCTYPE html>
<html lang="ja">
    <head>
        <meta charset="utf-8" />
        <meta name="viewport" content="width=device-width, initial-scale=1" />

        <title>システム設定ファイル | SOCKET-MANAGER Framework For PHP</title>
        <meta name="description" content="SOCKET-MANAGERフレームワークのシステム設定を解説。タイムゾーンやロケールの設定方法など、多言語対応の実装例と共に紹介。" />
        <meta content="PHP,タイムゾーン,framework,i18n,システム設定,ソケットマネージャー" name="keywords">
        <link rel="canonical" href="https://socket-manager.github.io/document/system-setting.html" />

        <script async src="https://www.googletagmanager.com/gtag/js?id=G-LF9W695NNW"></script>
        <script>
          window.dataLayer = window.dataLayer || [];
          function gtag(){dataLayer.push(arguments);}
          gtag('js', new Date());
        
          gtag('config', 'G-LF9W695NNW');
        </script>
        <link rel="icon" href="https://socket-manager.github.io/document/favicon.ico" type="image/x-icon" />
        <link type="text/css" rel="stylesheet" href="./css/common.css" media="all" />
        <script src="./js/jquery-3.7.1.min.js"></script>
        <script type="text/javascript" src="./js/common.js"></script>
        <script type="application/ld+json">
        {
            "@context": "https://schema.org",
            "@type": "TechArticle",
            "headline": "SOCKET-MANAGER Framework - システム設定ガイド",
            "description": "SOCKET-MANAGERフレームワークのシステム設定を解説。タイムゾーンやロケールの設定方法など、多言語対応の実装例と共に紹介。",
            "keywords": "PHP, ソケット通信, システム設定, 多言語対応, ソケットマネージャー",
            "articleSection": ["Technical Documentation", "Server Development", "PHP Programming"],
            "author": {
                "@type": "Person",
                "name": "SOCKET-MANAGER開発チーム"
            },
            "publisher": {
                "@type": "Organization",
                "name": "SOCKET-MANAGER",
                "logo": {
                    "@type": "ImageObject",
                    "url": "https://socket-manager.github.io/document/logo.png",
                    "width": 355,
                    "height": 50
                }
            },
            "mainEntityOfPage": {
                "@type": "WebPage",
                "@id": "https://socket-manager.github.io/document/system-setting.html"
            },
            "url": "https://socket-manager.github.io/document/system-setting.html",
            "breadcrumb": {
                "@type": "BreadcrumbList",
                "itemListElement": [{
                    "@type": "ListItem",
                    "position": 1,
                    "name": "Framework Top",
                    "item": "https://socket-manager.github.io/document/"
                },{
                    "@type": "ListItem",
                    "position": 2,
                    "name": "システム設定ファイル",
                    "item": "https://socket-manager.github.io/document/system-setting.html"
                }]
            },
            "isPartOf": {
                "@type": "WebSite",
                "name": "フレームワークのご紹介",
                "url": "https://socket-manager.github.io/document/"
            }
        }
        </script>
    </head>
    <body>
        <div class="layout">
            <div class="menu" role="navigation" aria-label="ページメニュー">
                <h2 class="menu-title">SOCKET-MANAGER</h2>
                <h4 class="menu-reference menu-page-title-bottom"><a href="./reference/" target="_blank" rel="noopener">&gt;&gt; Reference</a></h4>
                <h2 class="menu-label">MAIN-MENU</h2>
                <div class="menu-text">

                    <h3 class="menu-page-title-link"><a href="./">▶フレームワークのご紹介</a></h3>

                    <h3 class="menu-page-title-link"><a href="./event-handler.html">▶イベントハンドラについて</a></h3>

                </div>
                <h3 class="menu-label-sub">IMPLEMENT</h3>
                <div class="menu-text">

                    <h3 class="menu-page-title-link"><a href="./init-class.html">▶初期化クラス</a></h3>

                    <h3 class="menu-page-title-link"><a href="./unit-parameter.html">▶UNITパラメータクラス</a></h3>

                    <h3 class="menu-page-title-link"><a href="./protocol-unit.html">▶プロトコルUNITクラス</a></h3>

                    <h3 class="menu-page-title-link"><a href="./command-unit.html">▶コマンドUNITクラス</a></h3>

                    <h3 class="menu-page-title-link"><a href="./main.html">▶メイン処理クラス</a></h3>

                    <h3 class="menu-page-title-link"><a href="./setting.html">▶設定ファイル</a></h3>

                    <h3 class="menu-page-title-link"><a href="./message.html">▶メッセージファイル</a></h3>

                </div>
                <div class="menu-line"></div>
                <div class="menu-text">

                    <h3 class="menu-page-title-link-for-runtime-manager"><a href="./runtime-manager/" target="_blank" rel="noopener">&gt;&gt; ランタイムライブラリ</a></h3>

                    <h3 class="menu-page-title-link-for-runtime-manager"><a href="./simple-socket/" target="_blank" rel="noopener">&gt;&gt; シンプルソケット機能</a></h3>

                </div>
                <h3 class="menu-label-sub">ADVANCED</h3>
                <div class="menu-text">

                    <h3 class="menu-page-title-link"><a href="./concept.html">▶設計コンセプト</a></h3>

                    <h3 class="menu-page-title-link"><a href="./architecture.html">▶アーキテクチャ</a></h3>

                    <h3 class="menu-page-title-link"><a href="./communication.html">▶通信抽象化</a></h3>

                    <h3 class="menu-page-title-link"><a href="./union.html">▶共有基盤</a></h3>

                    <h3 class="menu-page-title-link"><a href="./event.html">▶イベント駆動アーキテクチャ</a></h3>

                    <h3 class="menu-page-title-link"><a href="./ipc.html">▶IPC（プロセス間通信）</a></h3>

                    <h3 class="menu-page-title-link"><a href="./multi-server.html">▶マルチサーバーの構成</a></h3>

                    <h3 class="menu-page-title-link"><a href="./tcp-and-udp.html">▶TCP/UDP通信について</a></h3>

                    <h3 class="menu-page-title-link"><a href="./laravel.html">▶Laravelと連携する</a></h3>

                    <h3 class="menu-page-title">▼システム設定ファイル</h3>

                    <ul>
                        <li><a href="./system-setting.html#begin">はじめに</a></li>
                    </ul>
                    <ul>
                        <li><a href="./system-setting.html#timezone">タイムゾーン（timezone）</a></li>
                    </ul>
                    <ul>
                        <li><a href="./system-setting.html#locale">ロケール（locale）</a></li>
                    </ul>

                    <h3 class="menu-page-title-link"><a href="./custom-command.html">▶カスタムコマンド作成機能</a></h3>

                    <h3 class="menu-page-title-link"><a href="./high-performance.html">▶ハイパフォーマンスモード</a></h3>

                    <h3 class="menu-page-title-link"><a href="./scale-test.html">▶WebSocket スケール性能</a></h3>

                    <h3 class="menu-page-title-link"><a href="./pure-tcp-scale.html">▶純粋 TCP スケール性能</a></h3>

                    <h3 class="menu-page-title-link"><a href="./itil.html">▶技術版 ITIL としての CUEI/O</a></h3>

                </div>
                <h3 class="menu-label-sub">OTHER-PROJECT</h3>
                <div class="menu-text">

                    <h3 class="menu-page-title-link"><a href="./new-project.html">▶新規開発環境</a></h3>

                    <h3 class="menu-page-title-link"><a href="./websocket.html">▶Websocketサーバー開発環境</a></h3>

                    <h3 class="menu-page-title-link"><a href="./dev-ops.html">▶フレームワークのDevOps環境</a></h3>

                </div>
                <div class="menu-line"></div>
                <div class="menu-text">

                    <h3 class="menu-page-title-link-for-minecraft"><a href="./minecraft-contents/" target="_blank" rel="noopener">&gt;&gt; マインクラフト専用環境</a></h3>

                    <h3 class="menu-page-title-link-for-launcher"><a href="./launcher/" target="_blank" rel="noopener">&gt;&gt; GUI & CLI ランチャー</a></h3>

                    <h3 class="menu-page-title-link-for-rest-api"><a href="./rest-api/" target="_blank" rel="noopener">&gt;&gt; REST-APIサーバー開発環境</a></h3>

                </div>
                <h2 class="menu-label">EXTRA-MENU</h2>
                <div class="menu-text">

                    <h3 class="menu-page-title-link"><a href="./extra-demo.html">▶デモサーバーの種類</a></h3>

                    <h3 class="menu-page-title-link"><a href="./extra-demo-command.html">▶デモのコマンド仕様</a></h3>

                    <h3 class="menu-page-title-link"><a href="./extra-demo-setting.html">▶デモの設定ファイル</a></h3>

                    <h3 class="menu-page-title-link"><a href="./extra-minecraft.html">▶マインクラフトの通信仕様</a></h3>

                    <h3 class="menu-page-title-link"><a href="./extra-close-frame.html">▶切断フレームの検証</a></h3>

                </div>
                <h2 class="menu-label">PHP-TECHNIQUE</h2>
                <div class="menu-text">

                    <h3 class="menu-page-title-link"><a href="./php-pass-by-reference.html">▶参照渡し</a></h3>

                    <h3 class="menu-page-title-link"><a href="./php-phpdoc.html">▶PHPDocのフォーマット</a></h3>

                </div>
                <div class="menu-dummy-for-framework"></div>
            </div>
            <div class="main" role="main">

                <h1>【システム設定ファイル】</h1>

                <a id="begin"></a>
                <h2 class="subtitle">はじめに</h2>

                <div class="text-block">
                    以下の場所にプロジェクト常設のシステム設定ファイルが配置されています。<br />

                    <pre aria-label="システム設定ファイルの格納場所">
/setting/app.php
                    </pre><br />

                    以降では各設定項目について説明しています。
                </div><br />

                <a id="timezone"></a>
                <h2 class="subtitle">タイムゾーン（timezone）</h2>

                <div class="text-block">
                    PHPのネイティブ関数であるdate_default_timezone_setの引数に渡すタイムゾーンを指定します。デフォルトは<code>Asia/Tokyo</code>です。<br />
                    タイムゾーンを指定する事によって国や地域毎にローカライズされた正しい日時を扱えるようになります。<br />
                    指定できるタイムゾーンは<font><a href="https://www.php.net/manual/ja/timezones.php" target="_blank" rel="noopener">&gt;&gt; こちら</a></font>をご覧ください。
                </div><br />

                <a id="locale"></a>
                <h2 class="subtitle">ロケール（locale）</h2>

                <div class="text-block">
                    システム内で使用する言語コードを指定します。デフォルトは<code>ja</code>です。<br />
                    コマンドのUsageや例外メッセージと<code>craft:locale</code>コマンド等を使って生成されたメッセージファイルの判定に利用されます。<br /><br />

                    ライブラリ内で使用されるコマンドのUsageや例外メッセージについては<code>ja</code>（日本語）と<code>en</code>（英語）の２値だけが利用されます。<br /><br />

                    例えば<code>ja</code>指定の場合は以下のように日本語で表示されます。<br />

                    <pre color-change="command" aria-label="Usage表示（日本語）">
> php worker

SOCKET-MANAGER Framework 1.X.X

Usage:
  command [arguments]

 main
  Empty...
 craft
  craft:init <初期化クラス名>                     初期化クラスの生成
  craft:parameter &lt;UNITパラメータクラス名&gt;        UNITパラメータクラスの生成
  craft:protocol <プロトコルUNIT定義のクラス名>   プロトコルUNIT定義のクラスとステータス名Enumの生成
  craft:command <コマンドUNIT定義のクラス名>      コマンドUNIT定義のクラスとキュー／ステータス名Enumの生成
  craft:main <メイン処理のクラス名>               メイン処理クラスの生成
  craft:setting <設定ファイル名>                  設定ファイルの生成
  craft:locale <メッセージファイル名>             メッセージファイルの生成
 runtime
  runtime:init <初期化クラス名>                   初期化クラスの生成
  runtime:parameter &lt;UNITパラメータクラス名&gt;      UNITパラメータクラスの生成
  runtime:units <ランタイムUNIT定義のクラス名>    ランタイムUNIT定義のクラスとキュー／ステータス名Enumの生成
  runtime:main <メイン処理のクラス名>             メイン処理クラスの生成
 simple
  simple:tcp-server <メイン処理のクラス名>        TCPサーバー用メイン処理クラスの生成
  simple:tcp-client <メイン処理のクラス名>        TCPクライアント用メイン処理クラスの生成
  simple:udp <メイン処理のクラス名>               UDP通信用メイン処理クラスの生成
                    </pre><br />

                    <code>en</code>を指定すれば以下のように英語で表示されます。<br />

                    <pre color-change="command" aria-label="Usage表示（英語）">
> php worker

SOCKET-MANAGER Framework 1.0.0

Usage:
  command [arguments]

 main
  Empty...
 craft
  craft:init &lt;initialization class name&gt;                  Generating initialization class
  craft:parameter &lt;UNIT parameter class name&gt;             Generate UNIT parameter class
  craft:protocol &lt;Class name of protocol UNIT definition&gt; Generate class and status name Enum for protocol UNIT definition
  craft:command &lt;Command UNIT definition class name&gt;      Generate command UNIT definition class and queue/status name Enum
  craft:main &lt;Main processing class name&gt;                 Generating main processing class
  craft:setting &lt;configuration file name&gt;                 Generate configuration file
  craft:locale &lt;message file name&gt;                        Generate message file
 runtime
  runtime:init <初期化クラス名>                   初期化クラスの生成
  runtime:parameter &lt;UNITパラメータクラス名&gt;      UNITパラメータクラスの生成
  runtime:units <ランタイムUNIT定義のクラス名>    ランタイムUNIT定義のクラスとキュー／ステータス名Enumの生成
  runtime:main <メイン処理のクラス名>             メイン処理クラスの生成
 simple
  simple:tcp-server <メイン処理のクラス名>        TCPサーバー用メイン処理クラスの生成
  simple:tcp-client <メイン処理のクラス名>        TCPクライアント用メイン処理クラスの生成
  simple:udp <メイン処理のクラス名>               UDP通信用メイン処理クラスの生成
                    </pre><br />

                    ※コーダーが任意で利用できる<code>UnitExceptionEnum</code>の<code>message</code>メソッドには任意で指定された言語コードが適用されます。<br />
                    ※上記２値以外を指定した場合のデフォルトスタンダードは<code>en</code>です。<br />
                    ※<code>craft:locale</code>コマンドと連携した使い方については<font><a href="./message.html" target="_blank" rel="noopener">▶メッセージファイル</a></font>のページをご覧ください。
                </div><br />
            </div>
        </div>
    </body>
</html>