RuleInterface::setName()
last analyzed

Size

Total Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 1
c 0
b 0
f 0
1
<?php declare(strict_types=1);
2
3
namespace Limoncello\Validation\Contracts\Rules;
4
5
/**
6
 * Copyright 2015-2020 [email protected]
7
 *
8
 * Licensed under the Apache License, Version 2.0 (the "License");
9
 * you may not use this file except in compliance with the License.
10
 * You may obtain a copy of the License at
11
 *
12
 * http://www.apache.org/licenses/LICENSE-2.0
13
 *
14
 * Unless required by applicable law or agreed to in writing, software
15
 * distributed under the License is distributed on an "AS IS" BASIS,
16
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17
 * See the License for the specific language governing permissions and
18
 * limitations under the License.
19
 */
20
21
use Limoncello\Validation\Contracts\Blocks\ExecutionBlockInterface;
22
23
/**
24
 * @package Limoncello\Validation
25
 */
26
interface RuleInterface
27
{
28
    /**
29
     * @return string
30
     */
31
    public function getName(): string;
32
33
    /**
34
     * @param string $name
35
     *
36
     * @return RuleInterface
0 ignored issues
show
Documentation introduced by
Should the return type not be \self?

This check compares the return type specified in the @return annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.

Loading history...
37
     */
38
    public function setName(string $name): self;
39
40
    /**
41
     * @return self
0 ignored issues
show
Documentation introduced by
Should the return type not be \self?

This check compares the return type specified in the @return annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.

Loading history...
42
     */
43
    public function unsetName(): self;
44
45
    /**
46
     * @return bool
47
     */
48
    public function isCaptureEnabled(): bool;
49
50
    /**
51
     * @return self
0 ignored issues
show
Documentation introduced by
Should the return type not be \self?

This check compares the return type specified in the @return annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.

Loading history...
52
     */
53
    public function enableCapture(): self;
54
55
    /**
56
     * @return self
0 ignored issues
show
Documentation introduced by
Should the return type not be \self?

This check compares the return type specified in the @return annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.

Loading history...
57
     */
58
    public function disableCapture(): self;
59
60
    /**
61
     * @return RuleInterface|null
62
     */
63
    public function getParent(): ?RuleInterface;
64
65
    /**
66
     * @param RuleInterface $rule
67
     *
68
     * @return self
0 ignored issues
show
Documentation introduced by
Should the return type not be \self?

This check compares the return type specified in the @return annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.

Loading history...
69
     */
70
    public function setParent(RuleInterface $rule): self;
71
72
    /**
73
     * @return self
0 ignored issues
show
Documentation introduced by
Should the return type not be \self?

This check compares the return type specified in the @return annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.

Loading history...
74
     */
75
    public function unsetParent(): self;
76
77
    /**
78
     * @return ExecutionBlockInterface
79
     */
80
    public function toBlock(): ExecutionBlockInterface;
81
}
82