Java PhpDocComment类代码示例

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包/类
static void fixMissingInheritDocForNamedElement(final PhpNamedElement phpNamedElement)
{
    if (phpNamedElement.getDocComment() != null) {
        return;
    }

    // write a new docblock with inheritdoc
    new WriteCommandAction.Simple(phpNamedElement.getProject(), phpNamedElement.getContainingFile()) {
        @Override
        protected void run() throws Throwable {
            String commentString = "/**\n * {@inheritDoc} \n*/";

            PhpDocComment comment = PhpPsiElementFactory.createFromText(
                    phpNamedElement.getProject(),
                    PhpDocComment.class,
                    commentString
            );

            if (comment == null) {
                return;
            }

            PhpCodeEditUtil.insertDocCommentBeforeAndGetTextRange(phpNamedElement, comment);
        }
    }.execute();
}
 

import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocComment; //导入依赖的package包/类
static void replaceDocblockForNamedElement(final PhpNamedElement phpNamedElement)
{
    // write a new docblock with inheritdoc
    new WriteCommandAction.Simple(phpNamedElement.getProject(), phpNamedElement.getContainingFile()) {
        @Override
        protected void run() throws Throwable {
            PhpDocComment docComment = phpNamedElement.getDocComment();
            if (docComment == null) {
                return;
            }
            docComment.delete();
        }
    }.execute();

    InheritDocUtil.fixMissingInheritDocForNamedElement(phpNamedElement);
}
 

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包/类
@Override
public boolean matches(PhpNamedElement element) {
    if (!canMatchElement(element)) {
        return false;
    }
    PhpDocComment docComment = element.getDocComment();
    if (docComment == null) {
        return false;
    }

    List<PhpDocTag> docTagList = PsiTreeUtil.getChildrenOfTypeAsList(docComment, PhpDocTag.class);
    for (PhpDocTag phpDocTag : docTagList) {
        PhpClass annotationReference = AnnotationUtil.getAnnotationReference(phpDocTag);
        if (annotationReference == null || annotationReference.getPresentableFQN() == null) {
            continue;
        }
        String fqn = annotationReference.getFQN();
        if (fqn != null && fqn.equals(expectedClass)) {
            return true;
        };
    }

    return false;
}
 

import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocComment; //导入依赖的package包/类
@Override
public void invoke(@NotNull Project project, Editor editor, PsiFile psiFile) throws IncorrectOperationException
{
    int primaryCaretOffset = editor.getCaretModel().getPrimaryCaret().getOffset();

    PsiElement currentPsiElement = psiFile.findElementAt(primaryCaretOffset);
    PsiElement statement = PsiTreeUtil.getParentOfType(currentPsiElement, Statement.class);
    if (statement == null) {
        return;
    }

    String commentStart = "/** @ContentType IDENTIFIER ";
    String commentContent = commentStart + currentPsiElement.getText() + "*/";
    PhpDocComment comment = PhpPsiElementFactory.createFromText(project, PhpDocComment.class, commentContent);
    if (comment == null) {
        return;
    }

    PsiElement result = statement.addBefore(comment, statement.getFirstChild());
    editor.getCaretModel().getPrimaryCaret().moveToOffset(result.getTextOffset() + commentStart.length() - 1);

    editor.getCaretModel().getPrimaryCaret().selectWordAtCaret(true);
}
 

import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocComment; //导入依赖的package包/类
@Nullable
@Override
public String resolveType(PsiElement psiElement)
{
    String variableName = psiElement.getText();
    PsiElement statement = PsiTreeUtil.getParentOfType(psiElement, Statement.class);
    PsiElement sibling = PsiTreeUtil.getPrevSiblingOfType(statement, PhpDocComment.class);
    PhpDocTag tag;

    // Check all statements within current scope for doc-blocks.
    do {
        tag = PsiTreeUtil.getChildOfType(sibling, PhpDocTag.class);
        if (tagMatches(tag, variableName)) {
            break;
        }
        sibling = PsiTreeUtil.getPrevSiblingOfType(sibling, PhpDocComment.class);
        tag = null;
    } while (sibling != null);

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

    return parsePhpDoc(tag);
}
 

import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocComment; //导入依赖的package包/类
/**
 * Get templates on "@Template()" and on method attached to given PhpDocTag
 */
@NotNull
public static Map<String, Collection<PsiElement>> getTemplateAnnotationFilesWithSiblingMethod(@NotNull PhpDocTag phpDocTag) {
    Map<String, Collection<PsiElement>> targets = new HashMap<>();

    // template on direct PhpDocTag
    Pair<String, Collection<PsiElement>> templateAnnotationFiles = TwigUtil.getTemplateAnnotationFiles(phpDocTag);
    if(templateAnnotationFiles != null) {
        targets.put(templateAnnotationFiles.getFirst(), templateAnnotationFiles.getSecond());
    }

    // templates on "Method" of PhpDocTag
    PhpDocComment phpDocComment = PsiTreeUtil.getParentOfType(phpDocTag, PhpDocComment.class);
    if(phpDocComment != null) {
        PsiElement method = phpDocComment.getNextPsiSibling();
        if(method instanceof Method) {
            for (String name : TwigUtil.getControllerMethodShortcut((Method) method)) {
                targets.put(name, new HashSet<>(getTemplatePsiElements(method.getProject(), name)));
            }
        }
    }

    return targets;
}
 

import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocComment; //导入依赖的package包/类
@NotNull
public static Map<String, String> getUseImportMap(@NotNull PhpDocComment phpDocComment) {

    // search for use alias in local file
    final Map<String, String> useImports = new HashMap<>();

    PhpPsiElement scope = PhpCodeInsightUtil.findScopeForUseOperator(phpDocComment);
    if(scope == null) {
        return useImports;
    }

    for (PhpUseList phpUseList : PhpCodeInsightUtil.collectImports(scope)) {
        for (PhpUse phpUse : phpUseList.getDeclarations()) {
            String alias = phpUse.getAliasName();
            if (alias != null) {
                useImports.put(alias, phpUse.getFQN());
            } else {
                useImports.put(phpUse.getName(), phpUse.getFQN());
            }
        }
    }

    return useImports;
}
 

import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocComment; //导入依赖的package包/类
public static boolean hasReference(@Nullable PhpDocComment docComment, String... className) {
    if(docComment == null) return false;

    Map<String, String> uses = AnnotationBackportUtil.getUseImportMap(docComment);

    for(PhpDocTag phpDocTag: PsiTreeUtil.findChildrenOfAnyType(docComment, PhpDocTag.class)) {
        if(!AnnotationBackportUtil.NON_ANNOTATION_TAGS.contains(phpDocTag.getName())) {
            PhpClass annotationReference = AnnotationBackportUtil.getAnnotationReference(phpDocTag, uses);
            if(annotationReference != null && PhpElementsUtil.isEqualClassName(annotationReference, className)) {
                return true;
            }
        }

    }

    return false;
}
 

import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocComment; //导入依赖的package包/类
public static PhpDocTag getReference(@Nullable PhpDocComment docComment, String className) {
    if(docComment == null) return null;

    Map<String, String> uses = AnnotationBackportUtil.getUseImportMap(docComment);

    for(PhpDocTag phpDocTag: PsiTreeUtil.findChildrenOfAnyType(docComment, PhpDocTag.class)) {
        if(AnnotationBackportUtil.NON_ANNOTATION_TAGS.contains(phpDocTag.getName())) {
            continue;
        }

        PhpClass annotationReference = AnnotationBackportUtil.getAnnotationReference(phpDocTag, uses);
        if(annotationReference != null && PhpElementsUtil.isEqualClassName(annotationReference, className)) {
            return phpDocTag;
        }
    }

    return null;
}
 

import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocComment; //导入依赖的package包/类
@Override
public void getPropertyValueCompletions(AnnotationPropertyParameter annotationPropertyParameter, AnnotationCompletionProviderParameter completionParameter) {

    String propertyName = annotationPropertyParameter.getPropertyName();
    if(propertyName == null) {
        return;
    }

    if(propertyName.equals("name") && PhpLangUtil.equalsClassNames(annotationPropertyParameter.getPhpClass().getPresentableFQN(), "Doctrine\\ORM\\Mapping\\Column")) {
        PhpDocComment phpDocComment = PsiTreeUtil.getParentOfType(annotationPropertyParameter.getElement(), PhpDocComment.class);
        if(phpDocComment != null) {
            PhpPsiElement classField = phpDocComment.getNextPsiSibling();
            if(classField != null && classField.getNode().getElementType() == PhpElementTypes.CLASS_FIELDS) {
                Field field = PsiTreeUtil.getChildOfType(classField, Field.class);
                if(field != null) {
                    String name = field.getName();
                    if(StringUtils.isNotBlank(name)) {
                        completionParameter.getResult().addElement(LookupElementBuilder.create(underscore(name)));
                    }
                }
            }
        }
    }

}
 

import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocComment; //导入依赖的package包/类
@Override
protected void addCompletions(@NotNull CompletionParameters completionParameters, ProcessingContext processingContext, @NotNull CompletionResultSet completionResultSet) {
    PsiElement psiElement = completionParameters.getOriginalPosition();
    if(psiElement == null) {
        return;
    }

    PhpDocComment parentOfType = PsiTreeUtil.getParentOfType(psiElement, PhpDocComment.class);
    if(parentOfType == null) {
        return;
    }

    AnnotationTarget annotationTarget = PhpElementsUtil.findAnnotationTarget(parentOfType);
    if(annotationTarget == null) {
        return;
    }

    Map<String, String> importMap = AnnotationUtil.getUseImportMap(parentOfType);

    Project project = completionParameters.getPosition().getProject();
    attachLookupElements(project, importMap , annotationTarget, completionResultSet);

}
 

import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocComment; //导入依赖的package包/类
@NotNull
public static Map<String, String> getUseImportMap(@Nullable PhpDocComment phpDocComment) {
    if(phpDocComment == null) {
        return Collections.emptyMap();
    }

    PhpPsiElement scope = PhpCodeInsightUtil.findScopeForUseOperator(phpDocComment);
    if(scope == null) {
        return Collections.emptyMap();
    }

    Map<String, String> useImports = new HashMap<>();

    for (PhpUseList phpUseList : PhpCodeInsightUtil.collectImports(scope)) {
        for(PhpUse phpUse : phpUseList.getDeclarations()) {
            String alias = phpUse.getAliasName();
            if (alias != null) {
                useImports.put(alias, phpUse.getFQN());
            } else {
                useImports.put(phpUse.getName(), phpUse.getFQN());
            }
        }
    }

    return useImports;
}
 

import com.jetbrains.php.lang.documentation.phpdoc.psi.PhpDocComment; //导入依赖的package包/类
@Nullable
public static PhpDocCommentAnnotation getPhpDocCommentAnnotationContainer(@Nullable PhpDocComment phpDocComment) {
    if(phpDocComment == null) return null;

    Map<String, String> uses = AnnotationUtil.getUseImportMap(phpDocComment);

    Map<String, PhpDocTagAnnotation> annotationRefsMap = new HashMap<>();
    for(PhpDocTag phpDocTag: PsiTreeUtil.findChildrenOfType(phpDocComment, PhpDocTag.class)) {
        if(!AnnotationUtil.NON_ANNOTATION_TAGS.contains(phpDocTag.getName())) {
            PhpClass annotationClass = AnnotationUtil.getAnnotationReference(phpDocTag, uses);
            if(annotationClass != null) {
                annotationRefsMap.put(annotationClass.getPresentableFQN(), new PhpDocTagAnnotation(annotationClass, phpDocTag));
            }
        }

    }

    return new PhpDocCommentAnnotation(annotationRefsMap, phpDocComment);
}