agent/php/ElasticApm/TransactionContextInterface.php

<?php

/*
 * Licensed to Elasticsearch B.V. under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch B.V. licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

declare(strict_types=1);

namespace Elastic\Apm;

interface TransactionContextInterface extends ExecutionSegmentContextInterface
{
    /**
     * Returns an object that can be used to collect information about HTTP request
     *
     * @link https://github.com/elastic/apm-server/blob/v7.0.0/docs/spec/context.json#L43
     * @link https://github.com/elastic/apm-server/blob/v7.0.0/docs/spec/request.json
     */
    public function request(): TransactionContextRequestInterface;

    /**
     * Returns an object thant can be used to collect information about logged in user
     *
     * @link https://github.com/elastic/apm-server/blob/v7.0.0/docs/spec/context.json#L49
     * @link https://github.com/elastic/apm-server/blob/v7.0.0/docs/spec/user.json
     */
    public function user(): TransactionContextUserInterface;
}