Test

<back to all web services

HelloWithEnum

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


enum EnumType : string
{
    case Value1 = 'Value1';
    case Value2 = 'Value2';
    case Value3 = 'Value3';
}

// @Flags()
enum EnumTypeFlags : int
{
    case Value1 = 0;
    case Value2 = 1;
    case Value3 = 2;
}

enum EnumWithValues : string
{
    case None = 'None';
    case Value1 = 'Member 1';
    case Value2 = 'Value2';
}

// @Flags()
enum EnumFlags : int
{
    case Value0 = 0;
    case Value1 = 1;
    case Value2 = 2;
    case Value3 = 4;
    case Value123 = 7;
}

enum EnumAsInt : int
{
    case Value1 = 1000;
    case Value2 = 2000;
    case Value3 = 3000;
}

enum EnumStyle : string
{
    case lower = 'lower';
    case UPPER = 'UPPER';
    case PascalCase = 'PascalCase';
    case camelCase = 'camelCase';
    case camelUPPER = 'camelUPPER';
    case PascalUPPER = 'PascalUPPER';
}

enum EnumStyleMembers : string
{
    case Lower = 'lower';
    case Upper = 'UPPER';
    case PascalCase = 'PascalCase';
    case CamelCase = 'camelCase';
    case CamelUpper = 'camelUPPER';
    case PascalUpper = 'PascalUPPER';
}

class HelloWithEnum implements JsonSerializable
{
    public function __construct(
        /** @var EnumType|null */
        public ?EnumType $enumProp=null,
        /** @var EnumTypeFlags|null */
        public ?EnumTypeFlags $enumTypeFlags=null,
        /** @var EnumWithValues|null */
        public ?EnumWithValues $enumWithValues=null,
        /** @var EnumType|null */
        public ?EnumType $nullableEnumProp=null,
        /** @var EnumFlags|null */
        public ?EnumFlags $enumFlags=null,
        /** @var EnumAsInt|null */
        public ?EnumAsInt $enumAsInt=null,
        /** @var EnumStyle|null */
        public ?EnumStyle $enumStyle=null,
        /** @var EnumStyleMembers|null */
        public ?EnumStyleMembers $enumStyleMembers=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['enumProp'])) $this->enumProp = JsonConverters::from('EnumType', $o['enumProp']);
        if (isset($o['enumTypeFlags'])) $this->enumTypeFlags = JsonConverters::from('EnumTypeFlags', $o['enumTypeFlags']);
        if (isset($o['enumWithValues'])) $this->enumWithValues = JsonConverters::from('EnumWithValues', $o['enumWithValues']);
        if (isset($o['nullableEnumProp'])) $this->nullableEnumProp = JsonConverters::from('EnumType', $o['nullableEnumProp']);
        if (isset($o['enumFlags'])) $this->enumFlags = JsonConverters::from('EnumFlags', $o['enumFlags']);
        if (isset($o['enumAsInt'])) $this->enumAsInt = JsonConverters::from('EnumAsInt', $o['enumAsInt']);
        if (isset($o['enumStyle'])) $this->enumStyle = JsonConverters::from('EnumStyle', $o['enumStyle']);
        if (isset($o['enumStyleMembers'])) $this->enumStyleMembers = JsonConverters::from('EnumStyleMembers', $o['enumStyleMembers']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->enumProp)) $o['enumProp'] = JsonConverters::to('EnumType', $this->enumProp);
        if (isset($this->enumTypeFlags)) $o['enumTypeFlags'] = JsonConverters::to('EnumTypeFlags', $this->enumTypeFlags);
        if (isset($this->enumWithValues)) $o['enumWithValues'] = JsonConverters::to('EnumWithValues', $this->enumWithValues);
        if (isset($this->nullableEnumProp)) $o['nullableEnumProp'] = JsonConverters::to('EnumType', $this->nullableEnumProp);
        if (isset($this->enumFlags)) $o['enumFlags'] = JsonConverters::to('EnumFlags', $this->enumFlags);
        if (isset($this->enumAsInt)) $o['enumAsInt'] = JsonConverters::to('EnumAsInt', $this->enumAsInt);
        if (isset($this->enumStyle)) $o['enumStyle'] = JsonConverters::to('EnumStyle', $this->enumStyle);
        if (isset($this->enumStyleMembers)) $o['enumStyleMembers'] = JsonConverters::to('EnumStyleMembers', $this->enumStyleMembers);
        return empty($o) ? new class(){} : $o;
    }
}

PHP HelloWithEnum DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/oneway/HelloWithEnum HTTP/1.1 
Host: test.servicestack.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"enumProp":"Value1","enumTypeFlags":0,"enumWithValues":"None","nullableEnumProp":"Value1","enumFlags":0,"enumAsInt":"Value1","enumStyle":"lower","enumStyleMembers":"lower"}