wikimedia/mediawiki-extensions-AbuseFilter
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/AbuseFilter.git synced 2024-11-24 06:03:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Copy levels documentation on AbuseFilterParser

Browse source 
doLevel- functions are currently documented in AFPToken. This patch
copies such comments on docblocks in AbuseFilterParser, the place where
this docs can really be helpful.

Change-Id: I4e47e760a56800faa9b0a1146e0d79f8955dca9a
This commit is contained in:
Daimona Eaytoy 2018-06-30 20:35:49 +02:00
parent e645ddcdf8
commit 7104c40518
2 changed files with 30 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
includes/parser/AFPToken.php
View file

@ -21,7 +21,7 @@
* * Entry - catches unexpected characters
* * Semicolon - ;
* * Set - :=
* * Conditionls (IF) - if-then-else-end, cond ? a :b
* * Conditionals (IF) - if-then-else-end, cond ? a :b
* * BoolOps (BO) - &, |, ^
* * CompOps (CO) - ==, !=, ===, !==, >, <, >=, <=
* * SumRel (SR) - +, -

31
includes/parser/AbuseFilterParser.php
View file

@ -248,7 +248,8 @@ class AbuseFilterParser {
}
/**
* Handles multiple expressions
* Handles multiple expressions delimited by a semicolon
*
* @param AFPData &$result
*/
protected function doLevelSemicolon( &$result ) {
@ -261,7 +262,7 @@ class AbuseFilterParser {
}
/**
* Handles multiple expressions
* Handles assignments (:=)
*
* @param AFPData &$result
* @throws AFPUserVisibleException
@ -331,6 +332,8 @@ class AbuseFilterParser {
}
/**
* Handles conditionals: if-then-else and ternary operator
*
* @param AFPData &$result
* @throws AFPUserVisibleException
*/
@ -452,6 +455,8 @@ class AbuseFilterParser {
}
/**
* Handles boolean operators (&, |, ^)
*
* @param AFPData &$result
*/
protected function doLevelBoolOps( &$result ) {
@ -479,6 +484,8 @@ class AbuseFilterParser {
}
/**
* Handles comparison operators
*
* @param AFPData &$result
*/
protected function doLevelCompares( &$result ) {
@ -499,6 +506,8 @@ class AbuseFilterParser {
}
/**
* Handles sum-related operations (+ and -)
*
* @param AFPData &$result
*/
protected function doLevelSumRels( &$result ) {
@ -523,6 +532,8 @@ class AbuseFilterParser {
}
/**
* Handles multiplication-related operations (*, / and %)
*
* @param AFPData &$result
*/
protected function doLevelMulRels( &$result ) {
@ -542,6 +553,8 @@ class AbuseFilterParser {
}
/**
* Handles powers (**)
*
* @param AFPData &$result
*/
protected function doLevelPow( &$result ) {
@ -559,6 +572,8 @@ class AbuseFilterParser {
}
/**
* Handles boolean inversion (!)
*
* @param AFPData &$result
*/
protected function doLevelBoolInvert( &$result ) {
@ -576,6 +591,8 @@ class AbuseFilterParser {
}
/**
* Handles keywords (in, like, rlike, contains, ...)
*
* @param AFPData &$result
*/
protected function doLevelSpecialWords( &$result ) {
@ -601,6 +618,8 @@ class AbuseFilterParser {
}
/**
* Handles unary plus and minus, like in -5 or -(2 * +2)
*
* @param AFPData &$result
*/
protected function doLevelUnarys( &$result ) {
@ -621,6 +640,8 @@ class AbuseFilterParser {
}
/**
* Handles array elements, parsing expressions like array[number]
*
* @param AFPData &$result
* @throws AFPUserVisibleException
*/
@ -648,6 +669,8 @@ class AbuseFilterParser {
}
/**
* Handles brackets, only ( and )
*
* @param AFPData &$result
* @throws AFPUserVisibleException
*/
@ -672,6 +695,8 @@ class AbuseFilterParser {
}
/**
* Handles functions
*
* @param AFPData &$result
* @throws AFPUserVisibleException
*/
@ -737,6 +762,8 @@ class AbuseFilterParser {
}
/**
* Handles the return value
*
* @param AFPData &$result
* @throws AFPUserVisibleException
*/