vendor/web-token/jwt-signature/Serializer/JWSSerializer.php


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

<?php

declare(strict_types=1);

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2014-2018 Spomky-Labs
 *
 * This software may be modified and distributed under the terms
 * of the MIT license.  See the LICENSE file for details.
 */

namespace Jose\Component\Signature\Serializer;

use Jose\Component\Signature\JWS;

interface JWSSerializer
{
    /**
     * The name of the serialization.
     */
    public function name(): string;

    public function displayName(): string;

    /**
     * Converts a JWS into a string.
     *
     * @throws \Exception
     */
    public function serialize(JWS $jws, ?int $signatureIndex = null): string;

    /**
     * Loads data and return a JWS object.
     *
     * @param string $input A string that represents a JWS
     *
     * @throws \Exception
     */
    public function unserialize(string $input): JWS;
}