Skip to content

Commit 0741df0

Browse files
committed
Update doc version
1 parent 0345617 commit 0741df0

5 files changed

Lines changed: 75 additions & 75 deletions

File tree

includes/Checker/Checks/Plugin_Repo/Prefixing_Check.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
/**
1818
* Check for prefixing.
1919
*
20-
* @since 1.6.0
20+
* @since 1.7.0
2121
*/
2222
class Prefixing_Check extends Abstract_PHP_CodeSniffer_Check {
2323

@@ -30,7 +30,7 @@ class Prefixing_Check extends Abstract_PHP_CodeSniffer_Check {
3030
*
3131
* Every check must have at least one category.
3232
*
33-
* @since 1.6.0
33+
* @since 1.7.0
3434
*
3535
* @return array The categories for the check.
3636
*/
@@ -41,7 +41,7 @@ public function get_categories() {
4141
/**
4242
* Returns an associative array of arguments to pass to PHPCS.
4343
*
44-
* @since 1.6.0
44+
* @since 1.7.0
4545
*
4646
* @param Check_Result $result The check result to amend, including the plugin context to check.
4747
* @return array An associative array of PHPCS CLI arguments.
@@ -69,7 +69,7 @@ protected function get_args( Check_Result $result ) {
6969
*
7070
* Every check must have a short description explaining what the check does.
7171
*
72-
* @since 1.6.0
72+
* @since 1.7.0
7373
*
7474
* @return string Description.
7575
*/
@@ -82,7 +82,7 @@ public function get_description(): string {
8282
*
8383
* Every check must have a URL with further information about the check.
8484
*
85-
* @since 1.6.0
85+
* @since 1.7.0
8686
*
8787
* @return string The documentation URL.
8888
*/

includes/Scanner/Log.php

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,46 +10,46 @@
1010
/**
1111
* Log class.
1212
*
13-
* @since 1.6.0
13+
* @since 1.7.0
1414
*/
1515
class Log {
1616

1717
/**
1818
* An array of logs.
1919
*
20-
* @since 1.6.0
20+
* @since 1.7.0
2121
* @var array
2222
*/
2323
private array $log = array();
2424

2525
/**
2626
* An array of logs with longer location.
2727
*
28-
* @since 1.6.0
28+
* @since 1.7.0
2929
* @var array
3030
*/
3131
private array $log_longer_location = array();
3232

3333
/**
3434
* An instance of the PHP_Parser class.
3535
*
36-
* @since 1.6.0
36+
* @since 1.7.0
3737
* @var PHP_Parser
3838
*/
3939
public PHP_Parser $parser_object;
4040

4141
/**
4242
* An array of strings to be removed from the log.
4343
*
44-
* @since 1.6.0
44+
* @since 1.7.0
4545
* @var string[]
4646
*/
4747
private array $remove_strings_from_log = array();
4848

4949
/**
5050
* Constructor.
5151
*
52-
* @since 1.6.0
52+
* @since 1.7.0
5353
*
5454
* @param PHP_Parser $parser An instance of the PHP_Parser class.
5555
*/
@@ -60,7 +60,7 @@ public function __construct( $parser ) {
6060
/**
6161
* Adds a log entry with the specified details to the log storage.
6262
*
63-
* @since 1.6.0
63+
* @since 1.7.0
6464
*
6565
* @param int $line_number The line number where the log entry originates from.
6666
* @param string $text The text content of the log entry.
@@ -105,7 +105,7 @@ public function add( $line_number, $text, $logid = 'default', $unique = false )
105105
/**
106106
* Generates a unique identifier for a specific line in a file.
107107
*
108-
* @since 1.6.0
108+
* @since 1.7.0
109109
*
110110
* @param int $line_number The line number for which the identifier is generated.
111111
* @return string The MD5 hash representing the unique identifier for the line.
@@ -128,7 +128,7 @@ public function get( $logid = 'default' ) {
128128
/**
129129
* Merges the provided log data with the existing log data for the specified identifier.
130130
*
131-
* @since 1.6.0
131+
* @since 1.7.0
132132
*
133133
* @param array $log The log data to merge.
134134
* @param string $logid The identifier of the log to merge into. Defaults to 'default'.
@@ -145,7 +145,7 @@ public function merge( $log, $logid = 'default' ) {
145145
/**
146146
* Adds a namespace to the log for a given identifier.
147147
*
148-
* @since 1.6.0
148+
* @since 1.7.0
149149
*
150150
* @param object $namespace_obj The namespace object to add, which should include a name property.
151151
* @param string $logid The identifier of the log where the namespace information should be added.
@@ -169,7 +169,7 @@ public function add_namespace( $namespace_obj, $logid, $unique = false ) {
169169
/**
170170
* Adds a function call expression to the log and assigns metadata for processing.
171171
*
172-
* @since 1.6.0
172+
* @since 1.7.0
173173
*
174174
* @param object $func_call The function call expression object to be logged.
175175
* @param int $argposition The position of the argument in the function call to extract metadata from.
@@ -201,7 +201,7 @@ public function add_call_expr( $func_call, $argposition, $logid, $unique = false
201201
/**
202202
* Adds a variable expression to the log and records its metadata.
203203
*
204-
* @since 1.6.0
204+
* @since 1.7.0
205205
*
206206
* @param object $var_call The variable expression object to be logged. It is expected to be an instance of specific PhpParser classes.
207207
* @param string $logid The identifier of the log where the variable expression should be added.
@@ -237,7 +237,7 @@ public function add_var_expr( $var_call, $logid, $unique = false, $accurate = tr
237237
/**
238238
* Adds abstraction declarations like classes, functions, interfaces, or traits to the log with specific context and type.
239239
*
240-
* @since 1.6.0
240+
* @since 1.7.0
241241
*
242242
* @param array $abstractions An array of abstraction objects to process and add to the log. Each object must have a type and name.
243243
* @param string $logid The identifier for the log to which the abstraction declarations will be added.
@@ -291,7 +291,7 @@ public function add_abstraction_declarations( $abstractions, $logid, $unique = f
291291
/**
292292
* Checks whether log data exists for the specified log identifier.
293293
*
294-
* @since 1.6.0
294+
* @since 1.7.0
295295
*
296296
* @param string $logid The identifier of the log to check for existence. Defaults to 'default'.
297297
* @return bool True if log data exists for the provided identifier, otherwise false.
@@ -303,7 +303,7 @@ public function exists( $logid = 'default' ) {
303303
/**
304304
* Constructs a location string consisting of the relative file path and line number.
305305
*
306-
* @since 1.6.0
306+
* @since 1.7.0
307307
*
308308
* @param int $line_number The line number in the file.
309309
* @param string $file_relative The file path relative to the root directory.

includes/Scanner/PHP_Parser.php

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
/**
2424
* Abstract class responsible for parsing files, logging, and processing Abstract Syntax Tree (AST) data.
2525
*
26-
* @since 1.6.0
26+
* @since 1.7.0
2727
*
2828
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
2929
* @SuppressWarnings(PHPMD.ExcessiveClassLength)
@@ -34,135 +34,135 @@ abstract class PHP_Parser {
3434
/**
3535
* A collection of all file paths to be processed.
3636
*
37-
* @since 1.6.0
37+
* @since 1.7.0
3838
* @var string[]
3939
*/
4040
public array $files = array();
4141

4242
/**
4343
* A collection of PHP file paths to be processed.
4444
*
45-
* @since 1.6.0
45+
* @since 1.7.0
4646
* @var string[]
4747
*/
4848
public array $files_php = array();
4949

5050
/**
5151
* The full path of the file currently being processed.
5252
*
53-
* @since 1.6.0
53+
* @since 1.7.0
5454
* @var string
5555
*/
5656
public string $file = '';
5757

5858
/**
5959
* The relative path of the file currently being processed.
6060
*
61-
* @since 1.6.0
61+
* @since 1.7.0
6262
* @var string
6363
*/
6464
public string $file_relative = '';
6565

6666
/**
6767
* Flag to indicate if parent nodes need to be fetched during AST traversal.
6868
*
69-
* @since 1.6.0
69+
* @since 1.7.0
7070
* @var bool
7171
*/
7272
public bool $needs_get_parents = false;
7373

7474
/**
7575
* Flag to indicate if sibling nodes need to be fetched during AST traversal.
7676
*
77-
* @since 1.6.0
77+
* @since 1.7.0
7878
* @var bool
7979
*/
8080
public bool $needs_get_siblings = false;
8181

8282
/**
8383
* Flag to indicate if the service is initialized and ready.
8484
*
85-
* @since 1.6.0
85+
* @since 1.7.0
8686
* @var bool
8787
*/
8888
private bool $ready = false;
8989

9090
/**
9191
* The PHP-Parser NodeFinder instance.
9292
*
93-
* @since 1.6.0
93+
* @since 1.7.0
9494
* @var \PhpParser\NodeFinder
9595
*/
9696
public $node_finder;
9797

9898
/**
9999
* The Abstract Syntax Tree (AST) of the current file.
100100
*
101-
* @since 1.6.0
101+
* @since 1.7.0
102102
* @var \PhpParser\Node[]|null
103103
*/
104104
public $stmts;
105105

106106
/**
107107
* The logging object instance.
108108
*
109-
* @since 1.6.0
109+
* @since 1.7.0
110110
* @var Log
111111
*/
112112
private Log $log_object;
113113

114114
/**
115115
* The PHP-Parser PrettyPrinter instance.
116116
*
117-
* @since 1.6.0
117+
* @since 1.7.0
118118
* @var \PhpParser\PrettyPrinter\Standard
119119
*/
120120
public $pretty_printer;
121121

122122
/**
123123
* List of known sanitization functions.
124124
*
125-
* @since 1.6.0
125+
* @since 1.7.0
126126
* @var string[]
127127
*/
128128
public array $sanitize_functions;
129129

130130
/**
131131
* List of known escaping functions.
132132
*
133-
* @since 1.6.0
133+
* @since 1.7.0
134134
* @var string[]
135135
*/
136136
public array $escaping_functions;
137137

138138
/**
139139
* Cache for `define()` statement objects found during parsing.
140140
*
141-
* @since 1.6.0
141+
* @since 1.7.0
142142
* @var array
143143
*/
144144
private array $defines_objects = array();
145145

146146
/**
147147
* Flag to indicate if the `define()` statement objects have been loaded.
148148
*
149-
* @since 1.6.0
149+
* @since 1.7.0
150150
* @var bool
151151
*/
152152
private bool $defines_objects_loaded = false;
153153

154154
/**
155155
* Cache for variable assignment expressions to avoid re-parsing.
156156
*
157-
* @since 1.6.0
157+
* @since 1.7.0
158158
* @var array
159159
*/
160160
private array $cache_assignments_expressions_for_variable = array();
161161

162162
/**
163163
* Constructor.
164164
*
165-
* @since 1.6.0
165+
* @since 1.7.0
166166
*/
167167
public function __construct() {
168168
$this->log_object = new Log( $this );
@@ -173,7 +173,7 @@ public function __construct() {
173173
/**
174174
* Loads files.
175175
*
176-
* @since 1.6.0
176+
* @since 1.7.0
177177
*
178178
* @param array $files Array of files.
179179
* @return void
@@ -192,7 +192,7 @@ function ( $file ) {
192192
/**
193193
* Returns relative path.
194194
*
195-
* @since 1.6.0
195+
* @since 1.7.0
196196
*
197197
* @param string $file File path.
198198
* @return string Relative path.
@@ -366,7 +366,7 @@ public function is_ready() {
366366
/**
367367
* Checks if the given object is of one of the specified classes.
368368
*
369-
* @since 1.6.0
369+
* @since 1.7.0
370370
*
371371
* @param object $object_name The object to check.
372372
* @param array $classes An array of class names to check against.

0 commit comments

Comments
 (0)