Completely strip unwanted text.

framework/Refactor/lib/Horde/Refactor/Config/FileLevelDocBlock.php

@@ -74,6 +74,13 @@ class FileLevelDocBlock extends Base
      */
     public $fileDescriptionExtractRegexp;
 
+    /**
+     * Text to strip from file summaries and descriptions.
+     *
+     * @var string
+     */
+    public $fileStripText;
+
     /**
      * Default tags for new, empty file-level DocBlocks.
      *
@@ -137,6 +144,13 @@ class FileLevelDocBlock extends Base
      */
     public $classDescriptionExtractRegexp;
 
+    /**
+     * Text to strip from file summaries and descriptions.
+     *
+     * @var string
+     */
+    public $classStripText;
+
     /**
      * Default tags for new, empty class-level DocBlocks.
      *
@@ -213,13 +227,16 @@ class FileLevelDocBlock extends Base
      */
     public function __construct(array $params = array())
     {
+        $stripRegexp = new Regexp('/^PHP version .*$/im');
         $linkRegexp = new Regexp('|^https?://pear\.horde\.org|');
         $params = array_merge(
             array(
                 'year' => date('Y'),
+                'fileStripText' => $stripRegexp,
                 'fileForbiddenTags' => array_merge(
                     $this->fileForbiddenTags, array('link' => $linkRegexp)
                 ),
+                'classStripText' => $stripRegexp,
                 'classForbiddenTags' => array_merge(
                     $this->classForbiddenTags, array('link' => $linkRegexp)
                 ),

framework/Refactor/lib/Horde/Refactor/Rule/FileLevelDocBlock.php

@@ -263,6 +263,11 @@ protected function _checkDocBlock($which)
 
         // Cleaning the summary and description.
         $text = $docblock->getText();
+        if ($this->_config->{$which . 'StripText'}) {
+            $text = trim(preg_replace(
+                $this->_config->{$which . 'StripText'}, '', $text
+            ));
+        }
         $text = $this->_stripIncorrectText($text, $other);
         if ($text != $docblock->getText()) {
             $this->addWarning(sprintf(

framework/Refactor/package.xml

@@ -180,6 +180,7 @@
          <file name="NoFileLevelDocBlock.php" role="test" />
          <file name="OtherCopyright.php" role="test" />
          <file name="RemoveForbiddenTags.php" role="test" />
+         <file name="RemoveStripText.php" role="test" />
         </dir> <!-- /test/Horde/Refactor/fixtures/FileLevelDocBlock/refactored -->
         <file name="ClassLevelDocBlock.php" role="test" />
         <file name="ClassLevelDocBlockWithFileLevelDocs.php" role="test" />
@@ -194,6 +195,7 @@
         <file name="NoFileLevelDocBlock.php" role="test" />
         <file name="OtherCopyright.php" role="test" />
         <file name="RemoveForbiddenTags.php" role="test" />
+        <file name="RemoveStripText.php" role="test" />
        </dir> <!-- /test/Horde/Refactor/fixtures/FileLevelDocBlock -->
        <dir name="Php4Constructor">
         <dir name="refactored">
@@ -356,6 +358,7 @@
    <install as="Horde/Refactor/fixtures/FileLevelDocBlock/NoFileLevelDocBlock.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/NoFileLevelDocBlock.php" />
    <install as="Horde/Refactor/fixtures/FileLevelDocBlock/OtherCopyright.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/OtherCopyright.php" />
    <install as="Horde/Refactor/fixtures/FileLevelDocBlock/RemoveForbiddenTags.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/RemoveForbiddenTags.php" />
+   <install as="Horde/Refactor/fixtures/FileLevelDocBlock/RemoveStripText.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/RemoveStripText.php" />
    <install as="Horde/Refactor/fixtures/FileLevelDocBlock/refactored/ClassLevelDocBlock.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/refactored/ClassLevelDocBlock.php" />
    <install as="Horde/Refactor/fixtures/FileLevelDocBlock/refactored/ClassLevelDocBlockWithFileLevelDocs.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/refactored/ClassLevelDocBlockWithFileLevelDocs.php" />
    <install as="Horde/Refactor/fixtures/FileLevelDocBlock/refactored/ClassLevelDocsInFileLevel.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/refactored/ClassLevelDocsInFileLevel.php" />
@@ -365,6 +368,7 @@
    <install as="Horde/Refactor/fixtures/FileLevelDocBlock/refactored/NoFileLevelDocBlock.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/refactored/NoFileLevelDocBlock.php" />
    <install as="Horde/Refactor/fixtures/FileLevelDocBlock/refactored/OtherCopyright.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/refactored/OtherCopyright.php" />
    <install as="Horde/Refactor/fixtures/FileLevelDocBlock/refactored/RemoveForbiddenTags.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/refactored/RemoveForbiddenTags.php" />
+   <install as="Horde/Refactor/fixtures/FileLevelDocBlock/refactored/RemoveStripText.php" name="test/Horde/Refactor/fixtures/FileLevelDocBlock/refactored/RemoveStripText.php" />
    <install as="Horde/Refactor/fixtures/Php4Constructor/Php4ConstructorOnly.php" name="test/Horde/Refactor/fixtures/Php4Constructor/Php4ConstructorOnly.php" />
    <install as="Horde/Refactor/fixtures/Php4Constructor/Php5Constructor.php" name="test/Horde/Refactor/fixtures/Php4Constructor/Php5Constructor.php" />
    <install as="Horde/Refactor/fixtures/Php4Constructor/WrongConstructorOrder.php" name="test/Horde/Refactor/fixtures/Php4Constructor/WrongConstructorOrder.php" />

framework/Refactor/test/Horde/Refactor/FileLevelDocBlockTest.php

@@ -170,6 +170,7 @@ public function getFileNames()
             array('ClassLevelDocsInFileLevel.php', false),
             array('FileLevelDocsInClassLevel.php', false),
             array('RemoveForbiddenTags.php', false),
+            array('RemoveStripText.php', false),
         );
     }
 }

framework/Refactor/test/Horde/Refactor/fixtures/FileLevelDocBlock/RemoveStripText.php

@@ -0,0 +1,27 @@
+<?php
+/**
+ * Copyright 2017 Horde LLC (http://www.horde.org/)
+ *
+ * PHP Version 5
+ *
+ * See the enclosed file COPYING for license information (LGPL). If you did
+ * not receive this file, see http://www.horde.org/licenses/lgpl21.
+ *
+ * @author   Some Author <author@acme.org>
+ * @category Horde
+ * @license  http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package  Auth
+ */
+
+/**
+ * This class does stuff.
+ *
+ * @author    Some Author <author@acme.org>
+ * @category  Horde
+ * @copyright 2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Auth
+ */
+class Foo
+{
+}

framework/Refactor/test/Horde/Refactor/fixtures/FileLevelDocBlock/refactored/RemoveStripText.php

@@ -0,0 +1,25 @@
+<?php
+/**
+ * Copyright 2017 Horde LLC (http://www.horde.org/)
+ *
+ * See the enclosed file COPYING for license information (LGPL). If you did
+ * not receive this file, see http://www.horde.org/licenses/lgpl21.
+ *
+ * @author   Some Author <author@acme.org>
+ * @category Horde
+ * @license  http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package  Auth
+ */
+
+/**
+ * This class does stuff.
+ *
+ * @author    Some Author <author@acme.org>
+ * @category  Horde
+ * @copyright 2017 Horde LLC
+ * @license   http://www.horde.org/licenses/lgpl21 LGPL-2.1
+ * @package   Auth
+ */
+class Foo
+{
+}