Feature/add use relationship

README.md

@@ -1,8 +1,8 @@
 # jqa-php-plugin
 
 [![GitHub license](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](LICENSE)
-[![Build Status](https://api.travis-ci.com/softvis-research/jqa-php-plugin.svg?branch=development)](https://travis-ci.com/softvis-research/jqa-php-plugin)
+[![Build Status](https://api.travis-ci.com/softvis-research/jqa-php-plugin.svg?branch=master)](https://travis-ci.com/softvis-research/jqa-php-plugin)
 
-This is a php parser of jQAssistant. It enables jQAssistant to scan and to analyze php files.
+This is a php parser for jQAssistant. It enables jQAssistant to scan and to analyze php files.
 
 ![graph](material/graph.png)

pom.xml

@@ -6,7 +6,7 @@
 
   <groupId>org.jqassistant.contrib.plugin.php</groupId>
   <artifactId>jqa-php-plugin</artifactId>
-  <version>1.0-SNAPSHOT</version>
+  <version>0.0.9</version>
 
   <name>php</name>
   <!-- FIXME change it to the project's website -->
@@ -111,7 +111,7 @@
         </plugin>
         <plugin>
           <artifactId>maven-surefire-plugin</artifactId>
-          <version>2.20.1</version>
+          <version>3.0.0-M3</version>
         </plugin>
         <plugin>
           <artifactId>maven-jar-plugin</artifactId>

src/main/java/Main.java

@@ -1,19 +1,13 @@
-import java.io.File;
-import java.io.InputStream;
-
 /*
  * To change this license header, choose License Headers in Project Properties.
  * To change this template file, choose Tools | Templates
  * and open the template in the editor.
  */
-
 /**
- *
  * @author falk
  */
 public class Main {
     public static void main(String[] args) {
         System.out.println("Main.main()");
-
     }
 }

src/main/java/org/jqassistant/contrib/plugin/php/model/PHPFileDescriptor.java

@@ -19,13 +19,6 @@
  */
 @Label("File")
 public interface PHPFileDescriptor extends PHPDescriptor, NamedDescriptor, FileDescriptor {
-
-//    /**
-//     * lines of code
-//     * @return set of lines
-//     */
-//    @Relation("HAS_LINE")
-//    Set<PHPLineDescriptor> getLines();
 
     /**
      * included functions

src/main/java/org/jqassistant/contrib/plugin/php/model/PHPFunctionDescriptor.java

@@ -21,14 +21,6 @@ public interface PHPFunctionDescriptor extends PHPDescriptor, FullQualifiedNameD
     String getName();
     void setName(String name);
 
-    /**
-     * count of lines
-     * @return integer 
-     */
-    @Property("linesOfCode")
-    int getLinesOfCode();
-    void setLinesOfCode(int linesOfCode);
-
     /**
      * Return all declared parameters of this method.
      *
@@ -57,8 +49,34 @@ public interface PHPFunctionDescriptor extends PHPDescriptor, FullQualifiedNameD
      * Number of first line in source file
      * @return integer 
      */
-    @Property("lineNumber")
-    int getLineNumber();
-    void setLineNumber(int lineNumber);
+    @Property("firstLineNumber")
+    int getFirstLineNumber();
+    void setFirstLineNumber(int firstLineNumber);
+
+    /**
+     * Number of last line in source file
+     * @return integer 
+     */
+    @Property("lastLineNumber")
+    int getLastLineNumber();
+    void setLastLineNumber(int lastLineNumber);
+
+
+    /**
+     * count of lines with commands
+     * @return integer 
+     */
+    @Property("effectiveLineCount")
+    int getEffectiveLineCount();
+    void setEffectiveLineCount(int effectiveLineCount);
+
+    /**
+     * Signature of function
+     * @return integer 
+     */
+    @Property("signature")
+    String getSignature();
+    void setSignature(String signature);
+
 
 }

src/main/java/org/jqassistant/contrib/plugin/php/model/PHPFunctionParameterDescriptor.java

@@ -15,11 +15,18 @@
 @Label("Parameter")
 public interface PHPFunctionParameterDescriptor extends PHPDescriptor{
 
+    /**
+     * Position of parameter
+     * @return Integer 
+     */
     @Property("index")
     int getIndex();
-
     void setIndex(int index);
 
+    /**
+     * Name of parameter
+     * @return String 
+     */
     String getName();
     void setName(String name);
 

src/main/java/org/jqassistant/contrib/plugin/php/model/PHPNamespaceDescriptor.java

@@ -17,6 +17,10 @@
 @Label(value = "Namespace", usingIndexedPropertyOf = FullQualifiedNameDescriptor.class)
 public interface PHPNamespaceDescriptor extends PHPDescriptor, FullQualifiedNameDescriptor {
 
+    /**
+     * Name of namespace
+     * @return String 
+     */
     String getName();
     void setName(String name);
 

src/main/java/org/jqassistant/contrib/plugin/php/model/PHPPropertyDescriptor.java

@@ -15,6 +15,10 @@
 @Label("Field")
 public interface PHPPropertyDescriptor extends PHPDescriptor  {
 
+    /**
+     * Name of field
+     * @return String 
+     */
     String getName();
     void setName(String name);
 
@@ -34,6 +38,14 @@ public interface PHPPropertyDescriptor extends PHPDescriptor  {
     Boolean isStatic();
     void setStatic(Boolean s);
 
+    /**
+     * is property constant
+     * @return boolean
+     */
+    @Property("constant")
+    Boolean isConstant();
+    void setConstant(Boolean c);
+
     /**
      * Number of line in source file
      * @return integer 

src/main/java/org/jqassistant/contrib/plugin/php/model/PHPTypeDescriptor.java

@@ -18,6 +18,10 @@
 @Label(value = "Type", usingIndexedPropertyOf = FullQualifiedNameDescriptor.class)
 public interface PHPTypeDescriptor extends PHPDescriptor, FullQualifiedNameDescriptor {
 
+    /**
+     * Name
+     * @return String 
+     */
     String getName();
     void setName(String name);
 

src/main/java/org/jqassistant/contrib/plugin/php/scanner/PHPFileScannerPlugin.java

@@ -5,45 +5,44 @@
  */
 package org.jqassistant.contrib.plugin.php.scanner;
 
-import java.io.BufferedReader;
-import java.io.IOException;
-import java.io.InputStreamReader;
-import java.util.ArrayList;
-import java.util.List;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
 import com.buschmais.jqassistant.core.scanner.api.Scanner;
 import com.buschmais.jqassistant.core.scanner.api.ScannerPlugin;
 import com.buschmais.jqassistant.core.scanner.api.Scope;
 import com.buschmais.jqassistant.core.store.api.Store;
 import com.buschmais.jqassistant.plugin.common.api.model.FileDescriptor;
 import com.buschmais.jqassistant.plugin.common.api.scanner.AbstractScannerPlugin;
 import com.buschmais.jqassistant.plugin.common.api.scanner.filesystem.FileResource;
-import java.io.File;
-import java.io.InputStream;
 import org.jqassistant.contrib.plugin.php.model.PHPFileDescriptor;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
 
 import static java.util.Arrays.asList;
-import org.antlr.v4.runtime.CharStreams;
-import org.antlr.v4.runtime.CommonTokenStream;
-import org.antlr.v4.runtime.Lexer;
-import org.antlr.v4.runtime.TokenStream;
-import org.antlr.v4.runtime.tree.ParseTree;
-import org.apache.commons.io.FileUtils;
-import org.jqassistant.contrib.plugin.php.PhpLexer;
-import org.jqassistant.contrib.plugin.php.PhpParser;
-import org.jqassistant.contrib.plugin.php.scanner.parser.PHPFileParser;
 
+/**
+ * PHP file scanner
+ * @author falk
+ */
 @ScannerPlugin.Requires(FileDescriptor.class)
 public class PHPFileScannerPlugin extends AbstractScannerPlugin<FileResource, PHPFileDescriptor> {
+
     private static final Logger LOGGER = LoggerFactory.getLogger(PHPFileScannerPlugin.class);
+
     public static final String JQASSISTANT_PLUGIN_PHP_SUFFIXES = "jqassistant.plugin.php.suffixes";
 
     private static List<String> suffixes = asList("php", "phtml");
 
-
+    /**
+     * check if file accepted by this plugin
+     * @param item
+     * @param path
+     * @param scope
+     * @return boolean
+     * @throws IOException 
+     */
     @Override
     public boolean accepts(final FileResource item, final String path, final Scope scope) throws IOException {
         int beginIndex = path.lastIndexOf(".");
@@ -61,19 +60,20 @@ public boolean accepts(final FileResource item, final String path, final Scope s
         return false;
     }
 
+    /**
+     * scan php file
+     * @param item
+     * @param path
+     * @param scope
+     * @param scanner
+     * @return PHPFileDescriptor
+     * @throws IOException 
+     */
     @Override
     public PHPFileDescriptor scan(final FileResource item, final String path, final Scope scope, final Scanner scanner) throws IOException {
         final Store store = scanner.getContext().getStore();
-		FileDescriptor fileDescriptor = scanner.getContext().getCurrentDescriptor();
-		final PHPFileDescriptor phpFileDescriptor = store.addDescriptorType(fileDescriptor, PHPFileDescriptor.class);
-
-//        try (BufferedReader reader = new BufferedReader(new InputStreamReader(item.createStream()))) {
-//            final PHPLineParser pumlLineParser = new PHPLineParser(store, phpFileDescriptor);
-//            String line;
-//            while ((line = reader.readLine()) != null) {
-//                pumlLineParser.parseLine(line);
-//            }
-//        }
+        FileDescriptor fileDescriptor = scanner.getContext().getCurrentDescriptor();
+        final PHPFileDescriptor phpFileDescriptor = store.addDescriptorType(fileDescriptor, PHPFileDescriptor.class);
 
         phpFileDescriptor.setName(item.getFile().getName());
 
@@ -83,6 +83,9 @@ public PHPFileDescriptor scan(final FileResource item, final String path, final
         return phpFileDescriptor;
     }
 
+    /**
+     * configuration
+     */
     @Override
     protected void configure() {
         super.configure();
@@ -97,5 +100,4 @@ protected void configure() {
 
         LOGGER.info(String.format("php plugin looks for files with suffixes '%s'", suffixes.toString()));
     }
-
-}
+}