diff --git a/file.php b/file.php index 0d2e609..e4d0130 100644 --- a/file.php +++ b/file.php @@ -46,7 +46,6 @@ class local_moodlecheck_file { protected $filephpdocs = null; protected $allphpdocs = null; protected $variables = null; - protected $defines = null; protected $constants = null; /** @@ -559,43 +558,6 @@ public function &get_constants() { return $this->constants; } - /** - * Returns all 'define' statements found in file - * - * Returns array of objects where each element represents a define statement: - * $variable->tid : token id of the token with variable name - * $variable->name : name of the variable (starts with $) - * $variable->phpdocs : phpdocs for this variable (instance of local_moodlecheck_phpdocs or false if not found) - * $variable->class : containing class object - * $variable->fullname : name of the variable with class name (i.e. classname::$varname) - * $variable->boundaries : array with ids of first and last token for this constant - * - * @return array - */ - public function &get_defines() { - if ($this->defines === null) { - $this->defines = []; - $this->get_tokens(); - for ($tid = 0; $tid < $this->tokenscount; $tid++) { - if ($this->tokens[$tid][0] == T_STRING && $this->tokens[$tid][1] == 'define' && - !$this->is_inside_function($tid) && !$this->is_inside_class($tid)) { - $next1id = $this->next_nonspace_token($tid, true); - $next1 = $this->next_nonspace_token($tid, false); - $next2 = $this->next_nonspace_token($next1id, false); - $variable = new stdClass; - $variable->tid = $tid; - if ($next1 == '(' && preg_match("/^(['\"])(.*)\\1$/", $next2, $matches)) { - $variable->fullname = $variable->name = $matches[2]; - } - $variable->phpdocs = $this->find_preceeding_phpdoc($tid); - $variable->boundaries = $this->find_object_boundaries($variable); - $defines[] = $variable; - } - } - } - return $this->defines; - } - /** * Finds and returns object boundaries * diff --git a/lang/en/local_moodlecheck.php b/lang/en/local_moodlecheck.php index 82f93c1..ddd662e 100644 --- a/lang/en/local_moodlecheck.php +++ b/lang/en/local_moodlecheck.php @@ -39,8 +39,6 @@ $string['rule_constsdocumented'] = 'All constants are documented'; $string['error_constsdocumented'] = 'Constant {$a->object} is not documented'; -$string['rule_definesdocumented'] = 'All define statements are documented'; -$string['error_definesdocumented'] = 'Define statement for {$a->object} is not documented'; $string['rule_noinlinephpdocs'] = 'There are no comments starting with three or more slashes'; $string['error_noinlinephpdocs'] = 'Found comment starting with three or more slashes'; @@ -63,8 +61,5 @@ $string['error_functionarguments'] = 'Phpdocs for function {$a->function} has incomplete parameters list'; $string['rule_functionarguments'] = 'Phpdocs for functions properly define all parameters'; -$string['error_definedoccorrect'] = 'Phpdocs for define statement must start with constant name and dash: {$a->object}'; -$string['rule_definedoccorrect'] = 'Check syntax for define statement'; - $string['rule_categoryvalid'] = 'Category tag is valid'; $string['error_categoryvalid'] = 'Category {$a->category} is not valid'; diff --git a/rules/phpdocs_basic.php b/rules/phpdocs_basic.php index 76fceab..d98de7b 100644 --- a/rules/phpdocs_basic.php +++ b/rules/phpdocs_basic.php @@ -25,12 +25,10 @@ defined('MOODLE_INTERNAL') || die; local_moodlecheck_registry::add_rule('constsdocumented')->set_callback('local_moodlecheck_constsdocumented'); -local_moodlecheck_registry::add_rule('definesdocumented')->set_callback('local_moodlecheck_definesdocumented'); local_moodlecheck_registry::add_rule('noinlinephpdocs')->set_callback('local_moodlecheck_noinlinephpdocs'); local_moodlecheck_registry::add_rule('phpdocsfistline')->set_callback('local_moodlecheck_phpdocsfistline'); local_moodlecheck_registry::add_rule('functiondescription')->set_callback('local_moodlecheck_functiondescription'); local_moodlecheck_registry::add_rule('functionarguments')->set_callback('local_moodlecheck_functionarguments'); -local_moodlecheck_registry::add_rule('definedoccorrect')->set_callback('local_moodlecheck_definedoccorrect'); local_moodlecheck_registry::add_rule('phpdocsinvalidinlinetag')->set_callback('local_moodlecheck_phpdocsinvalidinlinetag'); local_moodlecheck_registry::add_rule('phpdocsuncurlyinlinetag')->set_callback('local_moodlecheck_phpdocsuncurlyinlinetag'); local_moodlecheck_registry::add_rule('phpdoccontentsinlinetag')->set_callback('local_moodlecheck_phpdoccontentsinlinetag'); @@ -51,22 +49,6 @@ function local_moodlecheck_constsdocumented(local_moodlecheck_file $file) { return $errors; } -/** - * Checks if all variables have phpdocs blocks - * - * @param local_moodlecheck_file $file - * @return array of found errors - */ -function local_moodlecheck_definesdocumented(local_moodlecheck_file $file) { - $errors = []; - foreach ($file->get_defines() as $object) { - if ($object->phpdocs === false) { - $errors[] = ['object' => $object->fullname, 'line' => $file->get_line_number($object->tid)]; - } - } - return $errors; -} - /** * Checks that no comment starts with three or more slashes * @@ -321,22 +303,3 @@ function($type) { return implode('|', $types); } - -/** - * Checks that all define statement have constant name in phpdoc block - * - * @param local_moodlecheck_file $file - * @return array of found errors - */ -function local_moodlecheck_definedoccorrect(local_moodlecheck_file $file) { - $errors = []; - foreach ($file->get_defines() as $object) { - if ($object->phpdocs !== false) { - if (!preg_match('/^\s*'.$object->name.'\s+-\s+(.*)/', $object->phpdocs->get_description(), $matches) || - !strlen(trim($matches[1]))) { - $errors[] = ['line' => $object->phpdocs->get_line_number($file), 'object' => $object->fullname]; - } - } - } - return $errors; -}