tsugi/phpstan-stubs.php at master · tsugiproject/tsugi · GitHub

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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
<?php

/**
 * PHPStan stubs for globals and optional dependencies.
 */

namespace {
    const TSUGI_COOKIELESS_SESSION_NAME = "_LTI_TSUGI";
    const TSUGI_SESSION_LTI = 'lti';
    const TSUGI_SESSION_LTI_POST = 'lti_post';

    /** @var \Tsugi\Config\ConfigInfo|null $CFG */
    $CFG;

    /** @var \Tsugi\UI\Output|null $OUTPUT */
    $OUTPUT;

    /** @var \Tsugi\Util\PDOX|null $PDOX */
    $PDOX;

    /** @var bool $REDIRECTED */
    $REDIRECTED;

    /**
     * @return bool
     */
    /**
     * @return bool
     */
    function isInstructor(): bool
    {
        return false;
    }

    /**
     * @param string|null $path
     * @return string
     */
    function lmsAnalyticsKey(?string $path = null): string
    {
        return '';
    }

    /**
     * @param int $context_id
     * @param string $link_key
     * @param string|null $title
     * @param string|null $path
     * @return int|false
     */
    function lmsEnsureAnalyticsLink(int $context_id, string $link_key, ?string $title = null, ?string $path = null): int|false
    {
        return false;
    }

    /**
     * @param string $analytics_path
     * @param string|null $title
     * @return int|false
     */
    function lmsRecordLaunchAnalytics(string $analytics_path, ?string $title = null): int|false
    {
        return false;
    }

}

namespace PHPUnit\Framework {
    /**
     * Lightweight PHPUnit TestCase stub for static analysis in environments
     * where phpunit classes are not available (for example some CI jobs).
     */
    abstract class TestCase
    {
        public function assertEquals(mixed $expected, mixed $actual, string $message = ''): void
        {
        }

        public function assertTrue(mixed $condition, string $message = ''): void
        {
        }

        public function assertFalse(mixed $condition, string $message = ''): void
        {
        }

        public function assertCount(int $expectedCount, mixed $haystack, string $message = ''): void
        {
        }

        /**
         * @param iterable<mixed> $haystack
         */
        public function assertContains(mixed $needle, iterable $haystack, string $message = ''): void
        {
        }

        public function assertNotEmpty(mixed $actual, string $message = ''): void
        {
        }

        public function assertEmpty(mixed $actual, string $message = ''): void
        {
        }

        public function assertGreaterThan(mixed $expected, mixed $actual, string $message = ''): void
        {
        }

        public function assertGreaterThanOrEqual(mixed $expected, mixed $actual, string $message = ''): void
        {
        }

        public function assertStringContainsString(string $needle, string $haystack, string $message = ''): void
        {
        }

        public function markTestSkipped(string $message = ''): void
        {
        }
    }
}