PHPのお勉強！

PHP TOP
PHP 8.4.2 Released!

    例

    PHP で Apache Solr 拡張モジュールを使用する方法の例

    例1 ブートストラップ・ファイルの内容

    <?php

    /* Solr サーバーのドメイン名 */
    define('SOLR_SERVER_HOSTNAME', 'solr.example.com');

    /* セキュアなモードで動作するかどうか */
    define('SOLR_SECURE', true);

    /* 接続する HTTP ポート */
    define('SOLR_SERVER_PORT', ((SOLR_SECURE) ? 8443 : 8983));

    /* HTTP Basic 認証ユーザー名 */
    define('SOLR_SERVER_USERNAME', 'admin');

    /* HTTP Basic 認証パスワード */
    define('SOLR_SERVER_PASSWORD', 'changeit');

    /* HTTP 接続タイムアウト */
    /* HTTP データ転送動作に許される、秒単位の最大時間。既定値は３０秒 */
    define('SOLR_SERVER_TIMEOUT', 10);

    /* PEM 形式のプライベートキーとプライベート証明書に対するファイル名（その順序で連結されます） */
    define('SOLR_SSL_CERT', 'certs/combo.pem');

    /* PEM 形式のプライベート証明書のみに対するファイル名 */
    define('SOLR_SSL_CERT_ONLY', 'certs/solr.crt');

    /* PEM 形式のプライベートキーに対するファイル名 */
    define('SOLR_SSL_KEY', 'certs/solr.key');

    /* PEM 形式のプライベートキー・ファイルに対するパスワード */
    define('SOLR_SSL_KEYPASSWORD', 'StrongAndSecurePassword');

    /* 同等であることを証明する、一つ以上の CA 証明書を持つファイル名 */
    define('SOLR_SSL_CAINFO', 'certs/cacert.crt');

    /* 同等であることを証明する、複数の CA 証明書があるディレクトリ名 */
    define('SOLR_SSL_CAPATH', 'certs/');

    ?>

    例2 インデックスに文書を追加

    <?php

    include "bootstrap.php";

    $options = array
    (
    'hostname' => SOLR_SERVER_HOSTNAME,
    'login' => SOLR_SERVER_USERNAME,
    'password' => SOLR_SERVER_PASSWORD,
    'port' => SOLR_SERVER_PORT,
    );

    $client = new SolrClient($options);

    $doc = new SolrInputDocument();

    $doc->addField('id', 334455);
    $doc->addField('cat', 'Software');
    $doc->addField('cat', 'Lucene');

    $updateResponse = $client->addDocument($doc);

    print_r($updateResponse->getResponse());

    ?>

    上の例の出力は、 たとえば以下のようになります。

    SolrObject Object
(
    [responseHeader] => SolrObject Object
        (
            [status] => 0
            [QTime] => 446
        )

)

    例3 ある文書を他の文書にマージ

    <?php

    include "bootstrap.php";

    $doc = new SolrDocument();

    $second_doc = new SolrDocument();

    $doc->addField('id', 1123);

    $doc->features = "PHP Client Side";
    $doc->features = "Fast development cycles";

    $doc['cat'] = 'Software';
    $doc['cat'] = 'Custom Search';
    $doc->cat = 'Information Technology';

    $second_doc->addField('cat', 'Lucene Search');

    $second_doc->merge($doc, true);

    print_r($second_doc->toArray());


    ?>

    上の例の出力は、 たとえば以下のようになります。

    Array
(
    [document_boost] => 0
    [field_count] => 3
    [fields] => Array
        (
            [0] => SolrDocumentField Object
                (
                    [name] => cat
                    [boost] => 0
                    [values] => Array
                        (
                            [0] => Software
                            [1] => Custom Search
                            [2] => Information Technology
                        )

                )

            [1] => SolrDocumentField Object
                (
                    [name] => id
                    [boost] => 0
                    [values] => Array
                        (
                            [0] => 1123
                        )

                )

            [2] => SolrDocumentField Object
                (
                    [name] => features
                    [boost] => 0
                    [values] => Array
                        (
                            [0] => PHP Client Side
                            [1] => Fast development cycles
                        )

                )

        )

)

    例4 文書を検索 - SolrObject レスポンス

    <?php

    include "bootstrap.php";

    $options = array
    (
    'hostname' => SOLR_SERVER_HOSTNAME,
    'login' => SOLR_SERVER_USERNAME,
    'password' => SOLR_SERVER_PASSWORD,
    'port' => SOLR_SERVER_PORT,
    );

    $client = new SolrClient($options);

    $query = new SolrQuery();

    $query->setQuery('lucene');

    $query->setStart(0);

    $query->setRows(50);

    $query->addField('cat')->addField('features')->addField('id')->addField('timestamp');

    $query_response = $client->query($query);

    $response = $query_response->getResponse();

    print_r($response);

    ?>

    上の例の出力は、 たとえば以下のようになります。

    SolrObject Object
(
    [responseHeader] => SolrObject Object
        (
            [status] => 0
            [QTime] => 1
            [params] => SolrObject Object
                (
                    [wt] => xml
                    [rows] => 50
                    [start] => 0
                    [indent] => on
                    [q] => lucene
                    [fl] => cat,features,id,timestamp
                    [version] => 2.2
                )

        )

    [response] => SolrObject Object
        (
            [numFound] => 3
            [start] => 0
            [docs] => Array
                (
                    [0] => SolrObject Object
                        (
                            [cat] => Array
                                (
                                    [0] => Software
                                    [1] => Lucene
                                )

                            [id] => 334456
                        )

                    [1] => SolrObject Object
                        (
                            [cat] => Array
                                (
                                    [0] => Software
                                    [1] => Lucene
                                )

                            [id] => 334455
                        )

                    [2] => SolrObject Object
                        (
                            [cat] => Array
                                (
                                    [0] => software
                                    [1] => search
                                )

                            [features] => Array
                                (
                                    [0] => Advanced Full-Text Search Capabilities using Lucene
                                    [1] => Optimized for High Volume Web Traffic
                                    [2] => Standards Based Open Interfaces - XML and HTTP
                                    [3] => Comprehensive HTML Administration Interfaces
                                    [4] => Scalability - Efficient Replication to other Solr Search Servers
                                    [5] => Flexible and Adaptable with XML configuration and Schema
                                    [6] => Good unicode support: hello (hello with an accent over the e)
                                )

                            [id] => SOLR1000
                            [timestamp] => 2009-09-04T20:38:55.906
                        )

                )

        )

)

    例5 文書を検索 - SolrDocument レスポンス

    <?php

    include "bootstrap.php";

    $options = array
    (
    'hostname' => SOLR_SERVER_HOSTNAME,
    'login' => SOLR_SERVER_USERNAME,
    'password' => SOLR_SERVER_PASSWORD,
    'port' => SOLR_SERVER_PORT,
    );

    $client = new SolrClient($options);

    $query = new SolrQuery();

    $query->setQuery('lucene');

    $query->setStart(0);

    $query->setRows(50);

    $query->addField('cat')->addField('features')->addField('id')->addField('timestamp');

    $query_response = $client->query($query);

    $query_response->setParseMode(SolrQueryResponse::PARSE_SOLR_DOC);

    $response = $query_response->getResponse();

    print_r($response);

    ?>

    上の例の出力は、 たとえば以下のようになります。

    SolrObject Object
(
    [responseHeader] => SolrObject Object
        (
            [status] => 0
            [QTime] => 1
            [params] => SolrObject Object
                (
                    [wt] => xml
                    [rows] => 50
                    [start] => 0
                    [indent] => on
                    [q] => lucene
                    [fl] => cat,features,id,timestamp
                    [version] => 2.2
                )

        )

    [response] => SolrObject Object
        (
            [numFound] => 3
            [start] => 0
            [docs] => Array
                (
                    [0] => SolrDocument Object
                        (
                            [_hashtable_index:SolrDocument:private] => 19740
                        )

                    [1] => SolrDocument Object
                        (
                            [_hashtable_index:SolrDocument:private] => 25485
                        )

                    [2] => SolrDocument Object
                        (
                            [_hashtable_index:SolrDocument:private] => 25052
                        )

                )

        )

)

    例6 簡単な TermsComponent 例 - 基本

    <?php

    include "bootstrap.php";

    $options = array
    (
    'hostname' => SOLR_SERVER_HOSTNAME,
    'login' => SOLR_SERVER_USERNAME,
    'password' => SOLR_SERVER_PASSWORD,
    'port' => SOLR_SERVER_PORT,
    );

    $client = new SolrClient($options);

    $query = new SolrQuery();

    $query->setTerms(true);

    $query->setTermsField('cat');

    $updateResponse = $client->query($query);

    print_r($updateResponse->getResponse());

    ?>

    上の例の出力は、 たとえば以下のようになります。

    SolrObject Object
(
    [responseHeader] => SolrObject Object
        (
            [status] => 0
            [QTime] => 2
        )

    [terms] => SolrObject Object
        (
            [cat] => SolrObject Object
                (
                    [electronics] => 14
                    [Lucene] => 4
                    [Software] => 4
                    [memory] => 3
                    [card] => 2
                    [connector] => 2
                    [drive] => 2
                    [graphics] => 2
                    [hard] => 2
                    [monitor] => 2
                )

        )

)

    例7 簡単な TermsComponent 例 - 接頭辞を使用

    <?php

    include "bootstrap.php";

    $options = array
    (
    'hostname' => SOLR_SERVER_HOSTNAME,
    'login' => SOLR_SERVER_USERNAME,
    'password' => SOLR_SERVER_PASSWORD,
    'port' => SOLR_SERVER_PORT,
    );

    $client = new SolrClient($options);

    $query = new SolrQuery();

    $query->setTerms(true);

    /* $prefix で始まる語だけを返す */
    $prefix = 'c';

    $query->setTermsField('cat')->setTermsPrefix($prefix);

    $updateResponse = $client->query($query);

    print_r($updateResponse->getResponse());

    ?>

    上の例の出力は、 たとえば以下のようになります。

    SolrObject Object
(
    [responseHeader] => SolrObject Object
        (
            [status] => 0
            [QTime] => 1
        )

    [terms] => SolrObject Object
        (
            [cat] => SolrObject Object
                (
                    [card] => 2
                    [connector] => 2
                    [camera] => 1
                    [copier] => 1
                )

        )

)

    例8 簡単な TermsComponent 例 - 最小の頻度を指定

    <?php

    include "bootstrap.php";

    $options = array
    (
    'hostname' => SOLR_SERVER_HOSTNAME,
    'login' => SOLR_SERVER_USERNAME,
    'password' => SOLR_SERVER_PASSWORD,
    'port' => SOLR_SERVER_PORT,
    );

    $client = new SolrClient($options);

    $query = new SolrQuery();

    $query->setTerms(true);

    /* $prefix で始まる語だけを返す */
    $prefix = 'c';

    /* 2回以上の頻度の語だけを返す */
    $min_frequency = 2;

    $query->setTermsField('cat')->setTermsPrefix($prefix)->setTermsMinCount($min_frequency);

    $updateResponse = $client->query($query);

    print_r($updateResponse->getResponse());

    ?>

    上の例の出力は、 たとえば以下のようになります。

    SolrObject Object
(
    [responseHeader] => SolrObject Object
        (
            [status] => 0
            [QTime] => 0
        )

    [terms] => SolrObject Object
        (
            [cat] => SolrObject Object
                (
                    [card] => 2
                    [connector] => 2
                )

        )

)

    例9 簡単なファセット例

    <?php

    include "bootstrap.php";

    $options = array
    (
    'hostname' => SOLR_SERVER_HOSTNAME,
    'login' => SOLR_SERVER_USERNAME,
    'password' => SOLR_SERVER_PASSWORD,
    'port' => SOLR_SERVER_PORT,
    );

    $client = new SolrClient($options);

    $query = new SolrQuery('*:*');

    $query->setFacet(true);

    $query->addFacetField('cat')->addFacetField('name')->setFacetMinCount(2);

    $updateResponse = $client->query($query);

    $response_array = $updateResponse->getResponse();

    $facet_data = $response_array->facet_counts->facet_fields;

    print_r($facet_data);

    ?>

    上の例の出力は、 たとえば以下のようになります。

    SolrObject Object
(
    [cat] => SolrObject Object
        (
            [electronics] => 14
            [memory] => 3
            [Lucene] => 2
            [Software] => 2
            [card] => 2
            [connector] => 2
            [drive] => 2
            [graphics] => 2
            [hard] => 2
            [monitor] => 2
            [search] => 2
            [software] => 2
        )

    [name] => SolrObject Object
        (
            [gb] => 6
            [1] => 3
            [184] => 3
            [2] => 3
            [3200] => 3
            [400] => 3
            [500] => 3
            [ddr] => 3
            [i] => 3
            [ipod] => 3
            [memori] => 3
            [pc] => 3
            [pin] => 3
            [pod] => 3
            [sdram] => 3
            [system] => 3
            [unbuff] => 3
            [canon] => 2
            [corsair] => 2
            [drive] => 2
            [hard] => 2
            [mb] => 2
            [n] => 2
            [power] => 2
            [retail] => 2
            [video] => 2
            [x] => 2
        )

)

    例10 簡単なファセット例 - mincount を越える任意の項目と共に

    <?php

    include "bootstrap.php";

    $options = array
    (
    'hostname' => SOLR_SERVER_HOSTNAME,
    'login' => SOLR_SERVER_USERNAME,
    'password' => SOLR_SERVER_PASSWORD,
    'port' => SOLR_SERVER_PORT,
    );

    $client = new SolrClient($options);

    $query = new SolrQuery('*:*');

    $query->setFacet(true);

    $query->addFacetField('cat')->addFacetField('name')->setFacetMinCount(2)->setFacetMinCount(4, 'name');

    $updateResponse = $client->query($query);

    $response_array = $updateResponse->getResponse();

    $facet_data = $response_array->facet_counts->facet_fields;

    print_r($facet_data);

    ?>

    上の例の出力は、 たとえば以下のようになります。

    SolrObject Object
(
    [cat] => SolrObject Object
        (
            [electronics] => 14
            [memory] => 3
            [Lucene] => 2
            [Software] => 2
            [card] => 2
            [connector] => 2