Java PhpDocTag类代码示例

import com.jetbrains.php.lang.documentation.phpdoc.psi.tags.PhpDocTag; //导入依赖的package包/类
@Nullable
public static PhpClass findClassInSeeTags(PhpIndex index, PhpClass phpClass, String searchClassFQN) {
    if (phpClass.getDocComment() == null)
        return null;
    PhpClass activeRecordClass = null;
    PhpDocTag[] tags = phpClass.getDocComment().getTagElementsByName("@see");
    for (PhpDocTag tag : tags) {
        String className = tag.getText().replace(tag.getName(), "").trim();
        if (className.indexOf('\\') == -1) {
            className = phpClass.getNamespaceName() + className;
        }
        PhpClass classInSee = getClass(index, className);
        if (isClassInheritsOrEqual(classInSee, getClass(index, searchClassFQN))) {
            activeRecordClass = classInSee;
            break;
        }
    }
    return activeRecordClass;
}
 

import com.jetbrains.php.lang.documentation.phpdoc.psi.tags.PhpDocTag; //导入依赖的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.tags.PhpDocTag; //导入依赖的package包/类
/**
 * Checks if host is concrete annotation to inject syntax into it
 *
 * @param host Host element, typically string literal expression
 * @param annotationPrefix Annotation prefix
 * @return boolean
 */
public static boolean isInsideAnnotation(@NotNull StringLiteralExpression host, String annotationPrefix) {

    PhpDocTag phpDocTag = PsiTreeUtil.getParentOfType(host, PhpDocTag.class);
    if (phpDocTag == null || !AnnotationPattern.getDocBlockTag().accepts(phpDocTag)) {
        return false;
    }

    PhpDocTagAnnotation phpDocAnnotationContainer = AnnotationUtil.getPhpDocAnnotationContainer(phpDocTag);
    PhpClass phpClass = null;
    if (phpDocAnnotationContainer != null) {
        phpClass = phpDocAnnotationContainer.getPhpClass();
    }

    if (phpClass == null || phpClass.getFQN() == null) {
        return false;
    }

    return phpClass.getFQN().startsWith(annotationPrefix);

}
 

import com.jetbrains.php.lang.documentation.phpdoc.psi.tags.PhpDocTag; //导入依赖的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.tags.PhpDocTag; //导入依赖的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.tags.PhpDocTag; //导入依赖的package包/类
protected boolean tagMatches(PhpDocTag tag, String variableName)
{
    if (tag == null) {
        return false;
    }

    variableName = variableName.replace("$", "");
    String[] parts = tag.getTagValue().split(" ");
    for (String part : parts) {
        part = part.replace("$", "");
        if (part.equals(variableName)) {
            return true;
        }
    }

    return false;
}
 

import com.jetbrains.php.lang.documentation.phpdoc.psi.tags.PhpDocTag; //导入依赖的package包/类
protected String parsePhpDoc(PhpDocTag tag)
{
    if (!tag.getName().equals("@ContentType")) {
        return null;
    }

    String value = tag.getTagValue();
    if (value.length() == 0) {
        return null;
    }

    String[] parts = value.split(" ");
    if (parts.length == 1) {
        return parts[0];
    }

    String firstPart = parts[0];
    String secondPart = parts.length > 1 ? parts[1] : null;
    String contentClass = firstPart.contains("$") ? secondPart : firstPart;

    return typeSeparator() + contentClass;
}
 

import com.jetbrains.php.lang.documentation.phpdoc.psi.tags.PhpDocTag; //导入依赖的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.tags.PhpDocTag; //导入依赖的package包/类
private void visitPhpDocTag(@NotNull PhpDocTag phpDocTag) {

        // "@var" and user non related tags dont need an action
        if(AnnotationBackportUtil.NON_ANNOTATION_TAGS.contains(phpDocTag.getName())) {
            return;
        }

        Map<String, String> fileImports = AnnotationBackportUtil.getUseImportMap(phpDocTag);
        if(fileImports.size() == 0) {
            return;
        }

        String annotationFqnName = AnnotationBackportUtil.getClassNameReference(phpDocTag, fileImports);
        for (String annotation : annotations) {
            if(annotation.equals(annotationFqnName)) {
                this.phpDocTagProcessor.process(phpDocTag);
            }
        }
    }
 

import com.jetbrains.php.lang.documentation.phpdoc.psi.tags.PhpDocTag; //导入依赖的package包/类
/**
 * FooController::fooAction
 */
@Nullable
private String getController(@NotNull PhpDocTag phpDocTag) {
    Method method = AnnotationBackportUtil.getMethodScope(phpDocTag);
    if(method == null) {
        return null;
    }

    PhpClass containingClass = method.getContainingClass();
    if(containingClass == null) {
        return null;
    }

    return String.format("%s::%s",
        StringUtils.stripStart(containingClass.getFQN(), "\\"),
        method.getName()
    );
}
 

import com.jetbrains.php.lang.documentation.phpdoc.psi.tags.PhpDocTag; //导入依赖的package包/类
@Nullable
public static PhpClass getAnnotationReference(PhpDocTag phpDocTag, final Map<String, String> useImports) {

    String tagName = phpDocTag.getName();
    if(tagName.startsWith("@")) {
        tagName = tagName.substring(1);
    }

    String className = tagName;
    String subNamespaceName = "";
    if(className.contains("\\")) {
        className = className.substring(0, className.indexOf("\\"));
        subNamespaceName = tagName.substring(className.length());
    }

    if(!useImports.containsKey(className)) {
        return null;
    }

    return PhpElementsUtil.getClass(phpDocTag.getProject(), useImports.get(className) + subNamespaceName);

}
 

import com.jetbrains.php.lang.documentation.phpdoc.psi.tags.PhpDocTag; //导入依赖的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.tags.PhpDocTag; //导入依赖的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.tags.PhpDocTag; //导入依赖的package包/类
@Override
protected void addCompletions(@NotNull CompletionParameters parameters, ProcessingContext context, @NotNull CompletionResultSet result) {
    PsiElement psiElement = parameters.getOriginalPosition();
    if(psiElement == null) {
        return;
    }

    PhpDocTag phpDocTag = PsiTreeUtil.getParentOfType(parameters.getOriginalPosition(), PhpDocTag.class);
    PhpClass phpClass = AnnotationUtil.getAnnotationReference(phpDocTag);
    if(phpClass == null) {
        return;
    }

    AnnotationPropertyParameter annotationPropertyParameter = new AnnotationPropertyParameter(parameters.getOriginalPosition(), phpClass, AnnotationPropertyParameter.Type.DEFAULT);
    providerWalker(parameters, context, result, annotationPropertyParameter);

}
 

import com.jetbrains.php.lang.documentation.phpdoc.psi.tags.PhpDocTag; //导入依赖的package包/类
/**
 * Add goto for DocTag itself which should be the PhpClass and provide Extension
 *
 * @param psiElement origin DOC_TAG_NAME psi element
 * @param targets Goto targets
 */
private void addDocTagNameGoto(PsiElement psiElement, List<PsiElement> targets) {

    PsiElement phpDocTagValue = psiElement.getContext();
    if(!(phpDocTagValue instanceof PhpDocTag)) {
        return;
    }

    PhpClass phpClass = AnnotationUtil.getAnnotationReference((PhpDocTag) phpDocTagValue);
    if(phpClass == null) {
        return;
    }

    targets.add(phpClass);

    AnnotationDocTagGotoHandlerParameter parameter = new AnnotationDocTagGotoHandlerParameter((PhpDocTag) phpDocTagValue, phpClass, targets);
    for(PhpAnnotationDocTagGotoHandler phpAnnotationExtension : AnnotationUtil.EP_DOC_TAG_GOTO.getExtensions()) {
        phpAnnotationExtension.getGotoDeclarationTargets(parameter);
    }

}