Java PhpDocComment.getTagElementsByName方法代码示例

import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocComment; //导入方法依赖的package包/类
@NotNull
@Override
public PsiElementVisitor buildVisitor(@NotNull ProblemsHolder holder, boolean isOnTheFly) {
    return new PhpElementVisitor() {
        @Override
        public void visitPhpClass(PhpClass phpClass) {
            if ( ! TesterUtil.isTestClass(phpClass)) {
                return;
            }

            PhpDocComment docComment = phpClass.getDocComment();
            if (docComment == null || docComment.getTagElementsByName("@testCase").length == 0) {
                holder.registerProblem(phpClass, TesterBundle.message("inspections.annotation.description"), QUICK_FIX);
            }
        }
    };
}
 

import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocComment; //导入方法依赖的package包/类
private static boolean isValidReference(PhpNamedElement referencedElement, PsiElement contextElement) {
    MagentoModule referenceSourceModule = getMagentoModule(referencedElement);
    MagentoModule currentModule = getMagentoModule(contextElement);


    if (!areDifferentModules(referenceSourceModule, currentModule)) {
        return true;
    }

    PhpDocComment docComment = referencedElement.getDocComment();
    if(docComment == null) {
        return false;
    }

    PhpDocTag[] elements = docComment.getTagElementsByName(API_TAG);
    return elements.length > 0;
}
 

import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocComment; //导入方法依赖的package包/类
@Nullable
@Override
public String resolveType(PsiElement psiElement)
{
    String variableName;
    try {
        Parameter parameter = (Parameter)psiElement;
        variableName = parameter.getName();
    }
    catch (Exception e) {
        return null;
    }
    MethodImpl method = PsiTreeUtil.getParentOfType(psiElement, MethodImpl.class);
    if (method == null) {
        return null;
    }

    PhpDocComment comment = method.getDocComment();
    if (comment == null) {
        return null;
    }

    PhpDocTag[] phpDocTags = comment.getTagElementsByName("@ContentType");
    if (phpDocTags.length == 0) {
        return null;
    }

    for (PhpDocTag tag : phpDocTags) {
        if (tagMatches(tag, variableName)) {
            return parsePhpDoc(tag);
        }
    }

    return null;
}
 

import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocComment; //导入方法依赖的package包/类
@Nullable
@Override
public String resolveType(PsiElement psiElement)
{
    PhpDocComment comment;
    try {
        FieldImpl field = (FieldImpl)psiElement;
        comment = field.getDocComment();
    }
    catch (Exception e) {
        return null;
    }

    if (comment == null) {
        return null;
    }

    PhpDocTag[] phpDocTags = comment.getTagElementsByName("@ContentType");
    if (phpDocTags.length != 1) {
        return null;
    }
    PhpDocTag tag = phpDocTags[0];
    String[] tagParts = tag.getTagValue().split(" ");
    if (tagParts.length != 1) {
        return null;
    }

    return typeSeparator() + parsePhpDoc(tag);
}
 

import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocComment; //导入方法依赖的package包/类
public void attachDeprecatedProblem(PsiElement element, String text, ProblemsHolder holder) {

            PhpClass phpClass = ServiceUtil.getResolvedClassDefinition(element.getProject(), text, getLazyServiceCollector(element.getProject()));
            if(phpClass == null) {
                return;
            }

            PhpDocComment docComment = phpClass.getDocComment();
            if(docComment != null && docComment.getTagElementsByName("@deprecated").length > 0) {
                holder.registerProblem(element, String.format("Class '%s' is deprecated", phpClass.getName()), ProblemHighlightType.LIKE_DEPRECATED);
            }

        }
 

import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocComment; //导入方法依赖的package包/类
public static boolean isAnnotationClass(@NotNull PhpClass phpClass) {
    PhpDocComment phpDocComment = phpClass.getDocComment();
    if(phpDocComment != null) {
        PhpDocTag[] annotationDocTags = phpDocComment.getTagElementsByName("@Annotation");
        if(annotationDocTags.length > 0) {
            return true;
        }
    }

    return false;
}
 

import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocComment; //导入方法依赖的package包/类
private void attachLookupElement(CompletionResultSet completionResultSet, Field field) {
    if(field.isConstant()) {
       return;
    }

    String propertyName = field.getName();

    // private $isNillable = false;
    PhpType type = field.getType();
    if(type.toString().equals("bool")) {
        completionResultSet.addElement(new PhpAnnotationPropertyLookupElement(new AnnotationProperty(propertyName, AnnotationPropertyEnum.BOOLEAN)));
        return;
    }

    // private $isNillable = array();
    if(type.toString().equals("array")) {
        completionResultSet.addElement(new PhpAnnotationPropertyLookupElement(new AnnotationProperty(propertyName, AnnotationPropertyEnum.ARRAY)));
        return;
    }

    PhpDocComment docComment = field.getDocComment();
    if(docComment != null) {
        for(PhpDocTag varDocTag: docComment.getTagElementsByName("@var")) {
            PhpPsiElement phpPsiElement = varDocTag.getFirstPsiChild();
            if(phpPsiElement != null) {
                String typeText = phpPsiElement.getText().toLowerCase();
                if(!StringUtils.isBlank(typeText)) {

                    // @var array<string>
                    if(typeText.startsWith("array")) {
                        completionResultSet.addElement(new PhpAnnotationPropertyLookupElement(new AnnotationProperty(propertyName, AnnotationPropertyEnum.ARRAY)));
                        return;
                    }

                    if(typeText.equalsIgnoreCase("integer") || typeText.equalsIgnoreCase("int")) {
                        completionResultSet.addElement(new PhpAnnotationPropertyLookupElement(new AnnotationProperty(propertyName, AnnotationPropertyEnum.INTEGER)));
                        return;
                    }

                    if(typeText.equalsIgnoreCase("boolean") || typeText.equalsIgnoreCase("bool")) {
                        completionResultSet.addElement(new PhpAnnotationPropertyLookupElement(new AnnotationProperty(propertyName, AnnotationPropertyEnum.BOOLEAN)));
                        return;
                    }

                }
            }
        }
    }

    // public $var = array();
    if(field.getDefaultValue() instanceof ArrayCreationExpression) {
        completionResultSet.addElement(new PhpAnnotationPropertyLookupElement(new AnnotationProperty(propertyName, AnnotationPropertyEnum.ARRAY)));
        return;
    }

    // fallback
    completionResultSet.addElement(new PhpAnnotationPropertyLookupElement(new AnnotationProperty(propertyName, AnnotationPropertyEnum.STRING)));
}
 

import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocComment; //导入方法依赖的package包/类
/**
 * Provide a annotation class container. Allows easy access to @Target attributes
 * Array and single value supported: @Target("PROPERTY", "METHOD"), @Target("CLASS")
 */
@Nullable
public static PhpAnnotation getClassAnnotation(@NotNull PhpClass phpClass) {
    if(!AnnotationUtil.isAnnotationClass(phpClass)) {
        return null;
    }

    PhpDocComment phpDocComment = phpClass.getDocComment();
    if(phpDocComment == null) {
        return null;
    }

    List<AnnotationTarget> targets = new ArrayList<>();

    PhpDocTag[] tagElementsByName = phpDocComment.getTagElementsByName("@Target");

    if(tagElementsByName.length > 0) {
        for (PhpDocTag phpDocTag : tagElementsByName) {
            // @Target("PROPERTY", "METHOD")
            // @Target("CLASS")
            // @Target("ALL")
            String text = phpDocTag.getText();
            Matcher matcher = Pattern.compile("\"(\\w+)\"").matcher(text);

            // regex matched; on invalid we at target to UNKNOWN condition
            boolean isMatched = false;

            // match enum value
            while (matcher.find()) {
                isMatched = true;
                try {
                    targets.add(AnnotationTarget.valueOf(matcher.group(1).toUpperCase()));
                } catch (IllegalArgumentException e) {
                    targets.add(AnnotationTarget.UNKNOWN);
                }
            }

            // regex failed provide UNKNOWN target
            if(!isMatched) {
                targets.add(AnnotationTarget.UNKNOWN);
            }
        }
    } else {
        // no target attribute so UNDEFINED target
        targets.add(AnnotationTarget.UNDEFINED);
    }

    if(targets.size() == 0) {
        return null;
    }

    return new PhpAnnotation(phpClass, targets);
}