xref: /aosp_15_r20/external/grpc-grpc/src/php/lib/Grpc/Status.php (revision cc02d7e222339f7a4f6ba5f422e6413f4bd931f2)
1*cc02d7e2SAndroid Build Coastguard Worker<?php
2*cc02d7e2SAndroid Build Coastguard Worker/*
3*cc02d7e2SAndroid Build Coastguard Worker *
4*cc02d7e2SAndroid Build Coastguard Worker * Copyright 2020 gRPC authors.
5*cc02d7e2SAndroid Build Coastguard Worker *
6*cc02d7e2SAndroid Build Coastguard Worker * Licensed under the Apache License, Version 2.0 (the "License");
7*cc02d7e2SAndroid Build Coastguard Worker * you may not use this file except in compliance with the License.
8*cc02d7e2SAndroid Build Coastguard Worker * You may obtain a copy of the License at
9*cc02d7e2SAndroid Build Coastguard Worker *
10*cc02d7e2SAndroid Build Coastguard Worker *     http://www.apache.org/licenses/LICENSE-2.0
11*cc02d7e2SAndroid Build Coastguard Worker *
12*cc02d7e2SAndroid Build Coastguard Worker * Unless required by applicable law or agreed to in writing, software
13*cc02d7e2SAndroid Build Coastguard Worker * distributed under the License is distributed on an "AS IS" BASIS,
14*cc02d7e2SAndroid Build Coastguard Worker * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15*cc02d7e2SAndroid Build Coastguard Worker * See the License for the specific language governing permissions and
16*cc02d7e2SAndroid Build Coastguard Worker * limitations under the License.
17*cc02d7e2SAndroid Build Coastguard Worker *
18*cc02d7e2SAndroid Build Coastguard Worker */
19*cc02d7e2SAndroid Build Coastguard Worker
20*cc02d7e2SAndroid Build Coastguard Workernamespace Grpc;
21*cc02d7e2SAndroid Build Coastguard Worker
22*cc02d7e2SAndroid Build Coastguard Worker/**
23*cc02d7e2SAndroid Build Coastguard Worker * This is an experimental and incomplete implementation of gRPC server
24*cc02d7e2SAndroid Build Coastguard Worker * for PHP. APIs are _definitely_ going to be changed.
25*cc02d7e2SAndroid Build Coastguard Worker *
26*cc02d7e2SAndroid Build Coastguard Worker * DO NOT USE in production.
27*cc02d7e2SAndroid Build Coastguard Worker */
28*cc02d7e2SAndroid Build Coastguard Worker
29*cc02d7e2SAndroid Build Coastguard Worker/**
30*cc02d7e2SAndroid Build Coastguard Worker * Class Status
31*cc02d7e2SAndroid Build Coastguard Worker * @package Grpc
32*cc02d7e2SAndroid Build Coastguard Worker */
33*cc02d7e2SAndroid Build Coastguard Workerclass Status
34*cc02d7e2SAndroid Build Coastguard Worker{
35*cc02d7e2SAndroid Build Coastguard Worker    public static function status(int $code, string $details, array $metadata = null): array
36*cc02d7e2SAndroid Build Coastguard Worker    {
37*cc02d7e2SAndroid Build Coastguard Worker        $status = [
38*cc02d7e2SAndroid Build Coastguard Worker            'code' => $code,
39*cc02d7e2SAndroid Build Coastguard Worker            'details' => $details,
40*cc02d7e2SAndroid Build Coastguard Worker        ];
41*cc02d7e2SAndroid Build Coastguard Worker        if ($metadata) {
42*cc02d7e2SAndroid Build Coastguard Worker            $status['metadata'] = $metadata;
43*cc02d7e2SAndroid Build Coastguard Worker        }
44*cc02d7e2SAndroid Build Coastguard Worker        return $status;
45*cc02d7e2SAndroid Build Coastguard Worker    }
46*cc02d7e2SAndroid Build Coastguard Worker
47*cc02d7e2SAndroid Build Coastguard Worker    public static function ok(array $metadata = null): array
48*cc02d7e2SAndroid Build Coastguard Worker    {
49*cc02d7e2SAndroid Build Coastguard Worker        return Status::status(STATUS_OK, 'OK', $metadata);
50*cc02d7e2SAndroid Build Coastguard Worker    }
51*cc02d7e2SAndroid Build Coastguard Worker    public static function unimplemented(): array
52*cc02d7e2SAndroid Build Coastguard Worker    {
53*cc02d7e2SAndroid Build Coastguard Worker        return Status::status(STATUS_UNIMPLEMENTED, 'UNIMPLEMENTED');
54*cc02d7e2SAndroid Build Coastguard Worker    }
55*cc02d7e2SAndroid Build Coastguard Worker}
56